strictdoc 0.0.57a2__tar.gz → 0.0.58__tar.gz

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

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: strictdoc
-Version: 0.0.57a2
+Version: 0.0.58
 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/
@@ -23,7 +23,6 @@ Requires-Python: >=3.7
 Requires-Dist: beautifulsoup4==4.*,>=4.12.0
 Requires-Dist: docutils==0.*,>=0.16
 Requires-Dist: fastapi>=0.83.0
-Requires-Dist: graphviz>=0.20.1
 Requires-Dist: html5lib>=1.1
 Requires-Dist: jinja2>=2.11.2
 Requires-Dist: lxml==4.*,>=4.6.2

{strictdoc-0.0.57a2 → strictdoc-0.0.58}/pyproject.toml

@@ -50,7 +50,6 @@ classifiers = [
 dependencies = [
     "textx >= 3.0.0, == 3.*",
     "jinja2 >= 2.11.2",
-    "graphviz >= 0.20.1",
     # Reading project config from strictdoc.toml file.
     "toml",
 

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

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

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

@@ -347,18 +347,6 @@ 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(
-                spec_object.attribute_map[ReqIFChapterField.TEXT].value
-            )
-            free_texts.append(
-                FreeText(
-                    parent=None,
-                    parts=[free_text],
-                )
-            )
         # Sanitize the title. Titles can also come from XHTML attributes with
         # custom newlines such as:
         #             <ATTRIBUTE-VALUE-XHTML>
@@ -376,10 +364,31 @@ class P01_ReqIFToSDocConverter:
             custom_level=None,
             title=section_title,
             requirement_prefix=None,
-            free_texts=free_texts,
+            free_texts=[],
             section_contents=[],
         )
         section.ng_level = level
+
+        if ReqIFChapterField.TEXT in spec_object.attribute_map:
+            free_text = unescape(
+                spec_object.attribute_map[ReqIFChapterField.TEXT].value
+            )
+            node_field = SDocNodeField.create_from_string(
+                None,
+                field_name="STATEMENT",
+                field_value=free_text,
+                multiline=True,
+            )
+            node: SDocNode = SDocNode(
+                parent=section,
+                requirement_type="TEXT",
+                mid=None,
+                fields=[node_field],
+                relations=[],
+            )
+            node_field.parent = node
+            section.section_contents.append(node)
+
         return section
 
     @staticmethod

{strictdoc-0.0.57a2 → strictdoc-0.0.58}/strictdoc/backend/sdoc/models/document_config.py

@@ -40,7 +40,7 @@ class DocumentConfig:  # pylint: disable=too-many-instance-attributes
         requirement_style: Optional[str],
         requirement_in_toc: Optional[str],
         default_view: Optional[str],
-    ):
+    ) -> None:
         self.parent = parent
         self.version: Optional[str] = version
 
@@ -61,7 +61,7 @@ class DocumentConfig:  # pylint: disable=too-many-instance-attributes
             else (False if root == "False" else None)
         )
 
-        self.markup = markup
+        self.markup: Optional[str] = markup
         self.auto_levels: bool = auto_levels is None or auto_levels == "On"
 
         if layout is not None:
@@ -81,6 +81,11 @@ class DocumentConfig:  # pylint: disable=too-many-instance-attributes
         self.ng_line_start: int = 0
         self.ng_col_start: int = 0
 
+    def get_markup(self) -> str:
+        if self.markup is None:
+            return "RST"
+        return self.markup
+
     def get_requirement_style_mode(self) -> str:
         if (
             self.requirement_style is None

{strictdoc-0.0.57a2 → strictdoc-0.0.58}/strictdoc/backend/sdoc/validations/sdoc_validator.py

@@ -136,6 +136,7 @@ class SDocValidator:
         requirement: SDocNode,
         document_grammar: DocumentGrammar,
         path_to_sdoc_file: str,
+        auto_uid_mode: bool = True,
     ):
         if (
             requirement.requirement_type
@@ -185,6 +186,7 @@ class SDocValidator:
                         requirement_field=requirement_field,
                         grammar_field=grammar_field,
                         path_to_sdoc_file=path_to_sdoc_file,
+                        auto_uid_mode=auto_uid_mode,
                     )
                 )
             except StopIteration:
