strictdoc 0.0.57a2__tar.gz → 0.0.57a3__tar.gz

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

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: strictdoc
-Version: 0.0.57a2
+Version: 0.0.57a3
 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.57a3}/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.57a3}/strictdoc/__init__.py

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

{strictdoc-0.0.57a2 → strictdoc-0.0.57a3}/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.57a3}/strictdoc/cli/command_parser_builder.py

@@ -16,7 +16,6 @@ EXPORT_FORMATS = [
     "reqif-sdoc",
     "reqifz-sdoc",
     "spdx",
-    "dot",
 ]
 EXCEL_PARSERS = ["basic"]
 

{strictdoc-0.0.57a2 → strictdoc-0.0.57a3}/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.57a3}/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.57a3}/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.57a3}/strictdoc/export/html/form_objects/requirement_form_object.py

@@ -733,7 +733,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:
@@ -755,7 +758,14 @@ class RequirementFormObject(ErrorObject):
                 field_value = self.fields[grammar_element_field_.title][
                     0
                 ].field_unescaped_value
+
                 if (
+                    len(field_value) == 0
+                    and not single_choice_grammar_element_field.required
+                ):
+                    # The empty single choice fields are allowed if the field is not REQUIRED.
+                    pass
+                elif (
                     field_value
                     not in single_choice_grammar_element_field.options
                 ):

{strictdoc-0.0.57a2 → strictdoc-0.0.57a3}/strictdoc/server/routers/main_router.py

