libcoveweb2: additional_fields: additional_checks: jsonschema_validat…

…ion: Print JSON values nicer * quote strings * print lists as lists, with longer ones collapsed by default #20 #13 #22
Open-Telecoms-Data · Dec 20, 2022 · ba98bb3 · ba98bb3
1 parent d00df4e
commit ba98bb3
Show file tree

Hide file tree

Showing 7 changed files with 79 additions and 40 deletions.
diff --git a/cove_ofds/templates/cove_ofds/additional_checks_table.html b/cove_ofds/templates/cove_ofds/additional_checks_table.html
@@ -34,7 +34,7 @@ <h4>
                         {{ additional_check.path }}
                     </td>
                     <td>
-                        {{ additional_check.missing_node_id }}
+                        {% include "libcoveweb2/show_json_value.html" with value=additional_check.missing_node_id %}
                     </td>
                 </tr>
             {% endfor %}
@@ -50,7 +50,7 @@ <h4>
                         {{ additional_check.path }}
                     </td>
                     <td>
-                        {{ additional_check.missing_node_id }}
+                        {% include "libcoveweb2/show_json_value.html" with value=additional_check.missing_node_id %}
                     </td>
                 </tr>
             {% endfor %}
@@ -90,7 +90,7 @@ <h4>
                         {{ additional_check.path }}
                     </td>
                     <td>
-                        {{ additional_check.incorrect_type }}
+                        {% include "libcoveweb2/show_json_value.html" with value=additional_check.incorrect_type %}
                     </td>
                 </tr>
             {% endfor %}
@@ -130,7 +130,7 @@ <h4>
                         {{ additional_check.path }}
                     </td>
                     <td>
-                        {{ additional_check.incorrect_coordinates }}
+                        {% include "libcoveweb2/show_json_value.html" with value=additional_check.incorrect_coordinates %}
                     </td>
                 </tr>
             {% endfor %}
@@ -170,7 +170,7 @@ <h4>
                         {{ additional_check.path }}
                     </td>
                     <td>
-                        {{ additional_check.incorrect_type }}
+                        {% include "libcoveweb2/show_json_value.html" with value=additional_check.incorrect_type %}
                     </td>
                 </tr>
             {% endfor %}
@@ -210,7 +210,7 @@ <h4>
                         {{ additional_check.path }}
                     </td>
                     <td>
-                        {{ additional_check.incorrect_coordinates }}
+                        {% include "libcoveweb2/show_json_value.html" with value=additional_check.incorrect_coordinates %}
                     </td>
                 </tr>
             {% endfor %}
@@ -251,7 +251,7 @@ <h4>
                             {{ additional_check.path }}
                         </td>
                         <td>
-                            {{ additional_check.phase_id_not_found }}
+                            {% include "libcoveweb2/show_json_value.html" with value=additional_check.phase_id_not_found %}
                         </td>
                     </tr>
                 {% endfor %}
@@ -281,7 +281,7 @@ <h4>
                             {{ additional_check.path }}
                         </td>
                         <td>
-                            {{ additional_check.phase_id_not_found }}
+                            {% include "libcoveweb2/show_json_value.html" with value=additional_check.phase_id_not_found %}
                         </td>
                     </tr>
                 {% endfor %}
@@ -311,7 +311,7 @@ <h4>
                             {{ additional_check.path }}
                         </td>
                         <td>
-                            {{ additional_check.phase_id_not_found }}
+                            {% include "libcoveweb2/show_json_value.html" with value=additional_check.phase_id_not_found %}
                         </td>
                     </tr>
                 {% endfor %}
@@ -356,10 +356,10 @@ <h4>
                             {{ additional_check.path }}
                         </td>
                         <td>
-                            {{ additional_check.name_in_reference }}
+                            {% include "libcoveweb2/show_json_value.html" with value=additional_check.name_in_reference %}
                         </td>
                         <td>
-                            {{ additional_check.name_should_be }}
+                            {% include "libcoveweb2/show_json_value.html" with value=additional_check.name_should_be %}
                         </td>
                     </tr>
                 {% endfor %}
