Merge pull request #49 from opengisch/filter

Filter Expression from Settings

linking_relation_editor/gui/linking_child_manager_dialog.py

@@ -23,11 +23,13 @@
     QgsHighlight,
     QgsIdentifyMenu,
     QgsMessageBar,
+    QgsAttributeForm
 )
 from qgis.PyQt.QtCore import QModelIndex, Qt, QTimer
 from qgis.PyQt.QtWidgets import QAction, QDialog, QMessageBox
 from qgis.PyQt.uic import loadUiType
 from qgis.utils import iface
+from unittest.mock import MagicMock
 
 from linking_relation_editor.core.model.attribute_form_delegate import (
     AttributeFormDelegate,
@@ -52,6 +54,7 @@ def __init__(
         nmRelation: QgsRelation,
         editorContext: QgsAttributeEditorContext,
         oneToOne: bool,
+        filterExpression: str,
         linkingChildManagerDialogConfig: dict,
         parent=None,
     ):
@@ -64,6 +67,7 @@ def __init__(
         self._nmRelation = nmRelation
         self._editorContext = editorContext
         self._oneToOne = oneToOne
+        self._filterExpression = filterExpression
         self._linkingChildManagerDialogConfig = linkingChildManagerDialogConfig
 
         self._mapToolSelect = None
@@ -177,14 +181,22 @@ def __init__(
 
         self._feature_filter_widget = FeatureFilterWidget(self)
         self.mFooterHBoxLayout.insertWidget(0, self._feature_filter_widget)
-        if iface:  # TODO how to use iface in tests?
-            self._feature_filter_widget.init(
-                self._layer,
-                self._editorContext,
-                self._featuresModelFilterLeft,
-                iface.messageBar(),
-                QgsMessageBar.defaultMessageTimeout(),
-            )
+
+        # used for untittest
+        if not iface:
+            i = MagicMock()
+        else:
+            i = iface
+        self._feature_filter_widget.init(
+            self._layer,
+            self._editorContext,
+            self._featuresModelFilterLeft,
+            i.messageBar(),
+            QgsMessageBar.defaultMessageTimeout(),
+        )
+        if self._filterExpression:
+            self._feature_filter_widget.setFilterExpression(self._filterExpression,QgsAttributeForm.ReplaceFilter, True)
+        else:
             self._feature_filter_widget.filterShowAll()
 
         # Signal slots

linking_relation_editor/gui/linking_relation_editor_widget.py

@@ -185,6 +185,7 @@ def config(self):
         return {
             "buttons": metaEnumFromValue(QgsRelationEditorWidget.Button.AllButtons).valueToKeys(self.visibleButtons()),
             "show_first_feature": self.mShowFirstFeature,
+            "filter_exression": self.mFilterExpression,
             CONFIG_ONE_TO_ONE: self.mOneToOne,
             CONFIG_LINKING_CHILD_MANAGER_DIALOG: self.mLinkingChildManagerDialogConfig,
         }
@@ -195,6 +196,7 @@ def setConfig(self, config):
             config.get("buttons", metaEnumButtons.valueToKeys(QgsRelationEditorWidget.Button.AllButtons))
         )
         self.mShowFirstFeature = config.get("show_first_feature", True)
+        self.mFilterExpression = config.get("filter_expression")
         self.mOneToOne = config.get(CONFIG_ONE_TO_ONE)
         self.mLinkingChildManagerDialogConfig = config.get(CONFIG_LINKING_CHILD_MANAGER_DIALOG, {})
         self.updateButtons()
@@ -589,6 +591,7 @@ def _execLinkFeatureDialog(self):
             self.nmRelation(),
             self.editorContext(),
             self.mOneToOne,
+            self.mFilterExpression,
             self.mLinkingChildManagerDialogConfig,
             self,
         )

linking_relation_editor/tests/test_linking_child_manager_dialog.py

@@ -138,6 +138,7 @@ def test_Instantiate(self):
             QgsRelation(),
             QgsAttributeEditorContext(),
             False,
+            None,
             {},
             None,
         )
