Fix #173: Do not throw MissingAttributeException (#285)

arogachev · web-flow · commit 6dccadd14205 · 2022-08-10T00:47:46.000+03:00
diff --git a/src/DataSet/ArrayDataTrait.php b/src/DataSet/ArrayDataTrait.php
@@ -4,22 +4,16 @@
 
 namespace Yiisoft\Validator\DataSet;
 
-use Yiisoft\Validator\Exception\MissingAttributeException;
-
 /**
  * @internal
  */
 trait ArrayDataTrait
 {
     private array $data;
 
-    public function getAttributeValue(string $attribute)
+    public function getAttributeValue(string $attribute): mixed
     {
-        if (!isset($this->data[$attribute])) {
-            throw new MissingAttributeException("There is no \"$attribute\" key in the array.");
-        }
-
-        return $this->data[$attribute];
+        return $this->data[$attribute] ?? null;
     }
 
     public function getData(): array
diff --git a/src/DataSet/ScalarDataSet.php b/src/DataSet/ScalarDataSet.php
@@ -15,7 +15,7 @@ public function __construct($value)
         $this->value = $value;
     }
 
-    public function getAttributeValue(string $attribute)
+    public function getAttributeValue(string $attribute): mixed
     {
         return $this->value;
     }
diff --git a/src/DataSetInterface.php b/src/DataSetInterface.php
@@ -4,8 +4,6 @@
 
 namespace Yiisoft\Validator;
 
-use Yiisoft\Validator\Exception\MissingAttributeException;
-
 /**
  * DataSetInterface represents a key-value data set.
  */
@@ -14,11 +12,9 @@ interface DataSetInterface
     /**
      * Get specified attribute value.
      *
-     * @throws MissingAttributeException If there is no such value.
-     *
      * @return mixed
      */
-    public function getAttributeValue(string $attribute);
+    public function getAttributeValue(string $attribute): mixed;
 
     public function getData(): mixed;
 }
diff --git a/src/Exception/MissingAttributeException.php b/src/Exception/MissingAttributeException.php
diff --git a/tests/Stub/DataSet.php b/tests/Stub/DataSet.php
@@ -5,7 +5,6 @@
 namespace Yiisoft\Validator\Tests\Stub;
 
 use Yiisoft\Validator\DataSetInterface;
-use Yiisoft\Validator\Exception\MissingAttributeException;
 
 final class DataSet implements DataSetInterface
 {
@@ -16,13 +15,9 @@ public function __construct(array $data = [])
         $this->data = $data;
     }
 
-    public function getAttributeValue(string $attribute)
+    public function getAttributeValue(string $attribute): mixed
     {
-        if (!isset($this->data[$attribute])) {
-            throw new MissingAttributeException("There is no \"$attribute\" attribute in the class.");
-        }
-
-        return $this->data[$attribute];
+        return $this->data[$attribute] ?? null;
     }
 
     public function getData(): mixed
diff --git a/tests/Stub/RulesProvidedDataSet.php b/tests/Stub/RulesProvidedDataSet.php
@@ -5,7 +5,6 @@
 namespace Yiisoft\Validator\Tests\Stub;
 
 use Yiisoft\Validator\DataSetInterface;
-use Yiisoft\Validator\Exception\MissingAttributeException;
 use Yiisoft\Validator\RulesProviderInterface;
 
 final class RulesProvidedDataSet implements RulesProviderInterface, DataSetInterface
@@ -19,13 +18,9 @@ public function __construct(array $data, array $rules)
         $this->rules = $rules;
     }
 
-    public function getAttributeValue(string $attribute)
+    public function getAttributeValue(string $attribute): mixed
     {
-        if (!isset($this->data[$attribute])) {
-            throw new MissingAttributeException("There is no \"$attribute\" attribute in the class.");
-        }
-
-        return $this->data[$attribute];
+        return $this->data[$attribute] ?? null;
     }
 
     public function getRules(): iterable
diff --git a/tests/ValidatorTest.php b/tests/ValidatorTest.php
@@ -6,6 +6,8 @@
 
 use PHPUnit\Framework\TestCase;
 use stdClass;
+use Yiisoft\Validator\DataSet\ArrayDataSet;
+use Yiisoft\Validator\Error;
 use Yiisoft\Validator\Exception\RuleHandlerInterfaceNotImplementedException;
 use Yiisoft\Validator\Exception\RuleHandlerNotFoundException;
 use Yiisoft\Validator\Result;
@@ -143,4 +145,23 @@ public function getHandlerClassName(): string
             ],
         ]);
     }
+
+    /**
+     * @link https://github.com/yiisoft/validator/issues/173
+     */
+    public function testMissingRequiredAttribute(): void
+    {
+        $validator = FakeValidatorFactory::make();
+        $dataSet = new ArrayDataSet([
+            'merchantIdd' => 1,
+        ]);
+        $rules = [
+            'merchantId' => [new Required(), new Number(asInteger: true)],
+        ];
+        $result = $validator->validate($dataSet, $rules);
+        $this->assertEquals([
+            new Error('Value cannot be blank.', ['merchantId']),
+            new Error('Value must be an integer.', ['merchantId']),
+        ], $result->getErrors());
+    }
 }

Original file line number	Diff line number	Diff line change
`@@ -15,7 +15,7 @@ public function __construct($value)`
`15`	`15`	`$this->value = $value;`
`16`	`16`	`}`
`17`	`17`
`18`		`- public function getAttributeValue(string $attribute)`
	`18`	`+ public function getAttributeValue(string $attribute): mixed`
`19`	`19`	`{`
`20`	`20`	`return $this->value;`
`21`	`21`	`}`
Original file line number	Diff line number	Diff line change
`@@ -5,7 +5,6 @@`
`5`	`5`	`namespace Yiisoft\Validator\Tests\Stub;`
`6`	`6`
`7`	`7`	`use Yiisoft\Validator\DataSetInterface;`
`8`		`-use Yiisoft\Validator\Exception\MissingAttributeException;`
`9`	`8`
`10`	`9`	`final class DataSet implements DataSetInterface`
`11`	`10`	`{`
`@@ -16,13 +15,9 @@ public function __construct(array $data = [])`
`16`	`15`	`$this->data = $data;`
`17`	`16`	`}`
`18`	`17`
`19`		`- public function getAttributeValue(string $attribute)`
	`18`	`+ public function getAttributeValue(string $attribute): mixed`
`20`	`19`	`{`
`21`		`- if (!isset($this->data[$attribute])) {`
`22`		`- throw new MissingAttributeException("There is no \"$attribute\" attribute in the class.");`
`23`		`- }`
`24`		`-`
`25`		`- return $this->data[$attribute];`
	`20`	`+ return $this->data[$attribute] ?? null;`
`26`	`21`	`}`
`27`	`22`
`28`	`23`	`public function getData(): mixed`