Add DataWrapperInteface (#464)

* base implementation

* improve

* const

* [ci-review] Apply changes from Rector action.

* `DataWrapperInterface`

* Apply fixes from StyleCI

* tests

* improve

* rename

* Apply fixes from StyleCI

* docs

* Apply fixes from StyleCI

* rename const

* Apply fixes from StyleCI

* fix count

* more test

* [ci-review] Apply changes from Rector action.

* more test

* Apply fixes from StyleCI

* Add DataWrapperInterface docs

* Fix merge issue

* fix

Co-authored-by: rector-bot <rector@yiiframework.com>
Co-authored-by: StyleCI Bot <bot@styleci.io>
Co-authored-by: Alexander Makarov <sam@rmcreative.ru>

src/DataSet/ArrayDataSet.php

@@ -4,8 +4,7 @@
 
 namespace Yiisoft\Validator\DataSet;
 
-use Yiisoft\Validator\DataSetInterface;
-
+use Yiisoft\Validator\DataWrapperInterface;
 use Yiisoft\Validator\Helper\DataSetNormalizer;
 
 use function array_key_exists;
@@ -21,7 +20,7 @@
  * When using validator, there is no need to wrap your data manually. Array will be automatically wrapped with
  * {@see ArrayDataSet} by {@see DataSetNormalizer} during validation.
  */
-final class ArrayDataSet implements DataSetInterface
+final class ArrayDataSet implements DataWrapperInterface
 {
     public function __construct(
         /**
@@ -56,6 +55,11 @@ public function getData(): array
         return $this->data;
     }
 
+    public function getSource(): array
+    {
+        return $this->data;
+    }
+
     /**
      * Whether this data set has the attribute with a given name. Note that this means existence only and attributes
      * with empty values are treated as present too.

src/DataSet/ObjectDataSet.php

@@ -8,6 +8,7 @@
 use Yiisoft\Validator\AttributeTranslatorInterface;
 use Yiisoft\Validator\AttributeTranslatorProviderInterface;
 use Yiisoft\Validator\DataSetInterface;
+use Yiisoft\Validator\DataWrapperInterface;
 use Yiisoft\Validator\Helper\ObjectParser;
 use Yiisoft\Validator\RulesProvider\AttributesRulesProvider;
 use Yiisoft\Validator\RulesProviderInterface;
@@ -142,7 +143,7 @@
  *
  * @link https://www.php.net/manual/en/language.attributes.overview.php
  */
-final class ObjectDataSet implements RulesProviderInterface, DataSetInterface, AttributeTranslatorProviderInterface
+final class ObjectDataSet implements RulesProviderInterface, DataWrapperInterface, AttributeTranslatorProviderInterface
 {
     /**
      * @var bool Whether an {@see $object} provided a data set by implementing {@see DataSetInterface}.
@@ -259,12 +260,13 @@ public function hasAttribute(string $attribute): bool
     }
 
     /**
-     * Returns the validated data as a whole.
+     * Returns the validated data as array.
      *
-     * @return mixed Validated data, has mixed type if it was provided via {@see DataSetInterface::getData()}
-     * implementation, otherwise it's always an associative array - a mapping between property names and their values.
+     * @return array|null Result of object {@see DataSetInterface::getData()} method, if it was implemented
+     * {@see DataSetInterface}, otherwise returns the validated data as an associative array - a mapping between
+     * property names and their values.
      */
-    public function getData(): mixed
+    public function getData(): ?array
     {
         if ($this->dataSetProvided) {
             /** @var DataSetInterface $object */
@@ -275,6 +277,11 @@ public function getData(): mixed
         return $this->parser->getData();
     }
 
+    public function getSource(): object
+    {
+        return $this->object;
+    }
+
     /**
      * An optional attribute names translator. It's taken from the {@see $object} when
      * {@see AttributeTranslatorProviderInterface} is implemented. In case of it's missing, a `null` value is returned.

src/DataSet/SingleValueDataSet.php

@@ -4,7 +4,7 @@
 
 namespace Yiisoft\Validator\DataSet;
 
-use Yiisoft\Validator\DataSetInterface;
+use Yiisoft\Validator\DataWrapperInterface;
 
 /**
  * A data set used for a single value of any (mixed) data type. Does not support attributes.
@@ -26,7 +26,7 @@
  *
  * For arrays and objects {@see ArrayDataSet} and {@see ObjectDataSet} can be used accordingly.
  */
-final class SingleValueDataSet implements DataSetInterface
+final class SingleValueDataSet implements DataWrapperInterface
 {
     public function __construct(
         /**
@@ -50,12 +50,14 @@ public function getAttributeValue(string $attribute): mixed
     }
 
     /**
-     * A getter for {@see $data} property. Returns the validated data as a whole. In this case the single value itself
-     * is returned as a data because it can not be decoupled.
-     *
-     * @return mixed Single value of any (mixed) data type.
+     * Returns the validated data as array.
      */
-    public function getData(): mixed
+    public function getData(): ?array
+    {
+        return null;
+    }
+
+    public function getSource(): mixed
     {
         return $this->value;
     }

src/DataSetInterface.php

@@ -19,11 +19,12 @@ interface DataSetInterface
     public function getAttributeValue(string $attribute): mixed;
 
     /**
-     * Returns the validated data as a whole.
+     * Returns the validated data as an associative array, where keys are attribute names and values are their
+     * corresponding values. `null` means that implementation does not support getting an array of attributes.
      *
-     * @return mixed Validated data.
+     * @return array|null Validated data as array of attributes or `null` when does not support this.
      */
-    public function getData(): mixed;
+    public function getData(): ?array;
 
     /**
      * Whether a data set has the attribute with a given name. Note that this means existence only and attributes with

src/DataWrapperInterface.php

@@ -0,0 +1,20 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Yiisoft\Validator;
+
+/**
+ * Data wrapper interface provides access to raw data behind a data set.
+ *
+ * @internal
+ */
+interface DataWrapperInterface extends DataSetInterface
+{
+    /**
+     * Get raw data that is wrapped.
+     *
+     * @return mixed Raw data.
+     */
+    public function getSource(): mixed;
+}

src/Rule/AtLeastHandler.php

@@ -27,6 +27,9 @@ public function validate(mixed $value, object $rule, ValidationContext $context)
             throw new UnexpectedRuleException(AtLeast::class, $rule);
         }
 
+        /** @var mixed $value */
+        $value = $context->getParameter(ValidationContext::PARAMETER_VALUE_AS_ARRAY) ?? $value;
+
         $result = new Result();
 
         if (!is_array($value) && !is_object($value)) {

src/Rule/Callback.php

@@ -36,11 +36,6 @@ final class Callback implements
     use SkipOnErrorTrait;
     use WhenTrait;
 
-    /**
-     * @var object|null The object being validated. `null` if PHP attributes aren't used.
-     */
-    private ?object $validatedObject = null;
-
     /**
      * @param callable|null $callback Callable with the `function ($value, $rule, $context): Result` signature that
      * performs the validation. Mutually exclusive with {@see $method}.
@@ -102,24 +97,8 @@ public function getMethod(): string|null
         return $this->method;
     }
 
-    /**
-     * Get object being validated.
-     *
-     * @return object|null Object being validated. Null if PHP attributes aren't used.
-     *
-     * @see $validatedObject
-     */
-    public function getValidatedObject(): ?object
-    {
-        return $this->validatedObject;
-    }
-
     public function afterInitAttribute(object $object, int $target): void
     {
-        if ($target === Attribute::TARGET_CLASS) {
-            $this->validatedObject = $object;
-        }
-
         if ($this->method === null) {
             return;
         }

src/Rule/CallbackHandler.php

@@ -32,7 +32,7 @@ public function validate(mixed $value, object $rule, ValidationContext $context)
             throw new InvalidArgumentException('Using method outside of attribute scope is prohibited.');
         }
 
-        $result = $callback($rule->getValidatedObject() ?? $value, $rule, $context);
+        $result = $callback($value, $rule, $context);
         if (!$result instanceof Result) {
             throw new InvalidCallbackReturnTypeException($result);
         }

src/Rule/Count.php

@@ -7,7 +7,6 @@
 use Attribute;
 use Closure;
 use Countable;
-use Yiisoft\Validator\AfterInitAttributeEventInterface;
 use Yiisoft\Validator\LimitInterface;
 use Yiisoft\Validator\Rule\Trait\LimitTrait;
 use Yiisoft\Validator\Rule\Trait\SkipOnEmptyTrait;
@@ -32,19 +31,13 @@ final class Count implements
     SkipOnErrorInterface,
     WhenInterface,
     SkipOnEmptyInterface,
-    LimitInterface,
-    AfterInitAttributeEventInterface
+    LimitInterface
 {
     use LimitTrait;
     use SkipOnEmptyTrait;
     use SkipOnErrorTrait;
     use WhenTrait;
 
-    /**
-     * @var object|null Object being validated.
-     */
-    private ?object $objectValidated = null;
-
     /**
      * @param int|null $exactly Exact number of items. `null` means no strict comparison. Mutually exclusive with
      * {@see $min} and {@see $max}.
@@ -130,18 +123,6 @@ public function getIncorrectInputMessage(): string
         return $this->incorrectInputMessage;
     }
 
-    /**
-     * Get object being validated.
-     *
-     * @return object|null Object being validated.
-     *
-     * @see $objectValidated
-     */
-    public function getObjectValidated(): ?object
-    {
-        return $this->objectValidated;
-    }
-
     public function getOptions(): array
     {
         return array_merge($this->getLimitOptions(), [
@@ -158,11 +139,4 @@ public function getHandler(): string
     {
         return CountHandler::class;
     }
-
-    public function afterInitAttribute(object $object, int $target): void
-    {
-        if ($target === Attribute::TARGET_CLASS) {
-            $this->objectValidated = $object;
-        }
-    }
 }

src/Rule/CountHandler.php

@@ -32,7 +32,6 @@ public function validate(mixed $value, object $rule, ValidationContext $context)
         $result = new Result();
 
         /** @var mixed $value */
-        $value = $rule->getObjectValidated() ?? $value;
         if (!is_countable($value)) {
             $result->addError($rule->getIncorrectInputMessage(), [
                 'attribute' => $context->getTranslatedAttribute(),

src/Rule/EachHandler.php

@@ -23,6 +23,9 @@ public function validate(mixed $value, object $rule, ValidationContext $context)
             throw new UnexpectedRuleException(Each::class, $rule);
         }
 
+        /** @var mixed $value */
+        $value = $context->getParameter(ValidationContext::PARAMETER_VALUE_AS_ARRAY) ?? $value;
+
         $rules = $rule->getRules();
 
         $result = new Result();

src/Rule/NestedHandler.php

@@ -49,6 +49,9 @@ public function validate(mixed $value, object $rule, ValidationContext $context)
             throw new UnexpectedRuleException(Nested::class, $rule);
         }
 
+        /** @var mixed $value */
+        $value = $context->getParameter(ValidationContext::PARAMETER_VALUE_AS_ARRAY) ?? $value;
+
         $compoundResult = new Result();
 
         if ($rule->getRules() === null) {

src/ValidationContext.php

@@ -14,6 +14,8 @@
  */
 final class ValidationContext
 {
+    public const PARAMETER_VALUE_AS_ARRAY = 'yii-validator-value-as-array';
+
     /**
      * @var ValidatorInterface|null A validator instance. `null` means context data was not set
      * with {@see setContextDataOnce()} yet.

src/Validator.php

@@ -113,11 +113,13 @@ public function validate(
 
             if (is_int($attribute)) {
                 /** @psalm-suppress MixedAssignment */
-                $validatedData = $dataSet->getData();
+                $validatedData = $dataSet instanceof DataWrapperInterface ? $dataSet->getSource() : $data;
+                $context->setParameter(ValidationContext::PARAMETER_VALUE_AS_ARRAY, $dataSet->getData());
                 $context->setAttribute(null);
             } else {
                 /** @psalm-suppress MixedAssignment */
                 $validatedData = $dataSet->getAttributeValue($attribute);
+                $context->setParameter(ValidationContext::PARAMETER_VALUE_AS_ARRAY, null);
                 $context->setAttribute($attribute);
             }
 

tests/DataSet/SingleValueDataSetTest.php

@@ -13,8 +13,8 @@ public function testBase(): void
     {
         $data = new SingleValueDataSet(['test' => 'hello']);
 
-        $this->assertSame(['test' => 'hello'], $data->getData());
-
+        $this->assertNull($data->getData());
+        $this->assertSame(['test' => 'hello'], $data->getSource());
         $this->assertFalse($data->hasAttribute('test'));
         $this->assertNull($data->getAttributeValue('test'));
     }

tests/Rule/AtLeastTest.php

@@ -110,6 +110,13 @@ public function dataValidationPassed(): array
                 },
                 [new AtLeast(['attr2'])],
             ],
+            [
+                new class () {
+                    private int $attr1 = 1;
+                    private $attr2 = null;
+                },
+                [new AtLeast(['attr1', 'attr2'])],
+            ],
             [
                 ['attr1' => 1, 'attr2' => null],
                 [new AtLeast(['attr1', 'attr2'])],

tests/Rule/Base/RuleTestCase.php

@@ -27,8 +27,11 @@ abstract public function dataValidationFailed(): array;
     /**
      * @dataProvider dataValidationFailed
      */
-    public function testValidationFailed(mixed $data, array|RuleInterface|null $rules, array $errorMessagesIndexedByPath): void
-    {
+    public function testValidationFailed(
+        mixed $data,
+        array|RuleInterface|null $rules,
+        array $errorMessagesIndexedByPath
+    ): void {
         $result = (new Validator())->validate($data, $rules);
 
         $this->assertFalse($result->isValid());

tests/Rule/CompareToTest.php

@@ -6,7 +6,7 @@
 
 use InvalidArgumentException;
 use stdClass;
-use Yiisoft\Validator\DataSetInterface;
+use Yiisoft\Validator\DataWrapperInterface;
 use Yiisoft\Validator\Rule\Compare;
 use Yiisoft\Validator\Rule\CompareTo;
 use Yiisoft\Validator\Tests\Rule\Base\RuleTestCase;
@@ -433,13 +433,18 @@ public function dataValidationPassed(): array
 
     public function dataValidationFailed(): array
     {
-        $incorrectDataSet = new class () implements DataSetInterface {
+        $incorrectDataSet = new class () implements DataWrapperInterface {
             public function getAttributeValue(string $attribute): mixed
             {
                 return new stdClass();
             }
 
-            public function getData(): mixed
+            public function getData(): ?array
+            {
+                return null;
+            }
+
+            public function getSource(): mixed
             {
                 return false;
             }