Update HTML export

marcggl · May 5, 2024 · 11d8350 · 11d8350
1 parent 5f4e4c7
commit 11d8350
Show file tree

Hide file tree

Showing 7 changed files with 124 additions and 23 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -9,10 +9,12 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ### Added
 
+- Added import glue (#166)
 - Added test support for `azure` (#146)
 - Added support for `delta` tables on S3 (#24)
 - Added new command `datacontract catalog` that generates a data contract catalog with an `index.html` file.
-
+- Added field format information to HTML export
+
 ### Fixed
 - RDF Export: Fix error if owner is not a URI/URN
 

diff --git a/datacontract/breaking/breaking_rules.py b/datacontract/breaking/breaking_rules.py
@@ -20,6 +20,10 @@ class BreakingRules:
     field_ref_removed = Severity.WARNING
     field_ref_updated = Severity.WARNING
 
+    field_title_added = Severity.INFO
+    field_title_removed = Severity.INFO
+    field_title_updated = Severity.INFO
+
     field_type_added = Severity.WARNING
     field_type_removed = Severity.WARNING
     field_type_updated = Severity.ERROR

diff --git a/datacontract/model/data_contract_specification.py b/datacontract/model/data_contract_specification.py
@@ -63,6 +63,7 @@ class Definition(pyd.BaseModel):
 class Field(pyd.BaseModel):
     ref: str = pyd.Field(default=None, alias="$ref")
     ref_obj: Definition = pyd.Field(default=None, exclude=True)
+    title: str = None
     type: str = None
     format: str = None
     required: bool = None
@@ -95,6 +96,7 @@ class Model(pyd.BaseModel):
 class Info(pyd.BaseModel):
     title: str = None
     version: str = None
+    status: str = None
     description: str = None
     owner: str = None
     contact: Contact = None

diff --git a/datacontract/templates/datacontract.html b/datacontract/templates/datacontract.html
@@ -78,6 +78,13 @@ <h1 class="text-base font-semibold leading-6 text-gray-900" id="info">Info</h1>
                     <dd class="mt-1 text-sm text-gray-900">{{ datacontract.info.version }}</dd>
                   </div>
 
+                  {% if datacontract.info.status %}
+                  <div class="sm:col-span-1">
+                    <dt class="text-sm font-medium text-gray-500">Status</dt>
+                    <dd class="mt-1 text-sm text-gray-900">{{ datacontract.info.status }}</dd>
+                  </div>
+                  {% endif %}
+
                   {% if datacontract.info.description %}
                   <div class="sm:col-span-2">
                     <dt class="text-sm font-medium text-gray-500">Description</dt>
@@ -353,7 +360,7 @@ <h1 class="text-base font-semibold leading-6 text-gray-900">
                     <table class="min-w-full divide-y divide-gray-300">
                       <thead class="bg-gray-50">
                       <tr>
-                        <th scope="colgroup" colspan="4" class="py-2 pl-4 pr-3 text-left font-semibold text-gray-900 sm:pl-6">
+                        <th scope="colgroup" colspan="3" class="py-2 pl-4 pr-3 text-left font-semibold text-gray-900 sm:pl-6">
                           <span>{{ model_name }}</span>
                           <span class="inline-flex items-center rounded-md bg-gray-50 px-2 py-1 text-xs font-medium text-gray-600 ring-1 ring-inset ring-gray-500/10">{{ model.type }}</span>
                           <div class="text-sm font-medium text-gray-500">{{ model.description }}</div>
@@ -366,28 +373,81 @@ <h1 class="text-base font-semibold leading-6 text-gray-900">
                       {% for field_name, field in model.fields.items() %}
 
                       <tr>
-                        <td class="whitespace-nowrap py-2 pl-4 pr-2 text-sm font-medium text-gray-900 sm:pl-6 w-3/12">
+                        <td class="whitespace-nowrap py-2 pl-4 pr-2 text-sm font-medium text-gray-900 sm:pl-6 w-2/12">
                           <div class="py-2 text-sm">
-                            {{ field_name }}
+                            {% if field.title %}
+                            <div>{{ field.title }}</div>
+                            {% endif %}
+                            <div class="font-mono">{{ field_name }}</div>
                             {# TODO nested fields #}
                           </div>
                         </td>
-                        <td class="whitespace-nowrap px-1 py-2 text-sm text-gray-500 w-16">
-                          {% if field.required %}
-                          <span class="inline-flex items-center rounded-md bg-gray-50 px-1 py-1 text-xs font-medium text-gray-600 ring-1 ring-inset ring-gray-500/10" title="required">R</span>
-                          {% endif %}
-                          {% if field.unique %}
-                          <span class="inline-flex items-center rounded-md bg-gray-50 px-1 py-1 text-xs font-medium text-gray-600 ring-1 ring-inset ring-gray-500/10" title="unique">U</span>
-                          {% endif %}
-                        </td>
                         <td class="whitespace-nowrap px-1 py-2 text-sm text-gray-500 w-1/12">
                           {% if field.type %}
                           {{ field.type }}
                           {% endif %}
                         </td>
                         <td class="px-3 py-2 text-sm text-gray-500 w-7/12">
-                          <div class="text-gray-400">{{ field.description or "No description" }}</div>
-                          {# TODO add format information #}
+                          {% if field.description %}
+                          <div class="text-gray-500">{{ field.description }}</div>
+                          {% else %}
+                          <div class="text-gray-400">No description</div>
+                          {% endif %}
+
+                          {% if field.example %}
+                          <div class="mt-1 italic">
+                            Example: {{ field.example }}
+                          </div>
+                          {% endif %}
+
+                          <div>
+                            {% if field.primary %}
+                            <span class="inline-flex items-center rounded-md bg-gray-50 px-1 py-1 text-xs font-medium text-gray-600 ring-1 ring-inset ring-gray-500/10 mr-1 mt-1">primary</span>
+                            {% endif %}
+                            {% if field.required %}
+                            <span class="inline-flex items-center rounded-md bg-gray-50 px-1 py-1 text-xs font-medium text-gray-600 ring-1 ring-inset ring-gray-500/10 mr-1 mt-1">required</span>
+                            {% endif %}
+                            {% if field.unique %}
+                            <span class="inline-flex items-center rounded-md bg-gray-50 px-1 py-1 text-xs font-medium text-gray-600 ring-1 ring-inset ring-gray-500/10 mr-1 mt-1">unique</span>
+                            {% endif %}
+                            {% if field.format %}
+                            <span class="inline-flex items-center rounded-md bg-gray-50 px-1 py-1 text-xs font-medium text-gray-600 ring-1 ring-inset ring-gray-500/10 mr-1 mt-1">format:{{ field.format }}</span>
+                            {% endif %}
+                            {% if field.minLength %}
+                            <span class="inline-flex items-center rounded-md bg-gray-50 px-1 py-1 text-xs font-medium text-gray-600 ring-1 ring-inset ring-gray-500/10 mr-1 mt-1">minLength:{{ field.minLength }}</span>
+                            {% endif %}
+                            {% if field.maxLength %}
+                            <span class="inline-flex items-center rounded-md bg-gray-50 px-1 py-1 text-xs font-medium text-gray-600 ring-1 ring-inset ring-gray-500/10 mr-1 mt-1">maxLength:{{ field.maxLength }}</span>
+                            {% endif %}
+                            {% if field.pattern %}
+                            <span class="inline-flex items-center rounded-md bg-gray-50 px-1 py-1 text-xs font-medium text-gray-600 ring-1 ring-inset ring-gray-500/10 mr-1 mt-1">pattern:{{ field.pattern }}</span>
+                            {% endif %}
+                            {% if field.precision %}
+                            <span class="inline-flex items-center rounded-md bg-gray-50 px-1 py-1 text-xs font-medium text-gray-600 ring-1 ring-inset ring-gray-500/10 mr-1 mt-1">precision:{{ field.precision }}</span>
+                            {% endif %}
+                            {% if field.scale %}
+                            <span class="inline-flex items-center rounded-md bg-gray-50 px-1 py-1 text-xs font-medium text-gray-600 ring-1 ring-inset ring-gray-500/10 mr-1 mt-1">scale:{{ field.scale }}</span>
+                            {% endif %}
+                            {% if field.minimum %}
+                            <span class="inline-flex items-center rounded-md bg-gray-50 px-1 py-1 text-xs font-medium text-gray-600 ring-1 ring-inset ring-gray-500/10 mr-1 mt-1">minimum:{{ field.minimum }}</span>
+                            {% endif %}
+                            {% if field.exclusiveMinimum %}
+                            <span class="inline-flex items-center rounded-md bg-gray-50 px-1 py-1 text-xs font-medium text-gray-600 ring-1 ring-inset ring-gray-500/10 mr-1 mt-1">exclusiveMinimum:{{ field.exclusiveMinimum }}</span>
+                            {% endif %}
+                            {% if field.maximum %}
+                            <span class="inline-flex items-center rounded-md bg-gray-50 px-1 py-1 text-xs font-medium text-gray-600 ring-1 ring-inset ring-gray-500/10 mr-1 mt-1">maximum:{{ field.maximum }}</span>
+                            {% endif %}
+                            {% if field.exclusiveMaximum %}
+                            <span class="inline-flex items-center rounded-md bg-gray-50 px-1 py-1 text-xs font-medium text-gray-600 ring-1 ring-inset ring-gray-500/10 mr-1 mt-1">exclusiveMaximum:{{ field.exclusiveMaximum }}</span>
+                            {% endif %}
+                            {% if field.classification %}
+                            <span class="inline-flex items-center rounded-md bg-blue-50 px-1 py-1 text-xs font-medium text-blue-600 ring-1 ring-inset ring-blue-500/10 mr-1 mt-1">{{ field.classification }}</span>
+                            {% endif %}
+                            {% if field.pii %}
+                            <span class="inline-flex items-center rounded-md bg-yellow-50 px-1 py-1 text-xs font-medium text-yellow-600 ring-1 ring-inset ring-yellow-500/10 mr-1 mt-1">PII</span>
+                            {% endif %}
+                          </div>
+
                         </td>
 
                       </tr>

diff --git a/datacontract/templates/style/output.css b/datacontract/templates/style/output.css
@@ -736,12 +736,8 @@ video {
   width: 2.5rem;
 }
 
-.w-16 {
-  width: 4rem;
-}
-
-.w-3\/12 {
-  width: 25%;
+.w-2\/12 {
+  width: 16.666667%;
 }
 
 .w-4 {
@@ -929,6 +925,11 @@ video {
   border-radius: 0.375rem;
 }
 
+.bg-blue-50 {
+  --tw-bg-opacity: 1;
+  background-color: rgb(239 246 255 / var(--tw-bg-opacity));
+}
+
 .bg-gray-100 {
   --tw-bg-opacity: 1;
   background-color: rgb(243 244 246 / var(--tw-bg-opacity));
@@ -954,6 +955,11 @@ video {
   background-color: rgb(255 255 255 / var(--tw-bg-opacity));
 }
 
+.bg-yellow-50 {
+  --tw-bg-opacity: 1;
+  background-color: rgb(254 252 232 / var(--tw-bg-opacity));
+}
+
 .bg-opacity-75 {
   --tw-bg-opacity: 0.75;
 }
@@ -1054,6 +1060,10 @@ video {
   vertical-align: middle;
 }
 
+.font-mono {
+  font-family: ui-monospace, SFMono-Regular, Menlo, Monaco, Consolas, "Liberation Mono", "Courier New", monospace;
+}
+
 .text-2xl {
   font-size: 1.5rem;
   line-height: 2rem;
@@ -1091,6 +1101,10 @@ video {
   font-weight: 600;
 }
 
+.italic {
+  font-style: italic;
+}
+
 .leading-5 {
   line-height: 1.25rem;
 }
@@ -1103,6 +1117,11 @@ video {
   line-height: 1.75rem;
 }
 
+.text-blue-600 {
+  --tw-text-opacity: 1;
+  color: rgb(37 99 235 / var(--tw-text-opacity));
+}
+
 .text-gray-400 {
   --tw-text-opacity: 1;
   color: rgb(156 163 175 / var(--tw-text-opacity));
@@ -1133,6 +1152,11 @@ video {
   color: rgb(255 255 255 / var(--tw-text-opacity));
 }
 
+.text-yellow-600 {
+  --tw-text-opacity: 1;
+  color: rgb(202 138 4 / var(--tw-text-opacity));
+}
+
 .shadow {
   --tw-shadow: 0 1px 3px 0 rgb(0 0 0 / 0.1), 0 1px 2px -1px rgb(0 0 0 / 0.1);
   --tw-shadow-colored: 0 1px 3px 0 var(--tw-shadow-color), 0 1px 2px -1px var(--tw-shadow-color);
@@ -1166,6 +1190,10 @@ video {
   --tw-ring-color: rgb(0 0 0 / var(--tw-ring-opacity));
 }
 
+.ring-blue-500\/10 {
+  --tw-ring-color: rgb(59 130 246 / 0.1);
+}
+
 .ring-gray-300 {
   --tw-ring-opacity: 1;
   --tw-ring-color: rgb(209 213 219 / var(--tw-ring-opacity));
@@ -1179,6 +1207,10 @@ video {
   --tw-ring-color: rgb(17 24 39 / 0.05);
 }
 
+.ring-yellow-500\/10 {
+  --tw-ring-color: rgb(234 179 8 / 0.1);
+}
+
 .ring-opacity-5 {
   --tw-ring-opacity: 0.05;
 }

diff --git a/tests/fixtures/export/datacontract.yaml b/tests/fixtures/export/datacontract.yaml
@@ -3,6 +3,7 @@ id: orders-unit-test
 info:
   title: Orders Unit Test
   version: 1.0.0
+  status: active
   owner: checkout
   description: The orders data contract
   contact:

diff --git a/tests/test_changelog.py b/tests/test_changelog.py
@@ -599,7 +599,7 @@ def test_definition_added():
     output = result.stdout
 
     assert result.exit_code == 0
-    assert "15 changes: 0 error, 13 warning, 2 info\n" in output
+    assert "16 changes: 0 error, 13 warning, 3 info\n" in output
     assert (
         r"""warning [field_ref_added] at 
 ./fixtures/breaking/datacontract-definitions-v2.yaml
@@ -719,7 +719,7 @@ def test_definition_removed():
     output = result.stdout
 
     assert result.exit_code == 0
-    assert "15 changes: 3 error, 9 warning, 3 info\n" in output
+    assert "16 changes: 3 error, 9 warning, 4 info\n" in output
     assert (
         r"""warning [field_ref_removed] at 
 ./fixtures/breaking/datacontract-definitions-v1.yaml
@@ -839,7 +839,7 @@ def test_definition_updated():
     output = result.stdout
 
     assert result.exit_code == 0
-    assert "15 changes: 12 error, 1 warning, 2 info\n" in output
+    assert "16 changes: 12 error, 1 warning, 3 info\n" in output
     assert (
         r"""warning [field_ref_updated] at 
 ./fixtures/breaking/datacontract-definitions-v3.yaml