Merge pull request #158 from strictdoc-project/stanislaw/examples

 examples: JSON example: add field types

Author: stanislaw

reqif/experimental/reqif_schema.py

@@ -31,6 +31,7 @@ def __init__(self, reqif_bundle: ReqIFBundle):
         assert reqif_bundle.core_content is not None
         assert reqif_bundle.core_content.req_if_content is not None
         assert reqif_bundle.core_content.req_if_content.spec_types is not None
+
         for spec_type in reqif_bundle.core_content.req_if_content.spec_types:
             if not isinstance(spec_type, ReqIFSpecObjectType):
                 continue
@@ -84,3 +85,11 @@ def is_spec_object_a_heading(self, spec_object: ReqIFSpecObject):
         # could be detected, assume that all spec objects in the ReqIF file are
         # simply requirements.
         return False
+
+    def iterate_unique_field_names(self):
+        unique_names_so_far = set()
+        for attribute_definition_ in self.spec_object_type_attributes.values():
+            if attribute_definition_.long_name in unique_names_so_far:
+                continue
+            unique_names_so_far.add(attribute_definition_.long_name)
+            yield attribute_definition_.long_name, attribute_definition_.attribute_type.name

tests/integration/examples/04_convert_reqif_to_json/expected/sample1_polarion.json

@@ -30,11 +30,29 @@
         }
     ],
     "fields": [
-        "ReqIF.ChapterName",
-        "ReqIF.ForeignCreatedBy",
-        "ReqIF.ForeignCreatedOn",
-        "ReqIF.ForeignID",
-        "ReqIF.Text",
-        "Status"
+        {
+            "name": "ReqIF.ChapterName",
+            "type": "STRING"
+        },
+        {
+            "name": "ReqIF.ForeignCreatedBy",
+            "type": "STRING"
+        },
+        {
+            "name": "ReqIF.ForeignCreatedOn",
+            "type": "DATE"
+        },
+        {
+            "name": "ReqIF.ForeignID",
+            "type": "STRING"
+        },
+        {
+            "name": "ReqIF.Text",
+            "type": "XHTML"
+        },
+        {
+            "name": "Status",
+            "type": "ENUMERATION"
+        }
     ]
 }

tests/integration/examples/04_convert_reqif_to_json/expected/sample2_sdoc.json

@@ -167,14 +167,41 @@
         }
     ],
     "fields": [
-        "ReqIF.ForeignID",
-        "LEVEL",
-        "STATUS",
-        "TAGS",
-        "ReqIF.Name",
-        "ReqIF.Text",
-        "RATIONALE",
-        "NOTES",
-        "ReqIF.ChapterName"
+        {
+            "name": "ReqIF.ForeignID",
+            "type": "STRING"
+        },
+        {
+            "name": "LEVEL",
+            "type": "STRING"
+        },
+        {
+            "name": "STATUS",
+            "type": "STRING"
+        },
+        {
+            "name": "TAGS",
+            "type": "STRING"
+        },
+        {
+            "name": "ReqIF.Name",
+            "type": "STRING"
+        },
+        {
+            "name": "ReqIF.Text",
+            "type": "STRING"
+        },
+        {
+            "name": "RATIONALE",
+            "type": "STRING"
+        },
+        {
+            "name": "NOTES",
+            "type": "STRING"
+        },
+        {
+            "name": "ReqIF.ChapterName",
+            "type": "STRING"
+        }
     ]
 }

tests/integration/examples/04_convert_reqif_to_json/expected/sample3_eclipse_rmf.json

@@ -77,9 +77,21 @@
         }
     ],
     "fields": [
-        "ReqIF.Name",
-        "A1",
-        "A2",
-        "E1"
+        {
+            "name": "ReqIF.Name",
+            "type": "XHTML"
+        },
+        {
+            "name": "A1",
+            "type": "STRING"
+        },
+        {
+            "name": "A2",
+            "type": "STRING"
+        },
+        {
+            "name": "E1",
+            "type": "ENUMERATION"
+        }
     ]
 }

tests/integration/examples/04_convert_reqif_to_json/script.py

@@ -77,13 +77,13 @@ def convert(reqif_bundle: ReqIFBundle) -> ReqDict:
         # field names available in the ReqIF file.
         # NOTE: This can create many unused columns if the requirements and
         # chapters attributes are two distinct sets of fields.
-        reqif_dict.fields = []
-        reqif_dict.fields.extend(
-            list(
-                {
-                    attribute_definition_.long_name: 1
-                    for attribute_definition_ in reqif_schema.spec_object_type_attributes.values()
-                }.keys()
+        reqif_dict.fields = list(
+            map(
+                lambda attribute_tuple_: {
+                    "name": attribute_tuple_[0],
+                    "type": attribute_tuple_[1],
+                },
+                reqif_schema.iterate_unique_field_names(),
             )
         )
 

tests/integration/examples/04_convert_reqif_to_json/test.itest

@@ -19,6 +19,3 @@ RUN: %diff %S/expected/sample1_polarion.json %S/Output/reqif_stdout/sample1_pola
 
 RUN: python %S/script.py %S/sample_polarion_reqifz.reqifz --output-dir %S/Output/reqifz
 RUN: %diff %S/expected/sample1_polarion.json %S/Output/reqifz/sample1_polarion.reqif.json
-
-TODO:
-- Type fields