add checks and messages for existing/duplicate regulation group short names

Author: nmaarnio

arho_feature_template/core/models.py

@@ -144,6 +144,16 @@ def from_config_file(cls, config_fp: Path) -> RegulationGroupLibrary:
                 ],
             )
 
+    def get_short_names(self) -> list[str]:
+        """Returns list of non-empty short names (letter codes) of regulation groups part of the library."""
+        short_names = []
+        for category in self.regulation_group_categories:
+            for regulation_group in category.regulation_groups:
+                short_name = regulation_group.short_name
+                if short_name:
+                    short_names.append(short_name)
+        return short_names
+
 
 @dataclass
 class RegulationLibrary:

arho_feature_template/core/plan_manager.py

@@ -163,7 +163,7 @@ def edit_regulation_group(self, regulation_group: RegulationGroup):
         self._open_regulation_group_form(regulation_group)
 
     def _open_regulation_group_form(self, regulation_group: RegulationGroup):
-        regulation_group_form = PlanRegulationGroupForm(regulation_group)
+        regulation_group_form = PlanRegulationGroupForm(regulation_group, self.active_plan_regulation_group_library)
         if regulation_group_form.exec_():
             if regulation_group_form.save_as_config:
                 save_regulation_group_as_config(regulation_group_form.model)
@@ -297,7 +297,7 @@ def _plan_feature_geom_digitized(self, feature: QgsFeature):
 
         plan_feature.geom = feature.geometry()
         attribute_form = PlanFeatureForm(
-            plan_feature, title, [*self.regulation_group_libraries, self.active_plan_regulation_group_library]
+            plan_feature, title, self.regulation_group_libraries, self.active_plan_regulation_group_library
         )
         if attribute_form.exec_():
             save_plan_feature(attribute_form.model)
@@ -310,7 +310,7 @@ def edit_plan_feature(self, feature: QgsFeature, layer_name: str):
         # Geom editing handled with basic QGIS vertex editing?
         title = plan_feature.name if plan_feature.name else layer_name
         attribute_form = PlanFeatureForm(
-            plan_feature, title, [*self.regulation_group_libraries, self.active_plan_regulation_group_library]
+            plan_feature, title, self.regulation_group_libraries, self.active_plan_regulation_group_library
         )
         if attribute_form.exec_():
             save_plan_feature(attribute_form.model)

arho_feature_template/gui/dialogs/plan_feature_form.py

@@ -10,6 +10,7 @@
     QDialog,
     QDialogButtonBox,
     QLineEdit,
+    QMessageBox,
     QScrollArea,
     QSizePolicy,
     QSpacerItem,
@@ -39,7 +40,11 @@ class PlanFeatureForm(QDialog, FormClass):  # type: ignore
     """Parent class for feature forms for adding and modifying feature attribute data."""
 
     def __init__(
-        self, plan_feature: PlanFeature, form_title: str, regulation_group_libraries: list[RegulationGroupLibrary]
+        self,
+        plan_feature: PlanFeature,
+        form_title: str,
+        regulation_group_libraries: list[RegulationGroupLibrary],
+        active_plan_regulation_groups_library: RegulationGroupLibrary,
     ):
         super().__init__()
         self.setupUi(self)
