In RuleInterface replace getHandlerClassName(): string to `getHan…

…dler(): string|RuleHandlerInterface` (#468)
yiisoft · Dec 17, 2022 · 4734f7a · 4734f7a
1 parent 9562b0c
commit 4734f7a
Show file tree

Hide file tree

Showing 30 changed files with 84 additions and 32 deletions.
diff --git a/src/Rule/AtLeast.php b/src/Rule/AtLeast.php
@@ -98,7 +98,7 @@ public function getOptions(): array
         ];
     }
 
-    public function getHandlerClassName(): string
+    public function getHandler(): string
     {
         return AtLeastHandler::class;
     }

diff --git a/src/Rule/Boolean.php b/src/Rule/Boolean.php
@@ -110,7 +110,7 @@ public function getOptions(): array
         ];
     }
 
-    public function getHandlerClassName(): string
+    public function getHandler(): string
     {
         return BooleanHandler::class;
     }

diff --git a/src/Rule/Callback.php b/src/Rule/Callback.php
@@ -116,7 +116,7 @@ public function getOptions(): array
         ];
     }
 
-    public function getHandlerClassName(): string
+    public function getHandler(): string
     {
         return CallbackHandler::class;
     }

diff --git a/src/Rule/Compare.php b/src/Rule/Compare.php
@@ -179,7 +179,7 @@ public function getOptions(): array
         ];
     }
 
-    public function getHandlerClassName(): string
+    public function getHandler(): string
     {
         return CompareHandler::class;
     }

diff --git a/src/Rule/Composite.php b/src/Rule/Composite.php
@@ -99,7 +99,7 @@ public function getRules(): iterable
         return $this->rules;
     }
 
-    final public function getHandlerClassName(): string
+    final public function getHandler(): string
     {
         return CompositeHandler::class;
     }

diff --git a/src/Rule/Count.php b/src/Rule/Count.php
@@ -130,7 +130,7 @@ public function getOptions(): array
         ]);
     }
 
-    public function getHandlerClassName(): string
+    public function getHandler(): string
     {
         return CountHandler::class;
     }

diff --git a/src/Rule/Each.php b/src/Rule/Each.php
@@ -137,7 +137,7 @@ public function getOptions(): array
         ];
     }
 
-    public function getHandlerClassName(): string
+    public function getHandler(): string
     {
         return EachHandler::class;
     }

diff --git a/src/Rule/Email.php b/src/Rule/Email.php
@@ -159,7 +159,7 @@ public function getOptions(): array
         ];
     }
 
-    public function getHandlerClassName(): string
+    public function getHandler(): string
     {
         return EmailHandler::class;
     }

diff --git a/src/Rule/HasLength.php b/src/Rule/HasLength.php
@@ -126,7 +126,7 @@ public function getOptions(): array
         ]);
     }
 
-    public function getHandlerClassName(): string
+    public function getHandler(): string
     {
         return HasLengthHandler::class;
     }

diff --git a/src/Rule/In.php b/src/Rule/In.php
@@ -96,7 +96,7 @@ public function getOptions(): array
         ];
     }
 
-    public function getHandlerClassName(): string
+    public function getHandler(): string
     {
         return InHandler::class;
     }

diff --git a/src/Rule/Ip.php b/src/Rule/Ip.php
@@ -414,7 +414,7 @@ public function getOptions(): array
         ];
     }
 
-    public function getHandlerClassName(): string
+    public function getHandler(): string
     {
         return IpHandler::class;
     }

diff --git a/src/Rule/IsTrue.php b/src/Rule/IsTrue.php
@@ -88,7 +88,7 @@ public function getOptions(): array
         ];
     }
 
-    public function getHandlerClassName(): string
+    public function getHandler(): string
     {
         return IsTrueHandler::class;
     }

diff --git a/src/Rule/Json.php b/src/Rule/Json.php
@@ -73,7 +73,7 @@ public function getOptions(): array
         ];
     }
 
-    public function getHandlerClassName(): string
+    public function getHandler(): string
     {
         return JsonHandler::class;
     }

diff --git a/src/Rule/Nested.php b/src/Rule/Nested.php
@@ -360,7 +360,7 @@ public function getOptions(): array
         ];
     }
 