@@ -205,7 +207,9 @@ class SDocValidator:
                 grammar_field = next(grammar_fields_iterator, None)
                 requirement_field = next(requirement_field_iterator, None)
             else:
-                assert not grammar_field.required
+                assert not grammar_field.required or (
+                    grammar_field.title == "UID" and auto_uid_mode
+                )
                 grammar_field = next(grammar_fields_iterator, None)
 
         # REFS validation.
@@ -227,6 +231,7 @@ class SDocValidator:
         requirement_field: SDocNodeField,
         grammar_field: GrammarElementField,
         path_to_sdoc_file: str,
+        auto_uid_mode: bool = True,
     ) -> bool:
         if grammar_field is None:
             if requirement_field is None:
@@ -256,6 +261,25 @@ class SDocValidator:
 
         if grammar_field.title != requirement_field.field_name:
             if grammar_field.required:
+                if (
+                    grammar_field.title
+                    not in requirement.ordered_fields_lookup.keys()
+                ):
+                    # A special case: The Manage UID command auto-generates the UID,
+                    # so the field presence validation has to be relaxed.
+                    # The GitHub issue report:
+                    # manage auto-uid: UID field REQUIRED True leads to an error
+                    # https://github.com/strictdoc-project/strictdoc/issues/1896
+                    if grammar_field.title == "UID" and auto_uid_mode:
+                        return False
+
+                    raise StrictDocSemanticError.missing_required_field(
+                        node=requirement,
+                        grammar_field=grammar_field,
+                        document_grammar=document_grammar,
+                        path_to_sdoc_file=path_to_sdoc_file,
+                    )
+
                 raise StrictDocSemanticError.wrong_field_order(
                     node=requirement,
                     document_grammar=document_grammar,

{strictdoc-0.0.57a2 → strictdoc-0.0.58}/strictdoc/backend/sdoc/writer.py

@@ -74,7 +74,7 @@ class SDWriter:
         return document_output
 
     def write_with_fragments(
-        self, document: SDocDocument
+        self, document: SDocDocument, convert_free_text_to_text: bool = False
     ) -> Tuple[str, Dict[str, str]]:
         fragments_dict: Dict[str, str] = {}
 
@@ -234,8 +234,12 @@ class SDWriter:
 
         output += "\n"
 
-        output += self._print_node(document, document, document_iterator)
-
+        output += self._print_node(
+            document,
+            document,
+            document_iterator,
+            convert_free_text_to_text=convert_free_text_to_text,
+        )
         output = output.rstrip()
         output += "\n"
 
@@ -246,6 +250,7 @@ class SDWriter:
         root_node: Union[SDocDocument, SDocSection, SDocNode, DocumentFromFile],
         document: SDocDocument,
         document_iterator: DocumentCachingIterator,
+        convert_free_text_to_text: bool = False,
     ):
         assert isinstance(
             document_iterator, DocumentCachingIterator
@@ -258,7 +263,10 @@ class SDWriter:
                 if not node_.ng_whitelisted:
                     continue
                 output += self._print_node(
-                    node_, document, document_iterator=document_iterator
+                    node_,
+                    document,
+                    document_iterator=document_iterator,
+                    convert_free_text_to_text=convert_free_text_to_text,
                 )
             return output
 
@@ -269,14 +277,20 @@ class SDWriter:
             return self._print_document_from_file(document_from_file)
 
         if isinstance(root_node, SDocSection):
-            return self._print_section(root_node, document, document_iterator)
+            return self._print_section(
+                root_node,
+                document,
+                document_iterator,
+                convert_free_text_to_text,
+            )
 
         elif isinstance(root_node, SDocNode):
             output = ""
 
             # Special case for backward compatibility.
             if (
-                root_node.requirement_type == "TEXT"
+                not convert_free_text_to_text
+                and root_node.requirement_type == "TEXT"
                 and root_node.basic_free_text
             ):
                 output += self._print_free_text(root_node)
@@ -330,6 +344,7 @@ class SDWriter:
         section: SDocSection,
         document: SDocDocument,
         iterator: DocumentCachingIterator,
+        convert_free_text_to_text: bool = False,
     ):
         assert isinstance(section, SDocSection)
         output = ""
