[Feature] Add validation data to rules method signature (#529)

Ensures the validator `rules()` method receives the data that is to be validated.

Closes #497

Author: lucianholt97

src/Validation/AbstractValidators.php

@@ -176,9 +176,11 @@ abstract class AbstractValidators implements ValidatorFactoryInterface
      *
      * @param mixed|null $record
      *      the record being updated, or null if creating a resource.
+     * @param array $data
+     *      the data that is being validated.
      * @return mixed
      */
-    abstract protected function rules($record = null): array;
+    abstract protected function rules($record, array $data): array;
 
     /**
      * Get query parameter validation rules.
@@ -208,7 +210,8 @@ public function supportsClientIds(): bool
             return $this->clientIds;
         }
 
-        return $this->clientIds = collect($this->rules())->has('id');
+        return $this->clientIds = collect($this->rules(null, []))
+            ->has('id');
     }
 
     /**
@@ -217,8 +220,8 @@ public function supportsClientIds(): bool
     public function create(array $document): ValidatorInterface
     {
         return $this->validatorForResource(
-            $this->dataForCreate($document),
-            $this->rules(),
+            $data = $this->dataForCreate($document),
+            $this->rules(null, $data),
             $this->messages(),
             $this->attributes()
         );
@@ -230,8 +233,8 @@ public function create(array $document): ValidatorInterface
     public function update($record, array $document): ValidatorInterface
     {
         return $this->validatorForResource(
-            $this->dataForUpdate($record, $document),
-            $this->rules($record),
+            $data = $this->dataForUpdate($record, $document),
+            $this->rules($record, $data),
             $this->messages($record),
             $this->attributes($record)
         );
@@ -259,11 +262,11 @@ public function delete($record): ?ValidatorInterface
      */
     public function modifyRelationship($record, string $field, array $document): ValidatorInterface
     {
-        $data = $this->dataForRelationship($record, $field, $document);
+        $resource = ResourceObject::create($this->dataForRelationship($record, $field, $document));
 
         return $this->factory->createRelationshipValidator(
-            ResourceObject::create($data),
-            $this->relationshipRules($record, $field),
+            $resource,
+            $this->relationshipRules($record, $field, $resource->all()),
             $this->messages(),
             $this->attributes()
         );
@@ -552,11 +555,12 @@ protected function dataForRelationship($record, string $field, array $document):
      *
      * @param mixed $record
      * @param string $field
+     * @param array $data
      * @return array
      */
-    protected function relationshipRules($record, string $field): array
+    protected function relationshipRules($record, string $field, array $data): array
     {
-        return collect($this->rules($record))->filter(function ($v, $key) use ($field) {
+        return collect($this->rules($record, $data))->filter(function ($v, $key) use ($field) {
             return Str::startsWith($key, $field);
         })->all();
     }

stubs/independent/validators.stub

@@ -36,9 +36,11 @@ class DummyClass extends AbstractValidators
      *
      * @param mixed|null $record
      *      the record being updated, or null if creating a resource.
+     * @param array $data
+     *      the data being validated
      * @return mixed
      */
-    protected function rules($record = null): array
+    protected function rules($record, array $data): array
     {
         return [
             //

tests/dummy/app/JsonApi/Avatars/Validators.php

@@ -67,9 +67,11 @@ public function update($record, array $document): ValidatorInterface
      *
      * @param mixed|null $record
      *      the record being updated, or null if creating a resource.
+     * @param array $data
+     *      the data being validated.
      * @return mixed
      */
-    protected function rules($record = null): array
+    protected function rules($record, array $data): array
     {
         return [
             //

tests/dummy/app/JsonApi/Comments/Validators.php

@@ -51,7 +51,7 @@ class Validators extends AbstractValidators
     /**
      * @inheritdoc
      */
-    protected function rules($record = null): array
+    protected function rules($record, array $data): array
     {
         return [
             'content' => "required|string|min:1",

tests/dummy/app/JsonApi/Countries/Validators.php

@@ -41,7 +41,7 @@ class Validators extends AbstractValidators
     /**
      * @inheritDoc
      */
-    protected function rules($record = null): array
+    protected function rules($record, array $data): array
     {
         return [
             'name' => "required|string",

tests/dummy/app/JsonApi/Downloads/Validators.php

@@ -25,7 +25,7 @@ class Validators extends AbstractValidators
     /**
      * @inheritDoc
      */
-    protected function rules($record = null): array
+    protected function rules($record, array $data): array
     {
         return [
             'id' => 'nullable|string|min:1',

tests/dummy/app/JsonApi/Histories/Validators.php

@@ -38,7 +38,7 @@ class Validators extends AbstractValidators
     /**
      * @inheritDoc
      */
-    protected function rules($record = null): array
+    protected function rules($record, array $data): array
     {
         return [
             'detail' => ['required', 'string'],

tests/dummy/app/JsonApi/Phones/Validators.php

@@ -32,9 +32,11 @@ class Validators extends AbstractValidators
      *
      * @param object|null $record
      *      the record being updated, or null if it is a create request.
+     * @param array $data
+     *      the data being validated.
      * @return array
      */
-    protected function rules($record = null): array
+    protected function rules($record, array $data): array
     {
         return [
             //

tests/dummy/app/JsonApi/Posts/Validators.php

@@ -99,9 +99,10 @@ class Validators extends AbstractValidators
 
     /**
      * @param Post|null $record
+     * @param array $data
      * @return array|mixed
      */
-    protected function rules($record = null): array
+    protected function rules($record, array $data): array
     {
         $slugUnique = 'unique:posts,slug';
 

tests/dummy/app/JsonApi/QueueJobs/Validators.php

@@ -31,7 +31,7 @@ class Validators extends AbstractValidators
     /**
      * @inheritDoc
      */
-    protected function rules($record = null): array
+    protected function rules($record, array $data): array
     {
         throw new RuntimeException('Not implemented.');
     }