-    public function getHandlerClassName(): string
+    public function getHandler(): string
     {
         return NestedHandler::class;
     }

diff --git a/src/Rule/Number.php b/src/Rule/Number.php
@@ -157,7 +157,7 @@ public function getOptions(): array
         ];
     }
 
-    public function getHandlerClassName(): string
+    public function getHandler(): string
     {
         return NumberHandler::class;
     }

diff --git a/src/Rule/Regex.php b/src/Rule/Regex.php
@@ -98,7 +98,7 @@ public function getOptions(): array
         ];
     }
 
-    public function getHandlerClassName(): string
+    public function getHandler(): string
     {
         return RegexHandler::class;
     }

diff --git a/src/Rule/Required.php b/src/Rule/Required.php
@@ -85,7 +85,7 @@ public function getOptions(): array
         ];
     }
 
-    public function getHandlerClassName(): string
+    public function getHandler(): string
     {
         return RequiredHandler::class;
     }

diff --git a/src/Rule/StopOnError.php b/src/Rule/StopOnError.php
@@ -81,7 +81,7 @@ public function getOptions(): array
         ];
     }
 
-    public function getHandlerClassName(): string
+    public function getHandler(): string
     {
         return StopOnErrorHandler::class;
     }

diff --git a/src/Rule/Subset.php b/src/Rule/Subset.php
@@ -94,7 +94,7 @@ public function getOptions(): array
         ];
     }
 
-    public function getHandlerClassName(): string
+    public function getHandler(): string
     {
         return SubsetHandler::class;
     }

diff --git a/src/Rule/Url.php b/src/Rule/Url.php
@@ -127,7 +127,7 @@ public function getOptions(): array
         ];
     }
 
-    public function getHandlerClassName(): string
+    public function getHandler(): string
     {
         return UrlHandler::class;
     }

diff --git a/src/RuleInterface.php b/src/RuleInterface.php
@@ -28,14 +28,14 @@ interface RuleInterface
     public function getName(): string;
 
     /**
-     * A matching handler class name used for processing this rule.
+     * A matching handler class name or instance used for processing this rule.
      *
      * While not required, it's recommended to use rule class name with "Handler" suffix, so for `AtLeast` rule class
      * name the handler class name will be `AtLeastHandler` and so on.
      *
      * All packages handlers are stored within the same namespace as rules, but this is not a strict requirement.
      *
-     * @return string A rule handler class name.
+     * @return RuleHandlerInterface|string A rule handler class name or instance.
      */
-    public function getHandlerClassName(): string;
+    public function getHandler(): string|RuleHandlerInterface;
 }
diff --git a/src/Validator.php b/src/Validator.php
@@ -20,6 +20,7 @@
 
 use function extension_loaded;
 use function is_int;
