adding a feature to define where conditionals before searches

Author: adhenrique

src/Services/SearchService.php

@@ -2,7 +2,10 @@
 
 namespace LaravelDomainOriented\Services;
 
+use Illuminate\Contracts\Auth\Guard;
+use Illuminate\Database\Eloquent\Builder;
 use Illuminate\Http\Request;
+use Illuminate\Support\Facades\Auth;
 use LaravelDomainOriented\Models\SearchModel;
 
 class SearchService
@@ -19,7 +22,9 @@ public function __construct(SearchModel $model, FilterService $filterService)
 
     public function all(Request $request)
     {
-        $builder = $this->filterService->apply($this->model->query(), $request);
+        $builder = $this->beforeSearch($this->model->query(), Auth::guard());
+
+        $builder = $this->filterService->apply($builder, $request);
         $paginate = $request->get('paginate');
 
         $page = $paginate['page'] ?? 0;
@@ -34,11 +39,18 @@ public function all(Request $request)
 
     public function findById(int $id)
     {
-        return $this->model->findOrFail($id);
+        $builder = $this->beforeSearch($this->model->query(), Auth::guard());
+
+        return $builder->findOrFail($id);
     }
 
     public function getModel(): SearchModel
     {
         return $this->model;
     }
+
+    public function beforeSearch(Builder $builder, Guard $auth): Builder
+    {
+        return $builder;
+    }
 }

tests/Unit/SearchServiceTest.php

@@ -2,9 +2,16 @@
 
 namespace Tests\Unit;
 
+use App\Domain\Test\TestFilterService;
+use App\Domain\Test\TestSearchModel;
 use App\Domain\Test\TestSearchService;
+use Illuminate\Contracts\Auth\Guard;
+use Illuminate\Database\Eloquent\Builder;
 use Illuminate\Database\Eloquent\ModelNotFoundException;
 use Illuminate\Http\Request;
+use LaravelDomainOriented\Models\SearchModel;
+use LaravelDomainOriented\Services\FilterService;
+use LaravelDomainOriented\Services\SearchService;
 use LaravelDomainOriented\Tests\Cases\DBTestCase;
 
 class SearchServiceTest extends DBTestCase
@@ -95,4 +102,30 @@ public function it_should_throw_model_not_found_exception()
 
         $searchService->findById(15);
     }
+
+    /** @test **/
+    public function it_should_use_before_search_method_and_return_no_data()
+    {
+        $searchService = $this->app->make(MyCustomSearchService::class);
+        $request = new Request();
+        $data = $searchService->all($request);
+
+        $this->assertCount(0, $data);
+    }
+}
+
+class MyCustomSearchService extends SearchService {
+    protected SearchModel $model;
+    protected FilterService $filterService;
+
+    public function __construct(TestSearchModel $model, TestFilterService $filterService)
+    {
+        $this->model = $model;
+        $this->filterService = $filterService;
+    }
+
+    public function beforeSearch(Builder $builder, Guard $auth): Builder
+    {
+        return $builder->where('name', 'xxxx');
+    }
 }