@@ -359,14 +374,14 @@ class SDWriter:
             output += section.requirement_prefix
             output += "\n"
 
-        for free_text in section.free_texts:
-            output += "\n"
-            output += self._print_free_text(free_text)
         output += "\n"
 
         for node_ in section.section_contents:
             output += self._print_node(
-                node_, document, document_iterator=iterator
+                node_,
+                document,
+                document_iterator=iterator,
+                convert_free_text_to_text=convert_free_text_to_text,
             )
 
         output += "[/SECTION]"

{strictdoc-0.0.57a2 → strictdoc-0.0.58}/strictdoc/cli/cli_arg_parser.py

@@ -73,11 +73,13 @@ class PassthroughCommandConfig:
         output_dir: Optional[str],
         filter_requirements: Optional[str],
         filter_sections: Optional[str],
+        free_text_to_text: bool,
     ):
         self.input_file = input_file
         self.output_dir: Optional[str] = output_dir
         self.filter_requirements: Optional[str] = filter_requirements
         self.filter_sections: Optional[str] = filter_sections
+        self.free_text_to_text: bool = free_text_to_text
 
 
 @auto_described
@@ -263,6 +265,7 @@ class SDocArgsParser:
             self.args.output_dir,
             filter_requirements=self.args.filter_requirements,
             filter_sections=self.args.filter_sections,
+            free_text_to_text=self.args.free_text_to_text,
         )
 
     def get_export_config(self) -> ExportCommandConfig:

{strictdoc-0.0.57a2 → strictdoc-0.0.58}/strictdoc/cli/command_parser_builder.py

@@ -16,7 +16,6 @@ EXPORT_FORMATS = [
     "reqif-sdoc",
     "reqifz-sdoc",
     "spdx",
-    "dot",
 ]
 EXCEL_PARSERS = ["basic"]
 
@@ -386,6 +385,14 @@ class CommandParserBuilder:
             type=str,
             help="Filter which sections will be exported.",
         )
+        command_parser_passthrough.add_argument(
+            "--free-text-to-text",
+            action="store_true",
+            help=(
+                "This option makes all FREETEXT nodes to be converted to the new "
+                "TEXT nodes."
+            ),
+        )
 
     @staticmethod
     def add_dump_command(parent_command_parser):

{strictdoc-0.0.57a2 → strictdoc-0.0.58}/strictdoc/commands/manage_autouid_command.py

@@ -28,6 +28,7 @@ class ManageAutoUIDCommand:
                 TraceabilityIndexBuilder.create(
                     project_config=project_config,
                     parallelizer=parallelizer,
+                    auto_uid_mode=True,
                 )
             )
         except DocumentTreeError as exc:

{strictdoc-0.0.57a2 → strictdoc-0.0.58}/strictdoc/core/actions/export_action.py

@@ -10,7 +10,6 @@ from strictdoc.backend.sdoc.errors.document_tree_error import DocumentTreeError
 from strictdoc.core.project_config import ProjectConfig
 from strictdoc.core.traceability_index import TraceabilityIndex
 from strictdoc.core.traceability_index_builder import TraceabilityIndexBuilder
-from strictdoc.export.dot.document_dot_generator import DocumentDotGenerator
 from strictdoc.export.html.html_generator import HTMLGenerator
 from strictdoc.export.html.html_templates import HTMLTemplates
 from strictdoc.export.html2pdf.html2pdf_generator import HTML2PDFGenerator
