strictdoc 0.0.49a1__tar.gz → 0.0.49a3__tar.gz

{strictdoc-0.0.49a1 → strictdoc-0.0.49a3}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: strictdoc
-Version: 0.0.49a1
+Version: 0.0.49a3
 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.49a1 → strictdoc-0.0.49a3}/mypy.ini

@@ -22,8 +22,12 @@ ignore_missing_imports = True
 ignore_missing_imports = True
 
 # We ignore build folder but mypy still follows into the Python packages,
-# in this case starlette. This StackOverflow answers suggests a solution.
+# in this case pydantic, starlette, selenium.
+# This StackOverflow answers suggests a solution:
 # https://stackoverflow.com/a/70367929/598057
+[mypy-pydantic.*]
+follow_imports = skip
+
 [mypy-starlette.*]
 follow_imports = skip
 

{strictdoc-0.0.49a1 → strictdoc-0.0.49a3}/requirements.check.txt

@@ -20,7 +20,7 @@ pytidylib>=0.3.2
 openpyxl>=3.0.5
 
 # End2end tests
-seleniumbase; python_version<="3.7"
+seleniumbase
 
 # psutil is needed to reap Uvicorn's zombie processes when running end2end
 # tests. One day someone finds a better solution.

{strictdoc-0.0.49a1 → strictdoc-0.0.49a3}/strictdoc/__init__.py

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

{strictdoc-0.0.49a1 → strictdoc-0.0.49a3}/strictdoc/backend/excel/import_/excel_to_sdoc_converter.py

@@ -132,7 +132,10 @@ class ExcelToSDocConverter:
             fields.extend(
                 [
                     GrammarElementFieldString(
-                        parent=None, title=name, required="False"
+                        parent=None,
+                        title=name,
+                        human_title=None,
+                        required="False",
                     ),
                 ]
             )

{strictdoc-0.0.49a1 → strictdoc-0.0.49a3}/strictdoc/backend/reqif/p01_sdoc/reqif_to_sdoc_converter.py

@@ -204,6 +204,7 @@ class P01_ReqIFToSDocConverter:  # pylint: disable=invalid-name
                     GrammarElementFieldString(
                         parent=None,
                         title=field_name,
+                        human_title=None,
                         required="False",
                     )
                 )
@@ -212,6 +213,7 @@ class P01_ReqIFToSDocConverter:  # pylint: disable=invalid-name
                     GrammarElementFieldString(
                         parent=None,
                         title=field_name,
+                        human_title=None,
                         required="False",
                     )
                 )
@@ -229,6 +231,7 @@ class P01_ReqIFToSDocConverter:  # pylint: disable=invalid-name
                         GrammarElementFieldMultipleChoice(
                             parent=None,
                             title=field_name,
+                            human_title=None,
                             options=options,
                             required="False",
                         )
@@ -238,6 +241,7 @@ class P01_ReqIFToSDocConverter:  # pylint: disable=invalid-name
                         GrammarElementFieldSingleChoice(
                             parent=None,
                             title=field_name,
+                            human_title=None,
                             options=options,
                             required="False",
                         )

{strictdoc-0.0.49a1 → strictdoc-0.0.49a3}/strictdoc/backend/reqif/p11_polarion/reqif_to_sdoc_converter.py

@@ -233,6 +233,7 @@ class P11_ReqIFToSDocConverter:  # pylint: disable=invalid-name
                     GrammarElementFieldString(
                         parent=None,
                         title=field_name,
+                        human_title=None,
                         required="False",
                     )
                 )
@@ -241,6 +242,7 @@ class P11_ReqIFToSDocConverter:  # pylint: disable=invalid-name
                     GrammarElementFieldString(
                         parent=None,
                         title=field_name,
+                        human_title=None,
                         required="False",
                     )
                 )
@@ -258,6 +260,7 @@ class P11_ReqIFToSDocConverter:  # pylint: disable=invalid-name
                         GrammarElementFieldMultipleChoice(
                             parent=None,
                             title=field_name,
+                            human_title=None,
                             options=options,
                             required="False",
                         )
