Merge pull request strictdoc-project#1903 from strictdoc-project/stan…

…islaw/mid_to_fields

backend/sdoc: SDocNode: Make MID a normal SDocField

docs/strictdoc_20_L1_Open_Requirements_Tool.sdoc

@@ -6,6 +6,43 @@ ROOT: True
 OPTIONS:
   ENABLE_MID: True
 
+[GRAMMAR]
+ELEMENTS:
+- TAG: TEXT
+  FIELDS:
+  - TITLE: UID
+    TYPE: String
+    REQUIRED: False
+  - TITLE: STATEMENT
+    TYPE: String
+    REQUIRED: False
+- TAG: REQUIREMENT
+  FIELDS:
+  - TITLE: MID
+    TYPE: String
+    REQUIRED: False
+  - TITLE: UID
+    TYPE: String
+    REQUIRED: False
+  - TITLE: STATUS
+    TYPE: String
+    REQUIRED: False
+  - TITLE: TITLE
+    TYPE: String
+    REQUIRED: False
+  - TITLE: STATEMENT
+    TYPE: String
+    REQUIRED: False
+  - TITLE: RATIONALE
+    TYPE: String
+    REQUIRED: False
+  - TITLE: COMMENT
+    TYPE: String
+    REQUIRED: False
+  RELATIONS:
+  - TYPE: Parent
+  - TYPE: File
+
 [FREETEXT]
 The StrictDoc project is structured around two distinct requirement documents that guide its development:
 

docs/strictdoc_21_L2_StrictDoc_Requirements.sdoc

@@ -5,6 +5,43 @@ REQ_PREFIX: SDOC-SRS-
 OPTIONS:
   ENABLE_MID: True
 
+[GRAMMAR]
+ELEMENTS:
+- TAG: TEXT
+  FIELDS:
+  - TITLE: UID
+    TYPE: String
+    REQUIRED: False
+  - TITLE: STATEMENT
+    TYPE: String
+    REQUIRED: False
+- TAG: REQUIREMENT
+  FIELDS:
+  - TITLE: MID
+    TYPE: String
+    REQUIRED: False
+  - TITLE: UID
+    TYPE: String
+    REQUIRED: False
+  - TITLE: STATUS
+    TYPE: String
+    REQUIRED: False
+  - TITLE: TITLE
+    TYPE: String
+    REQUIRED: False
+  - TITLE: STATEMENT
+    TYPE: String
+    REQUIRED: False
+  - TITLE: RATIONALE
+    TYPE: String
+    REQUIRED: False
+  - TITLE: COMMENT
+    TYPE: String
+    REQUIRED: False
+  RELATIONS:
+  - TYPE: Parent
+  - TYPE: File
+
 [SECTION]
 MID: bd8a7931c1e04df9bf08d291488c67aa
 TITLE: SDoc data model

docs/strictdoc_28_Backlog.sdoc

@@ -5,6 +5,43 @@ REQ_PREFIX: SDOC-BACKLOG-
 OPTIONS:
   ENABLE_MID: True
 
+[GRAMMAR]
+ELEMENTS:
+- TAG: TEXT
+  FIELDS:
+  - TITLE: UID
+    TYPE: String
+    REQUIRED: False
+  - TITLE: STATEMENT
+    TYPE: String
+    REQUIRED: False
+- TAG: REQUIREMENT
+  FIELDS:
+  - TITLE: MID
+    TYPE: String
+    REQUIRED: False
+  - TITLE: UID
+    TYPE: String
+    REQUIRED: False
+  - TITLE: STATUS
+    TYPE: String
+    REQUIRED: False
+  - TITLE: TITLE
+    TYPE: String
+    REQUIRED: False
+  - TITLE: STATEMENT
+    TYPE: String
+    REQUIRED: False
+  - TITLE: RATIONALE
+    TYPE: String
+    REQUIRED: False
+  - TITLE: COMMENT
+    TYPE: String
+    REQUIRED: False
+  RELATIONS:
+  - TYPE: Parent
+  - TYPE: File
+
 [FREETEXT]
 This document outlines the future work items for StrictDoc.
 

docs_extra/DO178_requirements.sdoc

@@ -10,8 +10,19 @@ OPTIONS:
 
 [GRAMMAR]
 ELEMENTS:
