strictdoc 0.0.57a1__tar.gz → 0.0.57a2__tar.gz

{strictdoc-0.0.57a1 → strictdoc-0.0.57a2}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: strictdoc
-Version: 0.0.57a1
+Version: 0.0.57a2
 Summary: StrictDoc is open-source software for technical documentation and requirements management.
 Project-URL: Changelog, https://github.com/strictdoc-project/strictdoc/blob/main/CHANGELOG.md
 Project-URL: Homepage, https://strictdoc.readthedocs.io/en/stable/

{strictdoc-0.0.57a1 → strictdoc-0.0.57a2}/strictdoc/__init__.py

@@ -1,6 +1,6 @@
 from strictdoc.core.environment import SDocRuntimeEnvironment
 
-__version__ = "0.0.57a1"
+__version__ = "0.0.57a2"
 
 
 environment = SDocRuntimeEnvironment(__file__)

{strictdoc-0.0.57a1 → strictdoc-0.0.57a2}/strictdoc/backend/reqif/p01_sdoc/reqif_to_sdoc_converter.py

@@ -94,15 +94,6 @@ class P01_ReqIFToSDocConverter:
         )
         return spec_object_type.long_name == "SECTION"
 
-    @staticmethod
-    def is_spec_object_free_text(
-        spec_object: ReqIFSpecObject, reqif_bundle: ReqIFBundle
-    ):
-        spec_object_type = reqif_bundle.lookup.get_spec_type_by_ref(
-            spec_object.spec_object_type
-        )
-        return spec_object_type.long_name == "FREETEXT"
-
     @staticmethod
     def convert_requirement_field_from_reqif(field_name: str) -> str:
         if field_name in ReqIFRequirementReservedField.SET:
@@ -158,7 +149,7 @@ class P01_ReqIFToSDocConverter:
                 reqif_bundle=reqif_bundle,
             )
 
-            converted_node: Union[SDocSection, SDocNode, FreeText]
+            converted_node: Union[SDocSection, SDocNode]
             if is_section:
                 converted_node = (
                     P01_ReqIFToSDocConverter.create_section_from_spec_object(
@@ -168,18 +159,6 @@ class P01_ReqIFToSDocConverter:
                         reqif_bundle=reqif_bundle,
                     )
                 )