@@ -57,7 +62,9 @@ def __init__(
         self.regulation_groups_tree_layout: QVBoxLayout
 
         # INIT
-        self.regulation_group_libraries = regulation_group_libraries
+        self.existing_group_short_names = active_plan_regulation_groups_library.get_short_names()
+        self.active_plan_regulation_groups_library = active_plan_regulation_groups_library
+        self.regulation_group_libraries = [*regulation_group_libraries, active_plan_regulation_groups_library]
         self.plan_regulation_group_libraries_combobox.addItems(
             library.name for library in self.regulation_group_libraries
         )
@@ -97,6 +104,44 @@ def _remove_spacer(self):
             self.plan_regulation_group_scrollarea_contents.layout().removeItem(self.scroll_area_spacer)
             self.scroll_area_spacer = None
 
+    def _check_regulation_group_short_names(self) -> bool:
+        seen_names = set()
+        existing_names = set()
+        duplicate_names = set()
+
+        for reg_group_widget in self.regulation_group_widgets:
+            short_name = reg_group_widget.short_name.text()
+            if not short_name:
+                continue
+
+            if short_name in self.existing_group_short_names:
+                existing_names.add(short_name)
+            if short_name in seen_names:
+                duplicate_names.add(short_name)
+            seen_names.add(short_name)
+
+        def format_names(names, last_item_conjucation: str = "ja"):
+            names = list(names)
+            formatted_names = ", ".join(f"'<b>{name}</b>'" for name in names[:-1])
+            formatted_names += f" {last_item_conjucation} " if len(names) > 1 else ""
+            formatted_names += f"'<b>{names[-1]}</b>'" if names else ""
+            return formatted_names
+
+        if existing_names:
+            if len(existing_names) == 1:
+                msg = f"Kaavamääräysryhmä lyhyellä nimellä {format_names(existing_names)} on jo olemassa."
+            else:
+                msg = f"Kaavamääräysryhmät lyhyillä nimillä {format_names(existing_names)} ovat jo olemassa."
+            QMessageBox.critical(self, "Virhe", msg)
+            return False
+
+        if duplicate_names:
+            msg = f"Lomakkeella on useita kaavamääräysryhmiä, joilla on lyhyt nimi {format_names(duplicate_names, 'tai')}."
+            QMessageBox.critical(self, "Virhe", msg)
+            return False
+
+        return True
+
     def add_selected_plan_regulation_group(self, item: QTreeWidgetItem, column: int):
         if not item.parent():
             return
@@ -113,7 +158,9 @@ def add_plan_regulation_group(self, definition: RegulationGroup):
         self._add_spacer()
 
     def open_plan_regulation_group_form(self, regulation_group_widget: RegulationGroupWidget):
-        group_as_form = PlanRegulationGroupForm(regulation_group_widget.into_model())
+        group_as_form = PlanRegulationGroupForm(
+            regulation_group_widget.into_model(), self.active_plan_regulation_groups_library
+        )
         if group_as_form.exec_():
             regulation_group_widget.from_model(group_as_form.model)
 
@@ -146,5 +193,6 @@ def into_model(self) -> PlanFeature:
         )
 
     def _on_ok_clicked(self):
-        self.model = self.into_model()
-        self.accept()
+        if self._check_regulation_group_short_names():
+            self.model = self.into_model()
+            self.accept()

arho_feature_template/gui/dialogs/plan_regulation_group_form.py

@@ -12,6 +12,7 @@
     QDialogButtonBox,
     QHBoxLayout,
     QLabel,
+    QMessageBox,
     QSizePolicy,
     QTextBrowser,
     QTreeWidgetItem,
@@ -23,6 +24,7 @@
     Regulation,
     RegulationConfig,
     RegulationGroup,
+    RegulationGroupLibrary,
     RegulationLibrary,
 )
 from arho_feature_template.gui.components.plan_proposition_widget import PropositionWidget
@@ -45,7 +47,9 @@
 class PlanRegulationGroupForm(QDialog, FormClass):  # type: ignore
     """Form to create a new plan regulation group."""
 
-    def __init__(self, regulation_group: RegulationGroup):
+    def __init__(
+        self, regulation_group: RegulationGroup, active_plan_regulation_groups_library: RegulationGroupLibrary
+    ):
         super().__init__()
         self.setupUi(self)
 
@@ -74,6 +78,7 @@ def __init__(self, regulation_group: RegulationGroup):
         self.regulation_widgets: list[RegulationWidget] = []
         self.proposition_widgets: list[PropositionWidget] = []
         self.save_as_config = False
+        self.existing_group_short_names = active_plan_regulation_groups_library.get_short_names()
 
         # Initialize regulation library
         self.regulations_selection_widget = TreeWithSearchWidget()
@@ -137,6 +142,14 @@ def _initalize_regulation_from_config(self, config: RegulationConfig, parent: QT
         for child_config in config.child_regulations:
             self._initalize_regulation_from_config(child_config, item)
 
+    def _check_short_name(self) -> bool:
+        short_name = self.short_name.text()
+        if short_name and short_name in self.existing_group_short_names:
+            msg = f"Kaavamääräysryhmä lyhyellä nimellä '<b>{short_name}</b>' on jo olemassa."
+            QMessageBox.critical(self, "Virhe", msg)
+            return False
+        return True
+
     def update_selected_regulation(self, item: QTreeWidgetItem, column: int):
         config: RegulationConfig = item.data(column, Qt.UserRole)  # Retrieve the associated config
         self.regulation_info.setText(config.description)
@@ -190,5 +203,6 @@ def into_model(self) -> RegulationGroup:
         )
 
     def _on_ok_clicked(self):
-        self.model = self.into_model()
-        self.accept()
+        if self._check_short_name():
+            self.model = self.into_model()
+            self.accept()