Merge pull request #2220 from strictdoc-project/stanislaw/merge_nodes

Migration: SDoc model: Merge Section, Node, Composite Node into just Node

Author: stanislaw

docs/strictdoc_02_feature_map.sdoc

@@ -35,7 +35,7 @@ ELEMENTS:
     REQUIRED: False
   - TITLE: STATEMENT
     TYPE: String
-    REQUIRED: False
+    REQUIRED: True
   - TITLE: RATIONALE
     TYPE: String
     REQUIRED: False

docs/strictdoc_05_troubleshooting.sdoc

@@ -6,9 +6,23 @@ VERSION: Git commit: @GIT_VERSION, Git branch: @GIT_BRANCH
 DATE: @GIT_COMMIT_DATETIME
 OPTIONS:
   ENABLE_MID: True
+  REQUIREMENT_STYLE: Narrative
 
 [GRAMMAR]
 ELEMENTS:
+- TAG: SECTION
+  PROPERTIES:
+    IS_COMPOSITE: True
+  FIELDS:
+  - TITLE: MID
+    TYPE: String
+    REQUIRED: False
+  - TITLE: UID
+    TYPE: String
+    REQUIRED: False
+  - TITLE: TITLE
+    TYPE: String
+    REQUIRED: True
 - TAG: TEXT
   FIELDS:
   - TITLE: MID
@@ -27,7 +41,7 @@ STATEMENT: >>>
 This document summarizes solutions to the most common issues reported by StrictDoc users.
 <<<
 
-[SECTION]
+[[SECTION]]
 MID: 17152ac7de9f4c138b85e2956091206f
 TITLE: Caching issues
 
@@ -43,4 +57,4 @@ StrictDoc caches many artifacts on disk. Some artifacts are cached using Python
 The pickle module serializes Python objects to disk. The issue with this approach is that when StrictDoc changes the schema of its objects (e.g., when SDocNode or SDocDocument objects gain a new property or a property type changes), an outdated object may be read from the cache after upgrading to a new StrictDoc version. While a more systematic solution might be implemented in the future, the current workaround is to manually delete the StrictDoc cache folder.
 <<<
 
-[/SECTION]
+[[/SECTION]]

strictdoc/backend/excel/import_/excel_to_sdoc_converter.py

@@ -152,6 +152,7 @@ def create_document(
             parent=None,
             tag="REQUIREMENT",
             property_is_composite="",
+            property_view_style="",
             fields=fields,
             relations=[],
         )

strictdoc/backend/reqif/p01_sdoc/reqif_to_sdoc_converter.py

