feat: initial work on filter validation

Author: lindyhopchris

src/Contracts/Filter.php

@@ -13,10 +13,10 @@
 
 use Illuminate\Database\Eloquent\Builder;
 use LaravelJsonApi\Contracts\Schema\Filter as BaseFilter;
+use LaravelJsonApi\Validation\Filters\IsValidated;
 
-interface Filter extends BaseFilter
+interface Filter extends BaseFilter, IsValidated
 {
-
     /**
      * Does the filter return a singular resource?
      *

src/Filters/Concerns/DeserializesValue.php

@@ -16,21 +16,26 @@
 
 trait DeserializesValue
 {
-
     /**
      * @var Closure|null
      */
     private ?Closure $deserializer = null;
 
+    /**
+     * @var bool
+     */
+    private bool $asBool = false;
+
     /**
      * Use the supplied callback to deserialize the value.
      *
      * @param Closure $deserializer
      * @return $this
      */
-    public function deserializeUsing(Closure $deserializer): self
+    public function deserializeUsing(Closure $deserializer): static
     {
         $this->deserializer = $deserializer;
+        $this->asBool = false;
 
         return $this;
     }
@@ -40,11 +45,9 @@ public function deserializeUsing(Closure $deserializer): self
      *
      * @return $this
      */
-    public function asBoolean(): self
+    public function asBoolean(): static
     {
-        $this->deserializeUsing(
-            static fn($value) => filter_var($value, FILTER_VALIDATE_BOOL)
-        );
+        $this->asBool = true;
 
         return $this;
     }
@@ -55,8 +58,12 @@ public function asBoolean(): self
      * @param mixed $value
      * @return mixed
      */
-    protected function deserialize($value)
+    protected function deserialize(mixed $value): mixed
     {
+        if (true === $this->asBool) {
+            return filter_var($value, FILTER_VALIDATE_BOOL);
+        }
+
         if ($this->deserializer) {
             return ($this->deserializer)($value);
         }

src/Filters/Concerns/HasDelimiter.php

@@ -19,7 +19,6 @@
 
 trait HasDelimiter
 {
-
     /**
      * @var string|null
      */
@@ -28,14 +27,12 @@ trait HasDelimiter
     /**
      * If the filter accepts a string value, the delimiter to use to extract values.
      *
-     * @param string $delimiter
+     * @param non-empty-string $delimiter
      * @return $this
      */
-    public function delimiter(string $delimiter): self
+    public function delimiter(string $delimiter): static
     {
-        if (empty($delimiter)) {
-            throw new InvalidArgumentException('Expecting a non-empty string delimiter.');
-        }
+        assert(!empty($delimiter), 'Expecting a non-empty string delimiter.');
 
         $this->delimiter = $delimiter;
 
@@ -45,10 +42,10 @@ public function delimiter(string $delimiter): self
     /**
      * Convert the provided value to an array.
      *
-     * @param string|array|null $value
+     * @param mixed $value
      * @return array
      */
-    protected function toArray($value): array
+    protected function toArray(mixed $value): array
     {
         if ($this->delimiter && is_string($value)) {
             return ('' !== $value) ? explode($this->delimiter, $value) : [];

src/Filters/Has.php

@@ -11,26 +11,31 @@
 
 namespace LaravelJsonApi\Eloquent\Filters;
 
+use Illuminate\Http\Request;
+use LaravelJsonApi\Core\Query\Input\Query;
 use LaravelJsonApi\Eloquent\Contracts\Filter;
 use LaravelJsonApi\Eloquent\Filters\Concerns\HasRelation;
 use LaravelJsonApi\Eloquent\Filters\Concerns\IsSingular;
 use LaravelJsonApi\Eloquent\Schema;
+use LaravelJsonApi\Validation\Filters\Validated;
+use LaravelJsonApi\Validation\Rules\JsonBoolean;
 use function filter_var;
 
 class Has implements Filter
 {
     use HasRelation;
     use IsSingular;
+    use Validated;
 
     /**
      * Create a new filter.
      *
      * @param Schema $schema
      * @param string $fieldName
      * @param string|null $key
-     * @return static
+     * @return self
      */
-    public static function make(Schema $schema, string $fieldName, string $key = null)
+    public static function make(Schema $schema, string $fieldName, string $key = null): self
     {
         return new static($schema, $fieldName, $key);
     }
@@ -64,13 +69,21 @@ public function apply($query, $value)
         return $query->doesntHave($relationName);
     }
 
+    /**
+     * @inheritDoc
+     */
+    public function validationRules(?Request $request, Query $query): array
+    {
+        return [(new JsonBoolean())->asString()];
+    }
+
     /**
      * Deserialize the value.
      *
      * @param mixed $value
      * @return bool
      */
-    protected function deserialize($value): bool
+    protected function deserialize(mixed $value): bool
     {
         return filter_var($value, FILTER_VALIDATE_BOOL);
     }

src/Filters/OnlyTrashed.php

@@ -15,7 +15,6 @@
 
 class OnlyTrashed extends WithTrashed
 {
-
     /**
      * @inheritDoc
      */
@@ -31,5 +30,4 @@ public function apply($query, $value)
 
         throw new LogicException("Filter {$this->key()} expects query builder to have a `withTrashed` method.");
     }
-
 }

src/Filters/Scope.php

@@ -13,12 +13,13 @@
 
 use LaravelJsonApi\Core\Support\Str;
 use LaravelJsonApi\Eloquent\Contracts\Filter;
+use LaravelJsonApi\Eloquent\Filters\Concerns\DeserializesValue;
+use LaravelJsonApi\Eloquent\Filters\Concerns\IsSingular;
 
 class Scope implements Filter
 {
-
-    use Concerns\DeserializesValue;
-    use Concerns\IsSingular;
+    use DeserializesValue;
+    use IsSingular;
 
     /**
      * @var string

src/Filters/Where.php

@@ -13,14 +13,20 @@
 
 use LaravelJsonApi\Core\Support\Str;
 use LaravelJsonApi\Eloquent\Contracts\Filter;
+use LaravelJsonApi\Eloquent\Filters\Concerns\DeserializesValue;
+use LaravelJsonApi\Eloquent\Filters\Concerns\HasColumn;
+use LaravelJsonApi\Eloquent\Filters\Concerns\HasOperator;
+use LaravelJsonApi\Eloquent\Filters\Concerns\IsSingular;
+use LaravelJsonApi\Validation\Filters\ValidatedWithRules;
+use LaravelJsonApi\Validation\Rules\JsonBoolean;
 
 class Where implements Filter
 {
-
-    use Concerns\DeserializesValue;
-    use Concerns\HasColumn;
-    use Concerns\HasOperator;
-    use Concerns\IsSingular;
+    use DeserializesValue;
+    use HasColumn;
+    use HasOperator;
+    use IsSingular;
+    use ValidatedWithRules;
 
     /**
      * @var string
@@ -72,6 +78,18 @@ public function apply($query, $value)
         );
     }
 
+    /**
+     * @return array<int, mixed>
+     */
+    protected function defaultRules(): array
+    {
+        if ($this->asBool) {
+            return [(new JsonBoolean())->asString()];
+        }
+
+        return [];
+    }
+
     /**
      * @return string
      */

src/Filters/WhereHas.php

@@ -12,18 +12,23 @@
 namespace LaravelJsonApi\Eloquent\Filters;
 
 use Closure;
+use Illuminate\Http\Request;
+use LaravelJsonApi\Core\Query\Input\Query;
 use LaravelJsonApi\Eloquent\Contracts\Filter;
 use LaravelJsonApi\Eloquent\Filters\Concerns\DeserializesToArray;
 use LaravelJsonApi\Eloquent\Filters\Concerns\HasRelation;
 use LaravelJsonApi\Eloquent\Filters\Concerns\IsSingular;
 use LaravelJsonApi\Eloquent\QueryBuilder\Applicators\FilterApplicator;
 use LaravelJsonApi\Eloquent\Schema;
+use LaravelJsonApi\Validation\Filters\FilterRuleMap;
+use LaravelJsonApi\Validation\Filters\Validated;
 
 class WhereHas implements Filter
 {
     use DeserializesToArray;
     use HasRelation;
     use IsSingular;
+    use Validated;
 
     /**
      * Create a new filter.
@@ -63,13 +68,22 @@ public function apply($query, $value)
         );
     }
 
+    /**
+     * @inheritDoc
+     */
+    public function validationRules(?Request $request, Query $query): array
+    {
+        return FilterRuleMap::make($this->schema->filters())
+            ->rules($request, $query);
+    }
+
     /**
      * Get the relation query callback.
      *
      * @param mixed $value
      * @return Closure
      */
-    protected function callback($value): Closure
+    protected function callback(mixed $value): Closure
     {
         return function($query) use ($value) {
             $relation = $this->relation();

src/Filters/WhereIdIn.php

@@ -16,12 +16,12 @@
 use LaravelJsonApi\Contracts\Schema\Schema;
 use LaravelJsonApi\Core\Schema\IdParser;
 use LaravelJsonApi\Eloquent\Contracts\Filter;
+use LaravelJsonApi\Eloquent\Filters\Concerns\HasDelimiter;
 use LaravelJsonApi\Eloquent\Schema as EloquentSchema;
 
 class WhereIdIn implements Filter
 {
-
-    use Concerns\HasDelimiter;
+    use HasDelimiter;
 
     /**
      * @var ID

src/Filters/WhereIdNotIn.php

@@ -13,7 +13,6 @@
 
 class WhereIdNotIn extends WhereIdIn
 {
-
     /**
      * @inheritDoc
      */

src/Filters/WhereIn.php

@@ -13,13 +13,15 @@
 
 use LaravelJsonApi\Core\Support\Str;
 use LaravelJsonApi\Eloquent\Contracts\Filter;
+use LaravelJsonApi\Eloquent\Filters\Concerns\DeserializesValue;
+use LaravelJsonApi\Eloquent\Filters\Concerns\HasColumn;
+use LaravelJsonApi\Eloquent\Filters\Concerns\HasDelimiter;
 
 class WhereIn implements Filter
 {
-
-    use Concerns\DeserializesValue;
-    use Concerns\HasColumn;
-    use Concerns\HasDelimiter;
+    use DeserializesValue;
+    use HasColumn;
+    use HasDelimiter;
 
     /**
      * @var string
@@ -78,7 +80,7 @@ public function apply($query, $value)
     }
 
     /**
-     * Deserialize the fitler value.
+     * Deserialize the filter value.
      *
      * @param string|array $value
      * @return array

src/Filters/WhereNull.php

@@ -11,13 +11,20 @@
 
 namespace LaravelJsonApi\Eloquent\Filters;
 
+use Illuminate\Http\Request;
+use LaravelJsonApi\Core\Query\Input\Query;
 use LaravelJsonApi\Core\Support\Str;
 use LaravelJsonApi\Eloquent\Contracts\Filter;
+use LaravelJsonApi\Eloquent\Filters\Concerns\HasColumn;
+use LaravelJsonApi\Eloquent\Filters\Concerns\IsSingular;
+use LaravelJsonApi\Validation\Filters\Validated;
+use LaravelJsonApi\Validation\Rules\JsonBoolean;
 
 class WhereNull implements Filter
 {
-    use Concerns\HasColumn;
-    use Concerns\IsSingular;
+    use HasColumn;
+    use IsSingular;
+    use Validated;
 
     /**
      * @var string
@@ -71,6 +78,14 @@ public function apply($query, $value)
         return $query->whereNotNull($column);
     }
 
+    /**
+     * @inheritDoc
+     */
+    public function validationRules(?Request $request, Query $query): array
+    {
+        return [(new JsonBoolean())->asString()];
+    }
+
     /**
      * Should a "where null" query be used?
      *
@@ -88,7 +103,7 @@ protected function isWhereNull(bool $value): bool
      * @param mixed $value
      * @return bool
      */
-    private function deserialize($value): bool
+    private function deserialize(mixed $value): bool
     {
         return filter_var($value, FILTER_VALIDATE_BOOL);
     }

src/Filters/WherePivot.php

@@ -15,7 +15,6 @@
 
 class WherePivot extends Where
 {
-
     /**
      * @inheritDoc
      */
@@ -40,5 +39,4 @@ public function apply($query, $value)
             $this->deserialize($value)
         );
     }
-
 }

src/Filters/WherePivotIn.php

@@ -15,7 +15,6 @@
 
 class WherePivotIn extends WhereIn
 {
-
     /**
      * @inheritDoc
      */

src/Filters/WherePivotNotIn.php

@@ -15,7 +15,6 @@
 
 class WherePivotNotIn extends WhereIn
 {
-
     /**
      * @inheritDoc
      */

src/Filters/WithTrashed.php

@@ -11,12 +11,17 @@
 
 namespace LaravelJsonApi\Eloquent\Filters;
 
+use Illuminate\Http\Request;
+use LaravelJsonApi\Core\Query\Input\Query;
 use LaravelJsonApi\Eloquent\Contracts\Filter;
+use LaravelJsonApi\Validation\Filters\Validated;
+use LaravelJsonApi\Validation\Rules\JsonBoolean;
 use LogicException;
 use function filter_var;
 
 class WithTrashed implements Filter
 {
+    use Validated;
 
     /**
      * @var string
@@ -75,13 +80,19 @@ public function key(): string
     }
 
     /**
-     * @param $value
+     * @inheritDoc
+     */
+    public function validationRules(?Request $request, Query $query): array
+    {
+        return [(new JsonBoolean())->asString()];
+    }
+
+    /**
+     * @param mixed $value
      * @return bool
      */
-    protected function deserialize($value): bool
+    protected function deserialize(mixed $value): bool
     {
         return filter_var($value, FILTER_VALIDATE_BOOL);
     }
-
-
 }