strictdoc 0.6.1a1__tar.gz → 0.7.0__tar.gz

{strictdoc-0.6.1a1 → strictdoc-0.7.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: strictdoc
-Version: 0.6.1a1
+Version: 0.7.0
 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/
@@ -22,7 +22,7 @@ Requires-Python: >=3.8
 Requires-Dist: beautifulsoup4==4.*,>=4.12.0
 Requires-Dist: docutils==0.*,>=0.16
 Requires-Dist: fastapi>=0.83.0
-Requires-Dist: html2print>=0.0.12
+Requires-Dist: html2print>=0.0.15
 Requires-Dist: html5lib>=1.1
 Requires-Dist: jinja2>=2.11.2
 Requires-Dist: openpyxl>=3.1.0

{strictdoc-0.6.1a1 → strictdoc-0.7.0}/pyproject.toml

@@ -88,7 +88,7 @@ dependencies = [
     "WebSockets",
 
     # HTML2PDF dependencies
-    "html2print >= 0.0.12",
+    "html2print >= 0.0.15",
 ]
 # @sdoc[/SDOC-SRS-89]
 

{strictdoc-0.6.1a1 → strictdoc-0.7.0}/strictdoc/__init__.py

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

{strictdoc-0.6.1a1 → strictdoc-0.7.0}/strictdoc/backend/excel/import_/excel_to_sdoc_converter.py

@@ -126,7 +126,6 @@ class ExcelToSDocConverter:
             config=document_config,
             view=None,
             grammar=None,
-            free_texts=[],
             section_contents=[],
         )
 

{strictdoc-0.6.1a1 → strictdoc-0.7.0}/strictdoc/backend/reqif/p01_sdoc/reqif_to_sdoc_converter.py

@@ -332,7 +332,7 @@ class P01_ReqIFToSDocConverter:
             else "<No title>"
         )
         document = SDocDocument(
-            None, document_title, document_config, None, None, [], []
+            None, document_title, document_config, None, None, []
         )
         if context.enable_mid:
             document.reserved_mid = specification.identifier
@@ -387,7 +387,6 @@ class P01_ReqIFToSDocConverter:
             custom_level=None,
             title=section_title,
             requirement_prefix=None,
-            free_texts=[],
             section_contents=[],
         )
         section.ng_level = level

{strictdoc-0.6.1a1 → strictdoc-0.7.0}/strictdoc/backend/reqif/p01_sdoc/sdoc_to_reqif_converter.py

@@ -430,6 +430,10 @@ class P01_SDocToReqIFObjectConverter:
         context: P01_SDocToReqIFBuildContext,
     ) -> ReqIFSpecObject:
         assert isinstance(section, SDocSection)
