Refactor Validator, create ValidatorRule class

src/Validator.php

@@ -13,73 +13,66 @@
  * Use https://github.com/vlucas/valitron under the hood.
  *
  * $v = new \Atk4\Validate\Validator($model);
+ *
+ * https://github.com/vlucas/valitron/blob/v1.4.11/src/Valitron/Validator.php#L1251
+ *
+ * @phpstan-type ValidatorCallback \Closure(string, mixed, list<mixed>, list<mixed>): bool
+ *
+ * https://github.com/vlucas/valitron/blob/master/src/Valitron/Validator.php#L1240
+ * @phpstan-type ValitronRuleType 'required'|'equals'|'different'|'accepted'|'array'|'numeric'|'integer'|'length'|'lengthBetween'|'lengthMin'|'lengthMax'|'min'|'max'|'between'|'in'|'listContains'|'notIn'|'contains'|'subset'|'containsUnique'|'ip'|'ipv4'|'ipv6'|'email'|'ascii'|'emailDNS'|'url'|'urlActive'|'alpha'|'alphaNum'|'slug'|'regex'|'date'|'dateFormat'|'dateBefore'|'dateAfter'|'boolean'|'creditCard'|'instanceOf'|'requiredWith'|'requiredWithout'|'optional'|'arrayHasKeys'
+ * @phpstan-type ValitronRule array<int|'message', ValitronRuleType|int|string|string[]|ValidatorCallback>
  */
 class Validator
 {
     use WarnDynamicPropertyTrait;
+
     /**
-     * Array of rules in following format which is natively supported by Valitron mapFieldsRules():
-     *  [
-     *      'foo' => [
-     *          ['required'],
-     *          ['integer', 'message'=>'test 1'],
-     *      ],
-     *      'bar' => [
-     *          ['email'],
-     *          ['lengthBetween', 4, 10, 'message'=>'test 2'],
-     *      ],
-     *  ];.
-     *
-     * @var array<string, array<string|array<string|int|\Closure(string, mixed, list<mixed>, list<mixed>): bool>>>
+     * @var list<ValidatorRule>
      */
     public array $rules = [];
 
+    public function __construct(Model $model)
+    {
+        $model->onHook(Model::HOOK_VALIDATE, \Closure::fromCallable([$this, 'validate']));
+    }
+
     /**
-     * Array of conditional rules in following format:
-     *  [
-     *      [
-     *          $conditions, // array of conditions
-     *          $then_rules, // array in $this->rules format which will be used if conditions are met
-     *          $else_rules  // array in $this->rules format which will be used if conditions are not met
-     *      ],
-     *  ].
+     * Set rules of particular field.
      *
-     * @var list<
-     *          array{
-     *              array<string, string>,
-     *              array<string, array<string|array<string|int|\Closure(string, mixed, list<mixed>, list<mixed>): bool>>>,
-     *              array<string, array<string|array<string|int|\Closure(string, mixed, list<mixed>, list<mixed>): bool>>>
-     *          }
-     *  >
+     * @param array<string|ValitronRule>                      $rules
+     * @param array<string, mixed>|list<array<string, mixed>> $conditions
+     *
+     * @return $this
      */
-    public array $if_rules = [];
-
-    public function __construct(Model $model)
+    public function rule(string $field, array $rules, ?string $activateOn = null, array $conditions = []): self
     {
-        $model->onHook(Model::HOOK_VALIDATE, \Closure::fromCallable([$this, 'validate']));
+        foreach ($rules as $rule) {
+            $validatorRule = new ValidatorRule($field, $rule);
+            if ($activateOn !== null) {
+                $validatorRule->setActivateOnResult($activateOn, $conditions);
+            }
+            $this->addValidatorRule($validatorRule);
+        }
+
+        return $this;
     }
 
     /**
      * Set one rule.
      *
-     * @param array<string|array<string|int|\Closure(string, mixed, list<mixed>, list<mixed>): bool>> $rules
-     *
      * @return $this
      */
-    public function rule(string $field, array $rules): self
+    public function addValidatorRule(ValidatorRule $validatorRule): self
     {
-        $this->rules[$field] = array_merge(
-            $this->rules[$field] ?? [],
-            $rules
-        );
+        $this->rules[] = $validatorRule;
 
         return $this;
     }
 
     /**
      * Set multiple rules.
      *
-     * @param array<string, array<string|array<string|int|\Closure(string, mixed, list<mixed>, list<mixed>): bool>>> $hash array with field name as key and rules as value
+     * @param array<string, list<string|ValitronRule>> $hash array with field name as key and rules as value
      *
      * @return $this
      */
@@ -95,19 +88,21 @@ public function rules(array $hash): self
     /**
      * Set conditional rules.
      *
-     * @param array<string, int|string>                                                                              $conditions
-     * @param array<string, array<string|array<string|int|\Closure(string, mixed, list<mixed>, list<mixed>): bool>>> $then_hash
-     * @param array<string, array<string|array<string|int|\Closure(string, mixed, list<mixed>, list<mixed>): bool>>> $else_hash
+     * @param array<string, mixed>|list<array<string, mixed>> $conditions
+     * @param array<string, string|list<string|ValitronRule>> $then_hash
+     * @param array<string, string|list<string|ValitronRule>> $else_hash
      *
      * @return $this
      */
     public function if(array $conditions, array $then_hash, array $else_hash = []): self
     {
-        $this->if_rules[] = [
-            $conditions,
-            $then_hash,
-            $else_hash,
-        ];
+        foreach ($then_hash as $field => $rules) {
+            $this->rule($field, $rules, ValidatorRule::ON_SUCCESS, $conditions);
+        }
+
+        foreach ($else_hash as $field => $rules) {
+            $this->rule($field, $rules, ValidatorRule::ON_FAIL, $conditions);
+        }
 
         return $this;
     }
@@ -117,28 +112,20 @@ public function if(array $conditions, array $then_hash, array $else_hash = []):
      *
      * @return array<string, string> array of errors in format: [field_name => error_message]
      */
-    public function validate(Model $model, ?string $intent = null): array
+    public function validate(Model $model): array
     {
         // initialize Validator, set data
         $v = new \Valitron\Validator($model->get());
 
-        // prepare array of all rules we have to validate
-        // this should also include respective rules from $this->if_rules.
-        $all_rules = $this->rules;
-
-        foreach ($this->if_rules as $row) {
-            [$conditions, $then_hash, $else_hash] = $row;
-
-            $test = true;
-            foreach ($conditions as $field => $value) {
-                $test = $test && ($model->get($field) === $value);
+        $rules = [];
+        foreach ($this->rules as $rule) {
+            if ($rule->isActivated($model) === true) {
+                $rules[$rule->field][] = $rule->getValitronRule();
             }
-
-            $all_rules = array_merge_recursive($all_rules, $test ? $then_hash : $else_hash);
         }
 
         // set up Valitron rules
-        $v->mapFieldsRules($all_rules);
+        $v->mapFieldsRules($rules);
 
         // validate and if errors then format them to fit Atk4 error format
         if ($v->validate() === true) {

src/ValidatorRule.php

@@ -0,0 +1,141 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Atk4\Validate;
+
+use Atk4\Data\Exception;
+use Atk4\Data\Model;
+
+/**
+ * https://github.com/vlucas/valitron/blob/v1.4.11/src/Valitron/Validator.php#L1251.
+ *
+ * @phpstan-type ValidatorCallback \Closure(string, mixed, list<mixed>, list<mixed>): bool
+ *
+ * https://github.com/vlucas/valitron/blob/master/src/Valitron/Validator.php#L1240
+ * @phpstan-type ValitronRuleType 'required'|'equals'|'different'|'accepted'|'array'|'numeric'|'integer'|'length'|'lengthBetween'|'lengthMin'|'lengthMax'|'min'|'max'|'between'|'in'|'listContains'|'notIn'|'contains'|'subset'|'containsUnique'|'ip'|'ipv4'|'ipv6'|'email'|'ascii'|'emailDNS'|'url'|'urlActive'|'alpha'|'alphaNum'|'slug'|'regex'|'date'|'dateFormat'|'dateBefore'|'dateAfter'|'boolean'|'creditCard'|'instanceOf'|'requiredWith'|'requiredWithout'|'optional'|'arrayHasKeys'
+ * @phpstan-type ValitronRule array<int|'message', ValitronRuleType|int|string|string[]|ValidatorCallback>
+ */
+class ValidatorRule
+{
+    public const ON_SUCCESS = 'success';
+    public const ON_FAIL = 'fail';
+    public string $field;
+
+    /**
+     * @var array<string, mixed>
+     */
+    public array $activateConditions = [];
+    public ?string $activateOn = null;
+
+    /**
+     * @var list<ValitronRule>
+     */
+    private array $rule = [];
+    private ?string $message = null;
+
+    /**
+     * @param ValitronRuleType|ValitronRule|ValidatorCallback $rule
+     */
+    public function __construct(string $field, $rule)
+    {
+        if (!is_array($rule)) {
+            $rule = [$rule];
+        }
+
+        $this->field = $field;
+
+        $message = $rule['message'] ?? null;
+        if (isset($rule['message'])) {
+            unset($rule['message']);
+        }
+
+        $this->setRule($rule);
+        $this->setMessage($message);
+    }
+
+    /**
+     * @param array<string, mixed> $activationConditions [field_name => value]
+     */
+    public function setActivateOnSuccess(array $activationConditions): void
+    {
+        $this->setActivateOnResult(self::ON_SUCCESS, $activationConditions);
+    }
+
+    /**
+     * @param array<string, mixed> $activationConditions [field_name => value]
+     */
+    public function setActivateOnFail(array $activationConditions): void
+    {
+        $this->setActivateOnResult(self::ON_FAIL, $activationConditions);
+    }
+
+    /**
+     * @param array<string, mixed> $activationConditions [field_name => value]
+     */
+    public function setActivateOnResult(string $activateOn, array $activationConditions): void
+    {
+        if ($this->activateOn !== null) {
+            throw new Exception('Activation condition already set');
+        }
+
+        $this->activateOn = $activateOn;
+        $this->activateConditions = $activationConditions;
+    }
+
+    public function isActivated(Model $model): bool
+    {
+        $this->activateOn ??= self::ON_SUCCESS;
+
+        foreach ($this->activateConditions as $conditionField => $conditionValue) {
+            if ($this->activateOn === self::ON_SUCCESS && $model->get($conditionField) !== $conditionValue) {
+                return false;
+            }
+
+            if ($this->activateOn === self::ON_FAIL && $model->get($conditionField) === $conditionValue) {
+                return false;
+            }
+        }
+
+        return true;
+    }
+
+    /**
+     * @param list<ValitronRule> $rule
+     */
+    private function setRule(array $rule): void
+    {
+        $this->rule = $rule;
+    }
+
+    private function setMessage(?string $message = null): void
+    {
+        $this->message = $message;
+    }
+
+    /**
+     * @return list<ValitronRule>
+     */
+    public function getRule(): array
+    {
+        return $this->rule;
+    }
+
+    public function getMessage(): ?string
+    {
+        return $this->message;
+    }
+
+    /**
+     * @return list<ValitronRule>
+     */
+    public function getValitronRule(): array
+    {
+        $rule = $this->getRule();
+        if ($this->getMessage() !== null) {
+            $rule['message'] = $this->getMessage();
+        }
+
+        return $rule;
+    }
+}