Merge pull request #2538 from strictdoc-project/stanislaw/validation

chore: rename: DocumentCachingIterator -> SDocDocumentIterator

Author: stanislaw

docs/sdoc_project_statistics.py

@@ -9,7 +9,7 @@
 from strictdoc.backend.sdoc_source_code.models.source_file_info import (
     SourceFileTraceabilityInfo,
 )
-from strictdoc.core.document_iterator import DocumentCachingIterator
+from strictdoc.core.document_iterator import SDocDocumentIterator
 from strictdoc.core.project_config import ProjectConfig
 from strictdoc.core.statistics.metric import Metric, MetricSection
 from strictdoc.core.traceability_index import TraceabilityIndex
@@ -85,7 +85,7 @@ def export(
         document_tree_stats.git_commit_hash = git_client.get_commit_hash()
 
         for document in traceability_index.document_tree.document_list:
-            document_iterator = DocumentCachingIterator(document)
+            document_iterator = SDocDocumentIterator(document)
             for node, _ in document_iterator.all_content(print_fragments=False):
                 if isinstance(node, SDocNode) and node.node_type == "SECTION":
                     document_tree_stats.total_sections += 1

strictdoc/backend/reqif/p01_sdoc/sdoc_to_reqif_converter.py

@@ -51,7 +51,7 @@
     ParentReqReference,
     Reference,
 )
-from strictdoc.core.document_iterator import DocumentCachingIterator
+from strictdoc.core.document_iterator import SDocDocumentIterator
 from strictdoc.core.document_tree import DocumentTree
 from strictdoc.helpers.cast import assert_cast
 from strictdoc.helpers.ordered_set import OrderedSet
@@ -259,7 +259,7 @@ def convert_document_tree(
             )
             spec_types.extend(document_spec_types)
 
-            document_iterator = DocumentCachingIterator(document)
+            document_iterator = SDocDocumentIterator(document)
 
             # FIXME: This is a throw-away object. It gets discarded when the
             #        iteration is over. Find a way to do without it.

strictdoc/backend/sdoc/models/document.py

@@ -320,10 +320,10 @@ def build_search_index(self) -> None:
         map_nodes_by_mid = {}
 
         from strictdoc.core.document_iterator import (  # noqa: PLC0415
-            DocumentCachingIterator,
+            SDocDocumentIterator,
         )
 
-        document_iterator = DocumentCachingIterator(self)
+        document_iterator = SDocDocumentIterator(self)
 
         for node, _ in document_iterator.all_content(
             print_fragments=False,

strictdoc/backend/sdoc/writer.py

@@ -32,7 +32,7 @@
     ParentReqReference,
     Reference,
 )
-from strictdoc.core.document_iterator import DocumentCachingIterator
+from strictdoc.core.document_iterator import SDocDocumentIterator
 from strictdoc.core.document_meta import DocumentMeta
 from strictdoc.core.project_config import ProjectConfig
 from strictdoc.helpers.cast import assert_cast
@@ -74,7 +74,7 @@ def write_with_fragments(
     ) -> Tuple[str, Dict[str, str]]:
         fragments_dict: Dict[str, str] = {}
 
-        document_iterator = DocumentCachingIterator(document)
+        document_iterator = SDocDocumentIterator(document)
         output = ""
 
         output += "[DOCUMENT]"
@@ -295,14 +295,14 @@ def _print_node(
         self,
         root_node: SDocElementIF,
         document: SDocDocument,
-        document_iterator: DocumentCachingIterator,
+        document_iterator: SDocDocumentIterator,
     ) -> str:
         # Currently, auto-generated nodes are never written back to file system.
         # We could revisit this in the future.
         if root_node.autogen:
             return ""
 
-        assert isinstance(document_iterator, DocumentCachingIterator), (
+        assert isinstance(document_iterator, SDocDocumentIterator), (
             document_iterator
         )
 

strictdoc/core/analyzers/document_uid_analyzer.py

@@ -9,7 +9,7 @@
     DocumentTreeStats,
     SinglePrefixRequirements,
 )
-from strictdoc.core.document_iterator import DocumentCachingIterator
+from strictdoc.core.document_iterator import SDocDocumentIterator
 from strictdoc.core.document_tree import DocumentTree
 from strictdoc.core.traceability_index import TraceabilityIndex
 from strictdoc.helpers.cast import assert_cast
@@ -65,7 +65,7 @@ def analyze_document(
         document: SDocDocument,
     ) -> DocumentStats:
         this_document_stats = DocumentStats(document)
-        document_iterator = DocumentCachingIterator(document)
+        document_iterator = SDocDocumentIterator(document)
         for node, _ in document_iterator.all_content():
             if isinstance(node, SDocNode) and node.node_type == "SECTION":
                 if node.reserved_uid is not None:

strictdoc/core/document_iterator.py

@@ -45,7 +45,7 @@ def get_level_string(self) -> str:
         return ".".join(map(str, self.level_stack))
 
 
-class DocumentCachingIterator:
+class SDocDocumentIterator:
     def __init__(self, document: SDocDocument) -> None:
         assert isinstance(document, SDocDocument), document
 

strictdoc/core/file_traceability_index.py

@@ -38,7 +38,7 @@
     SourceFileTraceabilityInfo,
 )
 from strictdoc.core.constants import GraphLinkType
-from strictdoc.core.document_iterator import DocumentCachingIterator
+from strictdoc.core.document_iterator import SDocDocumentIterator
 from strictdoc.core.project_config import ProjectConfig
 from strictdoc.core.source_tree import SourceFile
 from strictdoc.helpers.cast import assert_cast