@@ -131,18 +130,6 @@ class ExportAction:
                 self.project_config, self.traceability_index, output_dot_root
             )
 
-        if "dot" in self.project_config.export_formats:
-            output_dot_root = os.path.join(
-                self.project_config.export_output_dir, "dot"
-            )
-            Path(output_dot_root).mkdir(parents=True, exist_ok=True)
-            DocumentDotGenerator("profile1").export_tree(
-                self.traceability_index, output_dot_root
-            )
-            DocumentDotGenerator("profile2").export_tree(
-                self.traceability_index, output_dot_root
-            )
-
         if "json" in self.project_config.export_formats:
             output_json_root = os.path.join(
                 self.project_config.export_output_dir, "json"

{strictdoc-0.0.57a2 → strictdoc-0.0.58}/strictdoc/core/actions/passthrough_action.py

@@ -37,7 +37,10 @@ class PassthroughAction:
             else os.path.join(os.getcwd(), "output", "sdoc")
         )
         for document in traceability_index.document_tree.document_list:
-            output, fragments_dict = writer.write_with_fragments(document)
+            output, fragments_dict = writer.write_with_fragments(
+                document,
+                convert_free_text_to_text=project_config.passthrough_free_text_to_text,
+            )
 
             path_to_output_file_dir: str = os.path.join(
                 output_dir, document.meta.input_doc_dir_rel_path.relative_path

{strictdoc-0.0.57a2 → strictdoc-0.0.58}/strictdoc/core/environment.py

@@ -78,22 +78,6 @@ class SDocRuntimeEnvironment:
             self.path_to_strictdoc, "strictdoc", "export", "rst", "templates"
         )
 
-    def get_path_to_dot_templates(self):
-        if self.is_py_installer:
-            # If the application is run as a bundle, the PyInstaller bootloader
-            # extends the sys module by a flag frozen=True and sets the app
-            # path into variable _MEIPASS'.
-            bundle_dir = (
-                sys._MEIPASS  # pylint: disable=protected-access, no-member
-            )
-            return os.path.join(bundle_dir, "templates/dot")
-        if self.is_nuitka:
-            return os.path.join(self.path_to_strictdoc, "templates/dot")
-        # Normal Python
-        return os.path.join(
-            self.path_to_strictdoc, "strictdoc", "export", "dot", "templates"
-        )
-
     def get_path_to_html_templates(self):
         if self.is_py_installer:
             # If the application is run as a bundle, the PyInstaller bootloader

{strictdoc-0.0.57a2 → strictdoc-0.0.58}/strictdoc/core/project_config.py

@@ -127,6 +127,7 @@ class ProjectConfig:  # pylint: disable=too-many-instance-attributes
 
         self.passthrough_input_path: Optional[str] = None
         self.passthrough_output_dir: Optional[str] = None
+        self.passthrough_free_text_to_text: bool = False
 
         self.excel_export_fields: Optional[List[str]] = None
 
@@ -218,6 +219,7 @@ class ProjectConfig:  # pylint: disable=too-many-instance-attributes
     def integrate_passthrough_config(self, config: PassthroughCommandConfig):
         self.passthrough_input_path = config.input_file
         self.passthrough_output_dir = config.output_dir
+        self.passthrough_free_text_to_text = config.free_text_to_text
         self.filter_requirements = config.filter_requirements
         self.filter_sections = config.filter_sections
 

{strictdoc-0.0.57a2 → strictdoc-0.0.58}/strictdoc/core/traceability_index_builder.py

@@ -62,7 +62,8 @@ class TraceabilityIndexBuilder:
         *,
         project_config: ProjectConfig,
         parallelizer,
-        skip_source_files=False,
+        skip_source_files: bool = False,
+        auto_uid_mode: bool = False,
     ) -> TraceabilityIndex:
         # TODO: It would be great to hide this code behind --development flag.
         # There is no need for this to be activated in the Pip-released builds.