@@ -267,6 +270,7 @@ class P11_ReqIFToSDocConverter:  # pylint: disable=invalid-name
                         GrammarElementFieldSingleChoice(
                             parent=None,
                             title=field_name,
+                            human_title=None,
                             options=options,
                             required="False",
                         )

{strictdoc-0.0.49a1 → strictdoc-0.0.49a3}/strictdoc/backend/sdoc/error_handling.py

@@ -5,6 +5,7 @@ from strictdoc.backend.sdoc.models.document_grammar import (
     GrammarElement,
     GrammarElementField,
 )
+from strictdoc.backend.sdoc.models.document_view import ViewElement
 from strictdoc.backend.sdoc.models.reference import Reference
 from strictdoc.backend.sdoc.models.requirement import (
     Requirement,
@@ -291,6 +292,71 @@ class StrictDocSemanticError(Exception):
             filename=filename,
         )
 
+    @staticmethod
+    def view_references_nonexisting_grammar_element(
+        view_element: ViewElement,
+        object_type: str,
+        line=None,
+        col=None,
+        filename=None,
+    ):
+        return StrictDocSemanticError(
+            title=(
+                f"View element '{view_element.view_id}' references a non-existing"
+                f" grammar element '{object_type}'."
+            ),
+            hint=(
+                "Make sure that each View element references an existing "
+                "object in the grammar or the default REQUIREMENT object."
+            ),
+            example=None,
+            line=line,
+            col=col,
+            filename=filename,
+        )
+
+    @staticmethod
+    def view_references_nonexisting_field(
+        view_element: ViewElement,
+        object_type: str,
+        field_name: str,
+        line=None,
+        col=None,
+        filename=None,
+    ):
+        return StrictDocSemanticError(
+            title=(
+                f"View element '{view_element.view_id}' references a non-existing"
+                f" field '{field_name}' for grammar element '{object_type}'."
+            ),
+            hint=(
+                "Make sure that each View element references an existing "
+                "field in the grammar for the given grammar element."
+            ),
+            example=None,
+            line=line,
+            col=col,
+            filename=filename,
+        )
+
+    @staticmethod
+    def default_view_doesnt_exist(
+        default_view: str, line=None, col=None, filename=None
+    ):
+        return StrictDocSemanticError(
+            title=(
+                f"Default view '{default_view}' does not exist in the document."
+            ),
+            hint=(
+                "Make sure that the specified default view is created in the "
+                "VIEWS configuration."
+            ),
+            example=None,
+            line=line,
+            col=col,
+            filename=filename,
+        )
+
     def to_print_message(self):
         message = ""
         message += f"error: could not parse file: {self.file_path}.\n"

{strictdoc-0.0.49a1 → strictdoc-0.0.49a3}/strictdoc/backend/sdoc/grammar/grammar.py

@@ -102,12 +102,14 @@ GrammarElementField[noskipws]:
 
 GrammarElementFieldString[noskipws]:
   '  - TITLE: ' title=FieldName '\n'
+  ('    HUMAN_TITLE: ' human_title=SingleLineString '\n')?
   '    TYPE: String' '\n'
   '    REQUIRED: ' (required = BooleanChoice) '\n'
 ;
 
 GrammarElementFieldSingleChoice[noskipws]:
   '  - TITLE: ' title=FieldName '\n'
+  ('    HUMAN_TITLE: ' human_title=SingleLineString '\n')?
   '    TYPE: SingleChoice'
     '(' ((options = ChoiceOption) (options *= ChoiceOptionXs)) ')' '\n'
   '    REQUIRED: ' (required = BooleanChoice) '\n'
@@ -115,6 +117,7 @@ GrammarElementFieldSingleChoice[noskipws]:
 
 GrammarElementFieldMultipleChoice[noskipws]:
   '  - TITLE: ' title=FieldName '\n'
+  ('    HUMAN_TITLE: ' human_title=SingleLineString '\n')?
   '    TYPE: MultipleChoice'
     '(' ((options = ChoiceOption) (options *= ChoiceOptionXs)) ')' '\n'
   '    REQUIRED: ' (required = BooleanChoice) '\n'
