Update the validation engine of comparison-based rules

Signed-off-by: Henrique Moody <[email protected]>
Respect · Feb 22, 2024 · 0e87d1f · 0e87d1f
1 parent 692d317
commit 0e87d1f
Show file tree

Hide file tree

Showing 14 changed files with 19 additions and 71 deletions.
diff --git a/library/Rules/AbstractComparison.php → library/Rules/Comparison.php b/library/Rules/AbstractComparison.php → library/Rules/Comparison.php
@@ -10,8 +10,9 @@
 namespace Respect\Validation\Rules;
 
 use Respect\Validation\Helpers\CanCompareValues;
+use Respect\Validation\Result;
 
-abstract class AbstractComparison extends AbstractRule
+abstract class Comparison extends Standard
 {
     use CanCompareValues;
 
@@ -24,23 +25,17 @@ public function __construct(mixed $maxValue)
         $this->compareTo = $maxValue;
     }
 
-    public function validate(mixed $input): bool
+    public function evaluate(mixed $input): Result
     {
         $left = $this->toComparable($input);
         $right = $this->toComparable($this->compareTo);
 
+        $parameters = ['compareTo' => $this->compareTo];
+
         if (!$this->isAbleToCompareValues($left, $right)) {
-            return false;
+            return Result::failed($input, $this)->withParameters($parameters);
         }
 
-        return $this->compare($left, $right);
-    }
-
-    /**
-     * @return array<string, mixed>
-     */
-    public function getParams(): array
-    {
-        return ['compareTo' => $this->compareTo];
+        return (new Result($this->compare($left, $right), $input, $this))->withParameters($parameters);
     }
 }
diff --git a/library/Rules/Equals.php b/library/Rules/Equals.php
@@ -15,7 +15,7 @@
     '{{name}} must equal {{compareTo}}',
     '{{name}} must not equal {{compareTo}}',
 )]
-final class Equals extends AbstractComparison
+final class Equals extends Comparison
 {
     protected function compare(mixed $left, mixed $right): bool
     {

diff --git a/library/Rules/Equivalent.php b/library/Rules/Equivalent.php
@@ -18,36 +18,14 @@
     '{{name}} must be equivalent to {{compareTo}}',
     '{{name}} must not be equivalent to {{compareTo}}',
 )]
-final class Equivalent extends AbstractRule
+final class Equivalent extends Comparison
 {
-    public function __construct(
-        private readonly mixed $compareTo
-    ) {
-    }
-
-    public function validate(mixed $input): bool
-    {
-        if (is_scalar($input)) {
-            return $this->isStringEquivalent((string) $input);
-        }
-
-        return $input == $this->compareTo;
-    }
-
-    /**
-     * @return array<string, mixed>
-     */
-    public function getParams(): array
-    {
-        return ['compareTo' => $this->compareTo];
-    }
-
-    private function isStringEquivalent(string $input): bool
+    protected function compare(mixed $left, mixed $right): bool
     {
-        if (!is_scalar($this->compareTo)) {
-            return false;
+        if (!is_scalar($left)) {
+            return $left == $right;
         }
 
-        return mb_strtoupper((string) $input) === mb_strtoupper((string) $this->compareTo);
+        return mb_strtoupper((string) $left) === mb_strtoupper((string) $right);
     }
 }
diff --git a/library/Rules/GreaterThan.php b/library/Rules/GreaterThan.php
@@ -15,7 +15,7 @@
     '{{name}} must be greater than {{compareTo}}',
     '{{name}} must not be greater than {{compareTo}}',
 )]
-final class GreaterThan extends AbstractComparison
+final class GreaterThan extends Comparison
 {
     protected function compare(mixed $left, mixed $right): bool
     {

diff --git a/library/Rules/Identical.php b/library/Rules/Identical.php
@@ -15,7 +15,7 @@
     '{{name}} must be identical as {{compareTo}}',
     '{{name}} must not be identical as {{compareTo}}',
 )]
-final class Identical extends AbstractComparison
+final class Identical extends Comparison
 {
     protected function compare(mixed $left, mixed $right): bool
     {

diff --git a/library/Rules/LessThan.php b/library/Rules/LessThan.php
@@ -15,7 +15,7 @@
     '{{name}} must be less than {{compareTo}}',
     '{{name}} must not be less than {{compareTo}}',
 )]
