Add Limited Operators Support for Resource Filtering

src/Concerns/Resource/Operatable.php

@@ -0,0 +1,50 @@
+<?php
+
+namespace Lomkit\Rest\Concerns\Resource;
+
+use Lomkit\Rest\Http\Requests\RestRequest;
+
+trait Operatable
+{
+    /**
+     * The calculated operators if already done in this request.
+     *
+     * @var array
+     */
+    protected array $calculatedOperators;
+
+    /**
+     * The operators that could be provided.
+     *
+     * @param RestRequest $request
+     *
+     * @return array
+     */
+    public function operators(RestRequest $request): array
+    {
+        return [
+            '=',
+            '!=',
+            '>',
+            '>=',
+            '<',
+            '<=',
+            'like',
+            'not like',
+            'in',
+            'not in',
+        ];
+    }
+
+    /**
+     * Get the resource's operators.
+     *
+     * @param \Lomkit\Rest\Http\Requests\RestRequest $request
+     *
+     * @return array
+     */
+    public function getOperators(\Lomkit\Rest\Http\Requests\RestRequest $request): array
+    {
+        return $this->calculatedOperators ?? ($this->calculatedOperators = $this->operators($request));
+    }
+}

src/Http/Resource.php

@@ -11,6 +11,7 @@
 use Lomkit\Rest\Concerns\PerformsQueries;
 use Lomkit\Rest\Concerns\Resource\ConfiguresRestParameters;
 use Lomkit\Rest\Concerns\Resource\HasResourceHooks;
+use Lomkit\Rest\Concerns\Resource\Operatable;
 use Lomkit\Rest\Concerns\Resource\Paginable;
 use Lomkit\Rest\Concerns\Resource\Relationable;
 use Lomkit\Rest\Concerns\Resource\Rulable;
@@ -31,6 +32,7 @@ class Resource implements \JsonSerializable
     use Actionable;
     use Instructionable;
     use HasResourceHooks;
+    use Operatable;
 
     /**
      * The model the entry corresponds to.

src/Rules/SearchRules.php

@@ -131,7 +131,7 @@ public function filtersRules(\Lomkit\Rest\Http\Resource $resource, string $prefi
 
         $operatorRules = $isScoutMode ?
             ['=', 'in', 'not in'] :
-            ['=', '!=', '>', '>=', '<', '<=', 'like', 'not like', 'in', 'not in'];
+            $resource->getOperators($this->request);
 
         $fieldValidation = $isScoutMode ?
             Rule::in($resource->getScoutFields($this->request)) :

tests/Feature/Controllers/SearchFilteringOperationsTest.php

@@ -10,6 +10,7 @@
 use Lomkit\Rest\Tests\Support\Database\Factories\MorphToManyRelationFactory;
 use Lomkit\Rest\Tests\Support\Models\Model;
 use Lomkit\Rest\Tests\Support\Policies\GreenPolicy;
+use Lomkit\Rest\Tests\Support\Rest\Resources\LimitedModelResource;
 use Lomkit\Rest\Tests\Support\Rest\Resources\ModelResource;
 
 class SearchFilteringOperationsTest extends TestCase
@@ -626,4 +627,53 @@ public function test_getting_a_list_of_resources_filtered_by_morphed_by_many_piv
             new ModelResource()
         );
     }
+
+    public function test_getting_a_list_of_resources_filtered_by_limited_operators(): void
+    {
+        $matchingModel = ModelFactory::new()->create(['name' => 'match'])->fresh();
+        ModelFactory::new()->create(['name' => 'not match'])->fresh();
+
+        Gate::policy(Model::class, GreenPolicy::class);
+
+        $response = $this->post(
+            '/api/limited-models/search',
+            [
+                'search' => [
+                    'filters' => [
+                        ['field' => 'name', 'operator' => '=', 'value' => 'match'],
+                    ],
+                ],
+            ],
+            ['Accept' => 'application/json']
+        );
+
+        $this->assertResourcePaginated(
+            $response,
+            [$matchingModel],
+            new LimitedModelResource()
+        );
+    }
+
+    public function test_getting_a_list_of_resources_filtered_by_limited_operators_with_invalid_operator(): void
+    {
+        ModelFactory::new()->create(['name' => 'match'])->fresh();
+        ModelFactory::new()->create(['name' => 'not match'])->fresh();
+
+        Gate::policy(Model::class, GreenPolicy::class);
+
+        $response = $this->post(
+            '/api/limited-models/search',
+            [
+                'search' => [
+                    'filters' => [
+                        ['field' => 'name', 'operator' => 'like', 'value' => 'match'],
+                    ],
+                ],
+            ],
+            ['Accept' => 'application/json']
+        );
+
+        $response->assertStatus(422);
+        $response->assertJsonStructure(['message', 'errors' => ['search.filters.0.operator']]);
+    }
 }

tests/Support/Http/Controllers/LimitedModelController.php

@@ -0,0 +1,11 @@
+<?php
+
+namespace Lomkit\Rest\Tests\Support\Http\Controllers;
+
+use Lomkit\Rest\Http\Controllers\Controller;
+use Lomkit\Rest\Tests\Support\Rest\Resources\LimitedModelResource;
+
+class LimitedModelController extends Controller
+{
+    public static $resource = LimitedModelResource::class;
+}

tests/Support/Rest/Resources/LimitedModelResource.php

@@ -0,0 +1,16 @@
+<?php
+
+namespace Lomkit\Rest\Tests\Support\Rest\Resources;
+
+use Lomkit\Rest\Http\Requests\RestRequest;
+use Lomkit\Rest\Tests\Support\Models\Model;
+
+class LimitedModelResource extends ModelResource
+{
+    public static $model = Model::class;
+
+    public function operators(RestRequest $request): array
+    {
+        return ['='];
+    }
+}

tests/Support/Routes/api.php

@@ -4,6 +4,7 @@
 
 Route::group(['as' => 'api.', 'prefix' => 'api'], function () {
     \Lomkit\Rest\Facades\Rest::resource('models', \Lomkit\Rest\Tests\Support\Http\Controllers\ModelController::class);
+    \Lomkit\Rest\Facades\Rest::resource('limited-models', \Lomkit\Rest\Tests\Support\Http\Controllers\LimitedModelController::class);
     \Lomkit\Rest\Facades\Rest::resource('searchable-models', \Lomkit\Rest\Tests\Support\Http\Controllers\SearchableModelController::class);
     \Lomkit\Rest\Facades\Rest::resource('model-hooks', \Lomkit\Rest\Tests\Support\Http\Controllers\ModelHooksController::class)->withSoftDeletes();
     \Lomkit\Rest\Facades\Rest::resource('model-withs', \Lomkit\Rest\Tests\Support\Http\Controllers\ModelWithController::class);