feat: add validation to filters and page paginator

Author: lindyhopchris

src/Filters/Scope.php

@@ -15,11 +15,13 @@
 use LaravelJsonApi\Eloquent\Contracts\Filter;
 use LaravelJsonApi\Eloquent\Filters\Concerns\DeserializesValue;
 use LaravelJsonApi\Eloquent\Filters\Concerns\IsSingular;
+use LaravelJsonApi\Validation\Filters\ValidatedWithRules;
 
 class Scope implements Filter
 {
     use DeserializesValue;
     use IsSingular;
+    use ValidatedWithRules;
 
     /**
      * @var string

src/Filters/WhereIdIn.php

@@ -11,17 +11,21 @@
 
 namespace LaravelJsonApi\Eloquent\Filters;
 
+use Closure;
 use Illuminate\Database\Eloquent\Model;
 use LaravelJsonApi\Contracts\Schema\ID;
 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;
+use LaravelJsonApi\Validation\Filters\ValidatedWithRules;
+use LaravelJsonApi\Validation\Rules\ListOfIds;
 
 class WhereIdIn implements Filter
 {
     use HasDelimiter;
+    use ValidatedWithRules;
 
     /**
      * @var ID
@@ -143,4 +147,11 @@ protected function deserialize($value): array
         );
     }
 
+    /**
+     * @return array<int, mixed>
+     */
+    protected function defaultRules(): array
+    {
+        return [new ListOfIds($this->field, $this->delimiter)];
+    }
 }

src/Filters/WhereIn.php

@@ -16,12 +16,14 @@
 use LaravelJsonApi\Eloquent\Filters\Concerns\DeserializesValue;
 use LaravelJsonApi\Eloquent\Filters\Concerns\HasColumn;
 use LaravelJsonApi\Eloquent\Filters\Concerns\HasDelimiter;
+use LaravelJsonApi\Validation\Filters\ValidatedWithRules;
 
 class WhereIn implements Filter
 {
     use DeserializesValue;
     use HasColumn;
     use HasDelimiter;
+    use ValidatedWithRules;
 
     /**
      * @var string
@@ -103,5 +105,4 @@ private function guessColumn(): string
             Str::singular($this->name)
         );
     }
-
 }

src/Filters/WhereNotIn.php

@@ -13,7 +13,6 @@
 
 class WhereNotIn extends WhereIn
 {
-
     /**
      * @inheritDoc
      */

src/Pagination/PagePagination.php

@@ -20,12 +20,14 @@
 use LaravelJsonApi\Core\Pagination\Concerns\HasPageNumbers;
 use LaravelJsonApi\Core\Pagination\Page;
 use LaravelJsonApi\Eloquent\Contracts\Paginator;
+use LaravelJsonApi\Validation\Pagination\IsValidated;
+use LaravelJsonApi\Validation\Pagination\Validated;
 
-class PagePagination implements Paginator
+class PagePagination implements Paginator, IsValidated
 {
-
     use HasPageMeta;
     use HasPageNumbers;
+    use Validated;
 
     /**
      * @var array|null
@@ -171,6 +173,24 @@ protected function isSimplePagination(): bool
         return (bool) $this->simplePagination;
     }
 
+    /**
+     * @return array
+     */
+    protected function defaultRules(): array
+    {
+        return [
+            $this->pageKey => array_filter([
+                $this->required ? 'required' : null,
+                'integer',
+                'min:1',
+            ]),
+            $this->perPageKey => [
+                'integer',
+                $this->maxPerPage > 0 ? 'between:1,' . $this->maxPerPage : 'min:1',
+            ],
+        ];
+    }
+
     /**
      * @param Builder|Relation $query
      * @return bool