feat: add validation to array hash and list attributes

Author: lindyhopchris

src/Fields/ArrayHash.php

@@ -14,10 +14,17 @@
 use Closure;
 use LaravelJsonApi\Core\Json\Hash;
 use LaravelJsonApi\Core\Support\Arr;
+use LaravelJsonApi\Validation\Fields\IsValidated;
+
+use LaravelJsonApi\Validation\Fields\ValidatedWithKeyedSetOfRules;
+
+use LaravelJsonApi\Validation\Rules\JsonObject;
+
 use function is_null;
 
-class ArrayHash extends Attribute
+class ArrayHash extends Attribute implements IsValidated
 {
+    use ValidatedWithKeyedSetOfRules;
 
     /**
      * @var Closure|null
@@ -48,6 +55,13 @@ class ArrayHash extends Attribute
      */
     private ?string $keyCase = null;
 
+    /**
+     * Whether an empty array is allowed as the value.
+     *
+     * @var bool
+     */
+    private bool $allowEmpty = false;
+
     /**
      * Create an array attribute.
      *
@@ -184,6 +198,19 @@ public function dasherizeKeys(): self
         return $this;
     }
 
+    /**
+     * Whether an empty array is allowed as the value.
+     *
+     * @param bool $allowEmpty
+     * @return self
+     */
+    public function allowEmpty(bool $allowEmpty = true): self
+    {
+        $this->allowEmpty = $allowEmpty;
+
+        return $this;
+    }
+
     /**
      * @inheritDoc
      */
@@ -232,4 +259,11 @@ protected function assertValue($value): void
         }
     }
 
+    /**
+     * @return array<string, mixed>
+     */
+    protected function defaultRules(): array
+    {
+        return ['.' => (new JsonObject())->allowEmpty($this->allowEmpty)];
+    }
 }

src/Fields/ArrayList.php

@@ -12,11 +12,16 @@
 namespace LaravelJsonApi\Eloquent\Fields;
 
 use Illuminate\Support\Arr;
+use LaravelJsonApi\Validation\Fields\IsValidated;
+use LaravelJsonApi\Validation\Fields\ValidatedWithKeyedSetOfRules;
+use LaravelJsonApi\Validation\Rules\JsonArray;
+
 use function is_null;
 use function sort;
 
-class ArrayList extends Attribute
+class ArrayList extends Attribute implements IsValidated
 {
+    use ValidatedWithKeyedSetOfRules;
 
     /**
      * @var bool
@@ -88,4 +93,11 @@ protected function assertValue($value): void
         }
     }
 
+    /**
+     * @return array<string, mixed>
+     */
+    protected function defaultRules(): array
+    {
+        return ['.' => new JsonArray()];
+    }
 }

tests/lib/Integration/Fields/ArrayHashTest.php

@@ -16,6 +16,8 @@
 use Illuminate\Http\Request;
 use LaravelJsonApi\Eloquent\Fields\ArrayHash;
 use LaravelJsonApi\Eloquent\Tests\Integration\TestCase;
+use LaravelJsonApi\Validation\Fields\IsValidated;
+use LaravelJsonApi\Validation\Rules\JsonObject;
 
 class ArrayHashTest extends TestCase
 {
@@ -572,4 +574,23 @@ public function testHiddenCallback(): void
         $this->assertTrue($attr->isHidden($mock));
     }
 
+    public function testIsValidated(): void
+    {
+        $attr = ArrayHash::make('permissions');
+
+        $this->assertInstanceOf(IsValidated::class, $attr);
+        $this->assertEquals($expected = ['.' => new JsonObject()], $attr->rulesForCreation(null));
+        $this->assertEquals($expected, $attr->rulesForUpdate(null, new \stdClass()));
+    }
+
+    public function testIsValidatedAndAllowsEmpty(): void
+    {
+        $attr = ArrayHash::make('permissions')->allowEmpty();
+
+        $this->assertEquals(
+            $expected = ['.' => (new JsonObject())->allowEmpty()],
+            $attr->rulesForCreation(null)
+        );
+        $this->assertEquals($expected, $attr->rulesForUpdate(null, new \stdClass()));
+    }
 }

tests/lib/Integration/Fields/ArrayListTest.php

@@ -16,6 +16,8 @@
 use Illuminate\Http\Request;
 use LaravelJsonApi\Eloquent\Fields\ArrayList;
 use LaravelJsonApi\Eloquent\Tests\Integration\TestCase;
+use LaravelJsonApi\Validation\Fields\IsValidated;
+use LaravelJsonApi\Validation\Rules\JsonArray;
 
 class ArrayListTest extends TestCase
 {
@@ -327,4 +329,12 @@ public function testHiddenCallback(): void
         $this->assertTrue($attr->isHidden($mock));
     }
 
+    public function testItIsValidated(): void
+    {
+        $attr = ArrayList::make('permissions');
+
+        $this->assertInstanceOf(IsValidated::class, $attr);
+        $this->assertEquals($expected = ['.' => new JsonArray()], $attr->rulesForCreation(null));
+        $this->assertEquals($expected, $attr->rulesForUpdate(null, new \stdClass()));
+    }
 }