@@ -212,7 +212,7 @@ def create_main_router(
             static_path=project_config.dir_for_sdoc_assets,
         )
         markup_renderer = MarkupRenderer.create(
-            markup="RST",
+            markup=requirement.document.config.get_markup(),
             traceability_index=export_action.traceability_index,
             link_renderer=link_renderer,
             html_templates=html_generator.html_templates,
@@ -255,7 +255,7 @@ def create_main_router(
             static_path=project_config.dir_for_sdoc_assets,
         )
         markup_renderer = MarkupRenderer.create(
-            markup="RST",
+            markup=section.document.config.get_markup(),
             traceability_index=export_action.traceability_index,
             link_renderer=link_renderer,
             html_templates=html_generator.html_templates,
@@ -325,7 +325,7 @@ def create_main_router(
             static_path=project_config.dir_for_sdoc_assets,
         )
         markup_renderer = MarkupRenderer.create(
-            markup="RST",
+            markup=document.config.get_markup(),
             traceability_index=export_action.traceability_index,
             link_renderer=link_renderer,
             html_templates=html_generator.html_templates,
@@ -366,6 +366,14 @@ def create_main_router(
             section_mid=section_mid,
             request_form_data=request_form_data,
         )
+        reference_node: Union[SDocDocument, SDocSection] = (
+            export_action.traceability_index.get_node_by_mid(MID(reference_mid))
+        )
+        document = (
+            reference_node
+            if isinstance(reference_node, SDocDocument)
+            else reference_node.document
+        )
 
         context_document = export_action.traceability_index.get_node_by_mid(
             MID(context_document_mid)
@@ -392,7 +400,7 @@ def create_main_router(
                 static_path=project_config.dir_for_sdoc_assets,
             )
             markup_renderer = MarkupRenderer.create(
-                markup="RST",
+                markup=document.config.get_markup(),
                 traceability_index=export_action.traceability_index,
                 link_renderer=link_renderer,
                 html_templates=html_generator.html_templates,
@@ -432,7 +440,7 @@ def create_main_router(
             static_path=project_config.dir_for_sdoc_assets,
         )
         markup_renderer = MarkupRenderer.create(
-            markup="RST",
+            markup=document.config.get_markup(),
             traceability_index=export_action.traceability_index,
             link_renderer=link_renderer,
             html_templates=html_generator.html_templates,
@@ -487,7 +495,7 @@ def create_main_router(
             static_path=project_config.dir_for_sdoc_assets,
         )
         markup_renderer = MarkupRenderer.create(
-            markup="RST",
+            markup=section.document.config.get_markup(),
             traceability_index=export_action.traceability_index,
             link_renderer=link_renderer,
             html_templates=html_generator.html_templates,
@@ -548,7 +556,7 @@ def create_main_router(
                 static_path=project_config.dir_for_sdoc_assets,
             )
             markup_renderer = MarkupRenderer.create(
-                markup="RST",
+                markup=section.document.config.get_markup(),
                 traceability_index=export_action.traceability_index,
                 link_renderer=link_renderer,
                 html_templates=html_generator.html_templates,
@@ -598,7 +606,7 @@ def create_main_router(
             static_path=project_config.dir_for_sdoc_assets,
         )
         markup_renderer = MarkupRenderer.create(
-            markup="RST",
+            markup=section.document.config.get_markup(),
             traceability_index=export_action.traceability_index,
             link_renderer=link_renderer,
             html_templates=html_generator.html_templates,
@@ -657,7 +665,7 @@ def create_main_router(
             static_path=project_config.dir_for_sdoc_assets,
         )
         markup_renderer = MarkupRenderer.create(
-            markup="RST",
+            markup=section.document.config.get_markup(),
             traceability_index=export_action.traceability_index,
             link_renderer=link_renderer,
             html_templates=html_generator.html_templates,
@@ -752,7 +760,7 @@ def create_main_router(
             static_path=project_config.dir_for_sdoc_assets,
         )
         markup_renderer = MarkupRenderer.create(
-            markup="RST",
+            markup=document.config.get_markup(),
             traceability_index=export_action.traceability_index,
             link_renderer=link_renderer,
             html_templates=html_generator.html_templates,
@@ -823,7 +831,7 @@ def create_main_router(
             static_path=project_config.dir_for_sdoc_assets,
         )
         markup_renderer = MarkupRenderer.create(
-            markup="RST",
+            markup=document.config.get_markup(),
             traceability_index=export_action.traceability_index,
             link_renderer=link_renderer,
             html_templates=html_generator.html_templates,
@@ -912,7 +920,7 @@ def create_main_router(
                 static_path=project_config.dir_for_sdoc_assets,
             )
             markup_renderer = MarkupRenderer.create(
-                markup="RST",
+                markup=document.config.get_markup(),
                 traceability_index=export_action.traceability_index,
                 link_renderer=link_renderer,
                 html_templates=html_generator.html_templates,
@@ -958,7 +966,7 @@ def create_main_router(
             static_path=project_config.dir_for_sdoc_assets,
         )
         markup_renderer = MarkupRenderer.create(
-            markup="RST",
+            markup=document.config.get_markup(),
             traceability_index=export_action.traceability_index,
             link_renderer=link_renderer,
             html_templates=html_generator.html_templates,
@@ -1009,7 +1017,7 @@ def create_main_router(
             static_path=project_config.dir_for_sdoc_assets,
         )
         markup_renderer = MarkupRenderer.create(
-            markup="RST",
+            markup=document.config.get_markup(),
             traceability_index=export_action.traceability_index,
             link_renderer=link_renderer,
             html_templates=html_generator.html_templates,
@@ -1146,7 +1154,7 @@ def create_main_router(
                 static_path=project_config.dir_for_sdoc_assets,
             )
             markup_renderer = MarkupRenderer.create(
-                markup="RST",
+                markup=document.config.get_markup(),
                 traceability_index=export_action.traceability_index,
                 link_renderer=link_renderer,
                 html_templates=html_generator.html_templates,
@@ -1193,7 +1201,7 @@ def create_main_router(
             static_path=project_config.dir_for_sdoc_assets,
         )
         markup_renderer: MarkupRenderer = MarkupRenderer.create(
-            markup="RST",
+            markup=document.config.get_markup(),
             traceability_index=export_action.traceability_index,
             link_renderer=link_renderer,
             html_templates=html_generator.html_templates,
@@ -1258,7 +1266,7 @@ def create_main_router(
             static_path=project_config.dir_for_sdoc_assets,
         )
         markup_renderer = MarkupRenderer.create(
-            markup="RST",
+            markup=document.config.get_markup(),
             traceability_index=export_action.traceability_index,
             link_renderer=link_renderer,
             html_templates=html_generator.html_templates,
@@ -1369,7 +1377,7 @@ def create_main_router(
             static_path=project_config.dir_for_sdoc_assets,
         )
         markup_renderer = MarkupRenderer.create(
-            markup="RST",
+            markup=section.document.config.get_markup(),
             traceability_index=export_action.traceability_index,
             link_renderer=link_renderer,
             html_templates=html_generator.html_templates,
@@ -1472,7 +1480,7 @@ def create_main_router(
             static_path=project_config.dir_for_sdoc_assets,
         )
         markup_renderer = MarkupRenderer.create(
-            markup="RST",
+            markup=requirement.document.config.get_markup(),
             traceability_index=export_action.traceability_index,
             link_renderer=link_renderer,
             html_templates=html_generator.html_templates,
@@ -1572,7 +1580,7 @@ def create_main_router(
             static_path=project_config.dir_for_sdoc_assets,
         )
         markup_renderer = MarkupRenderer.create(
-            markup="RST",
+            markup=moved_node.document.config.get_markup(),
             traceability_index=export_action.traceability_index,
             link_renderer=link_renderer,
             html_templates=html_generator.html_templates,
@@ -1977,7 +1985,7 @@ def create_main_router(
             static_path=project_config.dir_for_sdoc_assets,
         )
         markup_renderer = MarkupRenderer.create(
-            markup="RST",
+            markup=document.config.get_markup(),
             traceability_index=export_action.traceability_index,
             link_renderer=link_renderer,
             html_templates=html_generator.html_templates,
@@ -2061,7 +2069,7 @@ def create_main_router(
             static_path=project_config.dir_for_sdoc_assets,
         )
         markup_renderer = MarkupRenderer.create(
-            markup="RST",
+            markup=document.config.get_markup(),
             traceability_index=export_action.traceability_index,
             link_renderer=link_renderer,
             html_templates=html_generator.html_templates,
@@ -2097,7 +2105,7 @@ def create_main_router(
             static_path=project_config.dir_for_sdoc_assets,
         )
         markup_renderer = MarkupRenderer.create(
-            markup="RST",
+            markup=document.config.get_markup(),
             traceability_index=export_action.traceability_index,
             link_renderer=link_renderer,
             html_templates=html_generator.html_templates,
@@ -2141,7 +2149,7 @@ def create_main_router(
             static_path=project_config.dir_for_sdoc_assets,
         )
         markup_renderer = MarkupRenderer.create(
-            markup="RST",
+            markup=document.config.get_markup(),
             traceability_index=export_action.traceability_index,
             link_renderer=link_renderer,
             html_templates=html_generator.html_templates,
@@ -2249,7 +2257,7 @@ def create_main_router(
             static_path=project_config.dir_for_sdoc_assets,
         )
         markup_renderer = MarkupRenderer.create(
-            markup="RST",
+            markup=document.config.get_markup(),
             traceability_index=export_action.traceability_index,
             link_renderer=link_renderer,
             html_templates=html_generator.html_templates,
@@ -2390,7 +2398,7 @@ def create_main_router(
             static_path=project_config.dir_for_sdoc_assets,
         )
         markup_renderer = MarkupRenderer.create(
-            markup="RST",
+            markup=document.config.get_markup(),
             traceability_index=export_action.traceability_index,
             link_renderer=link_renderer,
             html_templates=html_generator.html_templates,

{strictdoc-0.0.57a2 → strictdoc-0.0.57a3}/tasks.py

@@ -11,8 +11,8 @@ from typing import Optional
 if not hasattr(inspect, "getargspec"):
     inspect.getargspec = inspect.getfullargspec
 
-import invoke  # pylint: disable=wrong-import-position
-from invoke import task  # pylint: disable=wrong-import-position
+import invoke
+from invoke import task
 
 # Specifying encoding because Windows crashes otherwise when running Invoke
 # tasks below:
@@ -22,9 +22,7 @@ from invoke import task  # pylint: disable=wrong-import-position
 # seems to work.
 # FIXME: If you are a Windows user and expert, please advise on how to do this
 # properly.
-sys.stdout = open(  # pylint: disable=consider-using-with
-    1, "w", encoding="utf-8", closefd=False, buffering=1
-)
+sys.stdout = open(1, "w", encoding="utf-8", closefd=False, buffering=1)
 
 
 # To prevent all tasks from building to the same virtual environment.
@@ -95,7 +93,7 @@ def clean_itest_artifacts(context):
     run_invoke(context, find_command, warn=True)
 
 
-@task
+@task(aliases=["s"])
 def server(context, input_path=".", config=None):
     assert os.path.isdir(input_path), input_path
     if config is not None:
@@ -111,7 +109,7 @@ def server(context, input_path=".", config=None):
     )
 
 
-@task
+@task(aliases=["d"])
 def docs(context):
     run_invoke_with_tox(
         context,
@@ -180,7 +178,7 @@ def docs(context):
     )
 
 
-@task
+@task(aliases=["tu"])
 def test_unit(context, focus=None):
     focus_argument = f"-k {focus}" if focus is not None else ""
     run_invoke_with_tox(
@@ -204,7 +202,7 @@ def test_unit_server(context, focus=None):
     )
 
 
-@task()
+@task(aliases=["te"])
 def test_end2end(
     context,
     focus=None,
@@ -303,7 +301,7 @@ def test_coverage_report(context):
     )
 
 
-@task
+@task(aliases=["ti"])
 def test_integration(
     context,
     focus=None,
@@ -416,46 +414,7 @@ def lint_ruff_format(context):
         raise invoke.exceptions.UnexpectedExit(result)
 
 
-@task
-def lint_pylint(context):
-    # TODO: Fix --disable=import-error
-    try:
-        run_invoke_with_tox(
-            context,
-            ToxEnvironment.CHECK,
-            """
-                pylint
-                  --rcfile=.pylint.ini
-                  --disable=c-extension-no-member
-                  --disable=import-error
-                  strictdoc/ tests/ tasks.py
-            """,
-        )
-    except invoke.exceptions.UnexpectedExit as exc:
-        # pylink doesn't show an error message when exit code != 0, so we do.
-        print(  # noqa: T201
-            f"invoke: pylint exited with error code {exc.result.exited}"
-        )
-        raise exc
-
-
-@task
-def lint_flake8(context):
-    run_invoke_with_tox(
-        context,
-        ToxEnvironment.CHECK,
-        """
-            flake8
-                strictdoc/ tests/unit tests/unit_server
-                --ignore=E501,W503
-                --statistics
-                --max-line-length 80
-                --show-source
-        """,
-    )
-
-
-@task
+@task(aliases=["lr"])
 def lint_ruff(context):
     run_invoke_with_tox(
         context,
@@ -467,7 +426,7 @@ def lint_ruff(context):
 
 
 # @sdoc[SDOC-SRS-43]
-@task
+@task(aliases=["lm"])
 def lint_mypy(context):
     # FIXME
     if sys.version_info >= (3, 8):
@@ -494,17 +453,14 @@ def lint_mypy(context):
 # # @sdoc[/SDOC-SRS-43]
 
 
-@task
+@task(aliases=["l"])
 def lint(context):
     lint_ruff_format(context)
     lint_ruff(context)
-    # It looks like Ruff does the job, but keeping this for a while.
-    # lint_pylint(context)  # noqa: ERA001
-    # lint_flake8(context)  # noqa: ERA001
     lint_mypy(context)
 
 
-@task
+@task(aliases=["t"])
 def test(context):
     test_unit_coverage(context)
     test_unit_server(context)
@@ -512,7 +468,7 @@ def test(context):
     test_integration(context, html2pdf=True)
 
 
-@task
+@task(aliases=["c"])
 def check(context):
     lint(context)
     test(context)
@@ -713,7 +669,6 @@ def release_pyinstaller(context):
             --add-data strictdoc/export/html2pdf/html2pdf.py:.
             --add-data strictdoc/export/html/templates:templates/html
             --add-data strictdoc/export/rst/templates:templates/rst
-            --add-data strictdoc/export/dot/templates:templates/dot
             --add-data strictdoc/export/html/_static:_static
             --add-data strictdoc/export/html/_static_extra:_static_extra
             strictdoc/cli/main.py
@@ -819,19 +774,6 @@ def performance_snakeviz(context):
     run_invoke(context, command)
 
 
-@task()
-def dot(context):
-    run_invoke(
-        context,
-        """
-            python strictdoc/cli/main.py
-                export
-                    --formats dot
-                    .
-        """,
-    )
-
-
 @task()
 def autouid(context):
     run_invoke(