+- TAG: TEXT
+  FIELDS:
+  - TITLE: UID
+    TYPE: String
+    REQUIRED: False
+  - TITLE: STATEMENT
+    TYPE: String
+    REQUIRED: False
 - TAG: REQUIREMENT
   FIELDS:
+  - TITLE: MID
+    TYPE: String
+    REQUIRED: False
   - TITLE: UID
     TYPE: String
     REQUIRED: False

docs_extra/Zephyr_requirements.sdoc

@@ -6,6 +6,43 @@ ROOT: True
 OPTIONS:
   ENABLE_MID: True
 
+[GRAMMAR]
+ELEMENTS:
+- TAG: TEXT
+  FIELDS:
+  - TITLE: UID
+    TYPE: String
+    REQUIRED: False
+  - TITLE: STATEMENT
+    TYPE: String
+    REQUIRED: False
+- TAG: REQUIREMENT
+  FIELDS:
+  - TITLE: MID
+    TYPE: String
+    REQUIRED: False
+  - TITLE: UID
+    TYPE: String
+    REQUIRED: False
+  - TITLE: STATUS
+    TYPE: String
+    REQUIRED: False
+  - TITLE: TITLE
+    TYPE: String
+    REQUIRED: False
+  - TITLE: STATEMENT
+    TYPE: String
+    REQUIRED: False
+  - TITLE: RATIONALE
+    TYPE: String
+    REQUIRED: False
+  - TITLE: COMMENT
+    TYPE: String
+    REQUIRED: False
+  RELATIONS:
+  - TYPE: Parent
+  - TYPE: File
+
 [REQUIREMENT]
 MID: 68e87901205c4b0dbb6a0071479330b5
 UID: ZEP-1

strictdoc/backend/excel/import_/excel_to_sdoc_converter.py

