Merge pull request #2589 from strictdoc-project/stanislaw/single_choice_regex

feat(backend/sdoc): support SingleChoice values with parentheses

Author: stanislaw

strictdoc/backend/sdoc/grammar/type_system.py

@@ -4,7 +4,7 @@
 ;
 
 ChoiceOption[noskipws]:
-  /[\w\/|-]+( *[\w\/|-]+)*/
+  /(["])[^,]+\1|[^,()"]+/
 ;
 
 ChoiceOptionXs[noskipws]:

strictdoc/backend/sdoc/models/grammar_element.py

@@ -83,10 +83,24 @@ def __init__(
         self.title: str = title
         self.human_title: Optional[str] = human_title
         self.gef_type = RequirementFieldType.SINGLE_CHOICE
-        self.options: List[str] = options
+
+        processed_options = []
+        for option_ in options:
+            processed_options.append(option_.strip('"'))
+        self.options: List[str] = processed_options
+
         self.required: bool = required == "True"
         self.mid: MID = MID.create()
 
+    def get_unprocessed_options(self) -> List[str]:
+        unprocessed_options = []
+        for option_ in self.options:
+            if any(char_ in option_ for char_ in ["(", ")"]):
+                unprocessed_options.append('"' + option_ + '"')
+            else:
+                unprocessed_options.append(option_)
+        return unprocessed_options
+
 
 @auto_described
 class GrammarElementFieldMultipleChoice(GrammarElementField):

strictdoc/backend/sdoc/writer.py

@@ -458,7 +458,7 @@ def _print_grammar_field_type(
         elif isinstance(grammar_field, GrammarElementFieldSingleChoice):
             output += RequirementFieldType.SINGLE_CHOICE
             output += "("
-            output += ", ".join(grammar_field.options)
+            output += ", ".join(grammar_field.get_unprocessed_options())
             output += ")"
         elif isinstance(grammar_field, GrammarElementFieldMultipleChoice):
             output += RequirementFieldType.MULTIPLE_CHOICE

tests/integration/features/reqif/profiles/p01_sdoc/end_to_end/31_custom_grammar_single_choice_type/sample.sdoc

@@ -8,9 +8,13 @@ ELEMENTS:
   - TITLE: CHOICE_FIELD
     TYPE: SingleChoice(A, B, C, D)
     REQUIRED: False
+  - TITLE: CHOICE_FIELD_2
+    TYPE: SingleChoice("A(B)", "B(C)", "C(D)")
+    REQUIRED: False
   - TITLE: STATEMENT
     TYPE: String
     REQUIRED: False
 
 [REQUIREMENT]
 CHOICE_FIELD: A
+CHOICE_FIELD_2: A(B)

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

@@ -2,16 +2,19 @@
 @relation(SDOC-SRS-136, scope=file)
 """
 
+import pytest
+
 from strictdoc.backend.sdoc.models.document import SDocDocument
 from strictdoc.backend.sdoc.models.node import SDocNode
 from strictdoc.backend.sdoc.reader import SDReader
 from strictdoc.backend.sdoc.validations.sdoc_validator import SDocValidator
 from strictdoc.backend.sdoc.writer import SDWriter
 from strictdoc.helpers.cast import assert_cast
+from strictdoc.helpers.exception import StrictDocException
 from tests.unit.helpers.fake_document_meta import create_fake_document_meta
 
 
-def test_150_grammar_minimal_doc(default_project_config):
+def test_01_grammar_minimal_doc(default_project_config):
     input_sdoc = """
 [DOCUMENT]
 TITLE: Test Doc
@@ -58,7 +61,7 @@ def test_150_grammar_minimal_doc(default_project_config):
     assert expected_sdoc == output
 
 
-def test_151_grammar_single_choice(default_project_config):
+def test_10_grammar_single_choice(default_project_config):
     input_sdoc = """
 [DOCUMENT]
 TITLE: Test Doc
@@ -81,27 +84,93 @@ def test_151_grammar_single_choice(default_project_config):
   - TITLE: SINGLE_CHOICE_FIELD_3
     TYPE: SingleChoice(Hardware test, Software test)
     REQUIRED: True
+  - TITLE: SINGLE_CHOICE_FIELD_4
+    TYPE: SingleChoice("A(B)", "B(C)")
+    REQUIRED: True
   - TITLE: STATEMENT
     TYPE: String
     REQUIRED: False
 
 [LOW_LEVEL_REQUIREMENT]
 SINGLE_CHOICE_FIELD: A
-SINGLE_CHOICE_FIELD: Test/Hardware
-SINGLE_CHOICE_FIELD: Hardware test
+SINGLE_CHOICE_FIELD_2: Test/Hardware
+SINGLE_CHOICE_FIELD_3: Hardware test
+SINGLE_CHOICE_FIELD_4: A(B)
 """.lstrip()
 
     reader = SDReader()
 
     document = reader.read(input_sdoc)
     assert isinstance(document, SDocDocument)
 
+    assert len(document.section_contents) == 1
+    field_4 = document.grammar.elements_by_type["LOW_LEVEL_REQUIREMENT"].fields[
+        3
+    ]
+    assert field_4.options == ["A(B)", "B(C)"]
+
     writer = SDWriter(default_project_config)
     output = writer.write(document)
 
     assert input_sdoc == output
 
 
+def test_15_grammar_single_choice_with_branches_but_no_quotes_raises_exception():
+    input_sdoc = """
+[DOCUMENT]
+TITLE: Test Doc
+
+[GRAMMAR]
+ELEMENTS:
+- TAG: TEXT
+  FIELDS:
+  - TITLE: STATEMENT
+    TYPE: String
+    REQUIRED: True
+- TAG: LOW_LEVEL_REQUIREMENT
+  FIELDS:
+  - TITLE: SINGLE_CHOICE_FIELD
+    TYPE: SingleChoice(A(B))
+    REQUIRED: True
+  - TITLE: STATEMENT
+    TYPE: String
+    REQUIRED: False
+""".lstrip()
+
+    reader = SDReader()
+
+    with pytest.raises(StrictDocException):
+        _ = reader.read(input_sdoc)
+
+
+def test_16_grammar_single_choice_with_unmatched_quotes_raises_exception():
+    input_sdoc = """
+[DOCUMENT]
+TITLE: Test Doc
+
+[GRAMMAR]
+ELEMENTS:
+- TAG: TEXT
+  FIELDS:
+  - TITLE: STATEMENT
+    TYPE: String
+    REQUIRED: True
+- TAG: LOW_LEVEL_REQUIREMENT
+  FIELDS:
+  - TITLE: SINGLE_CHOICE_FIELD
+    TYPE: SingleChoice("A)
+    REQUIRED: True
+  - TITLE: STATEMENT
+    TYPE: String
+    REQUIRED: False
+""".lstrip()
+
+    reader = SDReader()
+
+    with pytest.raises(StrictDocException):
+        _ = reader.read(input_sdoc)
+
+
 def test_152_grammar_multiple_choice(default_project_config):
     input_sdoc = """\
 [DOCUMENT]