@@ -102,7 +103,9 @@ class TraceabilityIndexBuilder:
         # - assets
         # - runtime configuration
         traceability_index: TraceabilityIndex = (
-            TraceabilityIndexBuilder.create_from_document_tree(document_tree)
+            TraceabilityIndexBuilder.create_from_document_tree(
+                document_tree, auto_uid_mode
+            )
         )
         traceability_index.document_tree = document_tree
         traceability_index.asset_manager = asset_manager
@@ -193,6 +196,7 @@ class TraceabilityIndexBuilder:
     @timing_decorator("Build traceability graph")
     def create_from_document_tree(
         document_tree: DocumentTree,
+        auto_uid_mode: bool = True,
     ) -> TraceabilityIndex:
         # FIXME: Too many things going on below. Would be great to simplify this
         # workflow.
@@ -360,6 +364,7 @@ class TraceabilityIndexBuilder:
                             node,
                             document_grammar=document.grammar,
                             path_to_sdoc_file=document.meta.input_doc_full_path,
+                            auto_uid_mode=auto_uid_mode,
                         )
                     except StrictDocSemanticError as exc:
                         print(exc.to_print_message())  # noqa: T201

{strictdoc-0.0.57a2 → strictdoc-0.0.58}/strictdoc/export/html/_static/node.css

@@ -7,6 +7,10 @@ sdoc-node {
   position: relative;
 }
 
+sdoc-node[show-node-type-name] sdoc-requirement {
+  margin-top: calc(2 * var(--base-rhythm));
+}
+
 sdoc-node[show-node-type-name]::before {
   /* content: '[' attr(show-node-type-name) ']'; */
   content: attr(show-node-type-name);

{strictdoc-0.0.57a2 → strictdoc-0.0.58}/strictdoc/export/html/form_objects/grammar_element_form_object.py

@@ -256,7 +256,7 @@ class GrammarElementFormObject(ErrorObject):
             else:
                 fields_so_far.add(field.field_name)
 
-        if len(self.relations) == 0:
+        if len(self.relations) == 0 and self.element_name != "TEXT":
             self.add_error(
                 "Relations_Row",
                 (

{strictdoc-0.0.57a2 → strictdoc-0.0.58}/strictdoc/export/html/form_objects/requirement_form_object.py

@@ -2,7 +2,7 @@
 import html
 from collections import defaultdict
 from enum import Enum
-from typing import Dict, List, Optional, Set
+from typing import Dict, List, Optional, Set, Union
 
 from starlette.datastructures import FormData
 
@@ -24,6 +24,7 @@ from strictdoc.backend.sdoc.models.type_system import (
     FileEntry,
     FileEntryFormat,
     GrammarElementField,
+    GrammarElementFieldMultipleChoice,
     GrammarElementFieldSingleChoice,
     RequirementFieldType,
 )
@@ -100,6 +101,7 @@ class RequirementFormField:
         if grammar_field.gef_type in (
             RequirementFieldType.STRING,
             RequirementFieldType.SINGLE_CHOICE,
+            RequirementFieldType.MULTIPLE_CHOICE,
         ):
             return RequirementFormField(
                 field_mid=MID.create(),
@@ -123,6 +125,7 @@ class RequirementFormField:
         if grammar_field.gef_type in (
             RequirementFieldType.STRING,
             RequirementFieldType.SINGLE_CHOICE,
+            RequirementFieldType.MULTIPLE_CHOICE,
         ):
             field_value = requirement_field.get_text_value()
             escaped_field_value = html.escape(field_value)
@@ -372,9 +375,14 @@ class RequirementFormObject(ErrorObject):
         *,
         document: SDocDocument,
         context_document_mid: str,
-        next_uid: str,
+        next_uid: Optional[str],
         element_type: str,
     ) -> "RequirementFormObject":
+        """
+        For now, the next_uid cannot be non-None for TEXT nodes. This will likely
+        change in the future.
+        """
+
         assert document.grammar is not None
 
         new_requirement_mid: MID = MID.create()
@@ -406,7 +414,7 @@ class RequirementFormObject(ErrorObject):
                 )
             )
             form_fields.append(form_field)
-            if form_field.field_name == "UID":
+            if form_field.field_name == "UID" and next_uid is not None:
                 form_field.field_unescaped_value = next_uid
                 form_field.field_escaped_value = next_uid
 
@@ -733,7 +741,10 @@ class RequirementFormObject(ErrorObject):
             # STATEMENT/DESCRIPTION/CONTENT field has already been validated. Skip.
             if grammar_element_field_.title == statement_field_name:
                 continue
-            if grammar_element_field_.required:
+            if (
+                grammar_element_field_.gef_type == RequirementFieldType.STRING
+                and grammar_element_field_.required
+            ):
                 for form_field_ in self.fields[grammar_element_field_.title]:
                     field_value = form_field_.field_unescaped_value
                     if field_value is None or len(field_value) == 0:
@@ -745,27 +756,12 @@ class RequirementFormObject(ErrorObject):
                                 f"enter TBD (to be done) or TBC (to be confirmed)."
                             ),
                         )
