Merge pull request #24 from kettasoft/hotfix/invokable

Refactor Filter Engine: Integrate Payload, ClauseFactory & Dissector for cleaner filter execution

Author: kettasoft

config/filterable.php

@@ -236,6 +236,31 @@
             |
             */
             'normalize_keys' => false,
+
+            /*
+            |--------------------------------------------------------------------------
+            | Allowed SQL Operators
+            |--------------------------------------------------------------------------
+            |
+            | List of supported SQL operators you want to allow when parsing
+            | the expressions.
+            |
+            */
+            'allowed_operators' => [
+                'eq' => '=',
+                'neq' => '!=',
+                'gt' => '>',
+                'lt' => '<',
+                'gte' => '>=',
+                'lte' => '<=',
+                'like' => 'like',
+                'nlike' => 'not like',
+                'in' => 'in',
+                'nin' => 'not in',
+                'null' => 'is null',
+                'notnull' => 'is not null',
+                'between' => 'between',
+            ],
         ],
 
         /*

src/Engines/Foundation/Clause.php

@@ -8,6 +8,7 @@
 use Illuminate\Contracts\Support\Arrayable;
 use Kettasoft\Filterable\Engines\Foundation\Parsers\Dissector;
 use Kettasoft\Filterable\Engines\Foundation\Resolvers\RelationResolver;
+use Kettasoft\Filterable\Support\Payload;
 
 class Clause implements Arrayable, Jsonable
 {
@@ -38,26 +39,25 @@ class Clause implements Arrayable, Jsonable
 
   /**
    * Clause constructor.
-   * @param \Kettasoft\Filterable\Foundation\Resources $resources
-   * @param mixed $field
-   * @param mixed $dissector
+   * 
+   * @param Payload $payload
    */
-  public function __construct($field, $operator, $value)
+  public function __construct(protected Payload $payload)
   {
-    $this->field = $field;
-    $this->operator = $operator;
-    $this->value = $value;
+    $this->field = $payload->field;
+    $this->operator = $payload->operator;
+    $this->value = $payload->value;
   }
 
   /**
-   * Create Dissector instance.
-   * @param mixed $field
-   * @param mixed $dissector
+   * Create Clause instance.
+   * 
+   * @param Payload $payload
    * @return Clause
    */
-  public static function make($field, $operator, $value)
+  public static function make(Payload $payload)
   {
-    return new self($field, $operator, $value);
+    return new self($payload);
   }
 
   /**
@@ -96,6 +96,16 @@ public function relation($bag)
     return $instance;
   }
 
+  /**
+   * Get the Payload instance.
+   * 
+   * @return Payload
+   */
+  public function getPayload(): Payload
+  {
+    return $this->payload;
+  }
+
   public function apply(Builder $builder)
   {
     return $builder->where(

src/Engines/Foundation/ClauseFactory.php

@@ -43,8 +43,9 @@ public function make(Payload $payload): Clause
 
     $resolvedField    = $this->resolveField($payload);
     $resolvedOperator = $this->resolveOperator($payload);
+    $payload->setField($resolvedField)->setOperator($resolvedOperator);
 
-    return (new Clause($resolvedField, $resolvedOperator, $payload->value))
+    return (new Clause($payload))
       ->setStatus($valid);
   }
 

src/Engines/Invokeable.php

@@ -8,9 +8,11 @@
 use Kettasoft\Filterable\Support\Payload;
 use Illuminate\Support\Traits\ForwardsCalls;
 use Kettasoft\Filterable\Engines\Foundation\Engine;
-use Kettasoft\Filterable\Support\ConditionNormalizer;
 use Kettasoft\Filterable\Engines\Foundation\Attributes\AttributeContext;
 use Kettasoft\Filterable\Engines\Foundation\Attributes\AttributePipeline;
+use Kettasoft\Filterable\Engines\Foundation\Clause;
+use Kettasoft\Filterable\Engines\Foundation\ClauseFactory;
+use Kettasoft\Filterable\Engines\Foundation\Parsers\Dissector;
 
 class Invokeable extends Engine
 {
@@ -37,40 +39,42 @@ public function execute(Builder $builder): Builder
   {
     $this->builder = $builder;
 
+    // Set allowed fields from $filters property automatically.
+    $this->context->setAllowedFields($this->context->getFilterAttributes());
+
     foreach ($this->context->getFilterAttributes() as $filter) {
-      $value = $this->context->getRequest()->get($filter);
 
-      if (($this->context->hasIgnoredEmptyValues() || config('filterable.engines.invokable.ignore_empty_values')) && !$value) {
+      $dissector = Dissector::parse($this->context->getRequest()->get($filter), $this->defaultOperator());
+
+      $payload = new Payload($filter, $dissector->operator, $this->sanitizeValue($filter, $dissector->value), $dissector->value);
+
+      $clause = (new ClauseFactory($this))->make($payload);
+
+      if (($this->context->hasIgnoredEmptyValues() || config('filterable.engines.invokable.ignore_empty_values')) && !$clause->value) {
         continue;
       }
 
       $method = $this->getMethodName($filter);
 
-      $this->initializeFilters($filter, $method, $value);
+      $this->initializeFilters($filter, $method, $clause->getPayload());
     }
 
     return $this->builder;
   }
 
   /**
    * Initialize the filter methods and resolve value.
+   * @param string $key
    * @param string $method
-   * @param mixed $value
+   * @param Payload $payload
    * @return void
    */
-  protected function initializeFilters(string $key, string $method, mixed $value): void
+  protected function initializeFilters(string $key, string $method, Payload $payload): void
   {
-    $clause = ConditionNormalizer::normalize($value, '=');
-
-    $operator = $clause['operator'];
-    $val = $clause['value'];
-
     if (! method_exists($this->context, $method)) {
       return;
     }
 
-    $payload = new Payload($key, $operator, $this->sanitizeValue($key, $val), $val);
-
     $attrContext = new AttributeContext(
       $this->builder,
       $payload,

src/Support/Payload.php

@@ -228,6 +228,50 @@ public function setValue(mixed $value): Payload
     return $this;
   }
 
+  /**
+   * Set the payload field.
+   *
+   * @param string $field
+   * @return Payload
+   */
+  public function setField(string $field): Payload
+  {
+    $this->field = $field;
+    return $this;
+  }
+
+  /**
+   * Set the payload operator.
+   *
+   * @param string $operator
+   * @return Payload
+   */
+  public function setOperator(string $operator): Payload
+  {
+    $this->operator = $operator;
+    return $this;
+  }
+
+  /**
+   * Get the payload field.
+   *
+   * @return string
+   */
+  public function getField(): string
+  {
+    return $this->field;
+  }
+
+  /**
+   * Get the payload operator.
+   * 
+   * @return string
+   */
+  public function getOperator(): string
+  {
+    return $this->operator;
+  }
+
   /**
    * Get the payload value as an array.
    *

tests/Unit/Engines/InvokableEngineTest.php

@@ -34,36 +34,37 @@ public function setUp(): void
    * It can filter with basic class filter.
    * @test
    */
-  public function it_can_filter_by_request_query_key_name()
+  public function it_can_test_method_mapping_filter()
   {
-
     request()->merge([
-      'status' => '',
+      'status' => 'pending'
     ]);
 
     $filter = new class extends Filterable {
       protected $filters = ['status'];
-      public $ignoreEmptyValues = true;
+      protected $mentors = [
+        'status' => 'filterBystatus'
+      ];
 
-      public function status(Payload $payload)
+      public function filterBystatus(Payload $payload)
       {
-        return $this->builder->where('status', $payload->value);
+        return $this->builder->where('status', $payload);
       }
     };
 
     $posts = Post::filter($filter)->count();
 
-    $this->assertEquals(12, $posts);
+    $this->assertEquals(5, $posts);
   }
 
   /**
    * It can filter with basic class filter.
    * @test
    */
-  public function it_can_test_method_mapping_filter()
+  public function it_filter_with_ignored_null_or_empty_values()
   {
     request()->merge([
-      'status' => 'pending'
+      'status' => ''
     ]);
 
     $filter = new class extends Filterable {
@@ -74,7 +75,11 @@ public function it_can_test_method_mapping_filter()
 
       public function filterBystatus(Payload $payload)
       {
-        return $this->builder->where('status', $payload);
+        if ($payload->value) {
+          return $this->builder->where('status', $payload);
+        }
+
+        return $this->builder->where($payload->field, 'pending');
       }
     };
 
@@ -84,28 +89,24 @@ public function filterBystatus(Payload $payload)
   }
 
   /**
-   * It can filter with basic class filter.
+   * It can filter with field and operator.
    * @test
    */
-  public function it_filter_with_ignored_null_or_empty_values()
+  public function it_can_filter_with_field_and_operator()
   {
     request()->merge([
-      'status' => ''
+      'status' => [
+        'operator' => 'eq',
+        'value' => 'pending'
+      ]
     ]);
 
     $filter = new class extends Filterable {
       protected $filters = ['status'];
-      protected $mentors = [
-        'status' => 'filterBystatus'
-      ];
 
-      public function filterBystatus(Payload $payload)
+      public function status(Payload $payload)
       {
-        if ($payload->value) {
-          return $this->builder->where('status', $payload);
-        }
-
-        return $this->builder->where($payload->field, 'pending');
+        return $this->builder->where('status', $payload->operator, $payload->value);
       }
     };