@@ -215,7 +215,6 @@ def create_requirement(
         requirement = SDocNode(
             parent=template_requirement.parent,
             requirement_type=template_requirement.requirement_type,
-            mid=None,
             fields=list(template_requirement.enumerate_fields()),
             relations=template_requirement.relations,
         )

strictdoc/backend/reqif/p01_sdoc/reqif_to_sdoc_converter.py

@@ -382,7 +382,6 @@ def create_section_from_spec_object(
             node: SDocNode = SDocNode(
                 parent=section,
                 requirement_type="TEXT",
-                mid=None,
                 fields=[node_field],
                 relations=[],
             )
@@ -499,16 +498,22 @@ def create_requirement_from_spec_object(
                 spec_object_type.identifier
             ]
         )
-
+        if requirement_mid is not None:
+            fields.insert(
+                0,
+                SDocNodeField.create_from_string(
+                    None, "MID", requirement_mid, multiline=False
+                ),
+            )
         requirement = SDocNode(
             parent=parent_section,
             requirement_type=grammar_element.tag,
-            mid=requirement_mid,
             fields=fields,
             relations=[],
         )
         requirement.ng_level = level
-
+        for field_ in fields:
+            field_.parent = requirement
         if foreign_key_id_or_none is not None:
             spec_object_parents = reqif_bundle.get_spec_object_parents(
                 spec_object.identifier

strictdoc/backend/reqif/p01_sdoc/sdoc_to_reqif_converter.py

@@ -465,6 +465,9 @@ def _convert_requirement_to_spec_object(
 
         attributes: List[SpecObjectAttribute] = []
         for field in requirement.fields_as_parsed:
+            # The MID field, if exists, is extracted separately as a ReqIF Identifier.
+            if field.field_name == "MID":
+                continue
             grammar_field = grammar_element.fields_map[field.field_name]
             if isinstance(grammar_field, GrammarElementFieldSingleChoice):
                 data_type_ref = data_types_lookup[field.field_name]

strictdoc/backend/sdoc/error_handling.py

@@ -298,6 +298,25 @@ def grammar_reserved_statement_must_be_required(
             filename=path_to_sdoc_file,
         )
 
+    @staticmethod
+    def grammar_element_has_no_mid_field(
+        grammar_element: GrammarElement,
+        path_to_sdoc_file: str,
+    ):
+        return StrictDocSemanticError(
+            title=(
+                f"Grammar element '{grammar_element.tag}' is missing the MID field "
+                f"which contradicts to the DOCUMENT's ENABLE_MID setting."
+            ),
+            hint=(
+                "Either disable the ENABLE_MID option or ensure that every element has the MID field defined."
+            ),
+            example=None,
+            line=1,
+            col=1,
+            filename=path_to_sdoc_file,
+        )
+
     @staticmethod
     def view_references_nonexisting_grammar_element(
         document: SDocDocument,

strictdoc/backend/sdoc/grammar/grammar.py

@@ -175,7 +175,6 @@
 
 SDocNode[noskipws]:
   '[' !'SECTION' !SDocCompositeNodeTagName requirement_type = RequirementType ']' '\n'
-  ('MID: ' mid = SingleLineString '\n')?
   fields *= SDocNodeField
   (
     'RELATIONS:' '\n'
@@ -189,6 +188,8 @@
 
 SDocNodeField[noskipws]:
   (
+    field_name = 'MID' ': ' parts+=SingleLineString '\n'
+    |
     field_name = 'UID' ': ' parts+=/{REGEX_UID}/ '\n'
     |
     field_name = FieldName ':'
@@ -211,8 +212,6 @@
 SDocCompositeNode[noskipws]:
   '[COMPOSITE_' requirement_type = RequirementType ']' '\n'
 
-  ('MID: ' mid = SingleLineString '\n')?
-
   fields *= SDocNodeField
   (
     'RELATIONS:' '\n'

strictdoc/backend/sdoc/grammar_reader.py

@@ -49,7 +49,7 @@ def read(
 
         if not grammar.has_text_element():
             grammar.add_element_first(
-                DocumentGrammar.create_default_text_element()
+                DocumentGrammar.create_default_text_element(grammar)
             )
 
         # HACK:

strictdoc/backend/sdoc/models/document_grammar.py

@@ -201,6 +201,9 @@ def __init__(
 
         self.is_default = False
 
+        self.ng_line_start: Optional[int] = None
+        self.ng_col_start: Optional[int] = None
+
     @staticmethod
     def create_default(parent) -> "DocumentGrammar":
         text_element: GrammarElement = (
@@ -338,7 +341,7 @@ def update_with_elements(self, elements: List[GrammarElement]):
         self.elements_by_type = elements_by_type
 
     @staticmethod
-    def create_default_text_element() -> GrammarElement:
+    def create_default_text_element(parent=None) -> GrammarElement:
         fields: List[
             Union[
                 GrammarElementFieldString,
@@ -360,7 +363,7 @@ def create_default_text_element() -> GrammarElement:
             ),
         ]
         text_element = GrammarElement(
-            parent=None, tag="TEXT", fields=fields, relations=[]
+            parent=parent, tag="TEXT", fields=fields, relations=[]
         )
         return text_element
 

strictdoc/backend/sdoc/models/node.py

@@ -102,7 +102,6 @@ def __init__(
         self,
         parent: Union[SDocDocument, SDocSection, "SDocCompositeNode"],
         requirement_type: str,
-        mid: Optional[str],
         fields: List[SDocNodeField],
         relations: List[Reference],
         requirements: Optional[List["SDocNode"]] = None,
@@ -156,6 +155,12 @@ def __init__(
         self.ng_byte_end: Optional[int] = None
         self.context: SDocNodeContext = SDocNodeContext()
 
+        mid: Optional[str] = None
+        mid_fields: Optional[List[SDocNodeField]] = ordered_fields_lookup.get(
+            "MID", None
+        )
+        if mid_fields is not None:
+            mid = mid_fields[0].get_text_value()
         self.reserved_mid: MID = MID(mid) if mid is not None else MID.create()
         self.mid_permanent: bool = mid is not None
 

strictdoc/backend/sdoc/models/object_factory.py

@@ -128,7 +128,6 @@ def create_requirement(
         requirement = SDocNode(
             parent=parent,
             requirement_type=requirement_type,
-            mid=None,
             fields=fields,
             relations=[],
         )

strictdoc/backend/sdoc/models/type_system.py

@@ -6,6 +6,7 @@
 
 
 class RequirementFieldName:
+    MID = "MID"
     UID = "UID"
     LEVEL = "LEVEL"
     STATUS = "STATUS"