Merge pull request #14 from manala/feat/exclusify-filter

feat: Add an "exclusify" filter

Author: nervo

CHANGELOG.md

@@ -11,6 +11,7 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 - Add a "file" parameter to "path" module
 - Add a "find" module
+- Add an "exclusify" filter
 
 ## [1.1.0] - 2024-09-13
 

plugins/filter/exclusify.py

@@ -0,0 +1,22 @@
+from __future__ import annotations
+
+
+def exclusify(value, against):
+    paths = value
+    value_paths = {path['path'] for path in value}
+
+    for path in against:
+        if path['path'] not in value_paths:
+            path['state'] = 'absent'
+            paths.append(path)
+
+    return paths
+
+
+class FilterModule(object):
+    ''' Manala path exclusify jinja2 filters '''
+
+    def filters(self):
+        return {
+            "exclusify": exclusify,
+        }

plugins/filter/exclusify.yml

@@ -0,0 +1,21 @@
+---
+
+DOCUMENTATION:
+  name: exclusify
+  author:
+    - Manala (@manala)
+  short_description: Ensure exclusivity against a list of path, by marking the extras as absent
+  description:
+    - Ensure exclusivity against a list of path, by marking the extras as absent
+  positional: _input,against
+  options:
+    _input:
+      description: A list of paths.
+      type: list
+      elements: object
+      required: true
+    against:
+      description: A list of paths.
+      type: list
+      elements: str
+      required: true

tests/unit/plugins/filter/test_exclusify.py

@@ -0,0 +1,26 @@
+from __future__ import annotations
+
+import unittest
+from plugins.filter.exclusify import exclusify
+
+
+class TestExclusify(unittest.TestCase):
+
+    def test_exclusify(self):
+        self.assertEqual(
+            [
+                {"path": "foo"},
+                {"path": "bar"},
+                {'path': 'baz', 'state': 'absent'},
+            ],
+            exclusify(
+                [
+                    {"path": "foo"},
+                    {"path": "bar"},
+                ],
+                [
+                    {"path": "bar"},
+                    {"path": "baz"},
+                ],
+            )
+        )