strictdoc 0.0.56a2__tar.gz → 0.0.56a4__tar.gz

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

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: strictdoc
-Version: 0.0.56a2
+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/
@@ -28,7 +28,7 @@ Requires-Dist: html5lib>=1.1
 Requires-Dist: jinja2>=2.11.2
 Requires-Dist: lxml==4.*,>=4.6.2
 Requires-Dist: pygments==2.*,>=2.10.0
-Requires-Dist: python-datauri==0.*,>=0.2.9
+Requires-Dist: python-datauri==2.*,>=2.1.1
 Requires-Dist: python-multipart
 Requires-Dist: reqif==0.*,>=0.0.39
 Requires-Dist: requests

{strictdoc-0.0.56a2 → strictdoc-0.0.56a4}/pyproject.toml

@@ -66,7 +66,7 @@ dependencies = [
     # Static HTML export with embedded assets.
     "beautifulsoup4 >= 4.12.0, == 4.*",
     "html5lib>=1.1",  # Used by beautifulsoup4 as an optional plugin.
-    "python-datauri >= 0.2.9, == 0.*",
+    "python-datauri >= 2.1.1, == 2.*",
 
     # Excel
     "XlsxWriter >= 1.3.7, == 1.*",

{strictdoc-0.0.56a2 → strictdoc-0.0.56a4}/strictdoc/__init__.py

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

{strictdoc-0.0.56a2 → strictdoc-0.0.56a4}/strictdoc/backend/excel/export/excel_generator.py

@@ -98,7 +98,11 @@ class ExcelGenerator:
                         field_uc = field.upper()
 
                         # Special treatment for ParentReqReference and Comments
-                        if field_uc in ("REFS:PARENT", "PARENT", "PARENTS"):
+                        if field_uc in (
+                            "RELATIONS:PARENT",
+                            "PARENT",
+                            "PARENTS",
+                        ):
                             parent_refs = node.get_requirement_references(
                                 ReferenceType.PARENT
                             )
@@ -129,47 +133,50 @@ class ExcelGenerator:
                             # Using a transition marker to separate multiple
                             # comments
                             if node.comments:
-                                value = ""
+                                comment_row_value: str = ""
                                 for comment in node.comments:
-                                    if len(value) > 0:
-                                        value += "\n----------\n"
-                                    value += comment
-                                worksheet.write(row, idx, value)
+                                    if len(comment_row_value) > 0:
+                                        comment_row_value += "\n----------\n"
+                                    comment_row_value += comment
+                                worksheet.write(row, idx, comment_row_value)
                                 if (
-                                    value
-                                    and len(value)
+                                    comment_row_value
+                                    and len(comment_row_value)
                                     > columns[field][MAX_WIDTH_KEY]
                                 ):
-                                    columns[field][MAX_WIDTH_KEY] = len(value)
-                        elif field_uc in node.ordered_fields_lookup.keys():
-                            req_field = node.ordered_fields_lookup[field_uc][0]
-                            value = ""
-                            if req_field.field_value_references:
+                                    columns[field][MAX_WIDTH_KEY] = len(
+                                        comment_row_value
+                                    )
+                        elif field_uc == "RELATIONS":
+                            if len(node.relations) > 0:
+                                relations_components = []
                                 # Using a transition marker to separate
                                 # multiple references
-                                for ref in req_field.field_value_references:
-                                    if len(value) > 0:
-                                        value += "----------\n"
+                                for ref in node.relations:
                                     if isinstance(ref, ParentReqReference):
-                                        value += (
-                                            ref.ref_type
-                                            + ": "
-                                            + ref.ref_uid
-                                            + "\n"
+                                        relations_components.append(
+                                            ref.ref_type + ": " + ref.ref_uid
                                         )
                                     elif isinstance(ref, FileReference):
-                                        value += (
+                                        relations_components.append(
                                             ref.ref_type
                                             + ": "
                                             + ref.get_posix_path()
-                                            + "\n"
                                         )
-                            else:
-                                value = req_field.get_value()
+                                relations_row_value: str = (
+                                    "\n----------\n".join(relations_components)
+                                )
+                                worksheet.write(row, idx, relations_row_value)
+                                value_len = len(relations_row_value)
+                                if value_len > columns[field][MAX_WIDTH_KEY]:
+                                    columns[field][MAX_WIDTH_KEY] = value_len
+                        elif field_uc in node.ordered_fields_lookup.keys():
+                            req_field = node.ordered_fields_lookup[field_uc][0]
+                            value: str = req_field.get_value()
                             worksheet.write(row, idx, value)
-                            vallength = len(value)
-                            if vallength > columns[field][MAX_WIDTH_KEY]:
-                                columns[field][MAX_WIDTH_KEY] = vallength
+                            value_len = len(value)
+                            if value_len > columns[field][MAX_WIDTH_KEY]:
+                                columns[field][MAX_WIDTH_KEY] = value_len
                         elif hasattr(node, "special_fields"):
                             if len(node.special_fields):
                                 for special_field in node.special_fields:

{strictdoc-0.0.56a2 → 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):
@@ -38,7 +39,6 @@ def safe_name(dangerous_name):
     return dangerous_name
 
 
-# pylint: disable=too-many-instance-attributes
 class ExcelToSDocConverter:
     @staticmethod
     # optional argument title is present for external scripts to assign a title
@@ -173,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()
@@ -187,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,
@@ -197,34 +197,24 @@ 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_references=None,
+                        field_value=ensure_newline(value),
+                        multiline=True,
                     )
                 ]
         if parent_uid is not None:
             reference = ParentReqReference(
                 template_requirement, parent_uid, role=None
             )
-
-            requirement_field = SDocNodeField(
-                parent=template_requirement,
-                field_name="REFS",
-                field_value=None,
-                field_value_multiline=None,
-                field_value_references=[reference],
-            )
-            template_requirement.ordered_fields_lookup["REFS"] = [
-                requirement_field
-            ]
+            template_requirement.relations = [reference]
         requirement = SDocNode(
             parent=template_requirement.parent,
             requirement_type=template_requirement.requirement_type,
             mid=None,
             fields=list(template_requirement.enumerate_fields()),
+            relations=template_requirement.relations,
         )
 
         return requirement

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

@@ -32,12 +32,12 @@ from strictdoc.backend.sdoc.models.reference import (
 from strictdoc.backend.sdoc.models.section import SDocSection
 from strictdoc.backend.sdoc.models.type_system import (
     GrammarElementFieldMultipleChoice,
-    GrammarElementFieldReference,
     GrammarElementFieldSingleChoice,
     GrammarElementFieldString,
 )
 from strictdoc.helpers.string import (
     create_safe_requirement_tag_string,
+    ensure_newline,
     unescape,
 )
 
@@ -237,7 +237,6 @@ class P01_ReqIFToSDocConverter:
                 GrammarElementFieldString,
                 GrammarElementFieldMultipleChoice,
                 GrammarElementFieldSingleChoice,
-                GrammarElementFieldReference,
             ]
         ] = []
         for attribute in spec_object_type.attribute_definitions:
@@ -339,8 +338,6 @@ class P01_ReqIFToSDocConverter:
             document_config.markup = context.import_markup
 
         document.grammar = DocumentGrammar.create_default(document)
-        # FIXME: One day this will go away.
-        document.ng_at_least_one_relations_field = False
         return document
 
     @staticmethod
@@ -463,41 +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,
-                        field_value_references=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,
-                    field_value_references=None,
+                    multiline=multiline,
                 )
             )
 
@@ -514,10 +516,9 @@ class P01_ReqIFToSDocConverter:
             requirement_type=grammar_element.tag,
             mid=requirement_mid,
             fields=fields,
+            relations=[],
         )
         requirement.ng_level = level
-        # FIXME: One day this will go away.
-        requirement.ng_uses_old_refs_field = False
 
         if foreign_key_id_or_none is not None:
             spec_object_parents = reqif_bundle.get_spec_object_parents(
@@ -541,15 +542,7 @@ class P01_ReqIFToSDocConverter:
                     )
                 )
             if len(parent_refs) > 0:
-                requirement_field = SDocNodeField(
-                    parent=requirement,
-                    field_name="REFS",
-                    field_value=None,
-                    field_value_multiline=None,
-                    field_value_references=parent_refs,
-                )
-                fields.append(requirement_field)
-                requirement.ordered_fields_lookup["REFS"] = [requirement_field]
+                requirement.relations = parent_refs
         return requirement
 
     @staticmethod

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