@@ -390,10 +390,10 @@ <h4>
                             {{ additional_check.path }}
                         </td>
                         <td>
-                            {{ additional_check.name_in_reference }}
+                            {% include "libcoveweb2/show_json_value.html" with value=additional_check.name_in_reference %}
                         </td>
                         <td>
-                            {{ additional_check.name_should_be }}
+                            {% include "libcoveweb2/show_json_value.html" with value=additional_check.name_should_be %}
                         </td>
                     </tr>
                 {% endfor %}
@@ -424,10 +424,10 @@ <h4>
                             {{ additional_check.path }}
                         </td>
                         <td>
-                            {{ additional_check.name_in_reference }}
+                            {% include "libcoveweb2/show_json_value.html" with value=additional_check.name_in_reference %}
                         </td>
                         <td>
-                            {{ additional_check.name_should_be }}
+                            {% include "libcoveweb2/show_json_value.html" with value=additional_check.name_should_be %}
                         </td>
                     </tr>
                 {% endfor %}
@@ -469,7 +469,7 @@ <h4>
                             {{ additional_check.path }}
                         </td>
                         <td>
-                            {{ additional_check.organisation_id_not_found }}
+                            {% include "libcoveweb2/show_json_value.html" with value=additional_check.organisation_id_not_found %}
                         </td>
                     </tr>
                 {% endfor %}
@@ -499,7 +499,7 @@ <h4>
                             {{ additional_check.path }}
                         </td>
                         <td>
-                            {{ additional_check.organisation_id_not_found }}
+                            {% include "libcoveweb2/show_json_value.html" with value=additional_check.organisation_id_not_found %}
                         </td>
                     </tr>
                 {% endfor %}
@@ -529,7 +529,7 @@ <h4>
                             {{ additional_check.path }}
                         </td>
                         <td>
-                            {{ additional_check.organisation_id_not_found }}
+                            {% include "libcoveweb2/show_json_value.html" with value=additional_check.organisation_id_not_found %}
                         </td>
                     </tr>
                 {% endfor %}
@@ -577,10 +577,10 @@ <h4>
                             {{ additional_check.path }}
                         </td>
                         <td>
-                            {{ additional_check.name_in_reference }}
+                            {% include "libcoveweb2/show_json_value.html" with value=additional_check.name_in_reference %}
                         </td>
                         <td>
-                            {{ additional_check.name_should_be }}
+                            {% include "libcoveweb2/show_json_value.html" with value=additional_check.name_should_be %}
                         </td>
                     </tr>
                 {% endfor %}
@@ -615,10 +615,10 @@ <h4>
                             {{ additional_check.path }}
                         </td>
                         <td>
-                            {{ additional_check.name_in_reference }}
+                            {% include "libcoveweb2/show_json_value.html" with value=additional_check.name_in_reference %}
                         </td>
                         <td>
-                            {{ additional_check.name_should_be }}
+                            {% include "libcoveweb2/show_json_value.html" with value=additional_check.name_should_be %}
                         </td>
                     </tr>
                 {% endfor %}
@@ -649,10 +649,10 @@ <h4>
                             {{ additional_check.path }}
                         </td>
                         <td>
-                            {{ additional_check.name_in_reference }}
+                            {% include "libcoveweb2/show_json_value.html" with value=additional_check.name_in_reference %}
                         </td>
                         <td>
-                            {{ additional_check.name_should_be }}
+                            {% include "libcoveweb2/show_json_value.html" with value=additional_check.name_should_be %}
                         </td>
                     </tr>
                 {% endfor %}

diff --git a/cove_ofds/templates/cove_ofds/jsonschema_validation_table.html b/cove_ofds/templates/cove_ofds/jsonschema_validation_table.html
@@ -1,6 +1,5 @@
 {% load i18n %}
 {% load cove_tags %}
-{% load ofds_cove_tags %}
 
 
 <div style="text-align: right;">