-            elif P01_ReqIFToSDocConverter.is_spec_object_free_text(
-                spec_object,
-                reqif_bundle=reqif_bundle,
-            ):
-                converted_node = (
-                    P01_ReqIFToSDocConverter.create_free_text_from_spec_object(
-                        spec_object=spec_object,
-                    )
-                )
-                if len(current_section_.free_texts) == 0:
-                    current_section_.free_texts.append(converted_node)
-                return converted_node, False
             else:
                 converted_node = P01_ReqIFToSDocConverter.create_requirement_from_spec_object(
                     spec_object=spec_object,
@@ -368,6 +347,7 @@ class P01_ReqIFToSDocConverter:
         else:
             raise NotImplementedError(spec_object, attribute_map)
 
+        # FIXME: REMOVE this.
         free_texts = []
         if ReqIFChapterField.TEXT in spec_object.attribute_map:
             free_text = unescape(

{strictdoc-0.0.57a1 → strictdoc-0.0.57a2}/strictdoc/backend/reqif/p01_sdoc/sdoc_to_reqif_converter.py

@@ -47,7 +47,6 @@ from strictdoc.backend.sdoc.models.type_system import (
     GrammarElementFieldString,
     ReferenceType,
 )
-from strictdoc.backend.sdoc.writer import SDWriter
 from strictdoc.core.document_iterator import DocumentCachingIterator
 from strictdoc.core.document_tree import DocumentTree
 from strictdoc.helpers.cast import assert_cast
@@ -234,29 +233,7 @@ class P01_SDocToReqIFObjectConverter:
             )
 
             current_hierarchy = root_hierarchy
-            if len(document.free_texts) > 0:
-                # fmt: off
-                document_free_text_spec_object = (
-                    P01_SDocToReqIFObjectConverter
-                    ._convert_document_free_text_to_spec_object(
-                        document,
-                        context=context,
-                    )
-                )
-                # fmt: on
-                spec_objects.append(document_free_text_spec_object)
-                hierarchy = ReqIFSpecHierarchy(
-                    xml_node=None,
-                    is_self_closed=False,
-                    identifier=generate_unique_identifier("SPEC-HIERARCHY"),
-                    last_change=None,
-                    long_name=None,
-                    spec_object=document_free_text_spec_object.identifier,
-                    children=[],
-                    ref_then_children_order=True,
-                    level=document.ng_level + 1,
-                )
-                current_hierarchy.add_child(hierarchy)
+
             # FIXME: ReqIF must export complete documents including fragments.
             for node in document_iterator.all_content(
                 print_fragments=False, print_fragments_from_files=False
@@ -421,44 +398,6 @@ class P01_SDocToReqIFObjectConverter:
         )
         return reqif_bundle
 
-    @classmethod
-    def _convert_document_free_text_to_spec_object(
-        cls,
-        document: SDocDocument,
-        context: P01_SDocToReqIFBuildContext,
-    ) -> ReqIFSpecObject:
-        assert isinstance(document, SDocDocument)
-        assert len(document.free_texts) > 0
-        attributes = []
-        free_text_value = (
-            SDWriter.print_free_text_content(document.free_texts[0])
-        ).rstrip()
-        if context.multiline_is_xhtml:
-            attribute_type = SpecObjectAttributeType.XHTML
-        else:
-            attribute_type = SpecObjectAttributeType.STRING
-            free_text_value = escape(free_text_value)
-
-        free_text_attribute = SpecObjectAttribute(
-            xml_node=None,
-            attribute_type=attribute_type,
-            definition_ref=ReqIFChapterField.TEXT,
-            value=free_text_value,
-        )
-        attributes.append(free_text_attribute)
-        spec_object = ReqIFSpecObject(
-            xml_node=None,
-            description=None,
-            identifier=generate_unique_identifier("DOCUMENT_FREETEXT"),
-            last_change=None,
-            long_name=None,
-            spec_object_type=context.map_grammar_node_tags_to_spec_object_type[
-                document
-            ]["FREETEXT"].identifier,
-            attributes=attributes,
-        )
-        return spec_object
-
     @classmethod
     def _convert_section_to_spec_object(
         cls,
@@ -475,23 +414,6 @@ class P01_SDocToReqIFObjectConverter:
             value=section.title,
         )
         attributes.append(title_attribute)
-        if len(section.free_texts) > 0:
-            free_text_value = (
-                SDWriter.print_free_text_content(section.free_texts[0])
-            ).rstrip()
-            if context.multiline_is_xhtml:
-                attribute_type = SpecObjectAttributeType.XHTML
-            else:
-                attribute_type = SpecObjectAttributeType.STRING
-                free_text_value = escape(free_text_value)
-
-            free_text_attribute = SpecObjectAttribute(
-                xml_node=None,
-                attribute_type=attribute_type,
-                definition_ref=ReqIFChapterField.TEXT,
-                value=free_text_value,
-            )
-            attributes.append(free_text_attribute)
 
         """
         If MIDs is enabled and this section has an MID, use it for
@@ -742,15 +664,6 @@ class P01_SDocToReqIFObjectConverter:
             "SECTION"
         ] = section_spec_type
         spec_object_types.append(section_spec_type)
-        free_text_spec_type = (
-            P01_SDocToReqIFObjectConverter._create_free_text_spec_object_type(
-                context
-            )
-        )
-        context.map_grammar_node_tags_to_spec_object_type[grammar.parent][
-            "FREETEXT"
-        ] = free_text_spec_type
-        spec_object_types.append(free_text_spec_type)
 
         return spec_object_types
 
@@ -774,27 +687,3 @@ class P01_SDocToReqIFObjectConverter:
             attribute_definitions=attribute_definitions,
         )
         return spec_object_type
-
-    @classmethod
-    def _create_free_text_spec_object_type(
-        cls,
-        context: P01_SDocToReqIFBuildContext,
-    ):
-        attribute_definitions = []
-        chapter_name_attribute = SpecAttributeDefinition.create(
-            attribute_type=SpecObjectAttributeType.XHTML
-            if context.multiline_is_xhtml
-            else SpecObjectAttributeType.STRING,
-            identifier=ReqIFChapterField.TEXT,
-            datatype_definition=StrictDocReqIFTypes.MULTI_LINE_STRING.value,
-            long_name=ReqIFChapterField.TEXT,
-        )
-        attribute_definitions.append(chapter_name_attribute)
-
-        spec_object_type_identifier = "FREE_TEXT_" + uuid.uuid4().hex
-        spec_object_type = ReqIFSpecObjectType.create(
-            identifier=spec_object_type_identifier,
-            long_name="FREETEXT",
-            attribute_definitions=attribute_definitions,
-        )
-        return spec_object_type

{strictdoc-0.0.57a1 → strictdoc-0.0.57a2}/strictdoc/backend/reqif/reqif_export.py

@@ -8,9 +8,6 @@ from reqif.unparser import ReqIFUnparser, ReqIFZUnparser
 from strictdoc.backend.reqif.p01_sdoc.sdoc_to_reqif_converter import (
     P01_SDocToReqIFObjectConverter,
 )
-from strictdoc.backend.reqif.p02_simple.sdoc_to_reqif_converter import (
-    P02_SDocToReqIFObjectConverter,
-)
 from strictdoc.backend.reqif.sdoc_reqif_fields import ReqIFProfile
 from strictdoc.core.project_config import ProjectConfig
 from strictdoc.core.traceability_index import TraceabilityIndex
@@ -32,12 +29,6 @@ class ReqIFExport:
                 multiline_is_xhtml=project_config.reqif_multiline_is_xhtml,
                 enable_mid=project_config.reqif_enable_mid,
             )
-        elif project_config.reqif_profile == ReqIFProfile.P02_SIMPLE:
-            reqif_bundle = P02_SDocToReqIFObjectConverter.convert_document_tree(
-                document_tree=traceability_index.document_tree,
-                multiline_is_xhtml=project_config.reqif_multiline_is_xhtml,
-                enable_mid=project_config.reqif_enable_mid,
-            )
         else:
             raise NotImplementedError(
                 f"Requirements profile does not implement the ReqIF export yet: "

{strictdoc-0.0.57a1 → strictdoc-0.0.57a2}/strictdoc/backend/reqif/reqif_import.py

@@ -8,12 +8,6 @@ from reqif.reqif_bundle import ReqIFBundle, ReqIFZBundle
 from strictdoc.backend.reqif.p01_sdoc.reqif_to_sdoc_converter import (
     P01_ReqIFToSDocConverter,
 )
-from strictdoc.backend.reqif.p02_simple.reqif_to_sdoc_converter import (
-    P02_ReqIFToSDocConverter,
-)
-from strictdoc.backend.reqif.p11_polarion.reqif_to_sdoc_converter import (
-    P11_ReqIFToSDocConverter,
-)
 from strictdoc.backend.reqif.sdoc_reqif_fields import ReqIFProfile
 from strictdoc.backend.sdoc.models.document import SDocDocument
 from strictdoc.cli.cli_arg_parser import ImportReqIFCommandConfig
@@ -65,10 +59,6 @@ class ReqIFImport:
             or import_config.profile == ReqIFProfile.P01_SDOC
         ):
             return P01_ReqIFToSDocConverter()
-        if import_config.profile == ReqIFProfile.P02_SIMPLE:
-            return P02_ReqIFToSDocConverter()
-        if import_config.profile == ReqIFProfile.P11_POLARION:
-            return P11_ReqIFToSDocConverter()
         raise NotImplementedError(
             f"Unsupported profile: {import_config.profile}"
         )

{strictdoc-0.0.57a1 → strictdoc-0.0.57a2}/strictdoc/backend/reqif/sdoc_reqif_fields.py

@@ -1,9 +1,7 @@
 class ReqIFProfile:
     P01_SDOC = "p01_sdoc"
-    P02_SIMPLE = "p02_simple"
-    P11_POLARION = "p11_polarion"
 
-    ALL = [P01_SDOC, P02_SIMPLE, P11_POLARION]
+    ALL = [P01_SDOC]
 
 
 SDOC_SPEC_OBJECT_TYPE_SINGLETON = "REQUIREMENT_OR_SECTION"

{strictdoc-0.0.57a1 → strictdoc-0.0.57a2}/strictdoc/backend/sdoc/free_text_reader.py

@@ -1,4 +1,6 @@
 # mypy: disable-error-code="no-untyped-call,no-untyped-def"
+from typing import Tuple
+
 from textx import metamodel_from_str
 
 from strictdoc.backend.sdoc.grammar.grammar_builder import SDocGrammarBuilder
@@ -11,7 +13,9 @@ from strictdoc.helpers.textx import drop_textx_meta
 
 class SDFreeTextReader:
     @staticmethod
-    def _read(input_string, file_path=None):
+    def _read(
+        input_string, file_path=None
+    ) -> Tuple[FreeTextContainer, ParseContext]:
         meta_model = metamodel_from_str(
             SDocGrammarBuilder.create_free_text_grammar(),
             classes=[FreeTextContainer, InlineLink, Anchor],
@@ -32,6 +36,7 @@ class SDFreeTextReader:
         return document, parse_context
 
     @staticmethod
-    def read(input_string, file_path=None):
+    def read(input_string: str, file_path=None) -> FreeTextContainer:
+        assert isinstance(input_string, str), input_string
         document, _ = SDFreeTextReader._read(input_string, file_path)
         return document

{strictdoc-0.0.57a1 → strictdoc-0.0.57a2}/strictdoc/backend/sdoc/grammar_reader.py

@@ -47,6 +47,11 @@ class SDocGrammarReader:
         grammar: DocumentGrammar = grammar_wrapper.grammar
         grammar.parent = None
 
+        if not grammar.has_text_element():
+            grammar.add_element_first(
+                DocumentGrammar.create_default_text_element()
+            )
+
         # HACK:
         # ProcessPoolExecutor doesn't work because of non-picklable parts
         # of textx. The offending fields are stripped down because they

{strictdoc-0.0.57a1 → strictdoc-0.0.57a2}/strictdoc/backend/sdoc/models/anchor.py

@@ -1,5 +1,5 @@
 # mypy: disable-error-code="no-untyped-def"
-from typing import Optional
+from typing import Any, Optional
 
 from strictdoc.helpers.auto_described import auto_described
 from strictdoc.helpers.mid import MID
@@ -35,3 +35,9 @@ class Anchor:
     @property
     def parent_or_including_document(self):
         return self.parent.parent_or_including_document
+
+    def parent_node(self) -> Any:
+        # Anchor -> FreeText -> Section|Document
+        # or
+        # Anchor -> SDocField -> SDocNode
+        return self.parent.parent

{strictdoc-0.0.57a1 → strictdoc-0.0.57a2}/strictdoc/backend/sdoc/models/document.py

@@ -41,7 +41,6 @@ class SDocDocument:
             view if view is not None else DocumentView.create_default(self)
         )
         self.grammar: Optional[DocumentGrammar] = grammar
-        self.free_texts: List[FreeText] = free_texts
         self.section_contents: List = section_contents
 
         # FIXME: Plain list of all fragments found in the document.
@@ -55,7 +54,7 @@ class SDocDocument:
 
         self.reserved_mid: MID = MID(mid) if mid is not None else MID.create()
         self.mid_permanent: bool = mid is not None
-        self.included_documents: List["SDocDocument"] = []
+        self.included_documents: List[SDocDocument] = []
         self.context: SDocDocumentContext = SDocDocumentContext()
 
         self.ng_including_document_reference: Optional = None  # type: ignore[valid-type]
@@ -81,12 +80,23 @@ class SDocDocument:
     def is_composite_requirement(self) -> bool:
         return False
 
+    def get_display_node_type(self) -> str:
+        return "Document"
+
     def get_node_type_string(self) -> Optional[str]:
         return None
 
     def get_type_string(self) -> str:
         return "document" if not self.document_is_included() else "section"
 
+    def get_debug_info(self) -> str:
+        debug_components: List[str] = [f"TITLE = '{self.title}'"]
+        if self.meta is not None:
+            debug_components.append(
+                f" ({self.meta.input_doc_rel_path.relative_path})"
+            )
+        return f"Document({', '.join(debug_components)})"
+
     def document_is_included(self) -> bool:
         return self.ng_including_document_reference.get_document() is not None
 
@@ -138,6 +148,8 @@ class SDocDocument:
                     return True
                 continue
             if section_or_requirement.is_requirement:
+                if section_or_requirement.requirement_type == "TEXT":
+                    continue
                 return True
             assert section_or_requirement.is_section, section_or_requirement
             task_list.extend(section_or_requirement.section_contents)
@@ -168,9 +180,3 @@ class SDocDocument:
         yield from self.grammar.elements[
             0
         ].enumerate_custom_content_field_titles()
-
-    def set_freetext(self, freetext: Optional[FreeText]) -> None:
-        if freetext is None:
-            self.free_texts = []
-            return
-        self.free_texts = [freetext]

{strictdoc-0.0.57a1 → strictdoc-0.0.57a2}/strictdoc/backend/sdoc/models/document_grammar.py

@@ -203,6 +203,11 @@ class DocumentGrammar:
 
     @staticmethod
     def create_default(parent) -> "DocumentGrammar":
+        text_element: GrammarElement = (
+            DocumentGrammar.create_default_text_element()
+        )
+
+        # @sdoc[SDOC-SRS-132]
         fields: List[
             Union[
                 GrammarElementFieldString,
@@ -210,25 +215,6 @@ class DocumentGrammar:
                 GrammarElementFieldMultipleChoice,
             ]
         ] = [
-            GrammarElementFieldString(
-                parent=None,
-                title=RequirementFieldName.UID,
-                human_title=None,
-                required="False",
-            ),
-            GrammarElementFieldString(
-                parent=None,
-                title=RequirementFieldName.STATEMENT,
-                human_title=None,
-                required="True",
-            ),
-        ]
-        text_element = GrammarElement(
-            parent=None, tag="TEXT", fields=fields, relations=[]
-        )
-
-        # @sdoc[SDOC-SRS-132]
-        fields = [
             GrammarElementFieldString(
                 parent=None,
                 title=RequirementFieldName.UID,
@@ -315,6 +301,18 @@ class DocumentGrammar:
             )
         )
 
+    def has_text_element(self) -> bool:
+        for element_ in self.elements:
+            if element_.tag == "TEXT":
+                return True
+        return False
+
+    def add_element_first(self, element: GrammarElement):
+        self.elements.insert(0, element)
+        self.elements_by_type[element.tag] = element
+        self.registered_elements.add(element.tag)
+        self.is_default = False
+
     def update_element(
         self, existing_element: GrammarElement, updated_element: GrammarElement
     ):
@@ -339,6 +337,33 @@ class DocumentGrammar:
         self.registered_elements = registered_elements
         self.elements_by_type = elements_by_type
 
+    @staticmethod
+    def create_default_text_element() -> GrammarElement:
+        fields: List[
+            Union[
+                GrammarElementFieldString,
+                GrammarElementFieldSingleChoice,
+                GrammarElementFieldMultipleChoice,
+            ]
+        ] = [
+            GrammarElementFieldString(
+                parent=None,
+                title=RequirementFieldName.UID,
+                human_title=None,
+                required="False",
+            ),
+            GrammarElementFieldString(
+                parent=None,
+                title=RequirementFieldName.STATEMENT,
+                human_title=None,
+                required="True",
+            ),
+        ]
+        text_element = GrammarElement(
+            parent=None, tag="TEXT", fields=fields, relations=[]
+        )
+        return text_element
+
 
 class DocumentGrammarWrapper:
     def __init__(self, grammar: DocumentGrammar):

{strictdoc-0.0.57a1 → strictdoc-0.0.57a2}/strictdoc/backend/sdoc/models/free_text.py

@@ -13,6 +13,12 @@ class FreeText:
         self.parent = parent
         self.parts = parts
         self.ng_level = None
+        self.ng_line_start: Optional[int] = None
+        self.ng_line_end: Optional[int] = None
+        self.ng_col_start: Optional[int] = 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]:

{strictdoc-0.0.57a1 → strictdoc-0.0.57a2}/strictdoc/backend/sdoc/models/inline_link.py

@@ -1,17 +1,19 @@
 # mypy: disable-error-code="no-untyped-call,no-untyped-def"
+from typing import Any
+
 from strictdoc.helpers.auto_described import auto_described
 from strictdoc.helpers.mid import MID
 
 
 @auto_described()
 class InlineLink:
-    def __init__(self, parent, value):
-        self.parent = parent
-        self.link = value
+    def __init__(self, parent: Any, value: str) -> None:
+        self.parent: Any = parent
+        self.link: str = value
 
         # FIXME: Remove either mid or reserved_mid.
         self.mid: MID = MID.create()
         self.reserved_mid: MID = self.mid
 
-    def parent_node(self):
+    def parent_node(self) -> Any:
         return self.parent.parent