@@ -38,15 +38,14 @@ from strictdoc.backend.reqif.sdoc_reqif_fields import (
 from strictdoc.backend.sdoc.models.document import SDocDocument
 from strictdoc.backend.sdoc.models.document_grammar import DocumentGrammar
 from strictdoc.backend.sdoc.models.node import SDocNode
+from strictdoc.backend.sdoc.models.reference import ParentReqReference
 from strictdoc.backend.sdoc.models.section import SDocSection
 from strictdoc.backend.sdoc.models.type_system import (
     GrammarElementField,
     GrammarElementFieldMultipleChoice,
-    GrammarElementFieldReference,
     GrammarElementFieldSingleChoice,
     GrammarElementFieldString,
     ReferenceType,
-    RequirementFieldName,
 )
 from strictdoc.backend.sdoc.writer import SDWriter
 from strictdoc.core.document_iterator import DocumentCachingIterator
@@ -206,24 +205,6 @@ class P01_SDocToReqIFObjectConverter:
                         )
                         data_types.append(data_type)
                         data_types_lookup[field.title] = data_type.identifier
-                    elif isinstance(field, GrammarElementFieldReference):
-                        # TODO: implement correct reqIF Encoding for
-                        #  GrammarElementFieldReference. Treat as
-                        #  GrammarElementFieldString for now.
-                        if (
-                            StrictDocReqIFTypes.SINGLE_LINE_STRING.value
-                            in data_types_lookup
-                        ):
-                            continue
-                        data_type = ReqIFDataTypeDefinitionString.create(
-                            identifier=(
-                                StrictDocReqIFTypes.SINGLE_LINE_STRING.value
-                            ),
-                        )
-                        data_types.append(data_type)
-                        data_types_lookup[
-                            StrictDocReqIFTypes.SINGLE_LINE_STRING.value
-                        ] = data_type.identifier
                     else:
                         raise NotImplementedError(field) from None
 
@@ -562,17 +543,6 @@ class P01_SDocToReqIFObjectConverter:
 
         attributes: List[SpecObjectAttribute] = []
         for field in requirement.fields_as_parsed:
-            if field.field_name == RequirementFieldName.REFS:
-                parent_references: List[str] = []
-                for reference in field.field_value_references:
-                    if reference.ref_type != ReferenceType.PARENT:
-                        continue
-                    parent_references.append(reference.ref_uid)
-                    assert requirement.reserved_uid is not None
-                    context.map_uid_to_parent_uids[requirement.reserved_uid] = (
-                        parent_references
-                    )
-                continue
             grammar_field = grammar_element.fields_map[field.field_name]
             if isinstance(grammar_field, GrammarElementFieldSingleChoice):
                 data_type_ref = data_types_lookup[field.field_name]
@@ -581,7 +551,7 @@ class P01_SDocToReqIFObjectConverter:
                 for data_type in data_types:
                     if data_type_ref == data_type.identifier:
                         for data_type_value in data_type.values:
-                            if data_type_value.key == field.field_value:
+                            if data_type_value.key == field.get_value():
                                 enum_ref_value = data_type_value.identifier
                                 break
 
@@ -594,7 +564,7 @@ class P01_SDocToReqIFObjectConverter:
                     value=[enum_ref_value],
                 )
             elif isinstance(grammar_field, GrammarElementFieldMultipleChoice):
-                field_values: List[str] = field.field_value.split(",")
+                field_values: List[str] = field.get_value().split(",")
                 field_values = list(map(lambda v: v.strip(), field_values))
 
                 data_type_ref = data_types_lookup[field.field_name]
@@ -618,13 +588,9 @@ class P01_SDocToReqIFObjectConverter:
                     value=field_values_refs,
                 )
             elif isinstance(grammar_field, GrammarElementFieldString):
-                is_multiline_field = field.field_value_multiline is not None
+                is_multiline_field = field.is_multiline()
 
-                field_value: str = (
-                    field.field_value_multiline
-                    if field.field_value_multiline is not None
-                    else assert_cast(field.field_value, str)
-                )
+                field_value: str = field.get_value().rstrip()
 
                 attribute_type: str
                 if context.multiline_is_xhtml:
@@ -650,6 +616,20 @@ class P01_SDocToReqIFObjectConverter:
                 raise NotImplementedError(grammar_field) from None
             attributes.append(attribute)
 
+        if requirement.reserved_uid is not None:
+            parent_references: List[str] = []
+            for reference in requirement.relations:
+                if reference.ref_type != ReferenceType.PARENT:
+                    continue
+                parent_reference: ParentReqReference = assert_cast(
+                    reference, ParentReqReference
+                )
+                parent_references.append(parent_reference.ref_uid)
+
+            context.map_uid_to_parent_uids[requirement.reserved_uid] = (
+                parent_references
+            )
+
         spec_object_type: ReqIFSpecObjectType = (
             context.map_grammar_node_tags_to_spec_object_type[
                 requirement.document
@@ -728,22 +708,6 @@ class P01_SDocToReqIFObjectConverter:
                         long_name=field.title,
                         multi_valued=True,
                     )
-                elif isinstance(field, GrammarElementFieldReference):
-                    # TODO: implement correct reqIF Encoding for
-                    #  GrammarElementFieldReference. Treat as
-                    #  GrammarElementFieldString for now.
-                    field_title = field.title
-                    if field_title in SDocRequirementReservedField.SET:
-                        field_title = SDOC_TO_REQIF_FIELD_MAP[field_title]
-                    attribute = SpecAttributeDefinition.create(
-                        attribute_type=SpecObjectAttributeType.STRING,
-                        identifier=field_title,
-                        datatype_definition=(
-                            StrictDocReqIFTypes.SINGLE_LINE_STRING.value
-                        ),
-                        long_name=field_title,
-                    )
-
                 else:
                     raise NotImplementedError(field) from None
                 attribute_definitions.append(attribute)

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

@@ -32,11 +32,10 @@ from strictdoc.backend.sdoc.models.reference import (
 from strictdoc.backend.sdoc.models.section import SDocSection
 from strictdoc.backend.sdoc.models.type_system import (
     GrammarElementFieldMultipleChoice,
-    GrammarElementFieldReference,
     GrammarElementFieldSingleChoice,
     GrammarElementFieldString,
 )
-from strictdoc.helpers.string import unescape
+from strictdoc.helpers.string import ensure_newline, unescape
 
 
 class P02_ReqIFToSDocBuildContext:
@@ -199,7 +198,6 @@ class P02_ReqIFToSDocConverter:
                 GrammarElementFieldString,
                 GrammarElementFieldMultipleChoice,
                 GrammarElementFieldSingleChoice,
-                GrammarElementFieldReference,
             ]
         ] = []
         for attribute in spec_object_type.attribute_definitions:
@@ -297,8 +295,6 @@ class P02_ReqIFToSDocConverter:
             document_config.markup = context.import_markup
 
         document.grammar = DocumentGrammar.create_default(document)
-        # FIXME: One day this will go away.
-        document.ng_at_least_one_relations_field = False
         return document
 
     @staticmethod
@@ -421,41 +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,
-                        field_value_references=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,
-                    field_value_references=None,
+                    multiline=multiline,
                 )
             )
 
@@ -465,10 +461,9 @@ class P02_ReqIFToSDocConverter:
             requirement_type="REQUIREMENT",
             mid=requirement_mid,
             fields=fields,
+            relations=[],
         )
         requirement.ng_level = level
-        # FIXME: One day this will go away.
-        requirement.ng_uses_old_refs_field = False
 
         if foreign_key_id_or_none is not None:
             spec_object_parents = reqif_bundle.get_spec_object_parents(
@@ -492,13 +487,5 @@ class P02_ReqIFToSDocConverter:
                     )
                 )
             if len(parent_refs) > 0:
-                requirement_field = SDocNodeField(
-                    parent=requirement,
-                    field_name="REFS",
-                    field_value=None,
-                    field_value_multiline=None,
-                    field_value_references=parent_refs,
-                )
-                fields.append(requirement_field)
-                requirement.ordered_fields_lookup["REFS"] = [requirement_field]
+                requirement.relations = parent_refs
         return requirement