Fix #264: Remove GroupRule in favor of Composite (#267)

yiisoft · Jul 22, 2022 · 819311c · 819311c
1 parent 89f940c
commit 819311c
Show file tree

Hide file tree

Showing 35 changed files with 125 additions and 343 deletions.
diff --git a/README.md b/README.md
@@ -47,7 +47,6 @@ Library could be used in two ways: validating a single value and validating a se
 
 ```php
 use Yiisoft\Validator\ValidatorInterface;
-use Yiisoft\Validator\RuleSet;
 use Yiisoft\Validator\Rule\Required;
 use Yiisoft\Validator\Rule\Number;
 use Yiisoft\Validator\Result;
@@ -223,7 +222,6 @@ use Yiisoft\Validator\ValidatorInterface;
 use Yiisoft\Validator\Rule\Count;
 use Yiisoft\Validator\Rule\Each;
 use Yiisoft\Validator\Rule\Nested;
-use Yiisoft\Validator\RuleSet;
 
 // Usually obtained from container
 $validator = $container->get(ValidatorInterface::class);
@@ -373,11 +371,11 @@ final class Post
 
 ```php
 use Attribute;
-use \Yiisoft\Validator\Exception\UnexpectedRuleException;
+use Yiisoft\Validator\Exception\UnexpectedRuleException;
 use Yiisoft\Validator\Result;
 use Yiisoft\Validator\Rule\Number;
 use Yiisoft\Validator\RuleHandlerInterface;
-use \Yiisoft\Validator\RuleInterface;
+use Yiisoft\Validator\RuleInterface;
 use Yiisoft\Validator\ValidationContext;
 
 #[Attribute(Attribute::TARGET_PROPERTY | Attribute::IS_REPEATABLE)]
@@ -457,12 +455,12 @@ namespace App\Validator\Rule;
 
 use Attribute;
 use Yiisoft\Validator\Rule\Each;
-use Yiisoft\Validator\Rule\GroupRule;
+use Yiisoft\Validator\Rule\Composite;
 
 #[Attribute(Attribute::TARGET_PROPERTY | Attribute::IS_REPEATABLE)]