-            if (
-                grammar_element_field_.gef_type
-                == RequirementFieldType.SINGLE_CHOICE
+
+            if grammar_element_field_.gef_type in (
+                RequirementFieldType.SINGLE_CHOICE,
+                RequirementFieldType.MULTIPLE_CHOICE,
             ):
-                single_choice_grammar_element_field: GrammarElementFieldSingleChoice = assert_cast(
-                    grammar_element_field_, GrammarElementFieldSingleChoice
-                )
-                field_value = self.fields[grammar_element_field_.title][
-                    0
-                ].field_unescaped_value
-                if (
-                    field_value
-                    not in single_choice_grammar_element_field.options
-                ):
-                    self.add_error(
-                        grammar_element_field_.title,
-                        (
-                            f"Node's {grammar_element_field_.title} must be a value one of "
-                            f"{', '.join(single_choice_grammar_element_field.options)}."
-                        ),
-                    )
+                self._validate_choice(grammar_element_field_)
 
         requirement_uid: Optional[str] = (
             self.fields["UID"][0].field_unescaped_value
@@ -892,3 +888,56 @@ class RequirementFormObject(ErrorObject):
                         reference_field.validation_messages.append(
                             error_.to_validation_message()
                         )
+
+    def _validate_choice(self, grammar_element_field: GrammarElementField):
+        field_0 = self.fields[grammar_element_field.title][0]
+        if (
+            len(field_0.field_unescaped_value) == 0
+            and not grammar_element_field.required
+        ):
+            # The empty choice fields are allowed if the field is not REQUIRED.
+            return
+
+        choice_grammar_element_field: Union[
+            GrammarElementFieldSingleChoice,
+            GrammarElementFieldMultipleChoice,
+        ] = assert_cast(
+            grammar_element_field,
+            (
+                GrammarElementFieldSingleChoice,
+                GrammarElementFieldMultipleChoice,
+            ),
+        )
+        if (
+            grammar_element_field.gef_type == RequirementFieldType.SINGLE_CHOICE
+            and field_0.field_unescaped_value
+            not in choice_grammar_element_field.options
+        ):
+            self.add_error(
+                grammar_element_field.title,
+                (
+                    f"Node's {grammar_element_field.title} must be a value one of "
+                    f"{', '.join(choice_grammar_element_field.options)}."
+                ),
+            )
+        elif (
+            grammar_element_field.gef_type
+            == RequirementFieldType.MULTIPLE_CHOICE
+        ):
+            choices = [
+                choice.strip()
+                for choice in field_0.field_unescaped_value.split(",")
+            ]
+            if all(
+                choice in choice_grammar_element_field.options
+                for choice in choices
+            ):
+                field_0.field_unescaped_value = ", ".join(choices)
+            else:
+                self.add_error(
+                    grammar_element_field.title,
+                    (
+                        f"Node's {grammar_element_field.title} must not contain"
+                        f" values other than {', '.join(choice_grammar_element_field.options)}."
+                    ),
+                )