@@ -737,7 +737,7 @@ def create_folder_section(
 
         # Iterate over all generated documents to calculate all node levels.
         for document_ in documents_with_generated_content:
-            document_iterator = DocumentCachingIterator(document_)
+            document_iterator = SDocDocumentIterator(document_)
             for _, _ in document_iterator.all_content(
                 print_fragments=False,
             ):

strictdoc/core/traceability_index.py

@@ -18,7 +18,7 @@
 )
 from strictdoc.core.asset_manager import AssetManager
 from strictdoc.core.constants import GraphLinkType
-from strictdoc.core.document_iterator import DocumentCachingIterator
+from strictdoc.core.document_iterator import SDocDocumentIterator
 from strictdoc.core.document_meta import DocumentMeta
 from strictdoc.core.document_tree import DocumentTree
 from strictdoc.core.file_dependency_manager import FileDependencyManager
@@ -43,14 +43,14 @@ class TraceabilityIndex:
     def __init__(
         self,
         document_tree: DocumentTree,
-        document_iterators: Dict[SDocDocument, DocumentCachingIterator],
+        document_iterators: Dict[SDocDocument, SDocDocumentIterator],
         file_traceability_index: FileTraceabilityIndex,
         graph_database: GraphDatabase,
         file_dependency_manager: FileDependencyManager,
     ):
-        self._document_iterators: Dict[
-            SDocDocument, DocumentCachingIterator
-        ] = document_iterators
+        self._document_iterators: Dict[SDocDocument, SDocDocumentIterator] = (
+            document_iterators
+        )
         self._file_traceability_index: FileTraceabilityIndex = (
             file_traceability_index
         )
@@ -77,7 +77,7 @@ def __init__(
         )
 
     @property
-    def document_iterators(self) -> Dict[SDocDocument, DocumentCachingIterator]:
+    def document_iterators(self) -> Dict[SDocDocument, SDocDocumentIterator]:
         return self._document_iterators
 
     def is_small_project(self) -> bool:
@@ -156,7 +156,7 @@ def get_file_traceability_index(self) -> FileTraceabilityIndex:
 
     def get_document_iterator(
         self, document: SDocDocument
-    ) -> DocumentCachingIterator:
+    ) -> SDocDocumentIterator:
         return self.document_iterators[document]
 
     def get_parent_requirements(self, requirement: SDocNode) -> List[SDocNode]:
@@ -318,7 +318,7 @@ def get_node_by_uid_weak(
     ) -> Union[SDocDocument, SDocNode, None]:
         assert isinstance(uid, str), uid
         for document in self.document_tree.document_list:
-            document_iterator = DocumentCachingIterator(document)
+            document_iterator = SDocDocumentIterator(document)
             for node, _ in document_iterator.all_content(print_fragments=False):
                 if isinstance(node, SDocDocument):
                     if node.config.uid == uid:
@@ -1031,7 +1031,7 @@ def clone_to_bundle_document(
             output_document_dir_rel_path=SDocRelativePath(""),
         )
         traceability_index_copy.document_iterators[bundle_document] = (
-            DocumentCachingIterator(bundle_document)
+            SDocDocumentIterator(bundle_document)
         )
         for document_ in traceability_index_copy.document_tree.document_list:
             # Ignore all included documents. They are anyway included by

strictdoc/core/traceability_index_builder.py

@@ -32,7 +32,7 @@
 )
 from strictdoc.core.constants import GraphLinkType
 from strictdoc.core.document_finder import DocumentFinder
-from strictdoc.core.document_iterator import DocumentCachingIterator
+from strictdoc.core.document_iterator import SDocDocumentIterator
 from strictdoc.core.document_tree import DocumentTree
 from strictdoc.core.file_dependency_manager import FileDependencyManager
 from strictdoc.core.file_traceability_index import FileTraceabilityIndex
@@ -241,9 +241,7 @@ def create_from_document_tree(
 
         # FIXME: Too many things going on below. Would be great to simplify this
         # workflow.
-        d_01_document_iterators: Dict[
-            SDocDocument, DocumentCachingIterator
-        ] = {}
+        d_01_document_iterators: Dict[SDocDocument, SDocDocumentIterator] = {}
         d_07_file_traceability_index = FileTraceabilityIndex()
 
         graph_database = GraphDatabase(
@@ -435,7 +433,7 @@ def create_from_document_tree(
                 rhs_node=document_tags,
             )
 
-            document_iterator = DocumentCachingIterator(document)
+            document_iterator = SDocDocumentIterator(document)
             d_01_document_iterators[document] = document_iterator
 
             for node, _ in document_iterator.all_content(

strictdoc/core/transforms/delete_requirement.py

@@ -6,7 +6,7 @@
     SDocNodeIF,
 )
 from strictdoc.backend.sdoc.models.node import SDocNode
-from strictdoc.core.document_iterator import DocumentCachingIterator
+from strictdoc.core.document_iterator import SDocDocumentIterator
 from strictdoc.core.traceability_index import TraceabilityIndex
 from strictdoc.core.transforms.validation_error import (
     MultipleValidationErrorAsList,
@@ -29,7 +29,7 @@ def validate(self) -> None:
         document: SDocDocument = assert_cast(
             self.requirement.get_document(), SDocDocument
         )
-        document_iterator = DocumentCachingIterator(document=document)
+        document_iterator = SDocDocumentIterator(document=document)
         for document_node_, _ in document_iterator.all_node_content(
             self.requirement,
             print_fragments=True,