initial work on updating fields for validation

Author: lindyhopchris

composer.json

@@ -27,7 +27,8 @@
         "ext-json": "*",
         "illuminate/database": "^10.0",
         "illuminate/support": "^10.0",
-        "laravel-json-api/core": "^4.0"
+        "laravel-json-api/core": "^4.0",
+        "laravel-json-api/validation": "^4.0"
     },
     "require-dev": {
         "orchestra/testbench": "^8.0",

src/Fields/Boolean.php

@@ -19,8 +19,13 @@
 
 namespace LaravelJsonApi\Eloquent\Fields;
 
-class Boolean extends Attribute
+use LaravelJsonApi\Validation\Fields\IsValidated;
+use LaravelJsonApi\Validation\Fields\ValidatedWithListOfRules;
+use LaravelJsonApi\Validation\Rules\JsonBoolean;
+
+class Boolean extends Attribute implements IsValidated
 {
+    use ValidatedWithListOfRules;
 
     /**
      * Create a boolean attribute.
@@ -34,12 +39,20 @@ public static function make(string $fieldName, string $column = null): self
         return new self($fieldName, $column);
     }
 
+    /**
+     * @return array
+     */
+    protected function defaultRules(): array
+    {
+        return [new JsonBoolean()];
+    }
+
     /**
      * @inheritDoc
      */
     protected function assertValue($value): void
     {
-        if (!is_null($value) && !is_bool($value)) {
+        if ($value !== null && !is_bool($value)) {
             throw new \UnexpectedValueException(sprintf(
                 'Expecting the value of attribute %s to be a boolean.',
                 $this->name()

src/Fields/Concerns/IsReadOnly.php

@@ -25,26 +25,21 @@
 
 trait IsReadOnly
 {
-
     /**
      * Whether the field is read-only.
      *
      * @var Closure|bool
      */
-    private $readOnly = false;
+    private Closure|bool $readOnly = false;
 
     /**
      * Mark the field as read-only.
      *
      * @param Closure|bool $callback
      * @return $this
      */
-    public function readOnly($callback = true): self
+    public function readOnly(Closure|bool $callback = true): static
     {
-        if (!is_bool($callback) && !$callback instanceof Closure) {
-            throw new InvalidArgumentException('Expecting a boolean or closure.');
-        }
-
         $this->readOnly = $callback;
 
         return $this;
@@ -55,7 +50,7 @@ public function readOnly($callback = true): self
      *
      * @return $this
      */
-    public function readOnlyOnCreate(): self
+    public function readOnlyOnCreate(): static
     {
         $this->readOnly(static fn($request) => $request && $request->isMethod('POST'));
 
@@ -67,7 +62,7 @@ public function readOnlyOnCreate(): self
      *
      * @return $this
      */
-    public function readOnlyOnUpdate(): self
+    public function readOnlyOnUpdate(): static
     {
         $this->readOnly(static fn($request) => $request && $request->isMethod('PATCH'));
 

src/Fields/DateTime.php

@@ -20,11 +20,16 @@
 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\Rules\DateTimeIso8601;
 use function config;
 
-class DateTime extends Attribute
+class DateTime extends Attribute implements IsValidated
 {
+    use ValidatedWithListOfRules;
 
     /**
      * Should dates be converted to the defined time zone?
@@ -121,6 +126,14 @@ protected function parse($value): ?CarbonInterface
         return $value;
     }
 
+    /**
+     * @return DateTimeIso8601[]
+     */
+    protected function defaultRules(): array
+    {
+        return [new DateTimeIso8601()];
+    }
+
     /**
      * @inheritDoc
      */

src/Fields/ID.php

@@ -20,15 +20,16 @@
 namespace LaravelJsonApi\Eloquent\Fields;
 
 use Illuminate\Database\Eloquent\Model;
+use Illuminate\Http\Request;
 use LaravelJsonApi\Contracts\Schema\ID as IDContract;
 use LaravelJsonApi\Core\Schema\Concerns\ClientIds;
 use LaravelJsonApi\Core\Schema\Concerns\MatchesIds;
 use LaravelJsonApi\Core\Schema\Concerns\Sortable;
 use LaravelJsonApi\Eloquent\Contracts\Fillable;
+use LaravelJsonApi\Validation\Fields\IsValidated;
 
-class ID implements IDContract, Fillable
+class ID implements IDContract, Fillable, IsValidated
 {
-
     use ClientIds;
     use MatchesIds;
     use Sortable;
@@ -38,6 +39,11 @@ class ID implements IDContract, Fillable
      */
     private ?string $column;
 
+    /**
+     * @var string
+     */
+    private string $validationModifier = 'required';
+
     /**
      * Create an id field.
      *
@@ -112,6 +118,36 @@ public function isNotReadOnly($request): bool
         return !$this->isReadOnly($request);
     }
 
+    /**
+     * @return $this
+     */
+    public function nullable(): self
+    {
+        $this->validationModifier = 'nullable';
+
+        return $this;
+    }
+
+    /**
+     * @inheritDoc
+     */
+    public function rulesForCreation(?Request $request): array|null
+    {
+        if ($this->acceptsClientIds()) {
+            return [$this->validationModifier, "regex:/^{$this->pattern}$/{$this->flags}"];
+        }
+
+        return null;
+    }
+
+    /**
+     * @inheritDoc
+     */
+    public function rulesForUpdate(?Request $request, object $model): ?array
+    {
+        return null;
+    }
+
     /**
      * @inheritDoc
      */

src/Fields/Integer.php

@@ -0,0 +1,105 @@
+<?php
+/*
+ * Copyright 2023 Cloud Creativity Limited
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+declare(strict_types=1);
+
+namespace LaravelJsonApi\Eloquent\Fields;
+
+use LaravelJsonApi\Validation\Fields\IsValidated;
+use LaravelJsonApi\Validation\Fields\ValidatedWithListOfRules;
+use LaravelJsonApi\Validation\Rules\JsonNumber;
+use UnexpectedValueException;
+
+class Integer extends Attribute implements IsValidated
+{
+    use ValidatedWithListOfRules;
+
+    /**
+     * @var bool
+     */
+    private bool $acceptStrings = false;
+
+    /**
+     * Create a number attribute.
+     *
+     * @param string $fieldName
+     * @param string|null $column
+     * @return self
+     */
+    public static function make(string $fieldName, string $column = null): self
+    {
+        return new self($fieldName, $column);
+    }
+
+    /**
+     * @return $this
+     */
+    public function acceptStrings(): self
+    {
+        $this->acceptStrings = true;
+
+        return $this;
+    }
+
+    /**
+     * @return array
+     */
+    protected function defaultRules(): array
+    {
+        if ($this->acceptStrings) {
+            return ['numeric', 'integer'];
+        }
+
+        return [(new JsonNumber())->onlyIntegers()];
+    }
+
+    /**
+     * @inheritDoc
+     */
+    protected function assertValue($value): void
+    {
+        if (!$this->isInt($value)) {
+            $expected = $this->acceptStrings ?
+                'an integer or a numeric string that is an integer.' :
+                'an integer.';
+
+            throw new UnexpectedValueException(sprintf(
+                'Expecting the value of attribute %s to be ' . $expected,
+                $this->name(),
+            ));
+        }
+    }
+
+    /**
+     * Is the value a numeric value that this field accepts?
+     *
+     * @param mixed $value
+     * @return bool
+     */
+    private function isInt(mixed $value): bool
+    {
+        if ($this->acceptStrings && is_string($value) && is_numeric($value)) {
+            $value = filter_var($value, FILTER_VALIDATE_INT);
+        }
+
+        if ($value === null || is_int($value)) {
+            return true;
+        }
+
+        return false;
+    }
+}

src/Fields/Number.php

@@ -19,10 +19,15 @@
 
 namespace LaravelJsonApi\Eloquent\Fields;
 
+use LaravelJsonApi\Validation\Fields\IsValidated;
+use LaravelJsonApi\Validation\Fields\ValidatedWithListOfRules;
+use LaravelJsonApi\Validation\Rules\JsonNumber;
 use UnexpectedValueException;
 
-class Number extends Attribute
+class Number extends Attribute implements IsValidated
 {
+    use ValidatedWithListOfRules;
+
     /**
      * @var bool
      */
@@ -50,6 +55,18 @@ public function acceptStrings(): self
         return $this;
     }
 
+    /**
+     * @return array
+     */
+    protected function defaultRules(): array
+    {
+        if ($this->acceptStrings) {
+            return ['numeric'];
+        }
+
+        return [new JsonNumber()];
+    }
+
     /**
      * @inheritDoc
      */

src/Fields/SoftDelete.php

@@ -20,6 +20,8 @@
 namespace LaravelJsonApi\Eloquent\Fields;
 
 use Illuminate\Support\Facades\Date;
+use LaravelJsonApi\Validation\Rules\DateTimeIso8601;
+use LaravelJsonApi\Validation\Rules\JsonBoolean;
 use UnexpectedValueException;
 use function boolval;
 use function is_bool;
@@ -28,7 +30,6 @@
 
 class SoftDelete extends DateTime
 {
-
     /**
      * @var bool
      */
@@ -68,12 +69,23 @@ public function serialize(object $model)
         return parent::serialize($model);
     }
 
+    /**
+     * @return array
+     */
+    protected function defaultRules(): array
+    {
+        return [
+            'nullable',
+            $this->boolean ? new JsonBoolean() : new DateTimeIso8601(),
+        ];
+    }
+
     /**
      * @inheritDoc
      */
     protected function deserialize($value)
     {
-        if (true === $this->boolean && (is_bool($value) || is_null($value))) {
+        if (true === $this->boolean && (is_bool($value) || $value === null)) {
             return $this->parse($value ? Date::now() : null);
         }