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

[[NODE]] migration: carry over SECTION reset UID behavior

Author: stanislaw

strictdoc/backend/sdoc/models/model.py

@@ -96,7 +96,7 @@ def get_display_title(self, include_toc_number: bool = True) -> str:
         raise NotImplementedError  # pragma: no cover
 
 
-class SDocDocumentFromFileIF:
+class SDocDocumentFromFileIF(ABC):
     parent: Union[SDocDocumentIF, SDocSectionIF]
     ng_resolved_custom_level: Optional[str]
 

strictdoc/backend/sdoc/reader.py

@@ -2,7 +2,7 @@
 import sys
 import traceback
 from copy import copy
-from typing import Tuple
+from typing import Any, Tuple
 
 from textx import metamodel_from_str
 
@@ -65,9 +65,11 @@ def read_with_parse_context(
     ) -> Tuple[SDocDocument, ParseContext]:
         document, parse_context = SDReader._read(input_string, file_path)
 
+        # FIXME: When the [SECTION] is gone, remove this.
         if migrate_sections:
             SDReader.migrate_sections(document)
             SDReader.migration_sections_grammar(document)
+        SDReader.fixup_composite_requirements(document)
 
         return document, parse_context
 
@@ -197,20 +199,26 @@ def convert(section: SDocSection) -> SDocNode:
         return node
 
     @staticmethod
-    def migrate_sections(sdoc):
+    def fixup_composite_requirements(sdoc: SDocDocument) -> None:
+        for _, node_ in enumerate(copy(sdoc.section_contents)):
+            if isinstance(node_, SDocCompositeNode):
+                SDReader.migration_sections_grammar(sdoc)
+                break
+
+    @staticmethod
+    def migrate_sections(sdoc: Any) -> None:
         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
 
-            elif isinstance(node_, SDocCompositeNode):
-                SDReader.migration_sections_grammar(sdoc)
-
     @staticmethod
-    def migration_sections_grammar(sdoc: SDocDocument):
+    def migration_sections_grammar(sdoc: SDocDocument) -> None:
         grammar: DocumentGrammar = assert_cast(sdoc.grammar, DocumentGrammar)
+        if not grammar.is_default:
+            return
         section_element_exists = any(
             element_.tag == "SECTION" for element_ in grammar.elements
         )

strictdoc/core/analyzers/document_stats.py

@@ -21,7 +21,9 @@ class DocumentStats:
     requirements_per_prefix: Dict[str, SinglePrefixRequirements] = field(
         default_factory=dict
     )
-    sections_without_uid: List[SDocSection] = field(default_factory=list)
+    sections_without_uid: List[typing.Union[SDocNode, SDocSection]] = field(
+        default_factory=list
+    )
     section_uids_so_far: typing.Counter[str] = field(default_factory=Counter)
 
 
@@ -53,9 +55,14 @@ def get_next_requirement_uid_number(self, prefix: str) -> int:
         return next_number
 
     def get_auto_section_uid(
-        self, document_acronym: str, section: SDocSection
+        self,
+        document_acronym: str,
+        section: typing.Union[SDocNode, SDocSection],
     ) -> str:
-        section_title = create_safe_title_string(section.title)
+        if section.reserved_title is None:
+            return ""
+
+        section_title = create_safe_title_string(section.reserved_title)
         auto_uid = f"SECTION-{document_acronym}-{section_title}"
 
         count_so_far = self.section_uids_so_far[auto_uid]

strictdoc/core/analyzers/document_uid_analyzer.py

