strictdoc 0.0.56a3__tar.gz → 0.0.56a4__tar.gz

{strictdoc-0.0.56a3 → strictdoc-0.0.56a4}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: strictdoc
-Version: 0.0.56a3
+Version: 0.0.56a4
 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.56a3 → strictdoc-0.0.56a4}/strictdoc/__init__.py

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

{strictdoc-0.0.56a3 → strictdoc-0.0.56a4}/strictdoc/backend/excel/import_/excel_to_sdoc_converter.py

@@ -14,6 +14,7 @@ from strictdoc.backend.sdoc.models.node import SDocNode, SDocNodeField
 from strictdoc.backend.sdoc.models.object_factory import SDocObjectFactory
 from strictdoc.backend.sdoc.models.reference import ParentReqReference
 from strictdoc.backend.sdoc.models.type_system import GrammarElementFieldString
+from strictdoc.helpers.string import ensure_newline
 
 
 class RequirementColumns(NamedTuple):
@@ -172,7 +173,7 @@ class ExcelToSDocConverter:
             if comment in ("", "-"):
                 comments = None
             else:
-                comments = [comment]
+                comments = [ensure_newline(comment)]
         parent_uid = None
         if columns.parent_column is not None:
             parent_uid = row_values[columns.parent_column].strip()
@@ -186,7 +187,7 @@ class ExcelToSDocConverter:
             uid=uid,
             level=None,
             statement=None,
-            statement_multiline=statement,
+            statement_multiline=ensure_newline(statement),
             rationale=None,
             rationale_multiline=None,
             tags=None,
