Add support for multiple attribute in field_data #164

Signed-off-by: Thomas Druez <[email protected]>

Author: tdruez

scanpipe/templates/scanpipe/tabset/tab_content_default.html

@@ -1,10 +1,10 @@
 <dl>
-  {% for field_name, value in tab_data.fields.items %}
+  {% for field_name, field_data in tab_data.fields.items %}
     <dt class="has-text-weight-semibold">
-      {{ field_name }}
+      {{ field_data.label }}
     </dt>
     <dd class="mb-4">
-      <pre class="is-small">{{ value|default_if_none:''|urlize }}</pre>
+      <pre class="is-small">{{ field_data.value|default:''|default_if_none:''|urlize }}</pre>
     </dd>
   {% endfor %}
 </dl>

scanpipe/templates/scanpipe/tabset/tab_content_resources.html

@@ -1,7 +1,7 @@
 <div class="content">
-  <strong>Codebase resources</strong>
+  <strong>{{ tab_data.fields.codebase_resources.label }}</strong>
   <ul>
-    {% for resource in tab_data.fields.codebase_resources.all %}
+    {% for resource in tab_data.fields.codebase_resources.value.all %}
       <li>
         <a href="{{ resource.get_absolute_url }}">{{ resource }}</a>
       </li>

scanpipe/views.py

@@ -170,40 +170,62 @@ def get_tabset_data(self):
             tab_data = {
                 "icon_class": tab_definition.get("icon_class"),
                 "template": tab_definition.get("template"),
-                "fields": self.get_fields_with_values(tab_definition.get("fields"))
+                "fields": self.get_fields_data(tab_definition.get("fields"))
             }
             tabset_data[label] = tab_data
 
         return tabset_data
 
-    def get_fields_with_values(self, fields):
+    def get_fields_data(self, fields):
         """
         Returns the tab fields including their values for display.
         """
-        fields_with_values = {}
+        fields_data = {}
 
-        for field_name in fields:
-            fields_with_values[field_name] = self.get_field_data(field_name)
+        for field_definition in fields:
+            # Support for single "field_name" entry in fields list.
+            if not isinstance(field_definition, dict):
+                field_name = field_definition
+                field_data = {'name': field_name}
+            else:
+                field_name = field_definition.get('name')
+                field_data = field_definition[:]
+
+            if 'label' not in field_data:
+                field_data['label'] = self.get_field_label(field_name)
+
+            field_data['value'] = self.get_field_value(field_name)
 
-        return fields_with_values
+            fields_data[field_name] = field_data
 
-    def get_field_data(self, field_name):
+        return fields_data
+
+    def get_field_value(self, field_name):
         """
         Returns the formatted value for the given `field_name` on the current object.
         """
         field_value = getattr(self.object, field_name, None)
+
+        # TODO: Implement proper render for those fields.
+        if field_name in ['dependencies']:
+            return field_value
+
         if isinstance(field_value, list):
             field_value = "\n".join(field_value)
+
         return field_value
 
-    # @staticmethod
-    # def get_field_label(field_name):
-    #     return (
-    #         field_name
-    #         .replace("_", " ")
-    #         .capitalize()
-    #         .replace("url", "URL")
-    #     )
+    @staticmethod
+    def get_field_label(field_name):
+        """
+        Returns a formatted label for display based on the `field_name`.
+        """
+        return (
+            field_name
+            .replace("_", " ")
+            .capitalize()
+            .replace("url", "URL")
+        )
 
     def get_context_data(self, **kwargs):
         context = super().get_context_data(**kwargs)