+use function is_string;
 
 /**
  * Validator validates {@link DataSetInterface} against rules set for data set attributes.
@@ -140,7 +141,11 @@ private function validateInternal(mixed $value, iterable $rules, ValidationConte
                 continue;
             }
 
-            $ruleHandler = $this->ruleHandlerResolver->resolve($rule->getHandlerClassName());
+            $ruleHandler = $rule->getHandler();
+            if (is_string($ruleHandler)) {
+                $ruleHandler = $this->ruleHandlerResolver->resolve($ruleHandler);
+            }
+
             $ruleResult = $ruleHandler->validate($value, $rule, $context);
             if ($ruleResult->isValid()) {
                 continue;

diff --git a/tests/Rule/NestedTest.php b/tests/Rule/NestedTest.php
@@ -83,7 +83,7 @@ public function testHandlerClassName(): void
     {
         $rule = new Nested();
 
-        $this->assertSame(NestedHandler::class, $rule->getHandlerClassName());
+        $this->assertSame(NestedHandler::class, $rule->getHandler());
     }
 
     public function dataOptions(): array

diff --git a/tests/Rule/RequiredTest.php b/tests/Rule/RequiredTest.php
@@ -27,7 +27,7 @@ public function testDefaultValues(): void
         $rule = new Required();
 
         $this->assertInstanceOf(WhenEmpty::class, $rule->getEmptyCriteria());
-        $this->assertSame(RequiredHandler::class, $rule->getHandlerClassName());
+        $this->assertSame(RequiredHandler::class, $rule->getHandler());
         $this->assertSame('Value cannot be blank.', $rule->getMessage());
         $this->assertSame('required', $rule->getName());
         $this->assertSame('Value not passed.', $rule->getNotPassedMessage());

diff --git a/tests/Rule/RuleWithBuiltInHandler.php b/tests/Rule/RuleWithBuiltInHandler.php
@@ -0,0 +1,34 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Yiisoft\Validator\Tests\Rule;
+
+use Yiisoft\Validator\Result;
+use Yiisoft\Validator\RuleHandlerInterface;
+use Yiisoft\Validator\RuleInterface;
+use Yiisoft\Validator\ValidationContext;
+
+final class RuleWithBuiltInHandler implements RuleInterface, RuleHandlerInterface
+{
+    public function validate(mixed $value, object $rule, ValidationContext $context): Result
+    {
+        $result = new Result();
+
+        if ($value !== 42) {
+            $result->addError('Value must be 42.');
+        }
+
+        return $result;
+    }
+
+    public function getName(): string
+    {
+        return 'is42';
+    }
+
+    public function getHandler(): string|RuleHandlerInterface
+    {
+        return $this;
+    }
+}
diff --git a/tests/Support/Rule/NotNullRule/NotNull.php b/tests/Support/Rule/NotNullRule/NotNull.php
@@ -15,7 +15,7 @@ public function getName(): string
         return 'notNull';
     }
 
-    public function getHandlerClassName(): string
+    public function getHandler(): string
     {
         return NotNullHandler::class;
     }

diff --git a/tests/Support/Rule/RuleWithCustomHandler.php b/tests/Support/Rule/RuleWithCustomHandler.php
@@ -18,7 +18,7 @@ public function getName(): string
         return 'rule-with-custom-handler';
     }
 
-    public function getHandlerClassName(): string
+    public function getHandler(): string
     {
         return $this->handlerClassName;
     }

diff --git a/tests/Support/Rule/RuleWithoutOptions.php b/tests/Support/Rule/RuleWithoutOptions.php
@@ -14,7 +14,7 @@ public function getName(): string
         return 'test';
     }
 
-    public function getHandlerClassName(): string
+    public function getHandler(): string
     {
         return StubRuleHandler::class;
     }

diff --git a/tests/Support/Rule/StubRule/StubRuleWithOptions.php b/tests/Support/Rule/StubRule/StubRuleWithOptions.php
@@ -22,7 +22,7 @@ public function getOptions(): array
         return $this->options;
     }
 
-    public function getHandlerClassName(): string
+    public function getHandler(): string
     {
         return StubRuleHandler::class;
     }

diff --git a/tests/ValidatorTest.php b/tests/ValidatorTest.php
@@ -26,6 +26,7 @@
 use Yiisoft\Validator\Rule\Required;
 use Yiisoft\Validator\RuleInterface;
 use Yiisoft\Validator\RulesProviderInterface;
+use Yiisoft\Validator\Tests\Rule\RuleWithBuiltInHandler;
 use Yiisoft\Validator\Tests\Support\Data\EachNestedObjects\Foo;
 use Yiisoft\Validator\Tests\Support\Data\IteratorWithBooleanKey;
 use Yiisoft\Validator\Tests\Support\Data\ObjectWithAttributesOnly;
@@ -314,7 +315,7 @@ public function getName(): string
                         return 'test';
                     }
 
-                    public function getHandlerClassName(): string
+                    public function getHandler(): string
                     {
                         return $this->ruleHandler::class;
                     }
@@ -336,7 +337,7 @@ public function getName(): string
                         return 'test';
                     }
 
-                    public function getHandlerClassName(): string
+                    public function getHandler(): string
                     {
                         return 'NonExistClass';
                     }
@@ -1335,4 +1336,16 @@ public function testSimpleForm(array $expectedMessages, ?ValidationContext $vali
             $result->getErrorMessagesIndexedByPath()
         );
     }
+
+    public function testRuleWithBuiltInHandler(): void
+    {
+        $rule = new RuleWithBuiltInHandler();
+
+        $result = (new Validator())->validate(19, $rule);
+
+        $this->assertSame(
+            ['' => ['Value must be 42.']],
+            $result->getErrorMessagesIndexedByPath()
+        );
+    }
 }