Merge pull request #2307 from strictdoc-project/stanislaw/req_prefix

backend/sdoc: alias REQ_PREFIX to PREFIX, adjust the code and tests to PREFIX

Author: stanislaw

docs/sphinx/source/strictdoc_01_user_guide.rst

@@ -588,7 +588,7 @@ The following ``DOCUMENT`` fields are allowed:
    * - ``CLASSIFICATION``
      - Security classification of the document, e.g. Public, Internal, Restricted, Confidential
 
-   * - ``REQ_PREFIX``
+   * - ``PREFIX``
      - Requirement prefix that should be used for automatic generation of UIDs. See :ref:`Automatic assignment of requirements UID <SECTION-UG-Automatic-assignment-of-requirements-UID>`.
 
    * - ``ROOT``
@@ -2116,15 +2116,15 @@ A document-level requirement mask:
 
     [DOCUMENT]
     TITLE: Hello world doc
-    REQ_PREFIX: MYDOC-
+    PREFIX: MYDOC-
 
 A section-level requirement mask:
 
 .. code-block::
 
     [SECTION]
     TITLE: Section 2.
-    REQ_PREFIX: LEVEL2-REQ-
+    PREFIX: LEVEL2-REQ-
 
 .. _SECTION-TRACEABILITY-REQS-TO-SOURCE-CODE:
 

docs/strictdoc_01_user_guide.sdoc

@@ -621,7 +621,7 @@ The following ``DOCUMENT`` fields are allowed:
    * - ``CLASSIFICATION``
      - Security classification of the document, e.g. Public, Internal, Restricted, Confidential
 
-   * - ``REQ_PREFIX``
+   * - ``PREFIX``
      - Requirement prefix that should be used for automatic generation of UIDs. See [LINK: SECTION-UG-Automatic-assignment-of-requirements-UID].
 
    * - ``ROOT``
@@ -2559,15 +2559,15 @@ A document-level requirement mask:
 
     [DOCUMENT]
     TITLE: Hello world doc
-    REQ_PREFIX: MYDOC-
+    PREFIX: MYDOC-
 
 A section-level requirement mask:
 
 .. code-block::
 
     [[SECTION]]
     TITLE: Section 2.
-    REQ_PREFIX: LEVEL2-REQ-
+    PREFIX: LEVEL2-REQ-
 <<<
 
 [[/SECTION]]

docs/strictdoc_02_feature_map.sdoc

@@ -4,7 +4,7 @@ TITLE: StrictDoc Feature Map
 UID: SDOC_FEATURE_MAP
 VERSION: Git commit: @GIT_VERSION, Git branch: @GIT_BRANCH
 DATE: @GIT_COMMIT_DATETIME
-REQ_PREFIX: SDOC-FEAT-
+PREFIX: SDOC-FEAT-
 OPTIONS:
   ENABLE_MID: True
   VIEW_STYLE: Narrative

docs/strictdoc_20_L1_Open_Requirements_Tool.sdoc

@@ -3,7 +3,7 @@ MID: b7bcca934cd148c3855beb4c85723bc5
 TITLE: Requirements Tool Specification (L1)
 VERSION: Git commit: @GIT_VERSION, Git branch: @GIT_BRANCH
 DATE: @GIT_COMMIT_DATETIME
-REQ_PREFIX: SDOC-SSS-
+PREFIX: SDOC-SSS-
 ROOT: True
 OPTIONS:
   ENABLE_MID: True

docs/strictdoc_21_L2_StrictDoc_Requirements.sdoc

@@ -3,7 +3,7 @@ MID: 8a87daf19a7c487f89f396406a974509
 TITLE: StrictDoc Requirements Specification (L2)
 VERSION: Git commit: @GIT_VERSION, Git branch: @GIT_BRANCH
 DATE: @GIT_COMMIT_DATETIME
-REQ_PREFIX: SDOC-SRS-
+PREFIX: SDOC-SRS-
 OPTIONS:
   ENABLE_MID: True
 

docs/strictdoc_28_Backlog.sdoc

@@ -3,7 +3,7 @@ MID: cabef7629dda4f2fb34255d01fea8d5f
 TITLE: StrictDoc Backlog
 VERSION: Git commit: @GIT_VERSION, Git branch: @GIT_BRANCH
 DATE: @GIT_COMMIT_DATETIME
-REQ_PREFIX: SDOC-BACKLOG-
+PREFIX: SDOC-BACKLOG-
 OPTIONS:
   ENABLE_MID: True
 

docs_extra/DO178_requirements.sdoc

