Add inner_product filter (#9)

.github/workflows/pytest.yml

@@ -19,7 +19,7 @@ jobs:
       - name: Set up python 3
         uses: actions/setup-python@v4
         with:
-          python-version: '3.x'
+          python-version: "3.x"
 
       - name: Update ubuntu repositories
         run: sudo apt-get update
@@ -39,5 +39,5 @@ jobs:
       - name: Run molecule tests.
         run: make test
         env:
-          PY_COLORS: '1'
-          ANSIBLE_FORCE_COLOR: '1'
+          PY_COLORS: "1"
+          ANSIBLE_FORCE_COLOR: "1"

galaxy.yml

@@ -1,7 +1,7 @@
 ---
 namespace: nephelaiio
 name: plugins
-version: 0.0.7
+version: 0.0.8
 readme: README.md
 authors:
   - Ted Cook <[email protected]>

molecule/default/verify.yml

@@ -24,3 +24,13 @@
         expected: [["a"]]
         filter: "nephelaiio.plugins.set_difference"
         result: "{{ pairs | map(filter) }}"
+
+    - name: Test inner_product
+      ansible.builtin.assert:
+        that: result == expected
+        fail_msg: "{{ result | to_json }}"
+      vars:
+        pairs: [[["a", "b"], ["@c", "@d"]]]
+        expected: [["a@c", "a@d", "b@c", "b@d"]]
+        filter: "nephelaiio.plugins.inner_product"
+        result: "{{ pairs | map(filter) | map('map', 'join') }}"

plugins/filter/custom_filter.py

@@ -37,6 +37,8 @@
 - is_any_true(xs): Returns True if any element in the provided iterable is truthy.
 - is_all_true(xs): Returns True if all elements in the provided iterable are truthy.
 - search_regex(r, s): Checks if a string matches a given regex pattern.
+- set_difference(x): Return the set difference on a list-pair of lists
+- inner_product(x): Return the cartesian product of a list-pair of lists
 
 These functions are designed to assist in data manipulation and processing tasks, particularly useful in contexts
 where data structures need to be dynamically created, modified, or converted between different formats.
@@ -732,6 +734,17 @@ def set_difference(value):
     return list(set(a).difference(set(b)))
 
 
+def inner_product(value):
+    """
+    Return the inner product of an array pair:
+    .. sourcecode:: jinja
+        {{ [['a', 'b', ['c', 'd']] | map("inner_product") }}
+            -> [['a, 'c'], ['a', 'd'], ['b', 'c'], ['b', 'd']]
+    """
+    [a, b] = value
+    return [list(x) for x in itertools.product(a, b)]
+
+
 class FilterModule:
     """
     A class encapsulating a collection of jinja2 filters.
@@ -785,6 +798,8 @@ def filters(self):
             - is_any_true: Checks if any element in an iterable is true.
             - is_all_true: Checks if all elements in an iterable are true.
             - search_regex: Checks if a string matches a given regex pattern.
+            - set_difference: Return the set difference on a list-pair of lists
+            - inner_product: Return the cartesian product of a list-pair of lists
         """
 
         return {
@@ -819,4 +834,5 @@ def filters(self):
             "is_all_true": is_all_true,
             "search_regex": search_regex,
             "set_difference": set_difference,
+            "inner_product": inner_product,
         }

tests/test_filter.py

@@ -12,6 +12,7 @@
     alias_keys,
     drop_attributes,
     filename,
+    inner_product,
     ip_range,
     is_all_true,
     is_any_true,
@@ -478,3 +479,22 @@ def test_set_difference():
     assert set(set_difference([["a", "b"], ["a", "d"]])).difference(set(["b"])) == set()
     assert set(set_difference([["a", "b"], ["b", "c"]])).difference(set(["a"])) == set()
     assert set(set_difference([["a", "b"], ["a", "b"]])).difference(set([])) == set()
+
+
+def test_inner_product():
+    assert inner_product([[], []]) == []
+    assert inner_product([["a"], ["b"]]) == [["a", "b"]]
+    assert inner_product([["a", "b"], ["c"]]) == [
+        ["a", "c"],
+        ["b", "c"],
+    ]
+    assert inner_product([["a"], ["c", "d"]]) == [
+        ["a", "c"],
+        ["a", "d"],
+    ]
+    assert inner_product([["a", "b"], ["c", "d"]]) == [
+        ["a", "c"],
+        ["a", "d"],
+        ["b", "c"],
+        ["b", "d"],
+    ]