@@ -68,7 +68,9 @@ def analyze_document(
         this_document_stats = DocumentStats(document)
         document_iterator = DocumentCachingIterator(document)
         for node in document_iterator.all_content():
-            if isinstance(node, SDocSection):
+            if isinstance(node, SDocSection) or (
+                isinstance(node, SDocNode) and node.node_type == "SECTION"
+            ):
                 if node.reserved_uid is not None:
                     this_document_stats.section_uids_so_far[
                         node.reserved_uid
@@ -78,7 +80,7 @@ def analyze_document(
                 continue
             if not isinstance(node, SDocNode):
                 continue
-            if node.node_type == "TEXT":
+            if node.node_type in ("TEXT", "SECTION"):
                 continue
             requirement: SDocNode = node
             node_prefix: typing.Optional[str] = requirement.get_prefix()

strictdoc/server/routers/main_router.py

@@ -1034,19 +1034,22 @@ def reset_uid(reference_mid: str):
             MID(reference_mid)
         )
         next_uid: str = ""
-        if isinstance(reference_node, SDocNode):
-            if (node_prefix := reference_node.get_prefix()) is not None:
-                next_uid = document_tree_stats.get_next_requirement_uid(
-                    node_prefix
-                )
-        elif isinstance(reference_node, SDocSection):
+        if isinstance(reference_node, SDocSection) or (
+            isinstance(reference_node, SDocNode)
+            and reference_node.node_type == "SECTION"
+        ):
             document: SDocDocument = assert_cast(
                 reference_node.get_document(), SDocDocument
             )
             document_acronym = create_safe_acronym(document.title)
             next_uid = document_tree_stats.get_auto_section_uid(
                 document_acronym, reference_node
             )
+        elif isinstance(reference_node, SDocNode):
+            if (node_prefix := reference_node.get_prefix()) is not None:
+                next_uid = document_tree_stats.get_next_requirement_uid(
+                    node_prefix
+                )
         else:
             raise NotImplementedError(reference_node)  # pragma: no cover
 

tests/end2end/screens/document/update_section/_autouid/update_node_section_generate_auto_uid/expected_output/document.sdoc

@@ -0,0 +1,8 @@
+[DOCUMENT]
+TITLE: Document 1
+
+[[SECTION]]
+UID: SECTION-D-First-section
+TITLE: Modified title
+
+[[/SECTION]]

tests/end2end/screens/document/update_section/_autouid/update_node_section_generate_auto_uid/input/document.sdoc

@@ -0,0 +1,7 @@
+[DOCUMENT]
+TITLE: Document 1
+
+[[SECTION]]
+TITLE: First section
+
+[[/SECTION]]

tests/end2end/screens/document/update_section/_autouid/update_node_section_generate_auto_uid/test_case.py

@@ -0,0 +1,46 @@
+import os
+
+from tests.end2end.e2e_case import E2ECase
+from tests.end2end.end2end_test_setup import End2EndTestSetup
+from tests.end2end.helpers.screens.document.form_edit_requirement import (
+    Form_EditRequirement,
+)
+from tests.end2end.helpers.screens.project_index.screen_project_index import (
+    Screen_ProjectIndex,
+)
+from tests.end2end.server import SDocTestServer
+
+path_to_this_test_file_folder = os.path.dirname(os.path.abspath(__file__))
+
+
+class Test(E2ECase):
+    def test(self):
+        test_setup = End2EndTestSetup(path_to_test_file=__file__)
+
+        with SDocTestServer(
+            input_path=test_setup.path_to_sandbox,
+        ) as test_server:
+            self.open(test_server.get_host_and_port())
+
+            screen_project_index = Screen_ProjectIndex(self)
+
+            screen_project_index.assert_on_screen()
+            screen_project_index.assert_contains_document("Document 1")
+
+            screen_document = screen_project_index.do_click_on_first_document()
+
+            screen_document.assert_on_screen_document()
+            screen_document.assert_header_document_title("Document 1")
+
+            section_node = screen_document.get_node()
+            form_edit_section: Form_EditRequirement = (
+                section_node.do_open_form_edit_requirement()
+            )
+            form_edit_section.do_reset_uid_field()
+            form_edit_section.do_fill_in("TITLE", "Modified title")
+            form_edit_section.do_form_submit()
+
+            section_node.assert_requirement_title("Modified title", "1")
+            screen_document.assert_toc_contains("Modified title")
+
+        assert test_setup.compare_sandbox_and_expected_output()