feat: add validation contract to map field

Author: lindyhopchris

src/Fields/Map.php

@@ -12,6 +12,7 @@
 namespace LaravelJsonApi\Eloquent\Fields;
 
 use Illuminate\Database\Eloquent\Model;
+use Illuminate\Http\Request;
 use Illuminate\Support\Arr;
 use InvalidArgumentException;
 use LaravelJsonApi\Contracts\Resources\Serializer\Attribute as SerializableContract;
@@ -23,16 +24,17 @@
 use LaravelJsonApi\Eloquent\Fields\Concerns\Hideable;
 use LaravelJsonApi\Eloquent\Fields\Concerns\IsReadOnly;
 use LaravelJsonApi\Eloquent\Fields\Concerns\OnRelated;
+use LaravelJsonApi\Validation\Fields\IsValidated;
 use LogicException;
 
 class Map implements
     AttributeContract,
     EagerLoadableField,
     Fillable,
     Selectable,
-    SerializableContract
+    SerializableContract,
+    IsValidated
 {
-
     use Hideable;
     use OnRelated;
     use IsReadOnly;
@@ -215,6 +217,50 @@ public function serialize(object $model)
         return $values ?: null;
     }
 
+    /**
+     * @inheritDoc
+     */
+    public function rulesForCreation(?Request $request): ?array
+    {
+        $fields = [];
+        $rules = [];
+
+        /** @var AttributeContract $attr */
+        foreach ($this->map as $attr) {
+            if ($attr instanceof IsValidated) {
+                $fields[] = $name = $attr->name();
+                $rules[$name] = $attr->rulesForCreation($request);
+            }
+        }
+
+        return !empty($fields) ? [
+            '.' => 'array:' . implode(',', $fields),
+            ...$rules,
+        ] : null;
+    }
+
+    /**
+     * @inheritDoc
+     */
+    public function rulesForUpdate(?Request $request, object $model): ?array
+    {
+        $fields = [];
+        $rules = [];
+
+        /** @var AttributeContract $attr */
+        foreach ($this->map as $attr) {
+            if ($attr instanceof IsValidated) {
+                $fields[] = $name = $attr->name();
+                $rules[$name] = $attr->rulesForUpdate($request, $model);
+            }
+        }
+
+        return !empty($fields) ? [
+            '.' => 'array:' . implode(',', $fields),
+            ...$rules,
+        ] : null;
+    }
+
     /**
      * Set all values to null.
      *

tests/lib/Integration/Fields/MapTest.php

@@ -19,6 +19,9 @@
 use LaravelJsonApi\Eloquent\Fields\Number;
 use LaravelJsonApi\Eloquent\Fields\Str;
 use LaravelJsonApi\Eloquent\Tests\Integration\TestCase;
+use LaravelJsonApi\Validation\Fields\IsValidated;
+use LaravelJsonApi\Validation\Rules\JsonNumber;
+use LaravelJsonApi\Validation\Rules\JsonObject;
 
 class MapTest extends TestCase
 {
@@ -283,4 +286,44 @@ public function testHiddenCallback(): void
         $this->assertTrue($map->isHidden($mock));
     }
 
+    public function testItIsValidatedOnCreate(): void
+    {
+        $request = $this->createMock(Request::class);
+        $model = new \stdClass();
+
+        $map = Map::make('options', [
+            Str::make('foo', 'option_foo')
+                ->creationRules(function ($r) use ($request) {
+                    $this->assertSame($request, $r);
+                    return ['foo1'];
+                })
+                ->updateRules(function ($r, $m) use ($request, $model) {
+                    $this->assertSame($request, $r);
+                    $this->assertSame($model, $m);
+                    return ['foo2'];
+                }),
+            Number::make('bar', 'option_bar')
+                ->creationRules(function ($r) use ($request) {
+                    $this->assertSame($request, $r);
+                    return ['bar1'];
+                })
+                ->updateRules(function ($r, $m) use ($request, $model) {
+                    $this->assertSame($request, $r);
+                    $this->assertSame($model, $m);
+                    return ['bar2'];
+                }),
+        ]);
+
+        $this->assertInstanceOf(IsValidated::class, $map);
+        $this->assertEquals([
+            '.' => 'array:bar,foo',
+            'foo' => ['string', 'foo1'],
+            'bar' => [new JsonNumber(), 'bar1'],
+        ], $map->rulesForCreation($request));
+        $this->assertEquals([
+            '.' => 'array:bar,foo',
+            'foo' => ['string', 'foo2'],
+            'bar' => [new JsonNumber(), 'bar2'],
+        ], $map->rulesForUpdate($request, $model));
+    }
 }