Merge pull request #2391 from strictdoc-project/stanislaw/new_section_included_documents

 UI: Edit Grammar Element: support updating composite nodes and HUMAN_TITLE fields

Author: stanislaw

docs/strictdoc_04_release_notes.sdoc

@@ -45,14 +45,32 @@ STATEMENT: >>>
 This document maintains a record of all changes to StrictDoc since November 2023. It serves as a user-friendly version of the changelog, complementing the automatically generated, commit-by-commit changelog available as GitHub releases: `StrictDoc Releases <https://github.com/strictdoc-project/strictdoc/releases>`_.
 <<<
 
+[[SECTION]]
+MID: a5ab8dd5bc4045e99299eff729e430e6
+TITLE: Unreleased
+
+[TEXT]
+MID: 6d0bb97e7ef74fc1ae93cf2a91480e6a
+STATEMENT: >>>
+This release includes the following enhancements and bugfixes.
+
+**Fix for updating HUMAN_TITLE in Edit Grammar Element UI.**
+
+This change removes a previously implemented "clever" optimization that skipped saving a grammar element if none of its fields appeared to be modified. Over time, this check became outdated due to the introduction of new grammar element features such as HUMAN_TITLE, PROPERTIES/IS_COMPOSITE, PROPERTIES/VIEW_STYLE, and others. As a result, the issue manifested as a no-op where updates, such as changing a HUMAN_TITLE, were not saved to disk after submitting the form.
+
+Thanks to @zheylmun for reporting this issue.
+<<<
+
+[[/SECTION]]
+
 [[SECTION]]
 MID: 447ab1fa1d38453ab46e0002e6eb852d
 TITLE: 0.10.0 (2025-07-20)
 
 [TEXT]
 MID: c536381cea6842f0b77c1aa5ac942ce0
 STATEMENT: >>>
-This release includes the following enhancements.
+This release includes the following enhancements and bugfixes.
 
 **1) A small improvement to the behavior of the LEVEL/AUTO_LEVEL fields.**
 

strictdoc/core/transforms/update_grammar_element.py

