Merge pull request #2250 from strictdoc-project/stanislaw/nodes_migration

backend/sdoc: Prepare automatic migration: [SECTION] -> [[SECTION]]

Author: stanislaw

strictdoc/backend/sdoc/models/document_grammar.py

@@ -278,7 +278,9 @@ def __init__(
         self.ng_col_start: Optional[int] = None
 
     @staticmethod
-    def create_default(parent: Optional[SDocDocumentIF]) -> "DocumentGrammar":
+    def create_default(
+        parent: Optional[SDocDocumentIF], create_section_element: bool = False
+    ) -> "DocumentGrammar":
         text_element: GrammarElement = (
             DocumentGrammar.create_default_text_element()
         )
@@ -354,7 +356,17 @@ def create_default(parent: Optional[SDocDocumentIF]) -> "DocumentGrammar":
             requirement_element
         )
 
-        elements: List[GrammarElement] = [text_element, requirement_element]
+        elements: List[GrammarElement] = []
+
+        if create_section_element:
+            section_element: GrammarElement = (
+                DocumentGrammar.create_default_section_element()
+            )
+            elements.append(section_element)
+
+        elements.append(text_element)
+        elements.append(requirement_element)
+
         grammar = DocumentGrammar(
             parent=parent, elements=elements, import_from_file=None
         )
@@ -531,6 +543,52 @@ def create_default_text_element(
         )
         return text_element
 
+    @staticmethod
+    def create_default_section_element(
+        parent: Optional["DocumentGrammar"] = None, enable_mid: bool = False
+    ) -> GrammarElement:
+        fields: List[
+            Union[
+                GrammarElementFieldString,
+                GrammarElementFieldSingleChoice,
+                GrammarElementFieldMultipleChoice,
+            ]
+        ] = []
+        if enable_mid:
+            fields.append(
+                GrammarElementFieldString(
+                    parent=None,
+                    title=RequirementFieldName.MID,
+                    human_title=None,
+                    required="True",
+                )
+            )
+        fields.append(
+            GrammarElementFieldString(
+                parent=None,
+                title=RequirementFieldName.UID,
+                human_title=None,
+                required="False",
+            )
+        )
+        fields.append(
+            GrammarElementFieldString(
+                parent=None,
+                title=RequirementFieldName.TITLE,
+                human_title=None,
+                required="True",
+            ),
+        )
+        section_element = GrammarElement(
+            parent=parent,
+            tag="SECTION",
+            property_is_composite="True",
+            property_view_style="",
+            fields=fields,
+            relations=[],
+        )
+        return section_element
+
 
 class DocumentGrammarWrapper:
     def __init__(self, grammar: DocumentGrammar):

strictdoc/backend/sdoc/models/node.py