@@ -134,6 +134,10 @@ def _create_document_from_reqif_specification(
             if not isinstance(spec_object_type_, ReqIFSpecObjectType):
                 continue
 
+            # FIXME: [[NODE]]
+            if spec_object_type_.long_name == "SECTION":
+                continue
+
             grammar_element: GrammarElement = P01_ReqIFToSDocConverter.create_grammar_element_from_spec_object_type(
                 spec_object_type=spec_object_type_,
                 reqif_bundle=reqif_bundle,
@@ -315,6 +319,7 @@ def create_grammar_element_from_spec_object_type(
             # FIXME: MERGE NODES
             #        When the migration is done, make the nodes to be always recursive.
             property_is_composite="",
+            property_view_style="",
             fields=fields,
             relations=[],
         )

strictdoc/backend/sdoc/error_handling.py

@@ -145,11 +145,11 @@ def missing_required_field(
         grammar_fields = document_grammar.dump_fields(node.node_type)
         return StrictDocSemanticError(
             title=(
-                f"Requirement is missing a field that is required by "
+                f"Node is missing a field that is required by "
                 f"grammar: {grammar_field.title}."
             ),
             hint=(
-                f"Requirement fields: [{node.dump_fields_as_parsed()}], "
+                f"Node fields: [{node.dump_fields_as_parsed()}], "
                 f"grammar fields: [{grammar_fields}]."
             ),
             example=None,
@@ -339,53 +339,6 @@ def invalid_marker_role(
             filename=path_to_src_file,
         )
 
-    @staticmethod
-    def grammar_missing_reserved_statement(
-        grammar_element: GrammarElement,
-        path_to_sdoc_file: str,
-        line: int,
-        column: int,
-    ) -> "StrictDocSemanticError":
-        return StrictDocSemanticError(
-            title=(
-                f"Grammar element '{grammar_element.tag}' is missing a reserved"
-                " content field declaration, one of {STATEMENT, DESCRIPTION, CONTENT}."
-            ),
-            hint=(
-                "A content field plays a key role in StrictDoc's HTML user interface "
-                "as well as in the other export formats. It is a reserved field"
-                " that any grammar element must have."
-            ),
-            example=None,
-            line=line,
-            col=column,
-            filename=path_to_sdoc_file,
-        )
-
-    @staticmethod
-    def grammar_reserved_statement_must_be_required(
-        grammar_element: GrammarElement,
-        field_title: str,
-        path_to_sdoc_file: str,
-        line: int,
-        column: int,
-    ) -> "StrictDocSemanticError":
-        return StrictDocSemanticError(
-            title=(
-                f"Grammar element '{grammar_element.tag}'s {field_title} field "
-                f"must be declared as 'REQUIRED: True'."
-            ),
-            hint=(
-                "A content field plays a key role in StrictDoc's HTML user interface "
-                "as well as in the other export formats. It is a reserved field"
-                " that any grammar element must have with 'REQUIRED: True'."
-            ),
-            example=None,
-            line=line,
-            col=column,
-            filename=path_to_sdoc_file,
-        )
-
     @staticmethod
     def grammar_element_has_no_mid_field(
         grammar_element: GrammarElement,

strictdoc/backend/sdoc/grammar/grammar.py

@@ -120,7 +120,7 @@
 ;
 
 RequirementStyleChoice[noskipws]:
-  'Inline' | 'Simple' | 'Narrative' | 'Table' | 'Zebra'
+  'Plain' | 'Inline' | 'Simple' | 'Narrative' | 'Table' | 'Zebra'
 ;
 
 RequirementHasTitleChoice[noskipws]:
@@ -181,7 +181,7 @@
 
 SDocNode[noskipws]:
   '[' !'SECTION' !SDocCompositeNodeTagName node_type = RequirementType ']' '\n'
-  fields *= SDocNodeField
+  fields += SDocNodeField
   (
     'RELATIONS:' '\n'
     (relations += Reference)
@@ -191,7 +191,7 @@
 SDocCompositeNodeNew[noskipws]:
   '[[' node_type = RequirementType ']]' '\n'
 
-  fields *= SDocNodeField
+  fields += SDocNodeField
   (
     'RELATIONS:' '\n'
     (relations += Reference)

strictdoc/backend/sdoc/grammar/grammar_grammar.py

@@ -17,7 +17,8 @@
   '- TAG: ' tag = RequirementType '\n'
   (
     '  PROPERTIES:' '\n'
-    '    IS_COMPOSITE: ' property_is_composite=/(True|False)/ '\n'
+    ('    IS_COMPOSITE: ' property_is_composite=/(True|False)/ '\n' )?
+    ('    VIEW_STYLE: ' property_view_style=/(Plain|Simple|Inline|Narrative|Table|Zebra)/ '\n')?
   )?
   '  FIELDS:' '\n'
   fields += GrammarElementField

strictdoc/backend/sdoc/models/document_config.py

@@ -119,13 +119,18 @@ def get_markup(self) -> str:
         return self.markup
 
     def get_requirement_style_mode(self) -> str:
-        if self.requirement_style is None or self.requirement_style in (
+        if (
+            self.requirement_style is None
+            or self.requirement_style == "Narrative"
+        ):
+            return "narrative"
+        if self.requirement_style == "Plain":
+            return "plain"
+        if self.requirement_style in (
             "Inline",
             "Simple",
         ):
             return "simple"
-        if self.requirement_style == "Narrative":
-            return "narrative"
         if self.requirement_style == "Table":
             return "table"
         if self.requirement_style == "Zebra":

strictdoc/backend/sdoc/models/document_grammar.py

@@ -25,6 +25,7 @@ def __init__(
         parent: Optional["DocumentGrammar"],
         tag: str,
         property_is_composite: str,
+        property_view_style: str,
         fields: List[
             Union[
                 GrammarElementFieldString,
@@ -43,6 +44,20 @@ def __init__(
             if property_is_composite == ""
             else (property_is_composite == "True")
         )
+
+        assert property_view_style in (
+            "",
+            "Plain",
+            "Narrative",
+            "Simple",
+            "Inline",
+            "Table",
+            "Zebra",
+        )
+        self.property_view_style: Optional[str] = (
+            property_view_style.lower() if property_view_style != "" else None
+        )
+
         self.fields: List[
             Union[
                 GrammarElementFieldString,
@@ -76,9 +91,31 @@ def __init__(
             else:
                 pass
         self.fields_map: Dict[str, GrammarElementField] = fields_map
+
+        self.field_titles: List[str] = list(
+            map(lambda field__: field__.title, self.fields)
+        )
+
         self.content_field: Tuple[str, int] = (
             statement_field or description_field or content_field or ("", -1)
         )
+
+        # Some nodes have the content field, e.g., STATEMENT or DESCRIPTION,
+        # some don't. For those that don't, use TITLE as a boundary between
+        # the single-line and multiline.
+        multiline_field_index = self.content_field[1]
+        if multiline_field_index == -1:
+            try:
+                multiline_field_index = self.get_field_titles().index("TITLE")
+            except ValueError as value_error_:
+                raise RuntimeError(
+                    (
+                        f"The grammar element {self.tag} must have at least one of the "
+                        f"following fields: TITLE, STATEMENT, DESCRIPTION, CONTENT."
+                    ),
+                ) from value_error_
+        self.multiline_field_index: int = multiline_field_index
+
         self.mid: MID = MID.create()
         self.ng_line_start: Optional[int] = None
         self.ng_col_start: Optional[int] = None
@@ -89,6 +126,7 @@ def create_default(tag: str) -> "GrammarElement":
             parent=None,
             tag=tag,
             property_is_composite="",
+            property_view_style="",
             fields=[
                 GrammarElementFieldString(
                     parent=None,
@@ -135,18 +173,29 @@ def create_default_relations(
             ),
         ]
 
+    def is_field_multiline(self, field_name: str) -> bool:
+        field_index = self.field_titles.index(field_name)
+        try:
+            title_field_index = self.field_titles.index("TITLE")
+            if field_index <= title_field_index:
+                return False
+        except ValueError:
+            pass
+        return field_index >= self.content_field[1]
+
     def get_multiline_field_index(self) -> int:
-        multiline_field_index = self.content_field[1]
-        assert multiline_field_index != -1
-        return multiline_field_index
+        return self.multiline_field_index
+
+    def get_view_style(self) -> Optional[str]:
+        return self.property_view_style
 
     def get_relation_types(self) -> List[str]:
         return list(
             map(lambda relation_: relation_.relation_type, self.relations)
         )
 
     def get_field_titles(self) -> List[str]:
-        return list(map(lambda field_: field_.title, self.fields))
+        return self.field_titles
 
     def get_tag_lower(self) -> str:
         return self.tag.lower()
@@ -284,6 +333,7 @@ def create_default(parent: Optional[SDocDocumentIF]) -> "DocumentGrammar":
             parent=None,
             tag="REQUIREMENT",
             property_is_composite="",
+            property_view_style="",
             fields=fields,
             relations=[],
         )
@@ -344,13 +394,13 @@ def create_for_test_report(parent: SDocDocumentIF) -> "DocumentGrammar":
                 parent=None,
                 title=RequirementFieldName.STATUS,
                 human_title=None,
-                required="False",
+                required="True",
             ),
             GrammarElementFieldString(
                 parent=None,
                 title=RequirementFieldName.TITLE,
                 human_title=None,
-                required="False",
+                required="True",
             ),
             GrammarElementFieldString(
                 parent=None,
@@ -363,6 +413,7 @@ def create_for_test_report(parent: SDocDocumentIF) -> "DocumentGrammar":
             parent=None,
             tag="TEST_RESULT",
             property_is_composite="",
+            property_view_style="",
             fields=fields,
             relations=[],
         )
@@ -463,6 +514,7 @@ def create_default_text_element(
             parent=parent,
             tag="TEXT",
             property_is_composite="",
+            property_view_style="",
             fields=fields,
             relations=[],
         )