fix(document_iterator): implement a hack for preserving node numbers

Author: stanislaw

strictdoc/core/document_iterator.py

@@ -88,7 +88,13 @@ def all_node_content(
         print_fragments: bool = False,
         level_stack: Tuple[int, ...] = (),
         custom_level: bool = False,
+        update_levels: bool = True,
     ) -> Iterator[Tuple[SDocIteratedElementIF, DocumentIterationContext]]:
+        """
+        FIXME: update_levels is hack. Change the design so that the node state
+               is not patched during the iteration.
+        """
+
         if isinstance(node, SDocSection):
             # If node is not whitelisted, we ignore it. Also, note that due to
             # this early return, all child nodes of this node are ignored
@@ -100,8 +106,10 @@ def all_node_content(
             context = DocumentIterationContext(
                 node, level_stack, custom_level=custom_level
             )
-            node.context.title_number_string = context.get_level_string()
-            node.ng_level = context.get_level()
+
+            if update_levels:
+                node.context.title_number_string = context.get_level_string()
+                node.ng_level = context.get_level()
 
             yield node, context
 
@@ -128,6 +136,7 @@ def all_node_content(
                     level_stack=level_stack + (current_number,),
                     custom_level=custom_level
                     or subnode_.ng_resolved_custom_level is not None,
+                    update_levels=update_levels,
                 )
 
         elif isinstance(node, SDocNode):
@@ -141,8 +150,9 @@ def all_node_content(
             context = DocumentIterationContext(
                 node, level_stack, custom_level=custom_level
             )
-            node.context.title_number_string = context.get_level_string()
-            node.ng_level = context.get_level()
+            if update_levels:
+                node.context.title_number_string = context.get_level_string()
+                node.ng_level = context.get_level()
 
             yield node, context
 
@@ -161,6 +171,7 @@ def all_node_content(
                         level_stack=level_stack + (current_number,),
                         custom_level=custom_level
                         or subnode_.ng_resolved_custom_level is not None,
+                        update_levels=update_levels,
                     )
 
         elif isinstance(node, SDocDocument):
@@ -172,8 +183,11 @@ def all_node_content(
                 context = DocumentIterationContext(
                     node, level_stack, custom_level=custom_level
                 )
-                node.context.title_number_string = context.get_level_string()
-                node.ng_level = context.get_level()
+                if update_levels:
+                    node.context.title_number_string = (
+                        context.get_level_string()
+                    )
+                    node.ng_level = context.get_level()
 
                 yield node, context
 
@@ -198,6 +212,7 @@ def all_node_content(
                     level_stack=level_stack + (current_number,),
                     custom_level=custom_level
                     or subnode_.ng_resolved_custom_level is not None,
+                    update_levels=update_levels,
                 )
 
         elif isinstance(node, DocumentFromFile):
@@ -210,6 +225,7 @@ def all_node_content(
                 node.resolved_document,
                 print_fragments=print_fragments,
                 level_stack=level_stack,
+                update_levels=update_levels,
             )
 
         else:

strictdoc/core/transforms/delete_requirement.py

@@ -34,6 +34,8 @@ def validate(self) -> None:
         for document_node_, _ in document_iterator.all_node_content(
             self.requirement,
             print_fragments=True,
+            # FIXME: update_levels is a hack. See all_node_content().
+            update_levels=False,
         ):
             if not isinstance(document_node_, SDocNode):
                 continue

tests/end2end/screens/document/delete_node/_validation/delete_node_must_prevent_deletion_when_children_have_incoming_parent_RELATIONs/test_case.py

@@ -30,16 +30,16 @@ def test(self):
             requirement.do_delete_node(proceed_with_confirm=False)
 
             screen_document.assert_text(
-                "Cannot remove node 'Nesting section' with incoming LINKs from: "
-                "'Requirement title #2' -> 'SECTION_NESTING'."
+                "Cannot remove node '1. Nesting section' with incoming LINKs from: "
+                "'2. Requirement title #2' -> 'SECTION_NESTING'."
             )
             screen_document.assert_text(
-                "Cannot remove node 'Sub-nesting section' with incoming LINKs from: "
-                "'Requirement title #3' -> 'SECTION_SUBNESTING'."
+                "Cannot remove node '1.1. Sub-nesting section' with incoming LINKs from: "
+                "'3. Requirement title #3' -> 'SECTION_SUBNESTING'."
             )
             screen_document.assert_text(
-                "Cannot remove node 'Requirement title #1' with incoming relations from: "
-                "'Requirement title #2', 'Requirement title #3'."
+                "Cannot remove node '1.1.1. Requirement title #1' with incoming relations from: "
+                "'2. Requirement title #2', '3. Requirement title #3'."
             )
 
         assert test_setup.compare_sandbox_and_expected_output()