-final class RgbRule extends GroupRule
+final class RgbRule extends Composite
 {
-    public function getRuleSet(): array
+    public function getRules(): array
     {
         return [
             new Each([
@@ -754,19 +752,18 @@ final class Coordinate implements RuleInterface
 To reuse multiple validation rules it is advised to group rules like the following:
 
 ```php
-use Yiisoft\Validator\RuleSet;
 use Yiisoft\Validator\Rule\HasLength;
 use Yiisoft\Validator\Rule\Regex;
-use \Yiisoft\Validator\Rule\GroupRule;
+use \Yiisoft\Validator\Rule\Composite;
 
-final class UsernameRule extends GroupRule
+final class UsernameRule extends Composite
 {
-    public function getRuleSet(): RuleSet
+    public function getRules(): array
     {
-        return new RuleSet([
+        return [
             new HasLength(min: 2, max: 20),
             new Regex('~[a-z_\-]~i'),
-        ]);
+        ];
     }
 }
 ```

diff --git a/src/Attribute/Embedded.php b/src/Attribute/Embedded.php
@@ -8,30 +8,29 @@
 use Closure;
 use ReflectionAttribute;
 use ReflectionClass;
-use Yiisoft\Validator\Rule\GroupRule;
+use Yiisoft\Validator\Rule\Composite;
 use Yiisoft\Validator\RuleInterface;
 use Yiisoft\Validator\ValidationContext;
 
 /**
  * Collects all attributes from the reference and represents it as its own.
  */
 #[Attribute(Attribute::TARGET_PROPERTY | Attribute::IS_REPEATABLE)]
-final class Embedded extends GroupRule
+final class Embedded extends Composite
 {
     /**
      * @psalm-param Closure(mixed, ValidationContext):bool|null $when
      */
     public function __construct(
         private string $referenceClassName,
-        string $message = 'This value is not a valid.',
         bool $skipOnEmpty = false,
         bool $skipOnError = false,
         ?Closure $when = null,
     ) {
-        parent::__construct($message, $skipOnEmpty, $skipOnError, $when);
+        parent::__construct([], $skipOnEmpty, $skipOnError, $when);
     }
 
-    public function getRuleSet(): array
+    public function getRules(): array
     {
         $classMeta = new ReflectionClass($this->referenceClassName);
 

diff --git a/src/Rule/AtLeast.php b/src/Rule/AtLeast.php
@@ -9,7 +9,6 @@
 use JetBrains\PhpStorm\ArrayShape;
 use Yiisoft\Validator\SerializableRuleInterface;
 use Yiisoft\Validator\BeforeValidationInterface;
-use Yiisoft\Validator\Rule\Trait\HandlerClassNameTrait;
 use Yiisoft\Validator\Rule\Trait\BeforeValidationTrait;
 use Yiisoft\Validator\Rule\Trait\RuleNameTrait;
 use Yiisoft\Validator\ValidationContext;
@@ -21,7 +20,6 @@
 final class AtLeast implements SerializableRuleInterface, BeforeValidationInterface
 {
     use BeforeValidationTrait;
-    use HandlerClassNameTrait;
     use RuleNameTrait;
 
     public function __construct(
@@ -88,4 +86,9 @@ public function getOptions(): array
             'skipOnError' => $this->skipOnError,
         ];
     }
+
+    public function getHandlerClassName(): string
+    {
+        return AtLeastHandler::class;
+    }
 }
diff --git a/src/Rule/Boolean.php b/src/Rule/Boolean.php
@@ -9,7 +9,6 @@
 use JetBrains\PhpStorm\ArrayShape;
 use Yiisoft\Validator\SerializableRuleInterface;
 use Yiisoft\Validator\BeforeValidationInterface;
-use Yiisoft\Validator\Rule\Trait\HandlerClassNameTrait;
 use Yiisoft\Validator\Rule\Trait\BeforeValidationTrait;
 use Yiisoft\Validator\Rule\Trait\RuleNameTrait;
 use Yiisoft\Validator\ValidationContext;
@@ -21,7 +20,6 @@
 final class Boolean implements SerializableRuleInterface, BeforeValidationInterface
 {
     use BeforeValidationTrait;
-    use HandlerClassNameTrait;
     use RuleNameTrait;
 
     public function __construct(
@@ -106,4 +104,9 @@ public function getOptions(): array
             'skipOnError' => $this->skipOnError,
         ];
     }
+
+    public function getHandlerClassName(): string
+    {
+        return BooleanHandler::class;
+    }
 }
diff --git a/src/Rule/Callback.php b/src/Rule/Callback.php
@@ -8,15 +8,13 @@
 use JetBrains\PhpStorm\ArrayShape;
 use Yiisoft\Validator\SerializableRuleInterface;
 use Yiisoft\Validator\BeforeValidationInterface;
-use Yiisoft\Validator\Rule\Trait\HandlerClassNameTrait;
 use Yiisoft\Validator\Rule\Trait\BeforeValidationTrait;
 use Yiisoft\Validator\Rule\Trait\RuleNameTrait;
 use Yiisoft\Validator\ValidationContext;
 
 final class Callback implements SerializableRuleInterface, BeforeValidationInterface
 {
     use BeforeValidationTrait;
-    use HandlerClassNameTrait;
     use RuleNameTrait;
 
     public function __construct(
@@ -49,4 +47,9 @@ public function getOptions(): array
             'skipOnError' => $this->skipOnError,
         ];
     }
+
+    public function getHandlerClassName(): string
+    {
+        return CallbackHandler::class;
+    }
 }
diff --git a/src/Rule/Compare.php b/src/Rule/Compare.php
@@ -11,14 +11,12 @@
 use Yiisoft\Validator\BeforeValidationInterface;
 use Yiisoft\Validator\SerializableRuleInterface;
 use Yiisoft\Validator\Rule\Trait\BeforeValidationTrait;
-use Yiisoft\Validator\Rule\Trait\HandlerClassNameTrait;
 use Yiisoft\Validator\Rule\Trait\RuleNameTrait;
 use Yiisoft\Validator\ValidationContext;
 
 abstract class Compare implements SerializableRuleInterface, BeforeValidationInterface
 {
     use BeforeValidationTrait;
-    use HandlerClassNameTrait;
     use RuleNameTrait;
 
     /**
@@ -157,4 +155,9 @@ public function getOptions(): array
             'skipOnError' => $this->skipOnError,
         ];
     }
+
+    public function getHandlerClassName(): string
+    {
+        return CompareHandler::class;
+    }
 }
diff --git a/src/Rule/Composite.php b/src/Rule/Composite.php
@@ -9,7 +9,6 @@
 use Yiisoft\Validator\BeforeValidationInterface;
 use Yiisoft\Validator\SerializableRuleInterface;
 use Yiisoft\Validator\Rule\Trait\BeforeValidationTrait;
-use Yiisoft\Validator\Rule\Trait\HandlerClassNameTrait;
 use Yiisoft\Validator\Rule\Trait\RuleNameTrait;
 use Yiisoft\Validator\RuleInterface;
 use Yiisoft\Validator\ValidationContext;
@@ -18,10 +17,9 @@
  * Validates that the value is a valid json.
  */
 #[Attribute(Attribute::TARGET_PROPERTY | Attribute::IS_REPEATABLE)]
-final class Composite implements SerializableRuleInterface, BeforeValidationInterface
+class Composite implements SerializableRuleInterface, BeforeValidationInterface
 {
     use BeforeValidationTrait;
-    use HandlerClassNameTrait;
     use RuleNameTrait;
 
     public function __construct(
@@ -58,4 +56,9 @@ public function getRules(): iterable
     {
         return $this->rules;
     }
+
+    public function getHandlerClassName(): string
+    {
+        return CompositeHandler::class;
+    }
 }
diff --git a/src/Rule/Count.php b/src/Rule/Count.php
@@ -11,7 +11,6 @@
 use JetBrains\PhpStorm\ArrayShape;
 use Yiisoft\Validator\SerializableRuleInterface;
 use Yiisoft\Validator\BeforeValidationInterface;
-use Yiisoft\Validator\Rule\Trait\HandlerClassNameTrait;
 use Yiisoft\Validator\Rule\Trait\BeforeValidationTrait;
 use Yiisoft\Validator\Rule\Trait\RuleNameTrait;
 use Yiisoft\Validator\ValidationContext;
@@ -24,7 +23,6 @@
 final class Count implements SerializableRuleInterface, BeforeValidationInterface
 {
     use BeforeValidationTrait;
-    use HandlerClassNameTrait;
     use RuleNameTrait;
 
     public function __construct(
@@ -181,4 +179,9 @@ public function getOptions(): array
             'skipOnError' => $this->skipOnError,
         ];
     }
+
+    public function getHandlerClassName(): string
+    {
+        return CountHandler::class;
+    }
 }
diff --git a/src/Rule/Each.php b/src/Rule/Each.php
@@ -8,7 +8,6 @@
 use Closure;
 use Yiisoft\Validator\SerializableRuleInterface;
 use Yiisoft\Validator\BeforeValidationInterface;
-use Yiisoft\Validator\Rule\Trait\HandlerClassNameTrait;
 use Yiisoft\Validator\Rule\Trait\BeforeValidationTrait;
 use Yiisoft\Validator\Rule\Trait\RuleNameTrait;
 use Yiisoft\Validator\RuleInterface;
@@ -21,7 +20,6 @@
 final class Each implements SerializableRuleInterface, BeforeValidationInterface
 {
     use BeforeValidationTrait;
-    use HandlerClassNameTrait;
     use RuleNameTrait;
 
     public function __construct(
@@ -76,4 +74,9 @@ public function getOptions(): array
         }
         return $arrayOfRules;
     }
+
+    public function getHandlerClassName(): string
+    {
+        return EachHandler::class;
+    }
 }
diff --git a/src/Rule/Email.php b/src/Rule/Email.php
@@ -10,7 +10,6 @@
 use RuntimeException;
 use Yiisoft\Validator\SerializableRuleInterface;
 use Yiisoft\Validator\BeforeValidationInterface;
-use Yiisoft\Validator\Rule\Trait\HandlerClassNameTrait;
 use Yiisoft\Validator\Rule\Trait\BeforeValidationTrait;
 use Yiisoft\Validator\Rule\Trait\RuleNameTrait;
 
@@ -25,7 +24,6 @@
 final class Email implements SerializableRuleInterface, BeforeValidationInterface
 {
     use BeforeValidationTrait;
-    use HandlerClassNameTrait;
     use RuleNameTrait;
 
     public function __construct(
@@ -162,4 +160,9 @@ public function getOptions(): array
             'skipOnError' => $this->skipOnError,
         ];
     }
+
+    public function getHandlerClassName(): string
+    {
+        return EmailHandler::class;
+    }
 }
diff --git a/src/Rule/Equal.php b/src/Rule/Equal.php
@@ -66,9 +66,4 @@ public function __construct(
             when: $this->when
         );
     }
-
-    public function getHandlerClassName(): string
-    {
-        return CompareHandler::class;
-    }
 }
diff --git a/src/Rule/GreaterThan.php b/src/Rule/GreaterThan.php
@@ -62,9 +62,4 @@ public function __construct(
             when: $this->when
         );
     }
-
-    public function getHandlerClassName(): string
-    {
-        return CompareHandler::class;
-    }
 }
diff --git a/src/Rule/GreaterThanOrEqual.php b/src/Rule/GreaterThanOrEqual.php
@@ -62,9 +62,4 @@ public function __construct(
             when: $this->when
         );
     }
-
-    public function getHandlerClassName(): string
-    {
-        return CompareHandler::class;
-    }
 }