@@ -29,7 +29,7 @@ def __init__(
         self.document: SDocDocument = document
         self.traceability_index: TraceabilityIndex = traceability_index
 
-    def perform(self) -> bool:
+    def perform(self) -> None:
         form_object: GrammarElementFormObject = self.form_object
         document: SDocDocument = self.document
         existing_element: GrammarElement = document.grammar.get_element_by_mid(
@@ -61,23 +61,9 @@ def perform(self) -> bool:
         #
         document_grammar_field_names = updated_element.get_field_titles()
 
-        existing_document_grammar_field_names = (
-            existing_element.get_field_titles()
-        )
-        grammar_changed = (
-            document_grammar_field_names
-            != existing_document_grammar_field_names
-        )
         existing_requirement_element = document.grammar.elements_by_type[
             existing_element.tag
         ]
-        grammar_changed = (
-            grammar_changed
-            or existing_requirement_element.relations
-            != updated_element.relations
-        )
-        if not grammar_changed:
-            return False
 
         document.grammar.update_element(existing_element, updated_element)
 
@@ -138,5 +124,3 @@ def perform(self) -> bool:
                         new_relations.append(requirement_relation_)
                 requirement.relations = new_relations
             requirement.ordered_fields_lookup = new_ordered_fields_lookup
-
-        return True

strictdoc/export/html/form_objects/grammar_element_form_object.py

@@ -80,6 +80,12 @@ def get_input_field_name(self) -> str:
     def get_input_field_human_title(self) -> str:
         return f"document_grammar_field[{self.field_mid}][field_human_title]"
 
+    def get_input_field_required(self) -> str:
+        return f"document_grammar_field[{self.field_mid}][field_required]"
+
+    def get_input_field_required_value(self) -> str:
+        return "true" if self.field_required else "false"
+
 
 @auto_described
 class GrammarFormRelation:
@@ -110,6 +116,9 @@ def __init__(
         document_mid: str,
         element_mid: str,
         element_name: str,
+        is_composite: Optional[bool],
+        prefix: Optional[str],
+        view_style: Optional[str],
         fields: List[GrammarFormField],
         relations: List[GrammarFormRelation],
         project_config: ProjectConfig,
@@ -120,6 +129,9 @@ def __init__(
         self.document_mid = document_mid
         self.element_mid: str = element_mid
         self.element_name: str = element_name
+        self.is_composite: Optional[bool] = is_composite
+        self.prefix: Optional[str] = prefix
+        self.view_style: Optional[str] = view_style
         self.fields: List[GrammarFormField] = fields
         self.relations: List[GrammarFormRelation] = relations
         self.project_config: ProjectConfig = project_config
@@ -145,6 +157,10 @@ def create_from_request(
 
         element_mid = request_form_dict["element_mid"]
 
+        element_is_composite = request_form_dict["is_composite"]
+        element_prefix = request_form_dict["prefix"]
+        element_view_style = request_form_dict["view_style"]
+
         #
         # Grammar fields.
         #
@@ -158,11 +174,14 @@ def create_from_request(
                 field_human_title = field_human_title.strip()
                 if len(field_human_title) == 0:
                     field_human_title = None
+            field_required_string = field_dict.get("field_required")
+            field_required = field_required_string == "true"
+
             form_object_field = GrammarFormField(
                 field_mid=field_mid,
                 field_name=field_name,
                 field_human_title=field_human_title,
-                field_required=False,
+                field_required=field_required,
                 reserved=is_reserved_field(field_name),
             )
             form_object_fields.append(form_object_field)
@@ -194,6 +213,15 @@ def create_from_request(
             document_mid=document.reserved_mid,
             element_mid=element_mid,
             element_name=element.tag,
+            is_composite=(
+                True
+                if element_is_composite == "true"
+                else False
+                if element_is_composite == "false"
+                else None
+            ),
+            prefix=element_prefix,
+            view_style=element_view_style,
             fields=form_object_fields,
             relations=form_object_relations,
             project_config=project_config,
@@ -236,6 +264,9 @@ def create_from_document(
             document_mid=document.reserved_mid,
             element_mid=element_mid,
             element_name=element.tag,
+            is_composite=element.property_is_composite,
+            prefix=element.property_prefix,
+            view_style=element.property_view_style,
             fields=grammar_form_fields,
             relations=grammar_form_relations,
             project_config=project_config,
@@ -270,7 +301,10 @@ def validate(self) -> bool:
             else:
                 fields_so_far.add(field.field_name)
 
-        if len(self.relations) == 0 and self.element_name != "TEXT":
+        if len(self.relations) == 0 and self.element_name not in (
+            "TEXT",
+            "SECTION",
+        ):
             self.add_error(
                 "Relations_Row",
                 (
@@ -362,13 +396,19 @@ def convert_to_grammar_element(
                 raise NotImplementedError(relation)
 
         existing_element = existing_grammar.get_element_by_mid(self.element_mid)
+
         requirement_element = GrammarElement(
             parent=None,
             tag=existing_element.tag,
-            # FIXME: MERGE NODES.
-            property_is_composite="",
-            property_prefix="",
-            property_view_style="",
+            property_is_composite=(
+                "True"
+                if self.is_composite == True
+                else "False"
+                if self.is_composite == False
+                else ""
+            ),
+            property_prefix=self.prefix or "",
+            property_view_style=self.view_style or "",
             fields=grammar_fields,
             relations=relation_fields,
         )
@@ -462,3 +502,25 @@ def render_close_form() -> str:
             action="update",
             target="modal",
         )
+
+    def get_input_field_is_composite(self) -> str:
+        return "is_composite"
+
+    def get_input_field_is_composite_value(self) -> str:
+        if self.is_composite is not None:
+            if self.is_composite == True:
+                return "true"
+            return "false"
+        return ""
+
+    def get_input_field_prefix(self) -> str:
+        return "prefix"
+
+    def get_input_field_prefix_value(self) -> str:
+        return self.prefix or ""
+
+    def get_input_field_view_style(self) -> str:
+        return "view_style"
+
+    def get_input_field_view_style_value(self) -> str:
+        return self.view_style or ""

strictdoc/export/html/templates/components/grammar_form_element/index.jinja

@@ -23,6 +23,25 @@
     <input type="hidden" id="document_mid" name="document_mid" value="{{ form_object.document_mid }}"/>
     <input type="hidden" id="element_mid" name="element_mid" value="{{ form_object.element_mid }}"/>
 
+    {# FIXME: This will become a proper checkbox field eventually. #}
+    <input
+      type="hidden"
+      value="{{ form_object.get_input_field_is_composite_value() }}"
+      name="{{ form_object.get_input_field_is_composite() }}"
+    />
+    {# FIXME: This will become a proper checkbox field eventually. #}
+    <input
+      type="hidden"
+      value="{{ form_object.get_input_field_prefix_value() }}"
+      name="{{ form_object.get_input_field_prefix() }}"
+    />
+    {# FIXME: This will become a proper checkbox field eventually. #}
+    <input
+      type="hidden"
+      value="{{ form_object.get_input_field_view_style_value() }}"
+      name="{{ form_object.get_input_field_view_style() }}"
+    />
+
     {# Fields TAB #}
     <sdoc-tab-content id="Fields" active>
       <sdoc-form-descr>

strictdoc/export/html/templates/components/grammar_form_element/row_with_custom_field/index.jinja

@@ -37,6 +37,13 @@
   {%- endif -%}
 >
 
+  {# FIXME: This will become a proper checkbox field eventually. #}
+  <input
+    type="hidden"
+    value="{{ form_object.field.get_input_field_required_value() }}"
+    name="{{ form_object.field.get_input_field_required() }}"
+  />
+
   {%- set placeholder_name = form_object.field.field_name|default('custom field name', true) %}
   {# field_placeholder = "Enter "~placeholder_name~" here...", #}
   {%- with

strictdoc/export/html/templates/components/grammar_form_element/row_with_reserved_field/index.jinja

@@ -23,6 +23,13 @@
   {%- endif -%}
 >
 
+  {# FIXME: This will become a proper checkbox field eventually. #}
+  <input
+    type="hidden"
+    value="{{ form_object.field.get_input_field_required_value() }}"
+    name="{{ form_object.field.get_input_field_required() }}"
+  />
+
   {%- with
     field_class_name = "monospace",
     field_editable = false,

strictdoc/server/routers/main_router.py

@@ -2377,18 +2377,7 @@ async def document__save_grammar_element(request: Request) -> Response:
             document=document,
             traceability_index=export_action.traceability_index,
         )
-        grammar_changed = update_grammar_action.perform()
-
-        # If the grammar has not changed, do nothing and save the edit form.
-        if not grammar_changed:
-            output = form_object.render_close_form()
-            return HTMLResponse(
-                content=output,
-                status_code=200,
-                headers={
-                    "Content-Type": "text/vnd.turbo-stream.html",
-                },
-            )
+        update_grammar_action.perform()
 
         # Re-generate the document's SDOC.
         SDWriter(project_config).write_to_file(document)
@@ -2448,6 +2437,9 @@ def document__add_grammar_field(document_mid: str) -> Response:
             document_mid=document_mid,
             element_mid="NOT_RELEVANT",
             element_name="NOT_RELEVANT",
+            is_composite=None,  # Not used in this limited partial template.
+            prefix=None,  # Not used in this limited partial template.
+            view_style=None,  # Not used in this limited partial template.
             fields=[],  # Not used in this limited partial template.
             relations=[],  # Not used in this limited partial template.
             project_config=project_config,
@@ -2469,6 +2461,9 @@ def document__add_grammar_relation(document_mid: str) -> Response:
             document_mid=document_mid,
             element_mid="NOT_RELEVANT",
             element_name="NOT_RELEVANT",
+            is_composite=None,  # Not used in this limited partial template.
+            prefix=None,  # Not used in this limited partial template.
+            view_style=None,  # Not used in this limited partial template.
             fields=[],  # Not used in this limited partial template.
             relations=[],  # Not used in this limited partial template.
             project_config=project_config,

tests/end2end/screens/document/edit_document_grammar_element/_relations/update_grammar_text_node_noop_save_preserves_relations/expected_output/document.sdoc renamed to tests/end2end/screens/document/edit_document_grammar_element/_relations/update_grammar_element_noop/expected_output/document.sdoc

@@ -3,6 +3,18 @@ TITLE: Document 1
 
 [GRAMMAR]
 ELEMENTS:
+- TAG: SECTION
+  PROPERTIES:
+    IS_COMPOSITE: True
+    PREFIX: SECT-
+    VIEW_STYLE: Narrative
+  FIELDS:
+  - TITLE: UID
+    TYPE: String
+    REQUIRED: False
+  - TITLE: TITLE
+    TYPE: String
+    REQUIRED: False
 - TAG: TEXT
   FIELDS:
   - TITLE: UID
@@ -28,9 +40,14 @@ ELEMENTS:
   RELATIONS:
   - TYPE: Parent
 
+[[SECTION]]
+TITLE: Section example
+
 [REQUIREMENT]
 TITLE: Requirement title
 STATEMENT: >>>
 Requirement statement.
 <<<
 CUSTOM_FIELD: Value 1
+
+[[/SECTION]]

tests/end2end/screens/document/edit_document_grammar_element/_relations/update_grammar_text_node_noop_save_preserves_relations/input/document.sdoc renamed to tests/end2end/screens/document/edit_document_grammar_element/_relations/update_grammar_element_noop/input/document.sdoc

@@ -3,6 +3,18 @@ TITLE: Document 1
 
 [GRAMMAR]
 ELEMENTS:
+- TAG: SECTION
+  PROPERTIES:
+    IS_COMPOSITE: True
+    PREFIX: SECT-
+    VIEW_STYLE: Narrative
+  FIELDS:
+  - TITLE: UID
+    TYPE: String
+    REQUIRED: False
+  - TITLE: TITLE
+    TYPE: String
+    REQUIRED: False
 - TAG: TEXT
   FIELDS:
   - TITLE: UID
@@ -28,9 +40,14 @@ ELEMENTS:
   RELATIONS:
   - TYPE: Parent
 
+[[SECTION]]
+TITLE: Section example
+
 [REQUIREMENT]
 TITLE: Requirement title
 STATEMENT: >>>
 Requirement statement.
 <<<
 CUSTOM_FIELD: Value 1
+
+[[/SECTION]]