Add descriptions (#194)

* Add descriptions

* Fix ci

Author: haneslinger

.github/workflows/ci.yml

@@ -9,7 +9,7 @@ on:
 
 jobs:
   test:
-    runs-on: ubuntu-latest
+    runs-on: ubuntu-20.04
     strategy:
       matrix:
         tox_env: [python] #, precommit]
@@ -31,7 +31,7 @@ jobs:
       - uses: actions/checkout@v3
       - uses: actions/setup-python@v3
         with:
-          python-version: "3.7"
+          python-version: "3.6.7"
       - name: Display system info
         run: python -c "import sys; print(sys.version)"
       - name: Setup Python

bsyncviewer/lib/schema_parser.py

@@ -569,6 +569,7 @@ def _walk_sequence_or_choice_element(self, parent_element, root_path, current_tr
                 num_added += 1
                 return_rows.append({
                     'name': elem.name,
+                    'description': "; ".join([anno.documentation for  anno in elem.annotations]),
                     'type': elem.name,
                     'parent_path': root_path,
                     'path': root_path + '.' + elem.name,
@@ -612,6 +613,7 @@ def _walk_sequence_or_choice_element(self, parent_element, root_path, current_tr
                 num_added += 1
                 return_rows.append({
                     'name': elem.name,
+                    'description': "; ".join([anno.documentation for  anno in elem.annotations]),
                     'path': root_path + '.' + elem.name,
                     'type': NamedElement.my_string(),
                     'parent_path': root_path,
@@ -646,6 +648,7 @@ def _walk_sequence_or_choice_element(self, parent_element, root_path, current_tr
                 ref_type_clean = elem.ref_type
             return_rows.append({
                 'name': ref_type_clean,
+                'description': "; ".join([anno.documentation for  anno in elem.annotations]),
                 'path': root_path + '.' + ref_type_clean,
                 'type': ReferenceElement.my_string(),
                 'parent_path': root_path,
@@ -737,6 +740,7 @@ def _walk_restriction_element(parent_element, root_path, current_tree_level, cur
 
             return_rows.append({
                 'name': elem,
+                'description': None,
                 'full_path': root_path,
                 'path': the_path,
                 'type': 'Enumeration',
@@ -790,6 +794,7 @@ def process_schema(schema_object):
             # add 1 to tree level to account for root
             b = Attribute(
                 name=se['name'],
+                description=se["description"],
                 type=se['type'],
                 tree_level=(se['$$treeLevel'] + 1),
                 parent=get_parent_from_path(se['parent_path'], schema_object),

bsyncviewer/lib/tree_viewer.py

@@ -27,6 +27,7 @@ def get_jstree_node(el):
     node = {
         'id': u'{}'.format(el.pk),
         'text': u'{}'.format(node_name),
+        "description": u'{}'.format(el.description),
         'parent': u'{}'.format(parent_node),
         'icon': False
     }

bsyncviewer/migrations/0014_attribute_description.py

@@ -0,0 +1,18 @@
+# Generated by Django 2.2.28 on 2025-01-31 21:10
+
+from django.db import migrations, models
+
+
+class Migration(migrations.Migration):
+
+    dependencies = [
+        ('bsyncviewer', '0013_auto_20220408_2025'),
+    ]
+
+    operations = [
+        migrations.AddField(
+            model_name='attribute',
+            name='description',
+            field=models.CharField(default=None, max_length=15000, null=True),
+        ),
+    ]

bsyncviewer/models/attribute.py

@@ -3,6 +3,7 @@
 
 class Attribute(models.Model):
     name = models.CharField(max_length=250, db_index=True)
+    description = models.CharField(max_length=15000, null=True, default=None)
     type = models.CharField(max_length=100, default="<unknown_type>")
     schema = models.ForeignKey(
         'Schema', on_delete=models.CASCADE, related_name="attributes", db_index=True

bsyncviewer/static/css/overrides.css

@@ -246,6 +246,10 @@ a#current-path {
   font-size: 0.8em;
 }
 
+#term_description {
+  font-size: 0.8em;
+}
+
 ul.term-pad {
   padding-left: 10px !important;
 }

bsyncviewer/templates/dictionary.html

@@ -82,6 +82,7 @@ <h3 class="panel-title">Quicklinks</h3>
         </div>
 
         <h3 id="term_title" class="hidden">SELECTED NAME</h3>
+        <h3 id="term_description" class="hidden">SELECTED DESCRIPTION</h3>
         <div id="bedes_panel" class="panel panel-default hidden">
           <div class="panel-heading">
             <h4 class="panel-title">Data Dictionary Links</h4>
@@ -123,7 +124,6 @@ <h4 class="panel-title">Enumerations</h4>
     $(function () {
       let data = {{ schema_tree_data|safe }};
 
-
       $('#schematree').jstree({
         'core': {
           'data': data,
@@ -155,6 +155,9 @@ <h4 class="panel-title">Enumerations</h4>
                 $('#bedes_panel').removeClass('hidden').addClass('visible');
                 $('#term_title').removeClass('hidden').addClass('visible');
                 $('#term_title').html(node.text);
+
+                $('#term_description').removeClass('hidden').addClass('visible');
+                $('#term_description').html(node.original.description);
               } else {
                 $('#term_title').removeClass('visible').addClass('hidden');
                 $('#bedes_panel').removeClass('visible').addClass('hidden');