[Refactor] Add more adjustments to the resource request class

Author: lindyhopchris

src/Http/Requests/FormRequest.php

@@ -65,6 +65,22 @@ public function isJsonApi(): bool
         return $this->matchesType(self::JSON_API_MEDIA_TYPE, $this->header('CONTENT_TYPE'));
     }
 
+    /**
+     * Get the field name for a relationship request.
+     *
+     * @return string|null
+     */
+    public function getFieldName(): ?string
+    {
+        $route = $this->jsonApi()->route();
+
+        if ($route->hasRelation()) {
+            return $route->fieldName();
+        }
+
+        return null;
+    }
+
     /**
      * Get the JSON API schema for the request.
      *

src/Http/Requests/ResourceRequest.php

@@ -23,7 +23,6 @@
 use Illuminate\Contracts\Validation\Validator;
 use Illuminate\Database\Eloquent\Model;
 use Illuminate\Http\Response;
-use Illuminate\Support\Collection;
 use LaravelJsonApi\Contracts\Auth\Authorizer;
 use LaravelJsonApi\Contracts\Resources\Container as ResourceContainer;
 use LaravelJsonApi\Core\Document\ResourceObject;
@@ -42,6 +41,11 @@
 class ResourceRequest extends FormRequest
 {
 
+    /**
+     * @var bool
+     */
+    protected bool $validateExisting = true;
+
     /**
      * @var callable|null
      */
@@ -101,7 +105,7 @@ public function isUpdating(): bool
      *
      * @return bool
      */
-    public function isUpdatingRelation(): bool
+    public function isUpdatingRelationship(): bool
     {
         return $this->isMethod('PATCH') && $this->isRelationship();
     }
@@ -111,7 +115,7 @@ public function isUpdatingRelation(): bool
      *
      * @return bool
      */
-    public function isAttachingRelation(): bool
+    public function isAttachingRelationship(): bool
     {
         return $this->isMethod('POST') && $this->isRelationship();
     }
@@ -121,7 +125,7 @@ public function isAttachingRelation(): bool
      *
      * @return bool
      */
-    public function isDetachingRelation(): bool
+    public function isDetachingRelationship(): bool
     {
         return $this->isMethod('DELETE') && $this->isRelationship();
     }
@@ -133,7 +137,9 @@ public function isDetachingRelation(): bool
      */
     public function isModifyingRelationship(): bool
     {
-        return $this->isUpdatingRelation() || $this->isAttachingRelation() || $this->isDetachingRelation();
+        return $this->isUpdatingRelationship() ||
+            $this->isAttachingRelationship() ||
+            $this->isDetachingRelationship();
     }
 
     /**
@@ -164,11 +170,11 @@ public function authorizeResource(Authorizer $authorizer): bool
             $model = $this->modelOrFail();
             $fieldName = $this->jsonApi()->route()->fieldName();
 
-            if ($this->isAttachingRelation()) {
+            if ($this->isAttachingRelationship()) {
                 return $authorizer->attachRelationship($this, $model, $fieldName);
             }
 
-            if ($this->isDetachingRelation()) {
+            if ($this->isDetachingRelationship()) {
                 return $authorizer->detachRelationship($this, $model, $fieldName);
             }
 
@@ -198,16 +204,6 @@ public function document(): array
         return $document;
     }
 
-    /**
-     * Get the field name for a relationship request.
-     *
-     * @return string
-     */
-    public function fieldName(): string
-    {
-        return $this->jsonApi()->route()->fieldName();
-    }
-
     /**
      * @inheritDoc
      */
@@ -275,7 +271,7 @@ public function validationDataForDelete(): array
     public function validatedForRelation()
     {
         $data = $this->validated();
-        $fieldName = $this->fieldName();
+        $fieldName = $this->getFieldName();
 
         if (array_key_exists($fieldName, $data)) {
             return $data[$fieldName];
@@ -388,8 +384,14 @@ protected function createDeleteValidator(ValidationFactory $factory): Validator
         return $factory->make(
             $this->validationDataForDelete(),
             method_exists($this, 'deleteRules') ? $this->container->call([$this, 'deleteRules']) : [],
-            method_exists($this, 'deleteMessages') ? $this->deleteMessages() : $this->messages(),
-            method_exists($this, 'deleteAttributes') ? $this->deleteAttributes() : $this->attributes()
+            array_merge(
+                $this->messages(),
+                method_exists($this, 'deleteMessages') ? $this->deleteMessages() : []
+            ),
+            array_merge(
+                $this->attributes(),
+                method_exists($this, 'deleteAttributes') ? $this->deleteAttributes() : []
+            )
         );
     }
 
@@ -418,24 +420,24 @@ protected function dataForCreate(array $document): array
      * merge attributes provided by the client over the top of the existing attribute
      * values.
      *
-     * @param Model|object $record
-     *      the record being updated.
+     * @param Model|object $model
+     *      the model being updated.
      * @param array $document
      *      the JSON API document to validate.
      * @return array
      */
-    protected function dataForUpdate(object $record, array $document): array
+    protected function dataForUpdate(object $model, array $document): array
     {
         $data = $document['data'] ?? [];
 
-        if ($this->mustValidateExisting($record, $data)) {
+        if ($this->mustValidateExisting($model, $document)) {
             $data['attributes'] = $this->extractAttributes(
-                $record,
+                $model,
                 $data['attributes'] ?? []
             );
 
             $data['relationships'] = $this->extractRelationships(
-                $record,
+                $model,
                 $data['relationships'] ?? []
             );
         }
@@ -575,7 +577,7 @@ private function extractRelationships(object $model, array $new): array
     private function relationshipRules(): array
     {
         $rules = $this->container->call([$this, 'rules']);
-        $fieldName = $this->fieldName();
+        $fieldName = $this->getFieldName();
 
         return collect($rules)
             ->filter(fn($v, $key) => Str::startsWith($key, $fieldName))