@@ -160,6 +161,7 @@ def test_InstantiateRelation1N(self):
             QgsRelation(),
             QgsAttributeEditorContext(),
             False,
+            None,
             {},
             None,
         )
@@ -182,6 +184,7 @@ def test_InstantiateRelationNM(self):
             self.mRelationNM,
             QgsAttributeEditorContext(),
             False,
+            None,
             {},
             None,
         )
@@ -206,6 +209,7 @@ def test_quickFilter(self):
             QgsRelation(),
             QgsAttributeEditorContext(),
             False,
+            None,
             {},
             None,
         )
@@ -306,3 +310,88 @@ def test_quickFilter(self):
             dialog._featuresModelFilterLeft.data(dialog._featuresModelFilterLeft.index(1, 0), Qt.DisplayRole),
             "Layer1-1: Martina formerly known as Prisca",
         )
+
+    def test_passed_filter_expression(self):
+        # get a parent with no childs
+        parentFeature = QgsFeature()
+        for feature in self.mLayer2.getFeatures():
+            if feature.attribute("pk") == 12:
+                parentFeature = feature
+                break
+
+        self.assertTrue(parentFeature.isValid())
+
+        dialog = LinkingChildManagerDialog(
+            self.mLayer1,
+            self.mLayer2,
+            parentFeature,
+            self.mRelation,
+            QgsRelation(),
+            QgsAttributeEditorContext(),
+            False,
+            "name LIKE '%formerly known as Prince%'",
+            {},
+            None,
+        )
+
+        self.assertEqual(dialog.mLayerNameLabel.text(), self.mLayer1.name())
+
+        # one entry
+        # "Layer1-0: The Artist formerly known as Prince"
+        self.assertEqual(dialog._featuresModelFilterLeft.rowCount(), 1)
+        self.assertEqual(
+            dialog._featuresModelFilterLeft.data(dialog._featuresModelFilterLeft.index(0, 0), Qt.DisplayRole),
+            "Layer1-0: The Artist formerly known as Prince",
+        )
+
+        dialog = LinkingChildManagerDialog(
+            self.mLayer1,
+            self.mLayer2,
+            parentFeature,
+            self.mRelation,
+            QgsRelation(),
+            QgsAttributeEditorContext(),
+            False,
+            "name LIKE '%formerly%'",
+            {},
+            None,
+        )
+
+        self.assertEqual(dialog.mLayerNameLabel.text(), self.mLayer1.name())
+
+        # all entries with formerly
+        # "Layer1-0: The Artist formerly known as Prince"
+        # "Layer1-1: Martina formerly known as Prisca"
+        self.assertEqual(dialog._featuresModelFilterLeft.rowCount(), 2)
+        self.assertEqual(
+            dialog._featuresModelFilterLeft.data(dialog._featuresModelFilterLeft.index(0, 0), Qt.DisplayRole),
+            "Layer1-0: The Artist formerly known as Prince",
+        )
+        self.assertEqual(
+            dialog._featuresModelFilterLeft.data(dialog._featuresModelFilterLeft.index(1, 0), Qt.DisplayRole),
+            "Layer1-1: Martina formerly known as Prisca",
+        )
+
+        dialog = LinkingChildManagerDialog(
+            self.mLayer1,
+            self.mLayer2,
+            parentFeature,
+            self.mRelation,
+            QgsRelation(),
+            QgsAttributeEditorContext(),
+            False,
+            "name LIKE '%Prisca%'",
+            {},
+            None,
+        )
+
+        self.assertEqual(dialog.mLayerNameLabel.text(), self.mLayer1.name())
+
+        # one entry
+        # "Layer1-0: The Artist formerly known as Prince"
+        self.assertEqual(dialog._featuresModelFilterLeft.rowCount(), 1)
+        self.assertEqual(
+            dialog._featuresModelFilterLeft.data(dialog._featuresModelFilterLeft.index(0, 0), Qt.DisplayRole),
+            "Layer1-1: Martina formerly known as Prisca",
+        )
+