@@ -46,12 +45,12 @@
                 </td>
                 {% if col_instance %}
                     <td>
-                        {{ error.instance|error_instance_display }}
+                        {% include "libcoveweb2/show_json_value.html" with value=error.instance %}
                     </td>
                 {% endif %}
                 {% if col_validator_value %}
                     <td>
-                        {{ error.validator_value }}
+                        {% include "libcoveweb2/show_json_value.html" with value=error.validator_value %}
                     </td>
                 {% endif %}
             </tr>

diff --git a/cove_ofds/templatetags/__init__.py b/cove_ofds/templatetags/__init__.py
diff --git a/cove_ofds/templatetags/ofds_cove_tags.py b/cove_ofds/templatetags/ofds_cove_tags.py
diff --git a/libcoveweb2/templates/libcoveweb2/additional_fields_table.html b/libcoveweb2/templates/libcoveweb2/additional_fields_table.html
@@ -20,7 +20,7 @@
          <td>{{info.count}}</td>
          <td>
            {% for example in info.examples %}
-           {{example}} <br />
+           {% include "libcoveweb2/show_json_value.html" with value=example %} <br />
            {% endfor %}
          </td>
          <td>
@@ -64,7 +64,7 @@ <h4>{% blocktrans %}Child fields of {{parent_full_path}}{% endblocktrans %} </h4
                     <td>{{info.count}}</td>
                     <td>
                       {% for example in info.examples %}
-                        {{example}} <br />
+                        {% include "libcoveweb2/show_json_value.html" with value=example %} <br />
                       {% endfor %}
                     </td>
                  </tr>

diff --git a/libcoveweb2/templates/libcoveweb2/show_json_value.html b/libcoveweb2/templates/libcoveweb2/show_json_value.html
@@ -0,0 +1,32 @@
+{% load cove_tags %}
+
+{% if value|get_variable_type == 'str' %}
+    "{{ value }}"
+{% elif value|get_variable_type == 'list' %}
+    {% if value|length > 5 %}
+        <ul>
+            {% for v in value|slice:":5" %}
+                <li>{% include "libcoveweb2/show_json_value.html" with value=v dont_expand_lists=True %}</li>
+            {% endfor %}
+        </ul>
+        {% show_json_value_more_id as id %}
+        <button class="btn btn-primary" type="button" data-toggle="collapse" data-target="#{{ id }}" aria-expanded="false" aria-controls="{{ id }}">
+            Show/Hide more
+        </button>
+        <div class="collapse" id="{{ id }}">
+            <ul>
+                {% for v in value|slice:"5:" %}
+                    <li>{% include "libcoveweb2/show_json_value.html" with value=v dont_expand_lists=True %}</li>
+                {% endfor %}
+            </ul>
+        </div>
+    {% else %}
+        <ul>
+            {% for v in value %}
+                <li>{% include "libcoveweb2/show_json_value.html" with value=v dont_expand_lists=True %}</li>
+            {% endfor %}
+        </ul>
+    {% endif %}
+{% else %}
+    {{ value }}
+{% endif %}
diff --git a/libcoveweb2/templatetags/cove_tags.py b/libcoveweb2/templatetags/cove_tags.py
@@ -64,3 +64,22 @@ def take_or_sample(population, k):
 @register.filter(name="list_from_attribute")
 def list_from_attribute(list_of_dicts, key_name):
     return [value[key_name] for value in list_of_dicts]
+
+
+@register.filter(name="get_variable_type")
+def get_variable_type(value):
+    return type(value).__name__
+
+
+show_json_value_more_counter = 0
+
+
+@register.simple_tag
+def show_json_value_more_id():
+    """
+    Used by libcoveweb2/templates/libcoveweb2/show_json_value.html
+    To make sure that every time we need a show/hide link there, we get a unique CSS ID
+    """
+    global show_json_value_more_counter
+    show_json_value_more_counter = show_json_value_more_counter + 1
+    return "json_value_more_" + str(show_json_value_more_counter)