Merge pull request #7 from santalvarez/feature/not

santalvarez · web-flow · commit 9ec23d80ad08 · 2023-12-31T17:51:52.000-03:00
Version 0.5.0
diff --git a/docs/operators.md b/docs/operators.md
@@ -2,74 +2,18 @@
 
 ## Default Operators
 
-### Equal
-
-- **id**: "equal"
-
-- **description**: Compares if the value of the object is equal to the value of the condition.
-
-
-### Not Equal
-
-- **id**: "not_equal"
-- **description**: Compares if the value of the object is not equal to the value of the condition.
-
-
-### Greater Than
-
-- **id**: "greater_than"
-
-- **description**: Compares if the value of the object is greater than the value of the condition.
-
-
-### Greater Than Inclusive
-
-- **id**: "greater_than_inclusive"
-
-- **description**: Compares if the value of the object is greater than or equal to the value of the condition.
-
-
-### Less Than
-
-- **id**: "less_than"
-
-- **description**: Compares if the value of the object is less than the value of the condition.
-
-
-### Less Than Inclusive
-
-- **id**: "less_than_inclusive"
-
-- **description**: Compares if the value of the object is less than or equal to the value of the condition.
-
-
-### In
-
-- **id**: "in"
-
-- **description**: Compares if the value of the object is in the value of the condition.
-
-
-### Not In
-
-- **id**: "not_in"
-
-- **description**: Compares if the value of the object is not in the value of the condition.
-
-
-### Contains
-
-- **id**: "contains"
-
-- **description**: Compares if the value of the object contains the value of the condition.
-
-
-### Not Contains
-
-- **id**: "not_contains"
-
-- **description**: Compares if the value of the object does not contain the value of the condition.
-
+| Operator             | ID                      | Description                                                                                                     |
+|----------------------|-------------------------|-----------------------------------------------------------------------------------------------------------------|
+| Equal                | "equal"                 | Compares if the value of the object is equal to the value of the condition.                                    |
+| Not Equal            | "not_equal"             | Compares if the value of the object is not equal to the value of the condition.                                |
+| Greater Than         | "greater_than"          | Compares if the value of the object is greater than the value of the condition.                                |
+| Greater Than Inclusive| "greater_than_inclusive" | Compares if the value of the object is greater than or equal to the value of the condition.                  |
+| Less Than            | "less_than"             | Compares if the value of the object is less than the value of the condition.                                   |
+| Less Than Inclusive  | "less_than_inclusive"   | Compares if the value of the object is less than or equal to the value of the condition.                       |
+| In                   | "in"                    | Compares if the value of the object is in the value of the condition.                                          |
+| Not In               | "not_in"                | Compares if the value of the object is not in the value of the condition.                                      |
+| Contains             | "contains"              | Compares if the value of the object contains the value of the condition.                                       |
+| Not Contains         | "not_contains"          | Compares if the value of the object does not contain the value of the condition.                               |
 
 ## Custom Operator
 
diff --git a/docs/rules.md b/docs/rules.md
@@ -13,9 +13,12 @@ A basic rule consists of a name and a multi condition
 }
 ```
 
-**name(str, req):** The name of the rule
-
-**conditions(dict, req):** A [multi condition](#multi-condition). Defining a simple condition in here is not allowed, it needs to be inside a multi condition.
+| key | description | type | required |
+| --- | --- | --- | --- |
+| name | The name of the rule | str | yes |
+| description | A description of the rule. | str | no |
+| conditions | A [multi condition](#multi-condition). All rules start with a multi condition. | dict | yes |
+| extra | A dict that can be used to store extra information about the rule. | dict | no |
 
 ## Condition Types
 
@@ -30,19 +33,19 @@ A simple condition consists of an operator and a value.
     "value": "John"
 }
 ```
+Table describing the keys:
 
