feat: update validation of all fields including relations

lindyhopchris · lindyhopchris · commit b2f6dcca1e05 · 2024-03-28T21:04:20.000Z
diff --git a/src/Contracts/FillableToMany.php b/src/Contracts/FillableToMany.php
@@ -14,10 +14,10 @@
 use Illuminate\Database\Eloquent\Collection as EloquentCollection;
 use Illuminate\Database\Eloquent\Model;
 use LaravelJsonApi\Eloquent\Polymorphism\MorphMany;
+use LaravelJsonApi\Validation\Fields\IsValidated;
 
-interface FillableToMany extends IsReadOnly
+interface FillableToMany extends IsReadOnly, IsValidated
 {
-
     /**
      * Fill the model with the value of the JSON:API to-many relation.
      *
diff --git a/src/Contracts/FillableToOne.php b/src/Contracts/FillableToOne.php
@@ -12,10 +12,10 @@
 namespace LaravelJsonApi\Eloquent\Contracts;
 
 use Illuminate\Database\Eloquent\Model;
+use LaravelJsonApi\Validation\Fields\IsValidated;
 
-interface FillableToOne extends IsReadOnly
+interface FillableToOne extends IsReadOnly, IsValidated
 {
-
     /**
      * Does the model need to exist in the database before the relation is filled?
      *
diff --git a/src/Fields/ArrayHash.php b/src/Fields/ArrayHash.php
@@ -15,16 +15,12 @@
 use LaravelJsonApi\Core\Json\Hash;
 use LaravelJsonApi\Core\Support\Arr;
 use LaravelJsonApi\Validation\Fields\IsValidated;
-
-use LaravelJsonApi\Validation\Fields\ValidatedWithKeyedSetOfRules;
-
+use LaravelJsonApi\Validation\Fields\ValidatedWithArrayKeys;
 use LaravelJsonApi\Validation\Rules\JsonObject;
 
-use function is_null;
-
 class ArrayHash extends Attribute implements IsValidated
 {
-    use ValidatedWithKeyedSetOfRules;
+    use ValidatedWithArrayKeys;
 
     /**
      * @var Closure|null
@@ -235,7 +231,7 @@ protected function deserialize($value)
             $value = ($this->keys)($value);
         }
 
-        if (is_null($value)) {
+        if ($value === null) {
             return null;
         }
 
@@ -251,7 +247,7 @@ protected function deserialize($value)
      */
     protected function assertValue($value): void
     {
-        if ((!is_null($value) && !is_array($value)) || (!empty($value) && !Arr::isAssoc($value))) {
+        if (($value !== null && !is_array($value)) || (!empty($value) && !Arr::isAssoc($value))) {
             throw new \UnexpectedValueException(sprintf(
                 'Expecting the value of attribute %s to be an associative array.',
                 $this->name()
diff --git a/src/Fields/ArrayList.php b/src/Fields/ArrayList.php
@@ -13,15 +13,13 @@
 
 use Illuminate\Support\Arr;
 use LaravelJsonApi\Validation\Fields\IsValidated;
-use LaravelJsonApi\Validation\Fields\ValidatedWithKeyedSetOfRules;
+use LaravelJsonApi\Validation\Fields\ValidatedWithArrayKeys;
 use LaravelJsonApi\Validation\Rules\JsonArray;
-
-use function is_null;
 use function sort;
 
 class ArrayList extends Attribute implements IsValidated
 {
-    use ValidatedWithKeyedSetOfRules;
+    use ValidatedWithArrayKeys;
 
     /**
      * @var bool
@@ -85,7 +83,7 @@ protected function deserialize($value)
      */
     protected function assertValue($value): void
     {
-        if ((!is_null($value) && !is_array($value)) || (!empty($value) && Arr::isAssoc($value))) {
+        if (($value !== null && !is_array($value)) || (!empty($value) && Arr::isAssoc($value))) {
             throw new \UnexpectedValueException(sprintf(
                 'Expecting the value of attribute %s to be an array list.',
                 $this->name()
diff --git a/src/Fields/Boolean.php b/src/Fields/Boolean.php
@@ -12,12 +12,12 @@
 namespace LaravelJsonApi\Eloquent\Fields;
 
 use LaravelJsonApi\Validation\Fields\IsValidated;
-use LaravelJsonApi\Validation\Fields\ValidatedWithListOfRules;
+use LaravelJsonApi\Validation\Fields\ValidatedWithRules;
 use LaravelJsonApi\Validation\Rules\JsonBoolean;
 
 class Boolean extends Attribute implements IsValidated
 {
-    use ValidatedWithListOfRules;
+    use ValidatedWithRules;
 
     /**
      * Create a boolean attribute.
diff --git a/src/Fields/DateTime.php b/src/Fields/DateTime.php
@@ -12,16 +12,15 @@
 namespace LaravelJsonApi\Eloquent\Fields;
 
 use Carbon\CarbonInterface;
-use Closure;
 use Illuminate\Support\Facades\Date;
 use LaravelJsonApi\Validation\Fields\IsValidated;
-use LaravelJsonApi\Validation\Fields\ValidatedWithListOfRules;
+use LaravelJsonApi\Validation\Fields\ValidatedWithRules;
 use LaravelJsonApi\Validation\Rules\DateTimeIso8601;
 use function config;
 
 class DateTime extends Attribute implements IsValidated
 {
-    use ValidatedWithListOfRules;
+    use ValidatedWithRules;
 
     /**
      * Should dates be converted to the defined time zone?
diff --git a/src/Fields/Integer.php b/src/Fields/Integer.php
@@ -12,13 +12,13 @@
 namespace LaravelJsonApi\Eloquent\Fields;
 
 use LaravelJsonApi\Validation\Fields\IsValidated;
-use LaravelJsonApi\Validation\Fields\ValidatedWithListOfRules;
+use LaravelJsonApi\Validation\Fields\ValidatedWithRules;
 use LaravelJsonApi\Validation\Rules\JsonNumber;
 use UnexpectedValueException;
 
 class Integer extends Attribute implements IsValidated
 {
-    use ValidatedWithListOfRules;
+    use ValidatedWithRules;
 
     /**
      * @var bool
diff --git a/src/Fields/Number.php b/src/Fields/Number.php
@@ -12,13 +12,13 @@
 namespace LaravelJsonApi\Eloquent\Fields;
 
 use LaravelJsonApi\Validation\Fields\IsValidated;
-use LaravelJsonApi\Validation\Fields\ValidatedWithListOfRules;
+use LaravelJsonApi\Validation\Fields\ValidatedWithRules;
 use LaravelJsonApi\Validation\Rules\JsonNumber;
 use UnexpectedValueException;
 
 class Number extends Attribute implements IsValidated
 {
-    use ValidatedWithListOfRules;
+    use ValidatedWithRules;
 
     /**
      * @var bool
diff --git a/src/Fields/Relations/BelongsTo.php b/src/Fields/Relations/BelongsTo.php
@@ -14,10 +14,13 @@
 use Illuminate\Database\Eloquent\Model;
 use LaravelJsonApi\Eloquent\Contracts\FillableToOne;
 use LaravelJsonApi\Eloquent\Fields\Concerns\IsReadOnly;
+use LaravelJsonApi\Validation\Fields\ValidatedWithArrayKeys;
+use LaravelJsonApi\Validation\Rules\HasOne as HasOneRule;
 
 class BelongsTo extends ToOne implements FillableToOne
 {
     use IsReadOnly;
+    use ValidatedWithArrayKeys;
 
     /**
      * Create a belongs-to relation.
@@ -93,4 +96,12 @@ public function associate(Model $model, ?array $identifier): ?Model
 
         return $model->getRelation($this->relationName());
     }
+
+    /**
+     * @return array
+     */
+    protected function defaultRules(): array
+    {
+        return ['.' => ['array:type,id', new HasOneRule($this)]];
+    }
 }
diff --git a/src/Fields/Relations/BelongsToMany.php b/src/Fields/Relations/BelongsToMany.php
@@ -11,18 +11,22 @@
 
 namespace LaravelJsonApi\Eloquent\Fields\Relations;
 
+use Closure;
 use Illuminate\Database\Eloquent\Collection as EloquentCollection;
 use Illuminate\Database\Eloquent\Model;
 use Illuminate\Database\Eloquent\Relations\BelongsToMany as EloquentBelongsToMany;
 use InvalidArgumentException;
 use LaravelJsonApi\Eloquent\Contracts\FillableToMany;
 use LaravelJsonApi\Eloquent\Fields\Concerns\IsReadOnly;
+use LaravelJsonApi\Validation\Fields\ValidatedWithArrayKeys;
+use LaravelJsonApi\Validation\Rules\HasMany as HasManyRule;
+use LaravelJsonApi\Validation\Rules\JsonArray;
 use function sprintf;
 
 class BelongsToMany extends ToMany implements FillableToMany
 {
-
     use IsReadOnly;
+    use ValidatedWithArrayKeys;
 
     /**
      * Create a belongs-to-many relation.
@@ -142,6 +146,17 @@ public function detach(Model $model, array $identifiers): iterable
         return $related;
     }
 
+    /**
+     * @return array
+     */
+    protected function defaultRules(): array
+    {
+        return [
+            '.' => [new JsonArray(), new HasManyRule($this)],
+            '*' => ['array:type,id'],
+        ];
+    }
+
     /**
      * @param Model $model
      * @return EloquentBelongsToMany
diff --git a/src/Fields/Relations/HasMany.php b/src/Fields/Relations/HasMany.php
@@ -17,6 +17,9 @@
 use Illuminate\Database\Eloquent\Relations\MorphMany as EloquentMorphMany;
 use LaravelJsonApi\Eloquent\Contracts\FillableToMany;
 use LaravelJsonApi\Eloquent\Fields\Concerns\IsReadOnly;
+use LaravelJsonApi\Validation\Fields\ValidatedWithArrayKeys;
+use LaravelJsonApi\Validation\Rules\HasMany as HasManyRule;
+use LaravelJsonApi\Validation\Rules\JsonArray;
 use function sprintf;
 
 class HasMany extends ToMany implements FillableToMany
@@ -31,6 +34,7 @@ class HasMany extends ToMany implements FillableToMany
     private const FORCE_DELETE_DETACHED_MODELS = 2;
 
     use IsReadOnly;
+    use ValidatedWithArrayKeys;
 
     /**
      * Flag for how to detach models from the relationship.
@@ -134,6 +138,17 @@ public function detach(Model $model, array $identifiers): iterable
         return $models;
     }
 
+    /**
+     * @return array
+     */
+    protected function defaultRules(): array
+    {
+        return [
+            '.' => [new JsonArray(), new HasManyRule($this)],
+            '*' => ['array:type,id'],
+        ];
+    }
+
     /**
      * @param Model $model
      * @param EloquentCollection $new
diff --git a/src/Fields/Relations/HasOne.php b/src/Fields/Relations/HasOne.php
@@ -16,9 +16,13 @@
 use Illuminate\Database\Eloquent\Relations\MorphOne as EloquentMorphOne;
 use LaravelJsonApi\Eloquent\Contracts\FillableToOne;
 use LaravelJsonApi\Eloquent\Fields\Concerns\IsReadOnly;
+use LaravelJsonApi\Validation\Fields\ValidatedWithArrayKeys;
+use LaravelJsonApi\Validation\Rules\HasOne as HasOneRule;
 
 class HasOne extends ToOne implements FillableToOne
 {
+    use ValidatedWithArrayKeys;
+
     /** @var int */
     private const KEEP_DETACHED_MODEL = 0;
 
@@ -135,6 +139,14 @@ public function associate(Model $model, ?array $identifier): ?Model
         return $model->getRelation($this->relationName());
     }
 
+    /**
+     * @return array
+     */
+    protected function defaultRules(): array
+    {
+        return ['.' => ['array:type,id', new HasOneRule($this)]];
+    }
+
     /**
      * @param Model|null $current
      * @param Model|null $new
diff --git a/src/Fields/Relations/MorphToMany.php b/src/Fields/Relations/MorphToMany.php
@@ -23,6 +23,9 @@
 use LaravelJsonApi\Eloquent\Fields\Concerns\IsReadOnly;
 use LaravelJsonApi\Eloquent\Polymorphism\MorphMany;
 use LaravelJsonApi\Eloquent\Polymorphism\MorphValue;
+use LaravelJsonApi\Validation\Fields\ValidatedWithArrayKeys;
+use LaravelJsonApi\Validation\Rules\HasMany as HasManyRule;
+use LaravelJsonApi\Validation\Rules\JsonArray;
 use LogicException;
 use Traversable;
 use UnexpectedValueException;
@@ -31,6 +34,7 @@ class MorphToMany extends ToMany implements PolymorphicRelation, IteratorAggrega
 {
     use Polymorphic;
     use IsReadOnly;
+    use ValidatedWithArrayKeys;
 
     /**
      * @var array
@@ -240,6 +244,17 @@ public function parse($models): iterable
         throw new LogicException('Expecting model value to already be a morph many value.');
     }
 
+    /**
+     * @return array
+     */
+    protected function defaultRules(): array
+    {
+        return [
+            '.' => [new JsonArray(), new HasManyRule($this)],
+            '*' => ['array:type,id'],
+        ];
+    }
+
     /**
      * Get the identifiers that are valid for the supplied relation.
      *
diff --git a/src/Fields/Relations/Relation.php b/src/Fields/Relations/Relation.php
@@ -35,7 +35,6 @@
 
 abstract class Relation implements RelationContract, SchemaAwareContract, SerializableContract
 {
-
     use EagerLoadable;
     use Filterable;
     use Hideable;
diff --git a/src/Fields/Str.php b/src/Fields/Str.php
@@ -12,11 +12,11 @@
 namespace LaravelJsonApi\Eloquent\Fields;
 
 use LaravelJsonApi\Validation\Fields\IsValidated;
-use LaravelJsonApi\Validation\Fields\ValidatedWithListOfRules;
+use LaravelJsonApi\Validation\Fields\ValidatedWithRules;
 
 class Str extends Attribute implements IsValidated
 {
-    use ValidatedWithListOfRules;
+    use ValidatedWithRules;
 
     /**
      * Create a string attribute.
diff --git a/tests/lib/Integration/Fields/ArrayHashTest.php b/tests/lib/Integration/Fields/ArrayHashTest.php
@@ -576,19 +576,28 @@ public function testHiddenCallback(): void
 
     public function testIsValidated(): void
     {
-        $attr = ArrayHash::make('permissions');
+        $attr = ArrayHash::make('permissions')
+            ->creationRules(['.' => 'array:foo,bar'])
+            ->updateRules(['.' => 'array:foo,bar']);
+
+        $expected = [
+            '.' => [new JsonObject(), 'array:foo,bar'],
+        ];
 
         $this->assertInstanceOf(IsValidated::class, $attr);
-        $this->assertEquals($expected = ['.' => new JsonObject()], $attr->rulesForCreation(null));
+        $this->assertEquals($expected, $attr->rulesForCreation(null));
         $this->assertEquals($expected, $attr->rulesForUpdate(null, new \stdClass()));
     }
 
     public function testIsValidatedAndAllowsEmpty(): void
     {
-        $attr = ArrayHash::make('permissions')->allowEmpty();
+        $attr = ArrayHash::make('permissions')
+            ->allowEmpty()
+            ->creationRules(['.' => 'array:foo,bar'])
+            ->updateRules(['.' => 'array:foo,bar']);
 
         $this->assertEquals(
-            $expected = ['.' => (new JsonObject())->allowEmpty()],
+            $expected = ['.' => [(new JsonObject())->allowEmpty(), 'array:foo,bar']],
             $attr->rulesForCreation(null)
         );
         $this->assertEquals($expected, $attr->rulesForUpdate(null, new \stdClass()));
diff --git a/tests/lib/Integration/Fields/ArrayListTest.php b/tests/lib/Integration/Fields/ArrayListTest.php
@@ -334,7 +334,7 @@ public function testItIsValidated(): void
         $attr = ArrayList::make('permissions');
 
         $this->assertInstanceOf(IsValidated::class, $attr);
-        $this->assertEquals($expected = ['.' => new JsonArray()], $attr->rulesForCreation(null));
+        $this->assertEquals($expected = ['.' => [new JsonArray()]], $attr->rulesForCreation(null));
         $this->assertEquals($expected, $attr->rulesForUpdate(null, new \stdClass()));
     }
 }
diff --git a/tests/lib/Integration/Fields/Relations/BelongsToManyTest.php b/tests/lib/Integration/Fields/Relations/BelongsToManyTest.php
diff --git a/tests/lib/Integration/Fields/Relations/BelongsToTest.php b/tests/lib/Integration/Fields/Relations/BelongsToTest.php
diff --git a/tests/lib/Integration/Fields/Relations/HasManyTest.php b/tests/lib/Integration/Fields/Relations/HasManyTest.php
diff --git a/tests/lib/Integration/Fields/Relations/HasOneTest.php b/tests/lib/Integration/Fields/Relations/HasOneTest.php

Original file line number	Diff line number	Diff line change
`@@ -14,10 +14,10 @@`
`14`	`14`	`use Illuminate\Database\Eloquent\Collection as EloquentCollection;`
`15`	`15`	`use Illuminate\Database\Eloquent\Model;`
`16`	`16`	`use LaravelJsonApi\Eloquent\Polymorphism\MorphMany;`
	`17`	`+use LaravelJsonApi\Validation\Fields\IsValidated;`
`17`	`18`
`18`		`-interface FillableToMany extends IsReadOnly`
	`19`	`+interface FillableToMany extends IsReadOnly, IsValidated`
`19`	`20`	`{`
`20`		`-`
`21`	`21`	`/**`
`22`	`22`	`* Fill the model with the value of the JSON:API to-many relation.`
`23`	`23`	`*`
Original file line number	Diff line number	Diff line change
`@@ -12,10 +12,10 @@`
`12`	`12`	`namespace LaravelJsonApi\Eloquent\Contracts;`
`13`	`13`
`14`	`14`	`use Illuminate\Database\Eloquent\Model;`
	`15`	`+use LaravelJsonApi\Validation\Fields\IsValidated;`
`15`	`16`
`16`		`-interface FillableToOne extends IsReadOnly`
	`17`	`+interface FillableToOne extends IsReadOnly, IsValidated`
`17`	`18`	`{`
`18`		`-`
`19`	`19`	`/**`
`20`	`20`	`* Does the model need to exist in the database before the relation is filled?`
`21`	`21`	`*`