Merge pull request #4 from openapi-json-schema-tools/feat_adds_key_info_to_required_report

Adds required key info

Author: spacether

analyze.py

@@ -35,7 +35,7 @@ def write_required_report(filtered_document_paths: typing.List[str], metrics_dat
         table_headers=('Metric', 'Qty'),
         table_data=tuple({
             'openapi_documents_qty': len(filtered_document_paths),
-            'required_key_qty': metrics_data.required_key_qty,
+            'required_usage_qty': metrics_data.required_usage_qty,
             'properties_adjacent_to_type_qty': len(metrics_data.required_adjacent_to_type),
             'properties_not_adjacent_to_type_qty': metrics_data.required_not_adjacent_to_type_qty,
         }.items())
@@ -45,12 +45,18 @@ def write_required_report(filtered_document_paths: typing.List[str], metrics_dat
         table_headers=('Type', 'Qty'),
         table_data=tuple(metrics_data.required_adjacent_to_type.items())
     )
+    required_key_info = report.TableInfo(
+        title='Required Key to Qty',
+        table_headers=('Required Key', 'Qty'),
+        table_data=tuple(metrics_data.required_key_to_qty.items())
+    )
     required_report = report.ReportInfo(
         title='Json Schema keyword=required Usage Info',
         description='Counts number of required keyword usages. Analyzes keyword=type info adjacent to required. documents: 3.0.0-3.1.0 yaml specs only',
         table_infos={
             'required_info': required_info,
-            'required_adjacent_info': required_adjacent_info
+            'required_adjacent_info': required_adjacent_info,
+            'required_key_info': required_key_info
         }
     )
     with open('reports/required_report.md', 'wt') as stream:
@@ -65,9 +71,10 @@ def write_required_report(filtered_document_paths: typing.List[str], metrics_dat
     print(f"properties_key_qty={metrics_data.properties_key_qty}")
     print(f"properties_adjacent_to_type={metrics_data.properties_adjacent_to_type}")
     print(f"properties_not_adjacent_to_type_qty={metrics_data.properties_not_adjacent_to_type_qty}")
-    print(f"required_key_qty={metrics_data.required_key_qty}")
+    print(f"required_usage_qty={metrics_data.required_usage_qty}")
     print(f"required_adjacent_to_type={metrics_data.required_adjacent_to_type}")
     print(f"required_not_adjacent_to_type_qty={metrics_data.required_not_adjacent_to_type_qty}")
+    print(f"required_key_to_qty={metrics_data.required_key_to_qty}")
 
     write_properties_report(filtered_document_paths, metrics_data)
     write_required_report(filtered_document_paths, metrics_data)

analyzer/loader.py

@@ -4,7 +4,7 @@
 import typing
 
 import yaml
-from yaml import constructor, resolver, _yaml
+from yaml import constructor, resolver, _yaml, nodes
 
 def find_document_paths() -> typing.List[str]:
     # note there are no json files
@@ -38,9 +38,11 @@ class MetricsData:
     properties_key_qty: int = 0
     properties_not_adjacent_to_type_qty: int = 0
     properties_adjacent_to_type: typing.Dict[str, int] = dataclasses.field(default_factory=lambda: {})
-    required_key_qty: int = 0
+    required_usage_qty: int = 0
     required_not_adjacent_to_type_qty: int = 0
     required_adjacent_to_type: typing.Dict[str, int] = dataclasses.field(default_factory=lambda: {})
+    required_key_to_qty: typing.Dict[str, int] = dataclasses.field(default_factory=lambda: {})
+
 
 
 class CustomConstructor(constructor.SafeConstructor):
@@ -60,9 +62,13 @@ def construct_mapping(self, node, deep=False):
             else:
                 self.metrics_data.properties_not_adjacent_to_type_qty += 1
         if 'required' in res:
-            val = res['required']
-            if type(val) is list:
-                self.metrics_data.required_key_qty += 1
+            required_keys = res['required']
+            if type(required_keys) is list:
+                self.metrics_data.required_usage_qty += 1
+                for required_key in required_keys:
+                    if required_key not in self.metrics_data.required_key_to_qty:
+                        self.metrics_data.required_key_to_qty[required_key] = 0
+                    self.metrics_data.required_key_to_qty[required_key] += 1
                 if 'type' in res:
                     type_str = str(res['type'])
                     if type_str not in self.metrics_data.required_adjacent_to_type:
@@ -73,6 +79,18 @@ def construct_mapping(self, node, deep=False):
 
         return res
 
+    def construct_yaml_seq(self, node):
+        # this is needed to load required list at construction time and to not use a generator that is
+        # fired later to finish processing
+        data = []
+        data.extend(self.construct_sequence(node))
+        return data
+
+
+CustomConstructor.add_constructor(
+        'tag:yaml.org,2002:seq',
+        CustomConstructor.construct_yaml_seq)
+
 
 class CustomLoader(
     _yaml.CParser,

analyzer/markdown.py

@@ -36,7 +36,9 @@ def __render_table(
         dashes = '-'*(i-2)
         row.insert(-1, dashes.center(i))
     stream.write('|'.join(row)+'\n')
-    for table_row in table_data:
+    table_date_list = list(table_data)
+    table_date_list.sort(key=lambda a: a[1], reverse = True)
+    for table_row in table_date_list:
         row = ['', '']
         for i, val in enumerate(table_row):
             row.insert(-1, ' '+str(val).ljust(table_column_lengths[i]-1))

extracted_key_data_v3specs/required_key_to_qty.json

@@ -5,29 +5,29 @@ Counts number of properties keyword usages. Analyzes keyword=type info adjacent
 ## General Metrics
 | Metric                              | Qty    |
 | ----------------------------------- | ------ |
+| properties_key_qty                  | 224423 |
+| properties_not_adjacent_to_type_qty | 7662   |
 | openapi_documents_qty               | 1878   |
-| properties_key_qty                  | 224453 |
 | properties_adjacent_to_type_qty     | 19     |
-| properties_not_adjacent_to_type_qty | 7662   |
 ## Properties Adjacent to Type Metrics
 | Type                       | Qty    |
 | -------------------------- | ------ |
-| object                     | 215151 |
-| array                      | 44     |
+| object                     | 215121 |
 | {}                         | 1374   |
-| string                     | 18     |
 | Feature                    | 83     |
-| AVRO                       | 3      |
-| PROTOBUF                   | 2      |
-| []                         | 55     |
-| directed                   | 1      |
+| ['object', 'null']         | 55     |
+| array                      | 44     |
 | Warning                    | 24     |
+| blob                       | 19     |
+| string                     | 18     |
 | name                       | 4      |
-| CustomActivity             | 2      |
+| AVRO                       | 3      |
 | SpecActivity               | 3      |
+| PROTOBUF                   | 2      |
 | PullRequestActivity        | 2      |
-| IssueActivity              | 1      |
+| CustomActivity             | 2      |
 | DiscordMessageSentActivity | 2      |
-| GithubActivity             | 1      |
-| blob                       | 19     |
 | String                     | 2      |
+| directed                   | 1      |
+| IssueActivity              | 1      |
+| GithubActivity             | 1      |