@@ -196,11 +197,11 @@ class ExcelToSDocConverter:
             value = row_values[i].strip()
             if value != "":
                 template_requirement.ordered_fields_lookup[name] = [
-                    SDocNodeField(
+                    SDocNodeField.create_from_string(
                         parent=None,
                         field_name=name,
-                        field_value=None,
-                        field_value_multiline=value,
+                        field_value=ensure_newline(value),
+                        multiline=True,
                     )
                 ]
         if parent_uid is not None:

{strictdoc-0.0.56a3 → strictdoc-0.0.56a4}/strictdoc/backend/reqif/p01_sdoc/reqif_to_sdoc_converter.py

@@ -37,6 +37,7 @@ from strictdoc.backend.sdoc.models.type_system import (
 )
 from strictdoc.helpers.string import (
     create_safe_requirement_tag_string,
+    ensure_newline,
     unescape,
 )
 
@@ -459,39 +460,46 @@ class P01_ReqIFToSDocConverter:
 
                 enum_values = ", ".join(enum_values_resolved)
                 fields.append(
-                    SDocNodeField(
+                    SDocNodeField.create_from_string(
                         parent=None,
                         field_name=sdoc_field_name,
                         field_value=enum_values,
-                        field_value_multiline=None,
+                        multiline=False,
                     )
                 )
                 continue
             assert isinstance(attribute.value, str)
             if long_name_or_none == "ReqIF.ForeignID":
                 foreign_key_id_or_none = attribute.definition_ref
-            attribute_value: Optional[str] = unescape(attribute.value)
-            attribute_multiline_value = None
+            attribute_value: str = unescape(attribute.value)
+            multiline: bool = False
             if (
                 "\n" in attribute_value
                 or attribute.attribute_type == SpecObjectAttributeType.XHTML
                 or field_name == ReqIFRequirementReservedField.TEXT
                 or field_name == ReqIFRequirementReservedField.COMMENT_NOTES
             ):
-                attribute_multiline_value = attribute_value.lstrip()
-                attribute_value = None
+                attribute_value = attribute_value.lstrip()
+                multiline = True
+                if attribute.attribute_type == SpecObjectAttributeType.XHTML:
+                    attribute_value = attribute.value_stripped_xhtml
+                    # Another strip() is hidden in .value_stripped_xhtml
+                    # but doing this anyway to highlight the intention.
+                    attribute_value = attribute_value.strip()
 
             sdoc_field_name = (
                 P01_ReqIFToSDocConverter.convert_requirement_field_from_reqif(
                     field_name,
                 )
             )
+            if multiline:
+                attribute_value = ensure_newline(attribute_value)
             fields.append(
-                SDocNodeField(
+                SDocNodeField.create_from_string(
                     parent=None,
                     field_name=sdoc_field_name,
                     field_value=attribute_value,
-                    field_value_multiline=attribute_multiline_value,
+                    multiline=multiline,
                 )
             )
 

{strictdoc-0.0.56a3 → strictdoc-0.0.56a4}/strictdoc/backend/reqif/p01_sdoc/sdoc_to_reqif_converter.py

@@ -590,7 +590,7 @@ class P01_SDocToReqIFObjectConverter:
             elif isinstance(grammar_field, GrammarElementFieldString):
                 is_multiline_field = field.is_multiline()
 
-                field_value: str = field.get_value()
+                field_value: str = field.get_value().rstrip()
 
                 attribute_type: str
                 if context.multiline_is_xhtml:

{strictdoc-0.0.56a3 → strictdoc-0.0.56a4}/strictdoc/backend/reqif/p02_simple/reqif_to_sdoc_converter.py

@@ -35,7 +35,7 @@ from strictdoc.backend.sdoc.models.type_system import (
     GrammarElementFieldSingleChoice,
     GrammarElementFieldString,
 )
-from strictdoc.helpers.string import unescape
+from strictdoc.helpers.string import ensure_newline, unescape
 
 
 class P02_ReqIFToSDocBuildContext:
@@ -417,39 +417,41 @@ class P02_ReqIFToSDocConverter:
 
                 enum_values = ", ".join(enum_values_resolved)
                 fields.append(
-                    SDocNodeField(
+                    SDocNodeField.create_from_string(
                         parent=None,
                         field_name=sdoc_field_name,
                         field_value=enum_values,
-                        field_value_multiline=None,
+                        multiline=False,
                     )
                 )
                 continue
             assert isinstance(attribute.value, str)
             if long_name_or_none == "ReqIF.ForeignID":
                 foreign_key_id_or_none = attribute.definition_ref
-            attribute_value: Optional[str] = unescape(attribute.value)
-            attribute_multiline_value = None
+            attribute_value: str = unescape(attribute.value)
+            multiline: bool = False
             if (
                 "\n" in attribute_value
                 or attribute.attribute_type == SpecObjectAttributeType.XHTML
                 or field_name == ReqIFRequirementReservedField.TEXT
                 or field_name == ReqIFRequirementReservedField.COMMENT_NOTES
             ):
-                attribute_multiline_value = attribute_value.lstrip()
-                attribute_value = None
+                attribute_value = attribute_value.lstrip()
+                multiline = True
 
             sdoc_field_name = (
                 P02_ReqIFToSDocConverter.convert_requirement_field_from_reqif(
                     field_name,
                 )
             )
+            if multiline:
+                attribute_value = ensure_newline(attribute_value)
             fields.append(
-                SDocNodeField(
+                SDocNodeField.create_from_string(
                     parent=None,
                     field_name=sdoc_field_name,
                     field_value=attribute_value,
-                    field_value_multiline=attribute_multiline_value,
+                    multiline=multiline,
                 )
             )
 

{strictdoc-0.0.56a3 → strictdoc-0.0.56a4}/strictdoc/backend/reqif/p11_polarion/reqif_to_sdoc_converter.py

@@ -37,7 +37,7 @@ from strictdoc.backend.sdoc.models.type_system import (
     GrammarElementFieldSingleChoice,
     GrammarElementFieldString,
 )
-from strictdoc.helpers.string import unescape
+from strictdoc.helpers.string import ensure_newline, unescape
 
 
 class P11_ReqIFToSDocConverter:  # pylint: disable=invalid-name
@@ -387,43 +387,43 @@ class P11_ReqIFToSDocConverter:  # pylint: disable=invalid-name
                     ].strip()
                 enum_values = ", ".join(enum_values_list)
                 fields.append(
-                    SDocNodeField(
+                    SDocNodeField.create_from_string(
                         parent=None,
                         field_name=field_name,
                         field_value=enum_values,
-                        field_value_multiline=None,
+                        multiline=False,
                     )
                 )
                 continue
             assert isinstance(attribute.value, str)
             if long_name_or_none == "ReqIF.ForeignID":
                 foreign_key_id_or_none = attribute.definition_ref
-            attribute_value: Optional[str] = unescape(attribute.value)
-            attribute_multiline_value = None
+            attribute_value: str = unescape(attribute.value)
+            multiline: bool = False
             if (
                 "\n" in attribute_value
                 or field_name == ReqIFRequirementReservedField.TEXT
                 or field_name == ReqIFRequirementReservedField.COMMENT_NOTES
             ):
                 if attribute.attribute_type == SpecObjectAttributeType.XHTML:
-                    attribute_multiline_value = attribute.value_stripped_xhtml
+                    attribute_value = attribute.value_stripped_xhtml
                     # Another strip() is hidden in .value_stripped_xhtml
                     # but doing this anyway to highlight the intention.
-                    attribute_multiline_value = (
-                        attribute_multiline_value.strip()
-                    )
+                    attribute_value = attribute_value.strip()
                 else:
-                    attribute_multiline_value = attribute_value.strip()
-                attribute_value = None
+                    attribute_value = attribute_value.strip()
+                multiline = True
 
             if field_name in ReqIFRequirementReservedField.SET:
                 field_name = REQIF_MAP_TO_SDOC_FIELD_MAP[field_name]
+            if multiline:
+                attribute_value = ensure_newline(attribute_value)
             fields.append(
-                SDocNodeField(
+                SDocNodeField.create_from_string(
                     parent=None,
                     field_name=field_name,
                     field_value=attribute_value,
-                    field_value_multiline=attribute_multiline_value,
+                    multiline=multiline,
                 )
             )
         requirement = SDocNode(

{strictdoc-0.0.56a3 → strictdoc-0.0.56a4}/strictdoc/backend/sdoc/error_handling.py

@@ -150,7 +150,7 @@ class StrictDocSemanticError(Exception):
         return StrictDocSemanticError(
             title=(
                 f"Requirement field has an invalid SingleChoice value: "
-                f"{requirement_field.field_value}."
+                f"{requirement_field.get_value()}."
             ),
             hint=(
                 f"Problematic field: {requirement_field.field_name}. "
@@ -176,7 +176,7 @@ class StrictDocSemanticError(Exception):
         return StrictDocSemanticError(
             title=(
                 f"Requirement field has an invalid MultipleChoice value: "
-                f"{requirement_field.field_value}."
+                f"{requirement_field.get_value()}."
             ),
             hint=(
                 f"Problematic field: {requirement_field.field_name}. "
@@ -201,7 +201,7 @@ class StrictDocSemanticError(Exception):
         return StrictDocSemanticError(
             title=(
                 f"Requirement field of type MultipleChoice is invalid: "
-                f"{requirement_field.field_value}."
+                f"{requirement_field.get_value()}."
             ),
             hint="MultipleChoice field requires ', '-separated values.",
             example=None,
@@ -219,7 +219,7 @@ class StrictDocSemanticError(Exception):
         return StrictDocSemanticError(
             title=(
                 f"Requirement field of type Tag is invalid: "
-                f"{requirement_field.field_value}."
+                f"{requirement_field.get_value()}."
             ),
             hint="Tag field requires ', '-separated values.",
             example=None,
@@ -365,7 +365,7 @@ class StrictDocSemanticError(Exception):
             filename=filename,
         )
 
-    def to_print_message(self):
+    def to_print_message(self) -> str:
         message = ""
         message += f"error: could not parse file: {self.file_path}.\n"
         message += f"Semantic error: {self.title}\n"

{strictdoc-0.0.56a3 → strictdoc-0.0.56a4}/strictdoc/backend/sdoc/grammar/grammar.py

@@ -1,4 +1,8 @@
 REGEX_UID = r"([A-Za-z0-9]+[A-Za-z0-9_\-]*)"
+
+NEGATIVE_MULTILINE_STRING_START = "(?!>>>\n)"
+NEGATIVE_MULTILINE_STRING_END = "(?!^<<<)"
+NEGATIVE_RELATIONS = "(?!^RELATIONS)"
 NEGATIVE_FREETEXT_END = "(?!^\\[\\/FREETEXT\\]\n)"
 NEGATIVE_INLINE_LINK_START = rf"(?!\[LINK: {REGEX_UID})"
 NEGATIVE_ANCHOR_START = rf"(?!^\[ANCHOR: {REGEX_UID})"
@@ -8,8 +12,12 @@ TextPart[noskipws]:
   (Anchor | InlineLink | NormalString)
 ;
 
+SingleLineTextPart[noskipws]:
+  (Anchor | InlineLink | /{NEGATIVE_MULTILINE_STRING_START}\S.*/)
+;
+
 NormalString[noskipws]:
-  (/(?ms){NEGATIVE_FREETEXT_END}{NEGATIVE_INLINE_LINK_START}{NEGATIVE_ANCHOR_START}./)+
+  (/(?ms){NEGATIVE_MULTILINE_STRING_END}{NEGATIVE_FREETEXT_END}{NEGATIVE_INLINE_LINK_START}{NEGATIVE_ANCHOR_START}./)+
 ;
 
 InlineLink[noskipws]:
@@ -21,6 +29,23 @@ Anchor[noskipws]:
   value = /{REGEX_UID}/ (', ' title = /\w+[\s\w+]*/)?
   /\](\Z|\n)/
 ;
+
+// According to the Strict Grammar Rule #3, both SingleLineString and
+// MultiLineString can never be empty strings.
+// Both must eventualy start with a non-space character.
+SingleLineString:
+  /{NEGATIVE_MULTILINE_STRING_START}\S.*$/
+;
+
+MultiLineString[noskipws]:
+  />>>\n/-
+    parts*=TextPart
+  /^<<</-
+;
+
+FieldName[noskipws]:
+  /{NEGATIVE_RELATIONS}[A-Z]+[A-Z_]*/
+;
 """
 
 FREE_TEXT_PARSER_GRAMMAR = r"""
@@ -148,7 +173,7 @@ ReservedKeyword[noskipws]:
 ;
 
 SDocNode[noskipws]:
-  '[' !SDocCompositeNodeTagName requirement_type = RequirementType ']' '\n'
+  '[' !'SECTION' !SDocCompositeNodeTagName requirement_type = RequirementType ']' '\n'
   ('MID: ' mid = SingleLineString '\n')?
   fields *= SDocNodeField
   (
@@ -165,8 +190,17 @@ SDocNodeField[noskipws]:
   (
     field_name = FieldName ':'
     (
-      ((' ' field_value = SingleLineString) '\n') |
-      (' ' (field_value_multiline = MultiLineString) '\n')
+        (' ' parts+=SingleLineTextPart '\n')
+        |
+        (
+          ' '
+          (
+            multiline__ = />>>\n/
+            parts+=TextPart
+            /^<<</
+          )
+          '\n'
+        )
     )
   )
 ;

{strictdoc-0.0.56a3 → strictdoc-0.0.56a4}/strictdoc/backend/sdoc/grammar/grammar_builder.py

@@ -1,11 +1,13 @@
-# mypy: disable-error-code="no-untyped-call,no-untyped-def"
 from strictdoc.backend.sdoc.grammar.grammar import (
     DOCUMENT_GRAMMAR,
     FREE_TEXT_PARSER_GRAMMAR,
     SECTION_GRAMMAR,
     TEXT_TYPES_GRAMMAR,
 )
-from strictdoc.backend.sdoc.grammar.grammar_grammar import GRAMMAR_GRAMMAR
+from strictdoc.backend.sdoc.grammar.grammar_grammar import (
+    GRAMMAR_GRAMMAR,
+    GRAMMAR_WRAPPER,
+)
 from strictdoc.backend.sdoc.grammar.type_system import (
     STRICTDOC_BASIC_TYPE_SYSTEM,
 )
@@ -13,12 +15,11 @@ from strictdoc.backend.sdoc.grammar.type_system import (
 
 class SDocGrammarBuilder:
     @staticmethod
-    def _prep_grammar(grammar):
-        grammar = (grammar).replace("'\\n'", "'\n'")
-        return grammar
+    def _prep_grammar(grammar: str) -> str:
+        return grammar.replace("'\\n'", "'\n'")
 
     @staticmethod
-    def create_grammar():
+    def create_grammar() -> str:
         grammar = SDocGrammarBuilder._prep_grammar(
             DOCUMENT_GRAMMAR
             + GRAMMAR_GRAMMAR
@@ -30,20 +31,23 @@ class SDocGrammarBuilder:
         return grammar
 
     @staticmethod
-    def create_free_text_grammar():
+    def create_free_text_grammar() -> str:
         return SDocGrammarBuilder._prep_grammar(
             FREE_TEXT_PARSER_GRAMMAR + TEXT_TYPES_GRAMMAR
         )
 
     @staticmethod
-    def create_grammar_grammar():
+    def create_grammar_grammar() -> str:
         grammar = SDocGrammarBuilder._prep_grammar(
-            GRAMMAR_GRAMMAR + STRICTDOC_BASIC_TYPE_SYSTEM
+            GRAMMAR_WRAPPER
+            + GRAMMAR_GRAMMAR
+            + STRICTDOC_BASIC_TYPE_SYSTEM
+            + TEXT_TYPES_GRAMMAR
         )
         return grammar
 
     @staticmethod
-    def create_raw_grammar():
+    def create_raw_grammar() -> str:
         grammar = (
             DOCUMENT_GRAMMAR
             + GRAMMAR_GRAMMAR
@@ -52,5 +56,4 @@ class SDocGrammarBuilder:
             + TEXT_TYPES_GRAMMAR
             + STRICTDOC_BASIC_TYPE_SYSTEM
         )
-
         return grammar

{strictdoc-0.0.56a3 → strictdoc-0.0.56a4}/strictdoc/backend/sdoc/grammar/grammar_grammar.py

@@ -86,3 +86,9 @@ ReferenceTypeXs[noskipws]:
   /, /- ReferenceType
 ;
 """
+
+GRAMMAR_WRAPPER = """
+DocumentGrammarWrapper[noskipws]:
+    grammar = DocumentGrammar
+;
+"""

{strictdoc-0.0.56a3 → strictdoc-0.0.56a4}/strictdoc/backend/sdoc/grammar/type_system.py

@@ -1,8 +1,4 @@
-NEGATIVE_MULTILINE_STRING_START = "(?!>>>\n)"
-NEGATIVE_MULTILINE_STRING_END = "(?!^<<<)"
-NEGATIVE_RELATIONS = "(?!^RELATIONS)"
-
-STRICTDOC_BASIC_TYPE_SYSTEM = rf"""
+STRICTDOC_BASIC_TYPE_SYSTEM = r"""
 BooleanChoice[noskipws]:
   ('True' | 'False')
 ;
@@ -15,23 +11,6 @@ ChoiceOptionXs[noskipws]:
   /, /- ChoiceOption
 ;
 
-FieldName[noskipws]:
-  /{NEGATIVE_RELATIONS}[A-Z]+[A-Z_]*/
-;
-
-// According to the Strict Grammar Rule #3, both SingleLineString and
-// MultiLineString can never be empty strings.
-// Both must eventualy start with a non-space character.
-SingleLineString:
-  /{NEGATIVE_MULTILINE_STRING_START}\S.*$/
-;
-
-MultiLineString[noskipws]:
-  />>>\n/-
-  /(?ms){NEGATIVE_MULTILINE_STRING_END} *{NEGATIVE_MULTILINE_STRING_END}\S({NEGATIVE_MULTILINE_STRING_END}.)+/
-  /^<<</-
-;
-
 RequirementType[noskipws]:
   !ReservedKeyword /[A-Z]+(_[A-Z]+)*/
 ;

{strictdoc-0.0.56a3 → strictdoc-0.0.56a4}/strictdoc/backend/sdoc/grammar_reader.py

@@ -1,4 +1,3 @@
-# mypy: disable-error-code="no-untyped-call,no-untyped-def"
 import sys
 import traceback
 from typing import Optional
@@ -8,27 +7,45 @@ from textx import metamodel_from_str
 from strictdoc.backend.sdoc.error_handling import StrictDocSemanticError
 from strictdoc.backend.sdoc.grammar.grammar_builder import SDocGrammarBuilder
 from strictdoc.backend.sdoc.models.constants import GRAMMAR_MODELS
-from strictdoc.backend.sdoc.models.document_grammar import DocumentGrammar
+from strictdoc.backend.sdoc.models.document_grammar import (
+    DocumentGrammar,
+    DocumentGrammarWrapper,
+)
 from strictdoc.backend.sdoc.pickle_cache import PickleCache
 from strictdoc.helpers.cast import assert_optional_cast
-from strictdoc.helpers.textx import drop_textx_meta
+from strictdoc.helpers.textx import (
+    drop_textx_meta,
+    preserve_source_location_data,
+)
 
 
 class SDocGrammarReader:
-    def __init__(self, path_to_output_root) -> None:
-        self.path_to_output_root = path_to_output_root
+    meta_model = metamodel_from_str(
+        SDocGrammarBuilder.create_grammar_grammar(),
+        classes=GRAMMAR_MODELS + [DocumentGrammarWrapper],
+        use_regexp_group=True,
+    )
+
+    def __init__(self, path_to_output_root: str) -> None:
+        self.path_to_output_root: str = path_to_output_root
 
     @staticmethod
-    def read(input_string, file_path=None) -> DocumentGrammar:
-        meta_model = metamodel_from_str(
-            SDocGrammarBuilder.create_grammar_grammar(),
-            classes=GRAMMAR_MODELS,
-            use_regexp_group=True,
+    def read(
+        input_string: str, file_path: Optional[str] = None
+    ) -> DocumentGrammar:
+        SDocGrammarReader.meta_model.register_obj_processors(
+            {
+                "GrammarElement": preserve_source_location_data,
+            }
         )
 
-        grammar: DocumentGrammar = meta_model.model_from_str(
-            input_string, file_name=file_path
+        grammar_wrapper: DocumentGrammarWrapper = (
+            SDocGrammarReader.meta_model.model_from_str(
+                input_string, file_name=file_path
+            )
         )
+        grammar: DocumentGrammar = grammar_wrapper.grammar
+        grammar.parent = None
 
         # HACK:
         # ProcessPoolExecutor doesn't work because of non-picklable parts
@@ -38,7 +55,7 @@ class SDocGrammarReader:
 
         return grammar
 
-    def read_from_file(self, file_path) -> DocumentGrammar:
+    def read_from_file(self, file_path: str) -> DocumentGrammar:
         unpickled_content: Optional[DocumentGrammar] = assert_optional_cast(
             PickleCache.read_from_cache(file_path, self.path_to_output_root),
             DocumentGrammar,

{strictdoc-0.0.56a3 → strictdoc-0.0.56a4}/strictdoc/backend/sdoc/models/document_grammar.py

@@ -97,6 +97,8 @@ class GrammarElement:
             statement_field or description_field or content_field or ("", -1)
         )
         self.mid: MID = MID.create()
+        self.ng_line_start: Optional[int] = None
+        self.ng_col_start: Optional[int] = None
 
     @staticmethod
     def create_default(tag: str):
@@ -178,9 +180,9 @@ class GrammarElement:
 class DocumentGrammar:
     def __init__(
         self,
+        parent,
         elements: List[GrammarElement],
         import_from_file: Optional[str] = None,
-        parent=None,
     ) -> None:
         self.parent = parent
         self.elements: List[GrammarElement] = elements
@@ -315,3 +317,9 @@ class DocumentGrammar:
         self.elements = elements
         self.registered_elements: Set[str] = registered_elements
         self.elements_by_type: Dict[str, GrammarElement] = elements_by_type
+
+
+class DocumentGrammarWrapper:
+    def __init__(self, grammar: DocumentGrammar):
+        assert isinstance(grammar, DocumentGrammar), grammar
+        self.grammar: DocumentGrammar = grammar