@@ -4,7 +4,7 @@ TITLE: Technical Note: DO-178C requirements tool requirements
 VERSION: Git commit: @GIT_VERSION, Git branch: @GIT_BRANCH
 DATE: @GIT_COMMIT_DATETIME
 CLASSIFICATION: Draft
-REQ_PREFIX: DO178-
+PREFIX: DO178-
 ROOT: True
 OPTIONS:
   ENABLE_MID: True

docs_extra/Zephyr_requirements.sdoc

@@ -3,7 +3,7 @@ MID: 2e7deb9808bb42879e7463b1d7ac9bba
 TITLE: Technical Note: Zephyr requirements tool requirements
 VERSION: Git commit: @GIT_VERSION, Git branch: @GIT_BRANCH
 DATE: @GIT_COMMIT_DATETIME
-REQ_PREFIX: ZEP-
+PREFIX: ZEP-
 ROOT: True
 OPTIONS:
   ENABLE_MID: True

strictdoc/backend/sdoc/grammar/grammar.py

@@ -70,7 +70,7 @@
   ('VERSION: ' version = SingleLineString '\n')?
   ('DATE: ' date = SingleLineString '\n')?
   ('CLASSIFICATION: ' classification = SingleLineString '\n')?
-  ('REQ_PREFIX: ' requirement_prefix = SingleLineString '\n')?
+  (/(REQ_)?PREFIX/ ': ' requirement_prefix = SingleLineString '\n')?
   ('ROOT: ' (root = BooleanChoice) '\n')?
   ('OPTIONS:' '\n'
     ('  ENABLE_MID: ' (enable_mid = BooleanChoice) '\n')?
@@ -156,7 +156,7 @@
   ('UID: ' uid = /{REGEX_UID}/ '\n')?
   ('LEVEL: ' custom_level = SingleLineString '\n')?
   'TITLE: ' title = SingleLineString '\n'
-  ('REQ_PREFIX: ' requirement_prefix = SingleLineString '\n')?
+  (/(REQ_)?PREFIX/ ': ' requirement_prefix = SingleLineString '\n')?
   section_contents *= SectionOrRequirement
   '\n'
   '[/SECTION]'

strictdoc/backend/sdoc/writer.py

@@ -113,7 +113,7 @@ def write_with_fragments(
 
             requirement_prefix = document_config.requirement_prefix
             if requirement_prefix is not None:
-                output += f"REQ_PREFIX: {requirement_prefix}"
+                output += f"PREFIX: {requirement_prefix}"
                 output += "\n"
 
             root = document_config.root
@@ -418,7 +418,7 @@ def _print_section(
         output += str(section.title)
         output += "\n"
         if section.requirement_prefix is not None:
-            output += "REQ_PREFIX: "
+            output += "PREFIX: "
             output += section.requirement_prefix
             output += "\n"
 

strictdoc/cli/command_parser_builder.py

@@ -515,8 +515,8 @@ def add_manage_command(parent_command_parser):
             description=(
                 "This command generates missing requirement UID automatically. "
                 "The UIDs are generated based on the nearest section "
-                "REQ_PREFIX (if provided) or the document's "
-                'REQ_PREFIX (if provided or "REQ-" by default).'
+                "PREFIX (if provided) or the document's "
+                'PREFIX (if provided or "REQ-" by default).'
             ),
             formatter_class=formatter,
         )

strictdoc/export/html/form_objects/document_config_form_object.py

@@ -128,8 +128,8 @@ def create_from_request(
             )
 
         document_requirement_prefix: str = ""
-        if "REQ_PREFIX" in config_fields:
-            document_requirement_prefix = config_fields["REQ_PREFIX"]
+        if "PREFIX" in config_fields:
+            document_requirement_prefix = config_fields["PREFIX"]
             document_requirement_prefix = sanitize_html_form_field(
                 document_requirement_prefix, multiline=False
             )

strictdoc/export/html/templates/screens/document/document/frame_document_config_edit.jinja.html

@@ -55,10 +55,10 @@
 
       {%- with
         field_type="singleline",
-        field_name="REQ_PREFIX",
-        field_input_name="document[REQ_PREFIX]",
+        field_name="PREFIX",
+        field_input_name="document[PREFIX]",
         field_value=form_object.document_requirement_prefix,
-        errors=form_object.get_errors("REQ_PREFIX")
+        errors=form_object.get_errors("PREFIX")
       -%}
         {% include "components/form/field/text/index.jinja" %}
       {%- endwith -%}

strictdoc/export/json/json_generator.py

@@ -74,7 +74,7 @@ def export_tree(
     def _write_document(cls, document: SDocDocument) -> Dict[str, Any]:
         document_dict: Dict[str, Any] = {
             "TITLE": document.title,
-            "REQ_PREFIX": None,
+            "PREFIX": None,
             JSONKey.GRAMMAR: {"ELEMENTS": []},
             JSONKey.OPTIONS: {},
             JSONKey.NODES: [],
@@ -99,7 +99,7 @@ def _write_document(cls, document: SDocDocument) -> Dict[str, Any]:
 
             requirement_prefix = document_config.requirement_prefix
             if requirement_prefix is not None:
-                document_dict["REQ_PREFIX"] = requirement_prefix
+                document_dict["PREFIX"] = requirement_prefix
 
             root = document_config.root
             if root is not None:
@@ -294,7 +294,7 @@ def _write_section(
             node_dict["LEVEL"] = section.custom_level
 
         if section.requirement_prefix is not None:
-            node_dict["REQ_PREFIX"] = section.requirement_prefix
+            node_dict["PREFIX"] = section.requirement_prefix
 
         return node_dict
 

tests/end2end/helpers/screens/document/form_edit_config.py

@@ -62,7 +62,7 @@ def do_fill_in_document_requirement_prefix(
         self, field_value: str, field_order: int = 1
     ) -> None:
         assert isinstance(field_value, str)
-        super().do_fill_in("document[REQ_PREFIX]", field_value, field_order)
+        super().do_fill_in("document[PREFIX]", field_value, field_order)
 
     def do_fill_in_document_abstract(
         self, field_value: str, field_order: int = 1

tests/end2end/screens/document/create_requirement/_autouid_and_PREFIX/create_requirement_generate_autouid_when_requirement_with_another_prefix_exists/expected_output/document.sdoc

@@ -1,6 +1,6 @@
 [DOCUMENT]
 TITLE: Document 1
-REQ_PREFIX: ZEP-
+PREFIX: ZEP-
 
 [REQUIREMENT]
 UID: ZEP-1

tests/end2end/screens/document/create_requirement/_autouid_and_PREFIX/create_requirement_generate_autouid_when_requirement_with_another_prefix_exists/expected_output/document2.sdoc

@@ -1,6 +1,6 @@
 [DOCUMENT]
 TITLE: Document 1
-REQ_PREFIX: ZEP-
+PREFIX: ZEP-
 
 [REQUIREMENT]
 UID: ZEP-2

tests/end2end/screens/document/create_requirement/_autouid_and_PREFIX/create_requirement_generate_autouid_when_requirement_with_another_prefix_exists/input/document.sdoc

@@ -1,6 +1,6 @@
 [DOCUMENT]
 TITLE: Document 1
-REQ_PREFIX: ZEP-
+PREFIX: ZEP-
 
 [REQUIREMENT]
 UID: ZEP-1

tests/end2end/screens/document/create_requirement/_autouid_and_PREFIX/create_requirement_generate_autouid_when_requirement_with_another_prefix_exists/input/document2.sdoc

@@ -1,6 +1,6 @@
 [DOCUMENT]
 TITLE: Document 1
-REQ_PREFIX: ZEP-
+PREFIX: ZEP-
 
 [REQUIREMENT]
 UID: ZEP-2

tests/end2end/screens/document/update_document_config/update_document_config_requirement_prefix/expected_output/document.sdoc

@@ -1,6 +1,6 @@
 [DOCUMENT]
 TITLE: Document 1
-REQ_PREFIX: PREFIX-
+PREFIX: PREFIX-
 
 [REQUIREMENT]
 TITLE: Requirement title

tests/integration/features/commands/bypass/03_basic_document_test/input.sdoc

@@ -4,5 +4,5 @@ UID: DOC-1
 VERSION: 1
 DATE: 2025-01-14
 CLASSIFICATION: TESTING
-REQ_PREFIX: REQ-
+PREFIX: REQ-
 ROOT: True

tests/integration/features/commands/manage/auto-uid/requirement_uids/03_requirement_prefix_document_level/input.expected.sdoc

@@ -1,6 +1,6 @@
 [DOCUMENT]
 TITLE: Hello world doc
-REQ_PREFIX: DOC-
+PREFIX: DOC-
 
 [REQUIREMENT]
 UID: DOC-1

tests/integration/features/commands/manage/auto-uid/requirement_uids/03_requirement_prefix_document_level/input.sdoc

@@ -1,6 +1,6 @@
 [DOCUMENT]
 TITLE: Hello world doc
-REQ_PREFIX: DOC-
+PREFIX: DOC-
 
 [REQUIREMENT]
 UID: DOC-1

tests/integration/features/commands/manage/auto-uid/requirement_uids/04_requirement_prefix_section_level/input.expected.sdoc

@@ -1,10 +1,10 @@
 [DOCUMENT]
 TITLE: Hello world doc
-REQ_PREFIX: DOC-
+PREFIX: DOC-
 
 [SECTION]
 TITLE: Section 1
-REQ_PREFIX: LEVEL1-REQ-
+PREFIX: LEVEL1-REQ-
 
 [REQUIREMENT]
 UID: LEVEL1-REQ-1
@@ -18,7 +18,7 @@ STATEMENT: System shall do L1-1.
 
 [SECTION]
 TITLE: Section 2
-REQ_PREFIX: LEVEL2-REQ-
+PREFIX: LEVEL2-REQ-
 
 [REQUIREMENT]
 UID: LEVEL2-REQ-2

tests/integration/features/commands/manage/auto-uid/requirement_uids/04_requirement_prefix_section_level/input.sdoc

@@ -1,10 +1,10 @@
 [DOCUMENT]
 TITLE: Hello world doc
-REQ_PREFIX: DOC-
+PREFIX: DOC-
 
 [SECTION]
 TITLE: Section 1
-REQ_PREFIX: LEVEL1-REQ-
+PREFIX: LEVEL1-REQ-
 
 [REQUIREMENT]
 UID: LEVEL1-REQ-1
@@ -17,7 +17,7 @@ STATEMENT: System shall do L1-1.
 
 [SECTION]
 TITLE: Section 2
-REQ_PREFIX: LEVEL2-REQ-
+PREFIX: LEVEL2-REQ-
 
 [REQUIREMENT]
 STATEMENT: System shall do L2-1.

tests/integration/features/commands/manage/auto-uid/requirement_uids/05_requirement_prefix_grammar_element_level/input.expected.sdoc

@@ -1,6 +1,6 @@
 [DOCUMENT]
 TITLE: Hello world doc
-REQ_PREFIX: DOC-
+PREFIX: DOC-
 
 [GRAMMAR]
 ELEMENTS:

tests/integration/features/commands/manage/auto-uid/requirement_uids/05_requirement_prefix_grammar_element_level/input.sdoc

@@ -1,6 +1,6 @@
 [DOCUMENT]
 TITLE: Hello world doc
-REQ_PREFIX: DOC-
+PREFIX: DOC-
 
 [GRAMMAR]
 ELEMENTS:

tests/integration/features/commands/manage/auto-uid/requirement_uids/08_works_across_documents_custom_prefix/input1.expected.sdoc

@@ -1,6 +1,6 @@
 [DOCUMENT]
 TITLE: Hello world doc 1
-REQ_PREFIX: ZEP-
+PREFIX: ZEP-
 
 [REQUIREMENT]
 UID: ZEP-1

tests/integration/features/commands/manage/auto-uid/requirement_uids/08_works_across_documents_custom_prefix/input1.sdoc

@@ -1,6 +1,6 @@
 [DOCUMENT]
 TITLE: Hello world doc 1
-REQ_PREFIX: ZEP-
+PREFIX: ZEP-
 
 [REQUIREMENT]
 STATEMENT: System 1 shall do 1.

tests/integration/features/commands/manage/auto-uid/requirement_uids/08_works_across_documents_custom_prefix/input2.expected.sdoc

@@ -1,6 +1,6 @@
 [DOCUMENT]
 TITLE: Hello world doc 2
-REQ_PREFIX: ZEP-
+PREFIX: ZEP-
 
 [REQUIREMENT]
 UID: ZEP-4

tests/integration/features/commands/manage/auto-uid/requirement_uids/08_works_across_documents_custom_prefix/input2.sdoc

@@ -1,6 +1,6 @@
 [DOCUMENT]
 TITLE: Hello world doc 2
-REQ_PREFIX: ZEP-
+PREFIX: ZEP-
 
 [REQUIREMENT]
 STATEMENT: System 2 shall do 1.

tests/unit/strictdoc/backend/sdoc/test_dsl_passthrough.py

@@ -534,7 +534,7 @@ def test_073_document_config_requirement_prefix(default_project_config):
 TITLE: Test Doc
 UID: SDOC-01
 VERSION: 0.0.1
-REQ_PREFIX: DOC-
+PREFIX: DOC-
 
 [REQUIREMENT]
 STATEMENT: ...