-final class LessThan extends AbstractComparison
+final class LessThan extends Comparison
 {
     protected function compare(mixed $left, mixed $right): bool
     {

diff --git a/library/Rules/Max.php b/library/Rules/Max.php
@@ -15,7 +15,7 @@
     '{{name}} must be less than or equal to {{compareTo}}',
     '{{name}} must not be less than or equal to {{compareTo}}',
 )]
-final class Max extends AbstractComparison
+final class Max extends Comparison
 {
     protected function compare(mixed $left, mixed $right): bool
     {

diff --git a/library/Rules/Min.php b/library/Rules/Min.php
@@ -15,7 +15,7 @@
     '{{name}} must be greater than or equal to {{compareTo}}',
     '{{name}} must not be greater than or equal to {{compareTo}}',
 )]
-final class Min extends AbstractComparison
+final class Min extends Comparison
 {
     protected function compare(mixed $left, mixed $right): bool
     {

diff --git a/tests/unit/Rules/EqualsTest.php b/tests/unit/Rules/EqualsTest.php
@@ -11,24 +11,13 @@
 
 use PHPUnit\Framework\Attributes\CoversClass;
 use PHPUnit\Framework\Attributes\Group;
-use PHPUnit\Framework\Attributes\Test;
 use Respect\Validation\Test\RuleTestCase;
 use stdClass;
 
 #[Group('rule')]
 #[CoversClass(Equals::class)]
 final class EqualsTest extends RuleTestCase
 {
-    #[Test]
-    public function shouldPassCompareToParameterToException(): void
-    {
-        $compareTo = new stdClass();
-        $equals = new Equals($compareTo);
-        $exception = $equals->reportError('input');
-
-        self::assertSame($compareTo, $exception->getParam('compareTo'));
-    }
-
     /** @return iterable<array{Equals, mixed}> */
     public static function providerForValidInput(): iterable
     {

diff --git a/tests/unit/Rules/GreaterThanTest.php b/tests/unit/Rules/GreaterThanTest.php
@@ -15,7 +15,6 @@
 use Respect\Validation\Test\Stubs\CountableStub;
 
 #[Group('rule')]
-#[CoversClass(AbstractComparison::class)]
 #[CoversClass(GreaterThan::class)]
 final class GreaterThanTest extends RuleTestCase
 {

diff --git a/tests/unit/Rules/IdenticalTest.php b/tests/unit/Rules/IdenticalTest.php
@@ -11,24 +11,13 @@
 
 use PHPUnit\Framework\Attributes\CoversClass;
 use PHPUnit\Framework\Attributes\Group;
-use PHPUnit\Framework\Attributes\Test;
 use Respect\Validation\Test\RuleTestCase;
 use stdClass;
 
 #[Group('rule')]
 #[CoversClass(Identical::class)]
 final class IdenticalTest extends RuleTestCase
 {
-    #[Test]
-    public function shouldPassCompareToParameterToException(): void
-    {
-        $compareTo = new stdClass();
-        $rule = new Identical($compareTo);
-        $exception = $rule->reportError('input');
-
-        self::assertSame($compareTo, $exception->getParam('compareTo'));
-    }
-
     /** @return iterable<array{Identical, mixed}> */
     public static function providerForValidInput(): iterable
     {

diff --git a/tests/unit/Rules/LessThanTest.php b/tests/unit/Rules/LessThanTest.php
@@ -15,7 +15,7 @@
 use Respect\Validation\Test\Stubs\CountableStub;
 
 #[Group('rule')]
-#[CoversClass(AbstractComparison::class)]
+#[CoversClass(Comparison::class)]
 #[CoversClass(LessThan::class)]
 final class LessThanTest extends RuleTestCase
 {

diff --git a/tests/unit/Rules/MaxTest.php b/tests/unit/Rules/MaxTest.php
@@ -17,7 +17,6 @@
 use Respect\Validation\Test\Stubs\CountableStub;
 
 #[Group('rule')]
-#[CoversClass(AbstractComparison::class)]
 #[CoversClass(Max::class)]
 final class MaxTest extends RuleTestCase
 {

diff --git a/tests/unit/Rules/MinTest.php b/tests/unit/Rules/MinTest.php
@@ -17,7 +17,6 @@
 use Respect\Validation\Test\Stubs\CountableStub;
 
 #[Group('rule')]
-#[CoversClass(AbstractComparison::class)]
 #[CoversClass(Min::class)]
 final class MinTest extends RuleTestCase
 {