@@ -184,7 +184,6 @@ def __init__(
         self.reserved_mid: MID = MID(mid) if mid is not None else MID.create()
         self.mid_permanent: bool = mid is not None
 
-        # HEF4
         self.ng_resolved_custom_level: Optional[str] = None
         self.custom_level: Optional[str] = None
         if RequirementFieldName.LEVEL in ordered_fields_lookup:

strictdoc/backend/sdoc/models/section.py

@@ -49,7 +49,6 @@ def __init__(
 
         self.section_contents = section_contents
 
-        # HEF4
         self.custom_level: Optional[str] = custom_level
         self.ng_resolved_custom_level: Optional[str] = custom_level
 

strictdoc/backend/sdoc/reader.py

@@ -1,6 +1,7 @@
 # mypy: disable-error-code="no-any-return,no-untyped-call,no-untyped-def"
 import sys
 import traceback
+from copy import copy
 from typing import Tuple
 
 from textx import metamodel_from_str
@@ -9,6 +10,9 @@
 from strictdoc.backend.sdoc.grammar.grammar_builder import SDocGrammarBuilder
 from strictdoc.backend.sdoc.models.constants import DOCUMENT_MODELS
 from strictdoc.backend.sdoc.models.document import SDocDocument
+from strictdoc.backend.sdoc.models.document_grammar import DocumentGrammar
+from strictdoc.backend.sdoc.models.node import SDocNode, SDocNodeField
+from strictdoc.backend.sdoc.models.section import SDocSection
 from strictdoc.backend.sdoc.pickle_cache import PickleCache
 from strictdoc.backend.sdoc.processor import ParseContext, SDocParsingProcessor
 from strictdoc.core.project_config import ProjectConfig
@@ -41,15 +45,24 @@ def _read(input_string, file_path=None):
         return document, parse_context
 
     @staticmethod
-    def read(input_string, file_path=None) -> SDocDocument:
-        document, _ = SDReader.read_with_parse_context(input_string, file_path)
+    def read(
+        input_string, file_path=None, migrate_sections: bool = False
+    ) -> SDocDocument:
+        document, _ = SDReader.read_with_parse_context(
+            input_string, file_path, migrate_sections=migrate_sections
+        )
         return document
 
     @staticmethod
     def read_with_parse_context(
-        input_string, file_path=None
+        input_string, file_path=None, migrate_sections: bool = False
     ) -> Tuple[SDocDocument, ParseContext]:
         document, parse_context = SDReader._read(input_string, file_path)
+
+        if migrate_sections:
+            SDReader.migrate_sections(document)
+            SDReader.migration_sections_grammar(document)
+
         return document, parse_context
 
     def read_from_file(
@@ -102,3 +115,74 @@ def read_from_file(
             # TODO: when --debug is provided
             traceback.print_exc()
             sys.exit(1)
+
+    @staticmethod
+    def convert(section: SDocSection) -> SDocNode:
+        """
+        FIXME: Handle LEVEL, REQ_PREFIX
+        """
+        fields = []
+
+        if section.mid_permanent:
+            fields.append(
+                SDocNodeField.create_from_string(
+                    None,
+                    field_name="MID",
+                    field_value=section.reserved_mid,
+                    multiline=False,
+                )
+            )
+        if section.reserved_uid is not None:
+            fields.append(
+                SDocNodeField.create_from_string(
+                    None,
+                    field_name="UID",
+                    field_value=section.reserved_uid,
+                    multiline=False,
+                )
+            )
+        fields.append(
+            SDocNodeField.create_from_string(
+                None,
+                field_name="TITLE",
+                field_value=section.reserved_title,
+                multiline=False,
+            )
+        )
+        node: SDocNode = SDocNode(
+            parent=section,
+            node_type="SECTION",
+            fields=fields,
+            relations=[],
+            is_composite=True,
+            section_contents=section.section_contents,
+            node_type_close="SECTION",
+        )
+        for field_ in fields:
+            field_.parent = node
+        return node
+
+    @staticmethod
+    def migrate_sections(sdoc):
+        for node_idx_, node_ in enumerate(copy(sdoc.section_contents)):
+            if isinstance(node_, SDocSection):
+                SDReader.migrate_sections(node_)
+
+                new_node = SDReader.convert(node_)
+                sdoc.section_contents[node_idx_] = new_node
+
+    @staticmethod
+    def migration_sections_grammar(sdoc: SDocDocument):
+        grammar: DocumentGrammar = assert_cast(sdoc.grammar, DocumentGrammar)
+        section_element_exists = any(
+            element_.tag == "SECTION" for element_ in grammar.elements
+        )
+        if not section_element_exists:
+            grammar.update_with_elements(
+                [
+                    DocumentGrammar.create_default_section_element(
+                        grammar, enable_mid=sdoc.config.enable_mid or False
+                    )
+                ]
+                + grammar.elements
+            )

tests/unit/strictdoc/backend/sdoc/test_dsl_passthrough_new_section_composite_syntax.py

@@ -0,0 +1,68 @@
+from strictdoc.backend.sdoc.models.document import SDocDocument
+from strictdoc.backend.sdoc.reader import SDReader
+from strictdoc.backend.sdoc.writer import SDWriter
+
+
+def test_010_multiple_sections(default_project_config):
+    input_sdoc = """\
+[DOCUMENT]
+TITLE: Test Doc
+
+[SECTION]
+TITLE: Test Section
+
+[SECTION]
+TITLE: Test Section (Nested)
+
+[SECTION]
+TITLE: Test Section (Sub-nested)
+
+[REQUIREMENT]
+STATEMENT: >>>
+This is a statement 1
+This is a statement 2
+This is a statement 3
+<<<
+
+[/SECTION]
+
+[/SECTION]
+
+[/SECTION]
+"""
+
+    output_sdoc = """\
+[DOCUMENT]
+TITLE: Test Doc
+
+[[SECTION]]
+TITLE: Test Section
+
+[[SECTION]]
+TITLE: Test Section (Nested)
+
+[[SECTION]]
+TITLE: Test Section (Sub-nested)
+
+[REQUIREMENT]
+STATEMENT: >>>
+This is a statement 1
+This is a statement 2
+This is a statement 3
+<<<
+
+[[/SECTION]]
+
+[[/SECTION]]
+
+[[/SECTION]]
+"""
+
+    reader = SDReader()
+
+    document = reader.read(input_sdoc, migrate_sections=True)
+    assert isinstance(document, SDocDocument)
+
+    writer = SDWriter(default_project_config)
+    output = writer.write(document)
+    assert output == output_sdoc