aggify 0.2.5__tar.gz → 0.2.7__tar.gz

{aggify-0.2.5 → aggify-0.2.7}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: aggify
-Version: 0.2.5
+Version: 0.2.7
 Summary: A MongoDB aggregation generator for Mongoengine
 Home-page: https://github.com/Aggify/aggify
 Author: SeYeD.Dev
@@ -30,6 +30,7 @@ Description-Content-Type: text/markdown
 [![Coverage](https://img.shields.io/codecov/c/github/Aggify/aggify)](https://coverage-badge.samuelcolvin.workers.dev/redirect/Aggify/aggify)
 [![License](https://img.shields.io/github/license/Aggify/aggify.svg)](https://github.com/Aggify/aggify/blob/main/LICENSE)
 [![Contributors](https://img.shields.io/github/contributors/Aggify/aggify.svg)](https://github.com/Aggify/aggify/graphs/contributors)
+[![Telegram](https://img.shields.io/badge/-telegram-red?color=white&logo=telegram&logoColor=blue)](https://t.me/Aggify)
 
 # Aggify
 
@@ -47,9 +48,7 @@ organized interface.
 
 ## TODO
 
-- [ ] `$replaceRoot`: Replaces the document structure with a new one.
-- [ ] `$project` (with expressions): Allows you to use expressions to reshape and calculate values.
-- [ ] `$redact`: Controls document inclusion during the aggregation pipeline.
+
 
 ## Installation
 

{aggify-0.2.5 → aggify-0.2.7}/README.md

@@ -11,6 +11,7 @@
 [![Coverage](https://img.shields.io/codecov/c/github/Aggify/aggify)](https://coverage-badge.samuelcolvin.workers.dev/redirect/Aggify/aggify)
 [![License](https://img.shields.io/github/license/Aggify/aggify.svg)](https://github.com/Aggify/aggify/blob/main/LICENSE)
 [![Contributors](https://img.shields.io/github/contributors/Aggify/aggify.svg)](https://github.com/Aggify/aggify/graphs/contributors)
+[![Telegram](https://img.shields.io/badge/-telegram-red?color=white&logo=telegram&logoColor=blue)](https://t.me/Aggify)
 
 # Aggify
 
@@ -28,9 +29,7 @@ organized interface.
 
 ## TODO
 
-- [ ] `$replaceRoot`: Replaces the document structure with a new one.
-- [ ] `$project` (with expressions): Allows you to use expressions to reshape and calculate values.
-- [ ] `$redact`: Controls document inclusion during the aggregation pipeline.
+
 
 ## Installation
 

{aggify-0.2.5 → aggify-0.2.7}/aggify/aggify.py

@@ -495,6 +495,39 @@ class Aggify:
 
         return merged_pipeline
 
+    # check_fields_exist(self.base_model, let)  # noqa
+    def get_field_name_recursively(self, field: str) -> str:
+        """
+        Recursively fetch the field name by following the hierarchy indicated by the field parameter.
+
+        The function traverses the field hierarchy indicated by double underscores in the field parameter.
+        At each level, it checks if the field exists and then fetches the database field name for it.
+        The entire hierarchy is then joined using a dot (.) separator.
+
+        Parameters:
+        - field (str): A string indicating the hierarchy of fields, separated by double underscores.
+
+        Returns:
+        - str: A dot-separated string representing the full path to the field in the database.
+        """
+
+        field_name = []
+        prev_base = self.base_model
+
+        # Split the field based on double underscores and process each item
+        for index, item in enumerate(field.split("__")):
+            # Ensure the field exists at the current level of hierarchy
+            check_fields_exist(prev_base, [item])  # noqa
+
+            # Append the database field name to the field_name list
+            field_name.append(get_db_field(prev_base, item))
+
+            # Move to the next level in the model hierarchy
+            prev_base = self.get_model_field(prev_base, item)
+
+        # Join the entire hierarchy using dots and return
+        return ".".join(field_name)
+
     @last_out_stage_check
     def lookup(
         self,
@@ -544,11 +577,12 @@ class Aggify:
         else:
             if not query:
                 raise InvalidArgument(expected_list=["query"])
-            check_fields_exist(self.base_model, let)  # noqa
+
             let_dict = {
-                field: f"${get_db_field(self.base_model, field)}"  # noqa
-                for field in let  # noqa
+                field: f"${get_db_field(self.base_model, self.get_field_name_recursively(field))}"  # noqa
+                for field in let
             }
+
             for q in query:
                 # Construct the match stage for each query
                 if isinstance(q, Q):
@@ -680,3 +714,61 @@ class Aggify:
         self.pipelines.append(new_root)
 
         return self
+
+    @last_out_stage_check
+    def redact(self, value1, condition, value2, then_value, else_value):
+        """
+        Add a $redact stage to the pipeline based on the provided conditions.
+
+        The $redact stage restricts the contents of the returned documents
+        based on the condition specified. This method assists in building
+        the $redact stage for a MongoDB aggregation pipeline.
+
+        Parameters:
+        - value1 (str): The first value to compare in the condition.
+        - condition (str): The MongoDB comparison operator (e.g., "$eq", "$lt").
+        - value2 (str): The second value to compare in the condition.
+        - then_value (str): The action to take if the condition is True.
+                            Expected values: "$DESCEND", "$PRUNE", "$KEEP".
+        - else_value (str): The action to take if the condition is False.
+                            Expected values: "$DESCEND", "$PRUNE", "$KEEP".
+
+        Returns:
+        - self: Returns the instance of the class to allow chaining.
+
+        Raises:
+        - InvalidArgument: If then_value or else_value are not in the expected list.
+        """
+
+        # List of valid redaction values
+        redact_values = ["DESCEND", "PRUNE", "KEEP"]
+
+        def clean_then_else(then_value, else_value):
+            """
+            Helper function to sanitize then_value and else_value.
+
+            Strips the dollar sign and converts values to uppercase.
+            """
+            return (
+                then_value.replace("$", "").upper(),
+                else_value.replace("$", "").upper(),
+            )
+
+        # Clean the provided then_value and else_value
+        then_value, else_value = clean_then_else(then_value, else_value)
+
+        # Check if the cleaned values are in the valid list
+        if then_value not in redact_values or else_value not in redact_values:
+            raise InvalidArgument(expected_list=redact_values)
+
+        # Construct the $redact stage with the provided condition
+        stage = {
+            "$redact": dict(
+                Cond(value1, condition, value2, f"$${then_value}", f"$${else_value}")
+            )
+        }
+
+        # Append the constructed stage to the pipelines list
+        self.pipelines.append(stage)
+
+        return self

{aggify-0.2.5 → aggify-0.2.7}/aggify/compiler.py

@@ -10,7 +10,7 @@ from aggify.utilty import get_db_field
 class Operators:
     QUERY_OPERATORS = {
         "exact": "$eq",
-        "iexact": "$eq",
+        "iexact": "$regex",
         "contains": "$regex",
         "icontains": "$regex",  # noqa
         "startswith": "$regex",
@@ -34,6 +34,23 @@ class Operators:
         **COMPARISON_OPERATORS,
     }
 
+    REGEX_PATTERNS = {
+        "iexact": "^{value}$",
+        "contains": "{value}",
+        "icontains": "{value}",
+        "startswith": "^{value}",
+        "istartswith": "^{value}",
+        "endswith": "{value}$",
+        "iendswith": "{value}$",
+    }
+
+    REGEX_OPTIONS = {
+        "iexact": "i",
+        "icontains": "i",
+        "istartswith": "i",
+        "iendswith": "i",
+    }
+
     def __init__(self, match_query: Dict[str, Any]):
         self.match_query = match_query
 
@@ -42,35 +59,30 @@ class Operators:
         # I think there should be easier way to inject comparison operators to be defined per each
         # like map an existing template to each operator
 
-        if operator in ["exact", "iexact"]:
-            self.match_query[field] = {Operators.ALL_OPERATORS[operator]: value}
-
-        elif operator in [
-            "contains",
-            "startswith",
-            "endswith",
-            "icontains",
-            "istartswith",
-            "iendswith",
-        ]:  # noqa
-            self.match_query[field] = {
-                Operators.ALL_OPERATORS[operator]: f".*{value}.*",
-                "$options": "i",
-            }
+        if operator in Operators.REGEX_PATTERNS:
+            if isinstance(value, F):
+                raise ValueError("Not implemented yet")
+            pattern = Operators.REGEX_PATTERNS[operator].format(value=value)
+            # Create the base query with the pattern
+            query = {Operators.ALL_OPERATORS[operator]: pattern}
+
+            # If there's an option for the operator, add it to the query
+            if operator in Operators.REGEX_OPTIONS:
+                query["$options"] = Operators.REGEX_OPTIONS[operator]
 
-        elif operator in Operators.ALL_OPERATORS[operator]:
+            self.match_query[field] = query
+        elif operator in Operators.ALL_OPERATORS:
             if isinstance(value, F):
                 self.match_query["$expr"] = {
-                    Operators.ALL_OPERATORS[operator]: [
-                        f"${field}",
-                        value.to_dict(),
-                    ]
+                    Operators.ALL_OPERATORS[operator]: [f"${field}", value.to_dict()]
                 }
-
             else:
                 self.match_query[field] = {Operators.ALL_OPERATORS[operator]: value}
         else:
-            self.match_query[field] = {Operators.ALL_OPERATORS[operator]: value}
+            # Default behavior
+            self.match_query[field] = {
+                Operators.ALL_OPERATORS.get(operator, operator): value
+            }
 
         return self.match_query
 

{aggify-0.2.5 → aggify-0.2.7}/pyproject.toml

@@ -1,6 +1,6 @@
 [tool.poetry]
 name = "aggify"
-version = "0.2.5"
+version = "0.2.7"
 authors = ["SeYeD.Dev <me@seyed.dev>"]
 repository = "https://github.com/Aggify/aggify"
 documentation = "https://github.com/Aggify/aggify/docs"