Merge pull request #2182 from strictdoc-project/stanislaw/remove_free_text

Code climate: backend/sdoc: free_text: remove unused code

Author: stanislaw

strictdoc/backend/reqif/p01_sdoc/reqif_to_sdoc_converter.py

@@ -23,7 +23,6 @@
     GrammarElement,
     create_default_relations,
 )
-from strictdoc.backend.sdoc.models.free_text import FreeText
 from strictdoc.backend.sdoc.models.node import SDocNode, SDocNodeField
 from strictdoc.backend.sdoc.models.reference import (
     ParentReqReference,
@@ -208,7 +207,7 @@ def node_converter_lambda(
                     spec_object_type_identifier_
                 )
             )
-            if spec_object_type.long_name in ("SECTION", "FREETEXT"):
+            if spec_object_type.long_name == "SECTION":
                 continue
             grammar_element = (
                 context.map_spec_object_type_identifier_to_grammar_node_tags[
@@ -604,15 +603,3 @@ def create_requirement_from_spec_object(
             if len(parent_refs) > 0:
                 requirement.relations = parent_refs
         return requirement
-
-    @staticmethod
-    def create_free_text_from_spec_object(
-        spec_object: ReqIFSpecObject,
-    ) -> FreeText:
-        free_text = unescape(
-            spec_object.attribute_map[ReqIFChapterField.TEXT].value
-        )
-        return FreeText(
-            parent=None,
-            parts=[free_text],
-        )

strictdoc/backend/sdoc/models/free_text.py

@@ -1,19 +1,9 @@
-"""
-@relation(SDOC-SRS-135, scope=file)
-"""
-
 from typing import Any, List, Optional
 
-from strictdoc.backend.sdoc.models.anchor import Anchor
-from strictdoc.backend.sdoc.models.inline_link import InlineLink
-from strictdoc.helpers.auto_described import auto_described
-
 
-@auto_described
-class FreeText:
-    def __init__(self, parent: Any, parts: List[Any]) -> None:
+class FreeTextContainer:
+    def __init__(self, parts: List[Any]) -> None:
         assert isinstance(parts, list)
-        self.parent = parent
         self.parts = parts
         self.ng_level = None
         self.ng_line_start: Optional[int] = None
@@ -22,43 +12,3 @@ def __init__(self, parent: Any, parts: List[Any]) -> None:
         self.ng_col_end: Optional[int] = None
         self.ng_byte_start: Optional[int] = None
         self.ng_byte_end: Optional[int] = None
-
-    @property
-    def parent_or_including_document(self) -> Optional[Any]:
-        return self.parent.parent_or_including_document
-
-    @property
-    def is_requirement(self) -> bool:
-        return False
-
-    @property
-    def is_section(self) -> bool:
-        return False
-
-    def get_parts_as_text(self) -> str:
-        # [LINK: SECTION-CUSTOM-GRAMMARS]
-        text = ""
-        for part in self.parts:
-            if isinstance(part, str):
-                text += part
-            elif isinstance(part, InlineLink):
-                text += "[LINK: "
-                text += part.link
-                text += "]"
-            elif isinstance(part, Anchor):
-                text += "[ANCHOR: "
-                text += part.value
-                if part.has_title:
-                    text += ", "
-                    text += part.title
-                text += "]"
-                text += "\n"
-                text += "\n"
-            else:
-                raise NotImplementedError(part)
-        return text
-
-
-class FreeTextContainer(FreeText):
-    def __init__(self, parts: List[Any]) -> None:
-        super().__init__(None, parts)

strictdoc/core/traceability_index.py

@@ -416,32 +416,31 @@ def create_section(self, section: SDocSection) -> None:
 
     def create_inline_link(self, new_link: InlineLink):
         assert isinstance(new_link, InlineLink)
+
         # InlineLink points to a section, node or to anchor.
-        # FIXME: De-nest this code by returning early.
-        if self.graph_database.has_link(
+        assert self.graph_database.has_link(
             link_type=GraphLinkType.UID_TO_NODE, lhs_node=new_link.link
-        ):
-            node_or_anchor: Union[
-                SDocDocument, SDocNode, SDocSection, Anchor
-            ] = assert_cast(
+        )
+
+        node_or_anchor: Union[SDocDocument, SDocNode, SDocSection, Anchor] = (
+            assert_cast(
                 self.graph_database.get_link_value(
                     link_type=GraphLinkType.UID_TO_NODE,
                     lhs_node=new_link.link,
                 ),
                 (SDocDocument, SDocNode, SDocSection, Anchor),
             )
-            self.graph_database.create_link(
-                link_type=GraphLinkType.NODE_TO_INCOMING_LINKS,
-                lhs_node=node_or_anchor.reserved_mid,
-                rhs_node=new_link,
-            )
-            self.graph_database.create_link(
-                link_type=GraphLinkType.MID_TO_NODE,
-                lhs_node=new_link.reserved_mid,
-                rhs_node=new_link,
-            )
-        else:
-            raise NotImplementedError
+        )
+        self.graph_database.create_link(
+            link_type=GraphLinkType.NODE_TO_INCOMING_LINKS,
+            lhs_node=node_or_anchor.reserved_mid,
+            rhs_node=new_link,
+        )
+        self.graph_database.create_link(
+            link_type=GraphLinkType.MID_TO_NODE,
+            lhs_node=new_link.reserved_mid,
+            rhs_node=new_link,
+        )
 
     def update_last_updated(self) -> None:
         """

strictdoc/export/json/json_generator.py

@@ -4,13 +4,10 @@
 from enum import Enum
 from typing import Any, Dict, List, Optional, Tuple
 
-from strictdoc.backend.sdoc.models.anchor import Anchor
 from strictdoc.backend.sdoc.models.document import SDocDocument
 from strictdoc.backend.sdoc.models.document_config import DocumentConfig
 from strictdoc.backend.sdoc.models.document_from_file import DocumentFromFile
 from strictdoc.backend.sdoc.models.document_grammar import DocumentGrammar
-from strictdoc.backend.sdoc.models.free_text import FreeText
-from strictdoc.backend.sdoc.models.inline_link import InlineLink
 from strictdoc.backend.sdoc.models.node import SDocCompositeNode, SDocNode
 from strictdoc.backend.sdoc.models.reference import (
     ChildReqReference,
@@ -310,30 +307,6 @@ def _write_grammar_field_type(cls, grammar_field) -> Dict:
         }
         return grammar_field_dict
 
-    @classmethod
-    def _write_free_text_content(cls, free_text) -> str:
-        assert isinstance(free_text, FreeText)
-        output = ""
-
-        for _, part in enumerate(free_text.parts):
-            if isinstance(part, str):
-                output += part
-            elif isinstance(part, InlineLink):
-                output += "[LINK: "
-                output += part.link
-                output += "]"
-            elif isinstance(part, Anchor):
-                output += "[ANCHOR: "
-                output += part.value
-                if part.has_title:
-                    output += ", "
-                    output += part.title
-                output += "]"
-                output += "\n"
-            else:
-                raise NotImplementedError(part)
-        return output
-
     @staticmethod
     def _write_requirement_relations(node: SDocNode) -> List:
         relations_list = []

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

@@ -3,7 +3,7 @@
 
 from strictdoc.backend.sdoc.free_text_reader import SDFreeTextReader
 from strictdoc.backend.sdoc.models.anchor import Anchor
-from strictdoc.backend.sdoc.models.free_text import FreeText
+from strictdoc.backend.sdoc.models.free_text import FreeTextContainer
 
 
 def test_001_anchor_without_space():
@@ -118,7 +118,7 @@ def test_014_two_anchors():
     reader = SDFreeTextReader()
 
     document = reader.read(free_text_input)
-    assert isinstance(document, FreeText)
+    assert isinstance(document, FreeTextContainer)
 
     assert document.parts[0] == "Hello world\n\n"
     assert document.parts[1].value == "AD1"
@@ -134,7 +134,7 @@ def test_020_link():
     reader = SDFreeTextReader()
 
     document = reader.read(free_text_input)
-    assert isinstance(document, FreeText)
+    assert isinstance(document, FreeTextContainer)
 
     assert document.parts[0] == "Hello world "
     assert document.parts[1].link == "FOO"