+        parent_document: SDocDocument = assert_cast(
+            section.get_document(), SDocDocument
+        )
+
         attributes = []
         title_attribute = SpecObjectAttribute(
             xml_node=None,
@@ -443,7 +447,7 @@ class P01_SDocToReqIFObjectConverter:
         If MIDs is enabled and this section has an MID, use it for
         SPEC-OBJECT IDENTIFIER.
         """
-        enable_mid = context.enable_mid and section.document.config.enable_mid
+        enable_mid = context.enable_mid and parent_document.config.enable_mid
         section_identifier: str
         if enable_mid and section.reserved_mid is not None:
             section_identifier = section.reserved_mid
@@ -451,7 +455,7 @@ class P01_SDocToReqIFObjectConverter:
             section_identifier = generate_unique_identifier("SECTION")
 
         spec_object_type: ReqIFSpecObjectType = (
-            context.map_grammar_node_tags_to_spec_object_type[section.document][
+            context.map_grammar_node_tags_to_spec_object_type[parent_document][
                 "SECTION"
             ]
         )
@@ -475,9 +479,9 @@ class P01_SDocToReqIFObjectConverter:
         data_types: List,
         data_types_lookup: Dict[str, str],
     ) -> ReqIFSpecObject:
-        enable_mid = (
-            context.enable_mid and requirement.document.config.enable_mid
-        )
+        node_document = assert_cast(requirement.get_document(), SDocDocument)
+
+        enable_mid = context.enable_mid and node_document.config.enable_mid
 
         requirement_identifier: str
         if enable_mid and requirement.reserved_mid is not None:
@@ -541,7 +545,7 @@ class P01_SDocToReqIFObjectConverter:
 
                 field_value: str = field.get_text_value().rstrip()
 
-                attribute_type: str
+                attribute_type: SpecObjectAttributeType
                 if context.multiline_is_xhtml:
                     attribute_type = (
                         SpecObjectAttributeType.XHTML
@@ -572,9 +576,9 @@ class P01_SDocToReqIFObjectConverter:
                 ] = requirement.relations
 
         spec_object_type: ReqIFSpecObjectType = (
-            context.map_grammar_node_tags_to_spec_object_type[
-                requirement.document
-            ][requirement.node_type]
+            context.map_grammar_node_tags_to_spec_object_type[node_document][
+                requirement.node_type
+            ]
         )
         spec_object = ReqIFSpecObject.create(
             identifier=requirement_identifier,
@@ -718,7 +722,7 @@ class P01_SDocToReqIFObjectConverter:
         chapter_name_attribute = SpecAttributeDefinition.create(
             attribute_type=SpecObjectAttributeType.STRING,
             identifier="ReqIF.ChapterName",
-            datatype_definition=(StrictDocReqIFTypes.SINGLE_LINE_STRING.value),
+            datatype_definition=StrictDocReqIFTypes.SINGLE_LINE_STRING.value,
             long_name="ReqIF.ChapterName",
         )
         attribute_definitions.append(chapter_name_attribute)

{strictdoc-0.6.1a1 → strictdoc-0.7.0}/strictdoc/backend/sdoc/grammar/grammar.py

@@ -4,7 +4,6 @@ NEGATIVE_MULTILINE_STRING_START = "(?!>>>\n)"
 NEGATIVE_MULTILINE_STRING_END = "(?!^<<<)"
 NEGATIVE_RELATIONS = "(?!^RELATIONS)"
 NEGATIVE_UID = "(?!^UID)"
-NEGATIVE_FREETEXT_END = "(?!^\\[\\/FREETEXT\\]\n)"
 NEGATIVE_INLINE_LINK_START = rf"(?!\[LINK: {REGEX_UID})"
 NEGATIVE_ANCHOR_START = rf"(?!^\[ANCHOR: {REGEX_UID})"
 
@@ -18,7 +17,7 @@ SingleLineTextPart[noskipws]:
 ;
 
 NormalString[noskipws]:
-  (/(?ms){NEGATIVE_MULTILINE_STRING_END}{NEGATIVE_FREETEXT_END}{NEGATIVE_INLINE_LINK_START}{NEGATIVE_ANCHOR_START}./)+
+  (/(?ms){NEGATIVE_MULTILINE_STRING_END}{NEGATIVE_INLINE_LINK_START}{NEGATIVE_ANCHOR_START}./)+
 ;
 
 InlineLink[noskipws]:
@@ -63,7 +62,6 @@ SDocDocument[noskipws]:
   (config = DocumentConfig)?
   (view = DocumentView)?
   ('\n' grammar = DocumentGrammar)?
-  free_texts *= SpaceThenFreeText
   section_contents *= SectionOrRequirement
 ;
 
@@ -146,7 +144,6 @@ SDocSection[noskipws]:
   ('LEVEL: ' custom_level = SingleLineString '\n')?
   'TITLE: ' title = SingleLineString '\n'
   ('REQ_PREFIX: ' requirement_prefix = SingleLineString '\n')?
-  free_texts *= SpaceThenFreeText
   section_contents *= SectionOrRequirement
   '\n'
   '[/SECTION]'
@@ -166,12 +163,8 @@ SpaceThenRequirement[noskipws]:
   '\n' (SDocNode | SDocCompositeNode)
 ;
 
-SpaceThenFreeText[noskipws]:
-  '\n' (FreeText)
-;
-
 ReservedKeyword[noskipws]:
-  'DOCUMENT' | 'GRAMMAR' | 'SECTION' | 'DOCUMENT_FROM_FILE' | 'FREETEXT'
+  'DOCUMENT' | 'GRAMMAR' | 'SECTION' | 'DOCUMENT_FROM_FILE'
 ;
 
 SDocNode[noskipws]:
@@ -228,9 +221,4 @@ SDocCompositeNode[noskipws]:
 RequirementStatus[noskipws]:
   'Draft' | 'Active' | 'Deleted';
 
-FreeText[noskipws]:
-  /\[FREETEXT\]\n/
-  parts*=TextPart
-  /\[\/FREETEXT\]\n/
-;
 """

strictdoc-0.7.0/strictdoc/backend/sdoc/models/anchor.py

@@ -0,0 +1,62 @@
+from typing import Optional
+
+from strictdoc.backend.sdoc.models.model import (
+    SDocDocumentIF,
+    SDocNodeFieldIF,
+    SDocNodeIF,
+)
+from strictdoc.helpers.auto_described import auto_described
+from strictdoc.helpers.cast import assert_cast
+from strictdoc.helpers.mid import MID
+
+
+@auto_described
+class Anchor:
+    def __init__(
+        self, parent: SDocNodeFieldIF, value: str, title: Optional[str]
+    ) -> None:
+        # In the grammar, the title is optional but textX passes it as an empty
+        # string. Putting an assert to monitor the regressions/changes if the
+        # grammar gets changed.
+        assert title is not None
+        # FIXME: Cannot enable this assert because the parent can also be
+        #        FreeTextContainer. Refactor the types.
+        # assert isinstance(parent, SDocNodeFieldIF), parent  # noqa: ERA001
+
+        self.parent: SDocNodeFieldIF = parent
+        self.value: str = value
+
+        has_title = len(title) > 0
+        self.title: str = title if has_title else value
+        self.has_title = has_title
+
+        # FIXME: Remove either mid or reserved_mid.
+        self.mid: MID = MID.create()
+        self.reserved_mid: MID = self.mid
+
+    def get_display_title(self) -> str:
+        return self.title
+
+    def get_document(self) -> SDocDocumentIF:
+        if isinstance(self.parent.parent, SDocDocumentIF):
+            return self.parent.parent
+        document: SDocDocumentIF = assert_cast(
+            self.parent_node().get_document(), SDocDocumentIF
+        )
+        return document
+
+    def get_parent_or_including_document(self) -> SDocDocumentIF:
+        return self.parent_node().get_parent_or_including_document()
+
+    # FIXME: Remove this. Use get_parent_or_including_document() instead.
+    @property
+    def parent_or_including_document(self) -> SDocDocumentIF:
+        return self.get_parent_or_including_document()
+
+    def get_including_document(self) -> Optional[SDocDocumentIF]:
+        return self.parent_node().get_including_document()
+
+    def parent_node(self) -> SDocNodeIF:
+        # Anchor -> SDocField -> SDocNode
+        parent_node: SDocNodeIF = assert_cast(self.parent.parent, SDocNodeIF)
+        return parent_node

{strictdoc-0.6.1a1 → strictdoc-0.7.0}/strictdoc/backend/sdoc/models/constants.py

@@ -10,7 +10,6 @@ from strictdoc.backend.sdoc.models.document_view import (
     DocumentView,
     ViewElement,
 )
-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,
@@ -48,7 +47,6 @@ SECTION_MODELS = [
     ParentReqReference,
     ChildReqReference,
     FileReference,
-    FreeText,
     InlineLink,
     Anchor,
     FileEntry,

{strictdoc-0.6.1a1 → strictdoc-0.7.0}/strictdoc/backend/sdoc/models/document.py

@@ -2,13 +2,18 @@
 @relation(SDOC-SRS-109, scope=file)
 """
 
-# mypy: disable-error-code="union-attr,type-arg"
 from typing import Generator, List, Optional
 
 from strictdoc.backend.sdoc.models.document_config import DocumentConfig
 from strictdoc.backend.sdoc.models.document_grammar import DocumentGrammar
 from strictdoc.backend.sdoc.models.document_view import DocumentView
-from strictdoc.backend.sdoc.models.free_text import FreeText
+from strictdoc.backend.sdoc.models.model import (
+    SDocDocumentContentIF,
+    SDocDocumentFromFileIF,
+    SDocDocumentIF,
+    SDocNodeIF,
+    SDocSectionIF,
+)
 from strictdoc.core.document_meta import DocumentMeta
 from strictdoc.helpers.auto_described import auto_described
 from strictdoc.helpers.mid import MID
@@ -21,7 +26,7 @@ class SDocDocumentContext:
 
 
 @auto_described
-class SDocDocument:
+class SDocDocument(SDocDocumentIF):
     def __init__(
         self,
         mid: Optional[str],
@@ -29,12 +34,9 @@ class SDocDocument:
         config: Optional[DocumentConfig],
         view: Optional[DocumentView],
         grammar: Optional[DocumentGrammar],
-        free_texts: List[FreeText],
-        section_contents: List,
+        section_contents: List[SDocDocumentContentIF],
         is_bundle_document: bool = False,
     ) -> None:
-        assert isinstance(free_texts, list)
-
         self.title: str = title
         self.reserved_title: str = title
         self.config: DocumentConfig = (
@@ -46,12 +48,11 @@ class SDocDocument:
             view if view is not None else DocumentView.create_default(self)
         )
         self.grammar: Optional[DocumentGrammar] = grammar
-        self.section_contents: List = section_contents
+        self.section_contents: List[SDocDocumentContentIF] = section_contents
 
         self.is_bundle_document: bool = is_bundle_document
 
-        # FIXME: Plain list of all fragments found in the document.
-        self.fragments_from_files: List = []
+        self.fragments_from_files: List[SDocDocumentFromFileIF] = []
 
         self.ng_level: int = 0
         self.ng_has_requirements = False
@@ -60,7 +61,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[SDocDocumentIF] = []
         self.context: SDocDocumentContext = SDocDocumentContext()
 
         self.ng_including_document_reference: Optional = None  # type: ignore[valid-type]
@@ -131,33 +132,27 @@ class SDocDocument:
 
     def has_any_toc_nodes(self) -> bool:
         for node_ in self.section_contents:
-            if node_.__class__.__name__ == "DocumentFromFile":
-                return True
-            if node_.is_section:
-                if node_.ng_resolved_custom_level != "None":
-                    return True
-                # Skip nodes without a TOC level.
+            # Skip nodes without a TOC level.
+            if (
+                isinstance(node_, SDocSectionIF)
+                and node_.ng_resolved_custom_level == "None"
+            ):
                 continue
             return True
         return False
 
     def has_any_requirements(self) -> bool:
-        from strictdoc.backend.sdoc.models.document_from_file import (
-            DocumentFromFile,
-        )
-
-        task_list = list(self.section_contents)
+        task_list: List[SDocDocumentContentIF] = list(self.section_contents)
         while len(task_list) > 0:
             section_or_requirement = task_list.pop(0)
-            if isinstance(section_or_requirement, DocumentFromFile):
+            if isinstance(section_or_requirement, SDocDocumentFromFileIF):
                 if section_or_requirement.has_any_requirements():
                     return True
                 continue
-            if section_or_requirement.is_requirement:
+            if isinstance(section_or_requirement, SDocNodeIF):
                 if section_or_requirement.node_type == "TEXT":
                     continue
                 return True
-            assert section_or_requirement.is_section, section_or_requirement
             task_list.extend(section_or_requirement.section_contents)
         return False
 
@@ -176,12 +171,16 @@ class SDocDocument:
         return self.config.get_requirement_prefix()
 
     def enumerate_meta_field_titles(self) -> Generator[str, None, None]:
+        assert self.grammar is not None
+        assert self.grammar.elements is not None
         # FIXME: currently only enumerating a single element ([0])
         yield from self.grammar.elements[0].enumerate_meta_field_titles()
 
     def enumerate_custom_content_field_titles(
         self,
     ) -> Generator[str, None, None]:
+        assert self.grammar is not None
+        assert self.grammar.elements is not None
         # FIXME: currently only enumerating a single element ([0])
         yield from self.grammar.elements[
             0

strictdoc-0.7.0/strictdoc/backend/sdoc/models/document_from_file.py

@@ -0,0 +1,85 @@
+"""
+@relation(SDOC-SRS-109, scope=file)
+"""
+
+from typing import List, Optional, Union
+
+from strictdoc.backend.sdoc.document_reference import DocumentReference
+from strictdoc.backend.sdoc.models.document import SDocDocument
+from strictdoc.backend.sdoc.models.model import (
+    SDocDocumentFromFileIF,
+    SDocDocumentIF,
+    SDocElementIF,
+    SDocNodeIF,
+    SDocSectionIF,
+)
+from strictdoc.helpers.auto_described import auto_described
+
+
+@auto_described
+class DocumentFromFile(SDocDocumentFromFileIF):
+    def __init__(
+        self,
+        parent: Union[SDocDocumentIF, SDocSectionIF],
+        file: str,
+    ) -> None:
+        self.parent: Union[SDocDocumentIF, SDocSectionIF] = parent
+        self.file: str = file
+
+        self.ng_has_requirements: bool = False
+        self.ng_document_reference: Optional[DocumentReference] = None
+        self.ng_included_document_reference: Optional[DocumentReference] = None
+        self.ng_resolved_custom_level: Optional[str] = None
+        self.ng_whitelisted: bool = True
+        self.resolved_full_path_to_document_file: Optional[str] = None
+        self.resolved_document: Optional[SDocDocumentIF] = None
+
+    def has_any_requirements(self) -> bool:
+        task_list: List[SDocElementIF] = list(self.section_contents)
+        while len(task_list) > 0:
+            element = task_list.pop(0)
+            if isinstance(element, SDocNodeIF):
+                if element.is_normative_node():
+                    return True
+                continue
+
+            if isinstance(element, SDocDocumentFromFileIF):
+                if element.has_any_requirements():
+                    return True
+
+            task_list.extend(element.section_contents)
+        return False
+
+    @property
+    def section_contents(self) -> List[SDocDocumentIF]:
+        assert self.resolved_document is not None
+        return [self.resolved_document]
+
+    def configure_with_resolved_document(
+        self, resolved_document: SDocDocument
+    ) -> None:
+        assert self.ng_included_document_reference is None
+        assert self.ng_document_reference is not None
+
+        assert resolved_document is not None
+        self.resolved_document = resolved_document
+
+        including_document_or_section = self.parent
+
+        if isinstance(including_document_or_section, SDocDocumentIF):
+            including_document = including_document_or_section
+        elif isinstance(including_document_or_section, SDocSectionIF):
+            including_document_: Optional[SDocDocumentIF] = (
+                including_document_or_section.get_document()
+            )
+            assert isinstance(including_document_, SDocDocumentIF)
+            including_document = including_document_
+        else:
+            raise AssertionError(including_document_or_section)
+
+        resolved_document.ng_including_document_from_file = self
+        resolved_document.ng_including_document_reference.set_document(
+            including_document
+        )
+
+        including_document.included_documents.append(resolved_document)

{strictdoc-0.6.1a1 → strictdoc-0.7.0}/strictdoc/backend/sdoc/models/document_grammar.py

@@ -1,6 +1,6 @@
 # mypy: disable-error-code="no-untyped-call,no-untyped-def,union-attr,type-arg"
 from collections import OrderedDict
-from typing import Dict, List, Optional, Set, Tuple, Union
+from typing import Dict, Generator, List, Optional, Set, Tuple, Union
 
 from strictdoc.backend.sdoc.models.type_system import (
     RESERVED_NON_META_FIELDS,
@@ -152,7 +152,7 @@ class GrammarElement:
                 return True
         return False
 
-    def enumerate_meta_field_titles(self):
+    def enumerate_meta_field_titles(self) -> Generator[str, None, None]:
         for field in self.fields:
             if field.title in (
                 RequirementFieldName.TITLE,
@@ -163,7 +163,9 @@ class GrammarElement:
                 continue
             yield field.title
 
-    def enumerate_custom_content_field_titles(self):
+    def enumerate_custom_content_field_titles(
+        self,
+    ) -> Generator[str, None, None]:
         after_title_or_statement = False
         for field in self.fields:
             if field.title in (

strictdoc-0.7.0/strictdoc/backend/sdoc/models/model.py

@@ -0,0 +1,124 @@
+from abc import ABC, abstractmethod
+from typing import Generator, List, Optional, Union
+
+from strictdoc.backend.sdoc.models.document_config import DocumentConfig
+from strictdoc.backend.sdoc.models.document_grammar import DocumentGrammar
+from strictdoc.core.document_meta import DocumentMeta
+
+
+class SDocNodeFieldIF(ABC):
+    parent: "SDocNodeIF"
+
+
+class SDocNodeIF(ABC):
+    node_type: str
+    ng_resolved_custom_level: Optional[str]
+
+    @abstractmethod
+    def is_normative_node(self) -> bool:
+        raise NotImplementedError
+
+    @abstractmethod
+    def is_text_node(self) -> bool:
+        raise NotImplementedError
+
+    @abstractmethod
+    def get_debug_info(self) -> str:
+        raise NotImplementedError
+
+    @abstractmethod
+    def get_document(self) -> Optional["SDocDocumentIF"]:
+        raise NotImplementedError
+
+    @abstractmethod
+    def get_including_document(self) -> Optional["SDocDocumentIF"]:
+        raise NotImplementedError
+
+    @abstractmethod
+    def get_parent_or_including_document(self) -> "SDocDocumentIF":
+        raise NotImplementedError
+
+
+class SDocCompositeNodeIF(SDocNodeIF):
+    section_contents: List["SDocSectionContentIF"]
+
+    @abstractmethod
+    def get_requirement_prefix(self) -> str:
+        raise NotImplementedError
+
+
+class SDocSectionIF(ABC):
+    ng_resolved_custom_level: Optional[str]
+    section_contents: List["SDocSectionContentIF"]
+
+    @abstractmethod
+    def get_document(self) -> Optional["SDocDocumentIF"]:
+        raise NotImplementedError
+
+    @abstractmethod
+    def get_requirement_prefix(self) -> str:
+        raise NotImplementedError
+
+    @abstractmethod
+    def get_debug_info(self) -> str:
+        raise NotImplementedError
+
+
+class SDocDocumentIF(ABC):
+    config: DocumentConfig
+    grammar: Optional[DocumentGrammar]
+    meta: Optional[DocumentMeta]
+    section_contents: List["SDocSectionContentIF"]
+    included_documents: List["SDocDocumentIF"]
+    is_bundle_document: bool
+
+    @abstractmethod
+    def get_requirement_prefix(self) -> str:
+        raise NotImplementedError
+
+    @abstractmethod
+    def get_debug_info(self) -> str:
+        raise NotImplementedError
+
+    @abstractmethod
+    def iterate_included_documents_depth_first(
+        self,
+    ) -> Generator["SDocDocumentIF", None, None]:
+        raise NotImplementedError
+
+
+class SDocDocumentFromFileIF:
+    ng_resolved_custom_level: Optional[str]
+
+    @abstractmethod
+    def has_any_requirements(self) -> bool:
+        raise NotImplementedError
+
+    @property
+    def section_contents(self) -> List[SDocDocumentIF]:
+        raise NotImplementedError
+
+
+SDocSectionContentIF = Union[
+    SDocCompositeNodeIF,
+    SDocNodeIF,
+    SDocSectionIF,
+    SDocDocumentFromFileIF,
+]
+
+
+SDocDocumentContentIF = Union[
+    SDocCompositeNodeIF,
+    SDocDocumentFromFileIF,
+    SDocNodeIF,
+    SDocSectionIF,
+]
+
+
+SDocElementIF = Union[
+    SDocNodeIF,
+    SDocCompositeNodeIF,
+    SDocSectionIF,
+    SDocDocumentIF,
+    SDocDocumentFromFileIF,
+]