-**operator(str, req):** The operator to use to compare the object with the defined value. Find info on built-in operators and how to define your own [here](operators.md).
-
-**path(str):** A [JSONPath](https://goessner.net/articles/JsonPath/) expression indicating what attribute of the object to evaluate.
-
-**value(any, req):** The value that will be used to compare with the object.
-
-**params(dict):** A dict that can provide the operator more information about how to process the object.
+| key | description | type | required |
+| --- | --- | --- | --- |
+| operator | The operator to use to compare the object with the defined value. Find info on built-in operators and how to define your own [here](operators.md). | str | yes |
+| path | A [JSONPath](https://goessner.net/articles/JsonPath/) expression indicating what attribute of the object to evaluate. Appart from accessing attributes it also supports accessing array elements by [index]. | str | no |
+| value | The value that will be used to compare with the object. | any | yes |
+| params | A dict that can provide the operator more information about how to process the object. | dict | no |
 
 
 ### Multi Condition
 
-Contains either the **any** or **all** fields. These fields contain a list of conditions that can be simple, multi or a mix of both.
+Contains either the **any**, **all** or **not** fields. These fields contain a list of conditions that can be simple, multi or a mix of both.
 
 ```json
 {
@@ -61,9 +64,12 @@ Contains either the **any** or **all** fields. These fields contain a list of co
 }
 ```
 
-**all(list):** All conditions inside have to match.
-
-**any(list):** One of the conditions inside have to match.
+Only one of these fields can be present in a multi condition.
+| key | description | type |
+| --- | --- | --- |
+| all | All conditions inside have to match. | list |
+| any | One of the conditions inside have to match. | list |
+| not | The result of the condition inside will be negated. | dict |
 
 
 ## Results
diff --git a/pyproject.toml b/pyproject.toml
@@ -1,6 +1,6 @@
 [tool.poetry]
 name = "python-rule-engine"
-version = "0.4.0"
+version = "0.5.0"
 description = "A rule engine where rules are written in JSON format"
 authors = ["Santiago Alvarez <santiago.salvarez@mercadolibre.com>"]
 homepage = "https://github.com/santalvarez/python-rule-engine"
diff --git a/src/python_rule_engine/models/multi_condition.py b/src/python_rule_engine/models/multi_condition.py
@@ -9,12 +9,13 @@
 class MultiCondition(Condition):
     def __init__(self, **data) -> None:
         super().__init__()
-        if "all" in data and "any" in data:
-            raise ValueError("Only one operator is supported")
-        if "all" not in data and "any" not in data:
-            raise ValueError("No valid operators found")
+
+        if sum([bool(data.get("any", [])), bool(data.get("all", [])), bool(data.get("not", {}))]) != 1:
+            raise ValueError("Only one of any, all or not can be defined")
+
         self.all = self.__validate_conditions(data.get("all", []), data["operators_dict"])
         self.any = self.__validate_conditions(data.get("any", []), data["operators_dict"])
+        self.not_ = self.__validate_not_condition(data.get("not", {}), data["operators_dict"])
 
     def __validate_conditions(self, data: List[dict], operators_dict) -> Optional[List[Condition]]:
         if not data:
@@ -28,26 +29,34 @@ def __validate_conditions(self, data: List[dict], operators_dict) -> Optional[Li
                 cds.append(MultiCondition(**cd))
         return cds
 
+    def __validate_not_condition(self, data: dict, operators_dict) -> Optional[Condition]:
+        if not data:
+            return None
+        data["operators_dict"] = operators_dict
+        try:
+            return SimpleCondition(**data)
+        except ValueError:
+            return MultiCondition(**data)
+
     def evaluate(self, obj):
         """ Run a multi condition on an object or dict
 
-        :param MultiCondition rule: The rule
         :param Any obj: The object
-        :return Rule: The original rule with aded result info
         """
 
         if self.any:
             return self.evaluate_any(obj)
 
-        return self.evaluate_all(obj)
+        if self.all:
+            return self.evaluate_all(obj)
+
+        return self.evaluate_not(obj)
 
     def evaluate_any(self, obj):
         """
-        Run a multi condition on an object or dict with 'any' type.
+        Run a multi condition on a dict with 'any' type.
 
-        :param multi_condition: The multi condition to be run.
         :param obj: The object to be tested.
-        :return: The original multi condition with added result info.
         """
 
         for _, cond in enumerate(self.any):
@@ -59,11 +68,9 @@ def evaluate_any(self, obj):
 
     def evaluate_all(self, obj):
         """
-        Run a multi condition on an object or dict with 'all' type.
+        Run a multi condition on a dict with 'all' type.
 
-        :param multi_condition: The multi condition to be run.
         :param obj: The object to be tested.
-        :return: The original multi condition with added result info.
         """
 
         for _, cond in enumerate(self.all):
@@ -74,3 +81,14 @@ def evaluate_all(self, obj):
                 return
 
         self.match = True
+
+    def evaluate_not(self, obj):
+        """
+        Run a multi condition on a dict with 'not' type.
+
+        :param obj: The object to be tested.
+        """
+
+        self.not_.evaluate(obj)
+
+        self.match = not self.not_.match
diff --git a/tests/test_rule_engine.py b/tests/test_rule_engine.py
@@ -1,7 +1,7 @@
 from python_rule_engine import RuleEngine
 
 
-def test_basic_rule_on_dict():
+def test_rule_with_all_condition():
     obj = {
         "person": {
             "name": "Santiago",
@@ -37,3 +37,68 @@ def test_basic_rule_on_dict():
 
     assert results[0].conditions.match is True
 
+def test_rule_with_any_condition():
+    obj = {
+        "person": {
+            "name": "Santiago",
+            "last_name": "Alvarez"
+        }
+    }
+
+    rule = {
+        "name": "basic_rule",
+        "conditions": {
+            "any": [
+                {
+                    "path": "$.person.name",
+                    "value": "Martin",
+                    "operator": "equal"
+                },
+                {
+                    "path": "$.person.last_name",
+                    "value": "Alvarez",
+                    "operator": "equal"
+                }
+            ]
+        }
+    }
+
+    engine = RuleEngine([rule])
+
+    results = engine.evaluate(obj)
+
+    assert results[0].conditions.match is True
+
+def test_rule_with_not_condition():
+    obj = {
+        "person": {
+            "name": "Santiago",
+            "last_name": "Alvarez"
+        }
+    }
+
+    rule = {
+        "name": "basic_rule",
+        "conditions": {
+            "not": {  # None of the conditions inside "all" should be true
+                "all": [
+                    {
+                        "path": "$.person.name",
+                        "value": "Martin",
+                        "operator": "equal"
+                    },
+                    {
+                        "path": "$.person.last_name",
+                        "value": "Palermo",
+                        "operator": "equal"
+                    }
+                ]
+            }
+        }
+    }
+
+    engine = RuleEngine([rule])
+
+    results = engine.evaluate(obj)
+
+    assert results[0].conditions.match is True