@@ -122,6 +125,7 @@ GrammarElementFieldMultipleChoice[noskipws]:
 
 GrammarElementFieldTag[noskipws]:
   '  - TITLE: ' title=FieldName '\n'
+  ('    HUMAN_TITLE: ' human_title=SingleLineString '\n')?
   '    TYPE: Tag' '\n'
   '    REQUIRED: ' (required = BooleanChoice) '\n'
 ;

{strictdoc-0.0.49a1 → strictdoc-0.0.49a3}/strictdoc/backend/sdoc/models/constants.py

@@ -8,6 +8,10 @@ from strictdoc.backend.sdoc.models.document_grammar import (
     DocumentGrammar,
     GrammarElement,
 )
+from strictdoc.backend.sdoc.models.document_view import (
+    DocumentView,
+    ViewElement,
+)
 from strictdoc.backend.sdoc.models.fragment import Fragment
 from strictdoc.backend.sdoc.models.fragment_from_file import FragmentFromFile
 from strictdoc.backend.sdoc.models.inline_link import InlineLink
@@ -37,6 +41,9 @@ from strictdoc.backend.sdoc.models.type_system import (
     GrammarElementRelationChild,
     GrammarElementRelationFile,
     GrammarElementRelationParent,
+    ViewElementField,
+    ViewElementHiddenTag,
+    ViewElementTags,
 )
 
 SECTION_MODELS = [
@@ -62,6 +69,7 @@ DOCUMENT_MODELS = [
     DocumentConfig,
     Document,
     DocumentGrammar,
+    DocumentView,
     DocumentBibliography,
     GrammarElement,
     GrammarElementFieldString,
@@ -73,6 +81,10 @@ DOCUMENT_MODELS = [
     GrammarElementRelationParent,
     GrammarElementRelationChild,
     GrammarElementRelationFile,
+    ViewElement,
+    ViewElementField,
+    ViewElementTags,
+    ViewElementHiddenTag,
 ]
 DOCUMENT_MODELS.extend(SECTION_MODELS)
 

{strictdoc-0.0.49a1 → strictdoc-0.0.49a3}/strictdoc/backend/sdoc/models/document.py

@@ -92,20 +92,8 @@ class Document:  # pylint: disable=too-many-instance-attributes
     def ng_resolved_custom_level(self):
         return None
 
-    @property
-    def requirement_prefix(self) -> str:
-        return (
-            self.config.requirement_prefix
-            if self.config.requirement_prefix is not None
-            else "REQ-"
-        )
-
     def get_requirement_prefix(self) -> str:
-        return (
-            self.config.requirement_prefix
-            if self.config.requirement_prefix is not None
-            else "REQ-"
-        )
+        return self.config.get_requirement_prefix()
 
     def enumerate_meta_field_titles(self):
         # TODO: currently only enumerating a single element ([0])

{strictdoc-0.0.49a1 → strictdoc-0.0.49a3}/strictdoc/backend/sdoc/models/document_config.py

@@ -85,7 +85,7 @@ class DocumentConfig:  # pylint: disable=too-many-instance-attributes
             self.requirement_in_toc is None or self.requirement_in_toc == "True"
         )
 
-    def get_requirement_prefix_or_default(self) -> str:
+    def get_requirement_prefix(self) -> str:
         if self.requirement_prefix is not None:
             return self.requirement_prefix
         return "REQ-"

{strictdoc-0.0.49a1 → strictdoc-0.0.49a3}/strictdoc/backend/sdoc/models/document_grammar.py

@@ -68,7 +68,7 @@ class GrammarElement:
         fields_map: OrderedDict = OrderedDict()
         for field in fields:
             fields_map[field.title] = field
-        self.fields_map = fields_map
+        self.fields_map: Dict[str, GrammarElementField] = fields_map
 
         if "REFS" in fields_map:
             field = fields_map["REFS"]
@@ -156,39 +156,51 @@ class DocumentGrammar:
         # @sdoc[SDOC-SRS-132]
         fields = [
             GrammarElementFieldString(
-                parent=None, title=RequirementFieldName.UID, required="False"
+                parent=None,
+                title=RequirementFieldName.UID,
+                human_title=None,
+                required="False",
             ),
             GrammarElementFieldString(
                 parent=None,
                 title=RequirementFieldName.LEVEL,
+                human_title=None,
                 required="False",
             ),
             GrammarElementFieldString(
                 parent=None,
                 title=RequirementFieldName.STATUS,
+                human_title=None,
                 required="False",
             ),
             GrammarElementFieldString(
-                parent=None, title=RequirementFieldName.TAGS, required="False"
+                parent=None,
+                title=RequirementFieldName.TAGS,
+                human_title=None,
+                required="False",
             ),
             GrammarElementFieldString(
                 parent=None,
                 title=RequirementFieldName.TITLE,
+                human_title=None,
                 required="False",
             ),
             GrammarElementFieldString(
                 parent=None,
                 title=RequirementFieldName.STATEMENT,
+                human_title=None,
                 required="False",
             ),
             GrammarElementFieldString(
                 parent=None,
                 title=RequirementFieldName.RATIONALE,
+                human_title=None,
                 required="False",
             ),
             GrammarElementFieldString(
                 parent=None,
                 title=RequirementFieldName.COMMENT,
+                human_title=None,
                 required="False",
             ),
             GrammarElementFieldReference(

{strictdoc-0.0.49a1 → strictdoc-0.0.49a3}/strictdoc/backend/sdoc/models/document_view.py

@@ -11,11 +11,13 @@ from strictdoc.helpers.auto_described import auto_described
 class ViewElement:
     def __init__(
         self,
+        parent,
         view_id: str,
         tags: List[ViewElementTags],
         hidden_tags: Optional[List[ViewElementHiddenTag]],
         name: Optional[str],
     ):
+        self.parent = parent
         self.view_id: str = view_id
         self.tags: List[ViewElementTags] = tags
         self.hidden_tags: Optional[List[ViewElementHiddenTag]] = hidden_tags
@@ -23,5 +25,6 @@ class ViewElement:
 
 
 class DocumentView:
-    def __init__(self, views: List[ViewElement]):
+    def __init__(self, parent, views: List[ViewElement]):
+        self.parent = parent
         self.views: List[ViewElement] = views

{strictdoc-0.0.49a1 → strictdoc-0.0.49a3}/strictdoc/backend/sdoc/models/requirement.py

@@ -445,7 +445,8 @@ class Requirement(Node):  # pylint: disable=too-many-instance-attributes, too-ma
             if (not is_single_line_field) and skip_multi_lines:
                 continue
 
-            yield field.field_name, meta_field_value
+            field_human_title = element.fields_map[field.field_name]
+            yield field_human_title.get_field_human_name(), meta_field_value
 
     def get_meta_field_value_by_title(self, field_title: str) -> Optional[str]:
         assert isinstance(field_title, str)
@@ -461,12 +462,18 @@ class Requirement(Node):  # pylint: disable=too-many-instance-attributes, too-ma
         meta_field_value = meta_field_value_or_none
         return meta_field_value
 
+    def get_field_human_title(self, field_name: str) -> str:
+        element: GrammarElement = self.document.grammar.elements_by_type[
+            self.requirement_type
+        ]
+        field_human_title = element.fields_map[field_name]
+        return field_human_title.get_field_human_name()
+
     def get_requirement_prefix(self) -> str:
-        parent: Union[Section, Document] = self.parent
-        while parent.requirement_prefix is None:
-            parent = parent.parent
-        assert parent.requirement_prefix is not None
-        return parent.requirement_prefix
+        parent: Union[Section, Document] = assert_cast(
+            self.parent, (Section, Document, CompositeRequirement)
+        )
+        return parent.get_requirement_prefix()
 
     def dump_fields_as_parsed(self):
         return ", ".join(
@@ -542,6 +549,9 @@ class Requirement(Node):  # pylint: disable=too-many-instance-attributes, too-ma
             self.requirement_type
         ]
         grammar_field_titles = list(map(lambda f: f.title, element.fields))
+        # FIXME: This will go away very soon when the RELATIONS become a
+        #        separate field in SDoc REQUIREMENT's grammar.
+        grammar_field_titles.append("REFS")
         field_index = grammar_field_titles.index(field_name)
         title_field_index = grammar_field_titles.index(
             RequirementFieldName.TITLE
@@ -625,3 +635,6 @@ class CompositeRequirement(Requirement):
     @property
     def document(self):
         return self.ng_document_reference.get_document()
+
+    def get_requirement_prefix(self) -> str:
+        return self.parent.get_requirement_prefix()

{strictdoc-0.0.49a1 → strictdoc-0.0.49a3}/strictdoc/backend/sdoc/models/type_system.py

@@ -172,17 +172,26 @@ class ReferenceType:
 class GrammarElementField:
     def __init__(self):
         self.title: str = ""
+        self.human_title: Optional[str] = None
         self.gef_type: str = ""
         self.required: bool = False
         self.mid: MID = MID.create()
 
+    def get_field_human_name(self) -> str:
+        if self.human_title is not None:
+            return self.human_title
+        return self.title
+
 
 @auto_described
 class GrammarElementFieldString(GrammarElementField):
-    def __init__(self, parent, title: str, required: str):
+    def __init__(
+        self, parent, title: str, human_title: Optional[str], required: str
+    ):
         super().__init__()
         self.parent = parent
         self.title: str = title
+        self.human_title: Optional[str] = human_title
         self.gef_type = RequirementFieldType.STRING
         self.required: bool = required == "True"
         self.mid: MID = MID.create()
@@ -190,10 +199,18 @@ class GrammarElementFieldString(GrammarElementField):
 
 @auto_described
 class GrammarElementFieldSingleChoice(GrammarElementField):
-    def __init__(self, parent, title: str, options: List[str], required: str):
+    def __init__(
+        self,
+        parent,
+        title: str,
+        human_title: Optional[str],
+        options: List[str],
+        required: str,
+    ):
         super().__init__()
         self.parent = parent
         self.title: str = title
+        self.human_title: Optional[str] = human_title
         self.gef_type = RequirementFieldType.SINGLE_CHOICE
         self.options: List[str] = options
         self.required: bool = required == "True"
@@ -202,10 +219,18 @@ class GrammarElementFieldSingleChoice(GrammarElementField):
 
 @auto_described
 class GrammarElementFieldMultipleChoice(GrammarElementField):
-    def __init__(self, parent, title: str, options: List[str], required: str):
+    def __init__(
+        self,
+        parent,
+        title: str,
+        human_title: Optional[str],
+        options: List[str],
+        required: str,
+    ):
         super().__init__()
         self.parent = parent
         self.title: str = title
+        self.human_title: Optional[str] = human_title
         self.gef_type = RequirementFieldType.MULTIPLE_CHOICE
         self.options: List[str] = options
         self.required: bool = required == "True"
@@ -214,10 +239,13 @@ class GrammarElementFieldMultipleChoice(GrammarElementField):
 
 @auto_described
 class GrammarElementFieldTag(GrammarElementField):
-    def __init__(self, parent, title: str, required: str):
+    def __init__(
+        self, parent, title: str, human_title: Optional[str], required: str
+    ):
         super().__init__()
         self.parent = parent
         self.title: str = title
+        self.human_title: Optional[str] = human_title
         self.gef_type = RequirementFieldType.TAG
         self.required: bool = required == "True"
         self.mid: MID = MID.create()
@@ -344,7 +372,8 @@ class GrammarElementFieldReference(GrammarElementField):
 
 @auto_described
 class ViewElementField:
-    def __init__(self, name: str, placement: Optional[str]):
+    def __init__(self, parent, name: str, placement: Optional[str]):
+        self.parent = parent
         self.name: str = name
         self.placement: Optional[str] = placement
 
@@ -352,13 +381,15 @@ class ViewElementField:
 @auto_described
 class ViewElementTags:
     def __init__(
-        self, object_type: str, visibile_fields: List[ViewElementField]
+        self, parent, object_type: str, visible_fields: List[ViewElementField]
     ):
+        self.parent = parent
         self.object_type: str = object_type
-        self.visible_fields: List[ViewElementField] = visibile_fields
+        self.visible_fields: List[ViewElementField] = visible_fields
 
 
 @auto_described
 class ViewElementHiddenTag:
-    def __init__(self, hidden_tag: str):
+    def __init__(self, parent, hidden_tag: str):
+        self.parent = parent
         self.hidden_tag: str = hidden_tag

{strictdoc-0.0.49a1 → strictdoc-0.0.49a3}/strictdoc/backend/sdoc/processor.py

@@ -7,6 +7,7 @@ from strictdoc.backend.sdoc.error_handling import StrictDocSemanticError
 from strictdoc.backend.sdoc.models.document import Document
 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.fragment import Fragment
 from strictdoc.backend.sdoc.models.fragment_from_file import FragmentFromFile
 from strictdoc.backend.sdoc.models.requirement import (
@@ -25,6 +26,7 @@ class ParseContext:
         self.document_grammar: DocumentGrammar = DocumentGrammar.create_default(
             None
         )
+        self.document_view: Optional[DocumentView] = None
         self.current_include_parent = None
         self.uses_old_refs_field: bool = False
         self.at_least_one_relations_field: bool = False
@@ -43,6 +45,7 @@ class SDocParsingProcessor:
             "Document": self.process_document,
             "DocumentConfig": self.process_document_config,
             "DocumentGrammar": self.process_document_grammar,
+            "DocumentView": self.process_document_view,
             "Section": self.process_section,
             "FragmentFromFile": self.process_include,
             "CompositeRequirement": self.process_composite_requirement,
@@ -63,6 +66,32 @@ class SDocParsingProcessor:
                 )
         self.parse_context.document_grammar = document_grammar
 
+    def process_document_view(self, document_view: DocumentView):
+        for view in document_view.views:
+            for tag in view.tags:
+                if (
+                    tag.object_type
+                    not in self.parse_context.document_grammar.registered_elements
+                ):
+                    raise StrictDocSemanticError.view_references_nonexisting_grammar_element(
+                        view,
+                        tag.object_type,
+                        **get_location(document_view),
+                    )
+                for field in tag.visible_fields:
+                    for (
+                        grammar_element
+                    ) in self.parse_context.document_grammar.elements:
+                        if field.name not in grammar_element.fields_map:
+                            raise StrictDocSemanticError.view_references_nonexisting_field(
+                                view,
+                                tag.object_type,
+                                field.name,
+                                **get_location(document_view),
+                            )
+
+        self.parse_context.document_view = document_view
+
     def process_section(self, section: Section):
         section.ng_document_reference = self.parse_context.document_reference
 

{strictdoc-0.0.49a1 → strictdoc-0.0.49a3}/strictdoc/backend/sdoc/reader.py

@@ -14,6 +14,7 @@ from strictdoc.backend.sdoc.models.constants import DOCUMENT_MODELS
 from strictdoc.backend.sdoc.models.document import Document
 from strictdoc.backend.sdoc.models.fragment import Fragment
 from strictdoc.backend.sdoc.processor import ParseContext, SDocParsingProcessor
+from strictdoc.backend.sdoc.validations.sdoc_validator import SDocValidator
 from strictdoc.helpers.cast import assert_cast
 from strictdoc.helpers.exception import StrictDocException
 from strictdoc.helpers.md5 import get_file_md5
@@ -65,17 +66,19 @@ class SDReader:
                 "  VALUE: REQ-1"
             )
 
+        return document, parse_context
+
+    @staticmethod
+    def read(input_string, file_path=None):
+        document, _ = SDReader._read(input_string, file_path)
+        SDocValidator.validate_document(document)
+
         # HACK:
         # ProcessPoolExecutor doesn't work because of non-picklable parts
         # of textx. The offending fields are stripped down because they
         # are not used anyway.
         drop_textx_meta(document)
 
-        return document, parse_context
-
-    @staticmethod
-    def read(input_string, file_path=None):
-        document, _ = SDReader._read(input_string, file_path)
         return document
 
     def read_from_file(self, file_path: str) -> Document: