Refactor filter method in Filterable trait to use scopeFilter

Thavarshan · Apr 10, 2024 · fd9362a · fd9362a
1 parent c54f910
commit fd9362a
Show file tree

Hide file tree

Showing 4 changed files with 57 additions and 14 deletions.
diff --git a/README.md b/README.md
@@ -119,7 +119,7 @@ class PostController extends Controller
 {
     public function index(Request $request, PostFilter $filter)
     {
-        $query = Post::query()->filter($filter);
+        $query = Post::filter($filter);
 
         $posts = $request->has('paginate')
             ? $query->paginate($request->query('per_page', 20))
@@ -145,7 +145,7 @@ class PostController extends Controller
     {
         $filter->forUser($request->user());
 
-        $query = Post::query()->filter($filter);
+        $query = Post::filter($filter);
 
         $posts = $request->has('paginate')
             ? $query->paginate($request->query('per_page', 20))
@@ -207,7 +207,7 @@ class PostFilterTest extends TestCase
         $inactivePost = Post::factory()->create(['status' => 'inactive']);
 
         $filter = new PostFilter(new Request(['status' => 'active']));
-        $filteredPosts = $filter->apply(Post::query())->get();
+        $filteredPosts = Post::filter($filter)->get();
 
         $this->assertTrue($filteredPosts->contains($activePost));
         $this->assertFalse($filteredPosts->contains($inactivePost));

diff --git a/src/Filterable/Interfaces/Filterable.php b/src/Filterable/Interfaces/Filterable.php
@@ -2,6 +2,7 @@
 
 namespace Filterable\Interfaces;
 
+use Exception;
 use Illuminate\Database\Eloquent\Builder;
 
 /**
@@ -14,9 +15,17 @@ interface Filterable
     /**
      * Apply all relevant space filters.
      *
-     * @param \Filterable\Interfaces\Filter $filters
+     * @param \Illuminate\Database\Eloquent\Builder $query
+     * @param \Filterable\Interfaces\Filter         $filters
+     * @param array|null                            $options
      *
-     * @return \Illuminate\Database\Eloquent\Builder
+     * @return \Illuminate\Database\Eloquent\Builder $query
+     *
+     * @throws Exception
      */
-    public function filter(Filter $filters): Builder;
+    public function scopeFilter(
+        Builder $query,
+        Filter $filters,
+        ?array $options = []
+    ): Builder;
 }
diff --git a/src/Filterable/Traits/Filterable.php b/src/Filterable/Traits/Filterable.php
@@ -11,15 +11,19 @@ trait Filterable
     /**
      * Apply all relevant space filters.
      *
-     * @param \Filterable\Interfaces\Filter $filters
-     * @param array|null                    $options
+     * @param \Illuminate\Database\Eloquent\Builder $query
+     * @param \Filterable\Interfaces\Filter         $filters
+     * @param array|null                            $options
      *
      * @return \Illuminate\Database\Eloquent\Builder $query
      *
      * @throws Exception
      */
-    public function filter(Filter $filters, ?array $options = []): Builder
-    {
-        return $filters->apply($this->newModelQuery(), $options);
+    public function scopeFilter(
+        Builder $query,
+        Filter $filters,
+        ?array $options = []
+    ): Builder {
+        return $filters->apply($query, $options);
     }
 }
diff --git a/tests/FilterTest.php b/tests/FilterTest.php
@@ -28,6 +28,11 @@ protected function setUp(): void
             'name' => 'John Doe',
             'email' => '[email protected]',
         ]);
+
+        MockFilterable::factory()->create([
+            'name' => 'Jane Doe',
+            'email' => '[email protected]',
+        ]);
     }
 
     /**
@@ -59,10 +64,11 @@ public function testAppliesFiltersDynamicallyBasedOnRequest(): void
             $model->newQuery()->where('name', 'LIKE', '%John Doe%')->toSql(),
             $results->toSql()
         );
+        $this->assertCount(1, $results->get());
         $this->assertEquals('John Doe', $results->first()->name);
     }
 
-    public function testAppliesFiltersDynamicallyBasedOnRequestWithCustomMethodNames(): void
+    public function testAppliesFiltersManuallyThroughModel(): void
     {
         $request = Request::create('/?name=' . urlencode('John Doe'), 'GET');
         $model = new MockFilterable();
@@ -71,6 +77,29 @@ public function testAppliesFiltersDynamicallyBasedOnRequestWithCustomMethodNames
         $cache = m::mock(Repository::class);
         $cache->shouldNotReceive('remember')->andReturn($builder);
 
+        // Assuming 'name' filter translates to a method call
+        $filter = new MockFilter($request, $cache);
+        $filter->setUseCache(false);
+
+        $results = $model->filter($filter);
+
+        $this->assertEquals(
+            $model->newQuery()->where('name', 'LIKE', '%John Doe%')->toSql(),
+            $results->toSql()
+        );
+        $this->assertCount(1, $results->get());
+        $this->assertEquals('John Doe', $results->first()->name);
+    }
+
+    public function testAppliesFiltersDynamicallyBasedOnRequestWithCustomMethodNames(): void
+    {
+        $request = Request::create('/?name=' . urlencode('Jane Doe'), 'GET');
+        $model = new MockFilterable();
+        $builder = $model->newQuery();
+
+        $cache = m::mock(Repository::class);
+        $cache->shouldNotReceive('remember')->andReturn($builder);
+
         // Assuming 'name' filter translates to a method call
         $filter = new class ($request, $cache) extends Filter {
             protected array $filterMethodMap = [
@@ -88,10 +117,11 @@ public function filterByName($name)
         $results = $filter->apply($builder);
 
         $this->assertEquals(
-            $model->newQuery()->where('name', 'LIKE', '%John Doe%')->toSql(),
+            $model->newQuery()->where('name', 'LIKE', '%Jane Doe%')->toSql(),
             $results->toSql()
         );
-        $this->assertEquals('John Doe', $results->first()->name);
+        $this->assertCount(1, $results->get());
+        $this->assertEquals('Jane Doe', $results->first()->name);
     }
 
     public function testHandlesCachingCorrectly(): void