Merge pull request #34 from kettasoft/feat/save-applied-filters

Add Applied Filters Tracking to Filterable Engine

Author: kettasoft

docs/api/filterable.md

@@ -269,6 +269,14 @@ Return the strict flag (`true`/`false`) or `null` when not explicitly set.
 
 ---
 
+### States & Clauses
+
+#### `applied($key): mixed`
+
+Get applied claueses.
+
+---
+
 ### Flow Control
 
 #### `when(bool $condition, callable $callback): static`

src/Contracts/Commitable.php

@@ -0,0 +1,21 @@
+<?php
+
+namespace Kettasoft\Filterable\Contracts;
+
+use Kettasoft\Filterable\Engines\Foundation\Clause;
+
+/**
+ * Contract for commitable filters.
+ * 
+ * @package Kettasoft\Filterable\Contracts
+ */
+interface Commitable
+{
+    /**
+     * Commit applied clauses.
+     * @param string $key
+     * @param Clause $clause
+     * @return bool
+     */
+    public function commit(string $key, Clause $clause): bool;
+}

src/Engines/Expression.php

@@ -49,6 +49,8 @@ public function execute(Builder $builder)
         continue; // skip disallowed field
       }
 
+      $this->commit($field, $clause);
+
       return Applier::apply(new ClauseApplier($clause), $builder);
     }
 

src/Engines/Foundation/Clause.php

@@ -42,7 +42,7 @@ class Clause implements Arrayable, Jsonable
    * 
    * @param Payload $payload
    */
-  public function __construct(protected Payload $payload)
+  public function __construct(Payload $payload)
   {
     $this->field = $payload->field;
     $this->operator = $payload->operator;

src/Engines/Foundation/Engine.php

@@ -110,4 +110,15 @@ final protected function sanitizeValue($filed, $value)
 
     return $sanitizer->handle($filed, $value);
   }
+
+  /**
+   * Commit applied clauses.
+   * @param string $key
+   * @param Clause $clause
+   * @return bool
+   */
+  final protected function commit(string $key, Clause $clause): bool
+  {
+    return $this->context->commit($key, $clause);
+  }
 }

src/Engines/Invokable.php

@@ -62,7 +62,9 @@ public function execute(Builder $builder): Builder
         throw new \RuntimeException(sprintf("Filter method [%s] conflicts with core Filterable method.", [$method]));
       }
 
-      $this->initializeFilters($filter, $method, $clause->getPayload());
+      $this->initializeFilters($filter, $method, $payload);
+
+      $this->commit($method, $clause);
     }
 
     return $this->builder;

src/Engines/Ruleset.php

@@ -43,6 +43,8 @@ public function execute(Builder $builder): Builder
       if (! $clause->validated) continue;
 
       Applier::apply(new ClauseApplier($clause), $builder);
+
+      $this->commit($field, $clause);
     }
 
     return $builder;

src/Engines/Tree.php

@@ -68,6 +68,8 @@ private function applyNode(Builder $builder, TreeNode $node)
       } else {
         Applier::apply(new ClauseApplier($clause), $builder);
       }
+
+      $this->commit($node->field, $clause);
     }
 
     return $builder;

src/Filterable.php

@@ -9,10 +9,12 @@
 use Illuminate\Support\Traits\Macroable;
 use Illuminate\Database\Eloquent\Builder;
 use Kettasoft\Filterable\Foundation\Invoker;
+use Kettasoft\Filterable\Contracts\Commitable;
 use Kettasoft\Filterable\Foundation\Resources;
 use Kettasoft\Filterable\Contracts\Validatable;
 use Kettasoft\Filterable\Contracts\Authorizable;
 use Kettasoft\Filterable\Sanitization\Sanitizer;
+use Kettasoft\Filterable\Engines\Foundation\Clause;
 use Kettasoft\Filterable\Engines\Foundation\Engine;
 use Kettasoft\Filterable\Foundation\Sorting\Sorter;
 use Kettasoft\Filterable\Contracts\FilterableContext;
@@ -21,15 +23,15 @@
 use Kettasoft\Filterable\Foundation\FilterableSettings;
 use Kettasoft\Filterable\Exceptions\MissingBuilderException;
 use Kettasoft\Filterable\Engines\Foundation\Executors\Executer;
+use Kettasoft\Filterable\Foundation\Contracts\FilterableProfile;
 use Kettasoft\Filterable\Foundation\Contracts\Sorting\Invokable;
+use Kettasoft\Filterable\Foundation\Events\Contracts\EventManager;
 use Kettasoft\Filterable\Foundation\Events\FilterableEventManager;
 use Kettasoft\Filterable\HttpIntegration\HeaderDrivenEngineSelector;
 use Kettasoft\Filterable\Foundation\Contracts\ShouldReturnQueryBuilder;
 use Kettasoft\Filterable\Exceptions\RequestSourceIsNotSupportedException;
-use Kettasoft\Filterable\Foundation\Contracts\FilterableProfile;
-use Kettasoft\Filterable\Foundation\Events\Contracts\EventManager;
 
-class Filterable implements FilterableContext, Authorizable, Validatable
+class Filterable implements FilterableContext, Authorizable, Validatable, Commitable
 {
   use Traits\InteractsWithFilterKey,
     Traits\InteractsWithMethodMentoring,
@@ -154,6 +156,12 @@ class Filterable implements FilterableContext, Authorizable, Validatable
    */
   protected static EventManager $eventManager;
 
+  /**
+   * Applied clauses.
+   * @var array
+   */
+  protected $applied = [];
+
   /**
    * Create a new Filterable instance.
    * @param Request|null $request
@@ -257,6 +265,34 @@ public function useProfile(FilterableProfile|callable|string $profile): static
     return $this;
   }
 
+  /**
+   * Commit clause.
+   * 
+   * @param string $key
+   * @param Clause $clause
+   * @return bool
+   */
+  public function commit(string $key, Clause $clause): bool
+  {
+    $this->applied[$key] = $clause;
+    return true;
+  }
+
+  /**
+   * Get applied clauses.
+   * 
+   * @param string $key
+   * @return array|Clause|null
+   */
+  public function applied($key = null)
+  {
+    if (!$key) {
+      return $this->applied;
+    }
+
+    return $this->applied[$key] ?? null;
+  }
+
   /**
    * Register the event manager instance.
    * @param array $options

tests/Feature/Filterable/FilterableCommitingFilterTest.php

@@ -0,0 +1,35 @@
+<?php
+
+namespace Kettasoft\Filterable\Tests\Feature\Filterable;
+
+use Kettasoft\Filterable\Filterable;
+use Kettasoft\Filterable\Tests\Models\Post;
+use Kettasoft\Filterable\Tests\TestCase;
+
+class FilterableCommitingFilterTest extends TestCase
+{
+    public function test_it_saving_applied_filters()
+    {
+        request()->merge([
+            'status' => 'active',
+            'category' => 'news',
+        ]);
+
+        $filterable = new class extends Filterable {
+            protected $filters = ['status', 'category'];
+            public function status($payload)
+            {
+                return $this->builder->where('status', $payload->value);
+            }
+            public function category($payload)
+            {
+                return $this->builder->where('category', $payload->value);
+            }
+        };
+
+        $filterable->apply(Post::query());
+
+        $this->assertCount(2, $filterable->applied());
+        $this->assertEquals('status', $filterable->applied('status')->field);
+    }
+}