Mechanism for validating single values, arrays and objects. Path awar…

…e validation errors.
norvica · Mar 29, 2024 · 5ace994 · 5ace994
1 parent 5e2700b
commit 5ace994
Show file tree

Hide file tree

Showing 45 changed files with 588 additions and 166 deletions.
diff --git a/src/Exception/LogicException.php b/src/Exception/LogicException.php
@@ -0,0 +1,23 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Norvica\Validation\Exception;
+
+use Throwable;
+
+final class LogicException extends \LogicException
+{
+    public function __construct(
+        string $message = '',
+        int $code = 0,
+        Throwable|null $previous = null,
+        array $path = [],
+    ) {
+        parent::__construct(
+            sprintf('%s: %s', implode('.', $path), $message),
+            $code,
+            $previous,
+        );
+    }
+}
diff --git a/src/Exception/PropertyRuleViolation.php b/src/Exception/PropertyRuleViolation.php
@@ -0,0 +1,24 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Norvica\Validation\Exception;
+
+use DomainException;
+use Throwable;
+
+final class PropertyRuleViolation extends DomainException
+{
+    public readonly array $path;
+
+    public function __construct(
+        string $message = '',
+        int $code = 0,
+        Throwable|null $previous = null,
+        array $path = [],
+    )
+    {
+        parent::__construct($message, $code, $previous);
+        $this->path = $path;
+    }
+}
diff --git a/src/Exception/ConstraintViolation.php → src/Exception/ValueRuleViolation.php b/src/Exception/ConstraintViolation.php → src/Exception/ValueRuleViolation.php
@@ -6,6 +6,6 @@
 
 use DomainException;
 
-final class ConstraintViolation extends DomainException
+final class ValueRuleViolation extends DomainException
 {
 }
diff --git a/src/Normalizing/Binary.php → src/Normalizer/Binary.php b/src/Normalizing/Binary.php → src/Normalizer/Binary.php
@@ -2,7 +2,7 @@
 
 declare(strict_types=1);
 
-namespace Norvica\Validation\Normalizing;
+namespace Norvica\Validation\Normalizer;
 
 final class Binary
 {

diff --git a/src/Normalizing/Lower.php → src/Normalizer/Lower.php b/src/Normalizing/Lower.php → src/Normalizer/Lower.php
@@ -2,7 +2,7 @@
 
 declare(strict_types=1);
 
-namespace Norvica\Validation\Normalizing;
+namespace Norvica\Validation\Normalizer;
 
 final class Lower
 {

diff --git a/src/Normalizing/Normalizable.php → src/Normalizer/Normalizable.php b/src/Normalizing/Normalizable.php → src/Normalizer/Normalizable.php
@@ -2,7 +2,7 @@
 
 declare(strict_types=1);
 
-namespace Norvica\Validation\Normalizing;
+namespace Norvica\Validation\Normalizer;
 
 interface Normalizable
 {

diff --git a/src/Normalizing/Numeric.php → src/Normalizer/Numeric.php b/src/Normalizing/Numeric.php → src/Normalizer/Numeric.php
@@ -2,7 +2,7 @@
 
 declare(strict_types=1);
 
-namespace Norvica\Validation\Normalizing;
+namespace Norvica\Validation\Normalizer;
 
 final class Numeric
 {

diff --git a/src/Normalizing/Spaceless.php → src/Normalizer/Spaceless.php b/src/Normalizing/Spaceless.php → src/Normalizer/Spaceless.php
@@ -2,7 +2,7 @@
 
 declare(strict_types=1);
 
-namespace Norvica\Validation\Normalizing;
+namespace Norvica\Validation\Normalizer;
 
 final class Spaceless
 {

diff --git a/src/Normalizing/Trim.php → src/Normalizer/Trim.php b/src/Normalizing/Trim.php → src/Normalizer/Trim.php
@@ -2,7 +2,7 @@
 
 declare(strict_types=1);
 
-namespace Norvica\Validation\Normalizing;
+namespace Norvica\Validation\Normalizer;
 
 final readonly class Trim
 {

diff --git a/src/Normalizing/Upper.php → src/Normalizer/Upper.php b/src/Normalizing/Upper.php → src/Normalizer/Upper.php
@@ -2,7 +2,7 @@
 
 declare(strict_types=1);
 
-namespace Norvica\Validation\Normalizing;
+namespace Norvica\Validation\Normalizer;
 
 final class Upper
 {

diff --git a/src/Constraint/Email.php → src/Rule/Email.php b/src/Constraint/Email.php → src/Rule/Email.php
@@ -2,15 +2,17 @@
 
 declare(strict_types=1);
 
-namespace Norvica\Validation\Constraint;
+namespace Norvica\Validation\Rule;
 
-use Norvica\Validation\Normalizing\Lower;
-use Norvica\Validation\Normalizing\Normalizable;
-use Norvica\Validation\Normalizing\Trim;
+use Attribute;
+use Norvica\Validation\Normalizer\Lower;
+use Norvica\Validation\Normalizer\Normalizable;
+use Norvica\Validation\Normalizer\Trim;
 use Norvica\Validation\Validation\EmailValidation;
 use Override;
 
-readonly class Email implements Validatable, Normalizable
+#[Attribute(Attribute::TARGET_PROPERTY)]
+readonly class Email implements Rule, Normalizable
 {
     /**
      * @param bool $dns Perform DNS checks (default `false`).

diff --git a/src/Constraint/Flag.php → src/Rule/Flag.php b/src/Constraint/Flag.php → src/Rule/Flag.php
@@ -2,14 +2,16 @@
 
 declare(strict_types=1);
 
-namespace Norvica\Validation\Constraint;
+namespace Norvica\Validation\Rule;
 
-use Norvica\Validation\Normalizing\Binary;
-use Norvica\Validation\Normalizing\Normalizable;
+use Attribute;
+use Norvica\Validation\Normalizer\Binary;
+use Norvica\Validation\Normalizer\Normalizable;
 use Norvica\Validation\Validation\FlagValidation;
 use Override;
 
-readonly class Flag implements Validatable, Normalizable
+#[Attribute(Attribute::TARGET_PROPERTY)]
+readonly class Flag implements Rule, Normalizable
 {
     public function __construct(
         public bool $value,

diff --git a/src/Constraint/Iban.php → src/Rule/Iban.php b/src/Constraint/Iban.php → src/Rule/Iban.php
@@ -2,15 +2,17 @@
 
 declare(strict_types=1);
 
-namespace Norvica\Validation\Constraint;
+namespace Norvica\Validation\Rule;
 
-use Norvica\Validation\Normalizing\Normalizable;
-use Norvica\Validation\Normalizing\Spaceless;
-use Norvica\Validation\Normalizing\Upper;
+use Attribute;
+use Norvica\Validation\Normalizer\Normalizable;
+use Norvica\Validation\Normalizer\Spaceless;
+use Norvica\Validation\Normalizer\Upper;
 use Norvica\Validation\Validation\IbanValidation;
 use Override;
 
-readonly class Iban implements Validatable, Normalizable
+#[Attribute(Attribute::TARGET_PROPERTY)]
+readonly class Iban implements Rule, Normalizable
 {
     #[Override]
     public static function normalizers(): array

diff --git a/src/Constraint/Ip.php → src/Rule/Ip.php b/src/Constraint/Ip.php → src/Rule/Ip.php
@@ -2,14 +2,16 @@
 
 declare(strict_types=1);
 
-namespace Norvica\Validation\Constraint;
+namespace Norvica\Validation\Rule;
 
-use Norvica\Validation\Normalizing\Normalizable;
-use Norvica\Validation\Normalizing\Trim;
+use Attribute;
+use Norvica\Validation\Normalizer\Normalizable;
+use Norvica\Validation\Normalizer\Trim;
 use Norvica\Validation\Validation\IpValidation;
 use Override;
 
-readonly class Ip implements Validatable, Normalizable
+#[Attribute(Attribute::TARGET_PROPERTY)]
+readonly class Ip implements Rule, Normalizable
 {
     public function __construct(
         public int|null $version = null,

diff --git a/src/Constraint/Number.php → src/Rule/Number.php b/src/Constraint/Number.php → src/Rule/Number.php
@@ -2,14 +2,16 @@
 
 declare(strict_types=1);
 
-namespace Norvica\Validation\Constraint;
+namespace Norvica\Validation\Rule;
 
-use Norvica\Validation\Normalizing\Normalizable;
-use Norvica\Validation\Normalizing\Numeric;
+use Attribute;
+use Norvica\Validation\Normalizer\Normalizable;
+use Norvica\Validation\Normalizer\Numeric;
 use Norvica\Validation\Validation\NumberValidation;
 use Override;
 
-readonly class Number implements Validatable, Normalizable
+#[Attribute(Attribute::TARGET_PROPERTY)]
+readonly class Number implements Rule, Normalizable
 {
     public function __construct(
         public int|float|null $min = null,

diff --git a/src/Constraint/Option.php → src/Rule/Option.php b/src/Constraint/Option.php → src/Rule/Option.php
@@ -2,14 +2,16 @@
 
 declare(strict_types=1);
 
-namespace Norvica\Validation\Constraint;
+namespace Norvica\Validation\Rule;
 
-use Norvica\Validation\Normalizing\Normalizable;
-use Norvica\Validation\Normalizing\Trim;
+use Attribute;
+use Norvica\Validation\Normalizer\Normalizable;
+use Norvica\Validation\Normalizer\Trim;
 use Norvica\Validation\Validation\OptionValidation;
 use Override;
 
-readonly class Option implements Validatable, Normalizable
+#[Attribute(Attribute::TARGET_PROPERTY)]
+readonly class Option implements Rule, Normalizable
 {
     /**
      * @param string[] $options

diff --git a/src/Constraint/Password.php → src/Rule/Password.php b/src/Constraint/Password.php → src/Rule/Password.php
@@ -2,13 +2,15 @@
 
 declare(strict_types=1);
 
-namespace Norvica\Validation\Constraint;
+namespace Norvica\Validation\Rule;
 
-use Norvica\Validation\Normalizing\Normalizable;
+use Attribute;
+use Norvica\Validation\Normalizer\Normalizable;
 use Norvica\Validation\Validation\PasswordValidation;
 use Override;
 
-readonly class Password implements Validatable, Normalizable
+#[Attribute(Attribute::TARGET_PROPERTY)]
+readonly class Password implements Rule, Normalizable
 {
     /**
      * @param int $min Minimal password length (default `8`).

diff --git a/src/Constraint/Validatable.php → src/Rule/Rule.php b/src/Constraint/Validatable.php → src/Rule/Rule.php
@@ -2,9 +2,9 @@
 
 declare(strict_types=1);
 
-namespace Norvica\Validation\Constraint;
+namespace Norvica\Validation\Rule;
 
-interface Validatable
+interface Rule
 {
     /**
      * @return callable-string

diff --git a/src/Constraint/Slug.php → src/Rule/Slug.php b/src/Constraint/Slug.php → src/Rule/Slug.php
@@ -2,8 +2,11 @@
 
 declare(strict_types=1);
 
-namespace Norvica\Validation\Constraint;
+namespace Norvica\Validation\Rule;
 
+use Attribute;
+
+#[Attribute(Attribute::TARGET_PROPERTY)]
 readonly class Slug extends Text
 {
     public function __construct(

diff --git a/src/Constraint/Text.php → src/Rule/Text.php b/src/Constraint/Text.php → src/Rule/Text.php
@@ -2,14 +2,16 @@
 
 declare(strict_types=1);
 
-namespace Norvica\Validation\Constraint;
+namespace Norvica\Validation\Rule;
 
-use Norvica\Validation\Normalizing\Normalizable;
-use Norvica\Validation\Normalizing\Trim;
+use Attribute;
+use Norvica\Validation\Normalizer\Normalizable;
+use Norvica\Validation\Normalizer\Trim;
 use Norvica\Validation\Validation\TextValidation;
 use Override;
 
-readonly class Text implements Validatable, Normalizable
+#[Attribute(Attribute::TARGET_PROPERTY)]
+readonly class Text implements Rule, Normalizable
 {
     public function __construct(
         public int|null $minLength = null,

diff --git a/src/Constraint/Uuid.php → src/Rule/Uuid.php b/src/Constraint/Uuid.php → src/Rule/Uuid.php
@@ -2,15 +2,17 @@
 
 declare(strict_types=1);
 
-namespace Norvica\Validation\Constraint;
+namespace Norvica\Validation\Rule;
 
-use Norvica\Validation\Normalizing\Lower;
-use Norvica\Validation\Normalizing\Normalizable;
-use Norvica\Validation\Normalizing\Trim;
+use Attribute;
+use Norvica\Validation\Normalizer\Lower;
+use Norvica\Validation\Normalizer\Normalizable;
+use Norvica\Validation\Normalizer\Trim;
 use Norvica\Validation\Validation\UuidValidation;
 use Override;
 
-readonly class Uuid implements Validatable, Normalizable
+#[Attribute(Attribute::TARGET_PROPERTY)]
+readonly class Uuid implements Rule, Normalizable
 {
     public function __construct(
         public int|null $version = null,

diff --git a/src/Validation/EmailValidation.php b/src/Validation/EmailValidation.php
@@ -4,8 +4,8 @@
 
 namespace Norvica\Validation\Validation;
 
-use Norvica\Validation\Constraint\Email;
-use Norvica\Validation\Exception\ConstraintViolation;
+use Norvica\Validation\Rule\Email;
+use Norvica\Validation\Exception\ValueRuleViolation;
 
 final class EmailValidation
 {
@@ -14,18 +14,18 @@ public function __invoke(string $value, Email $constraint): void
         $message = 'Value must be a valid E-mail address';
 
         if (!filter_var($value, FILTER_VALIDATE_EMAIL)) {
-            throw new ConstraintViolation($message);
+            throw new ValueRuleViolation($message);
         }
 
         [$local, $domain] = explode('@', $value, 2);
 
         if (!preg_match('/^[a-zA-Z0-9.!$%&\'*+\/=?^_`{|}~-]{1,64}$/', $local)) {
-            throw new ConstraintViolation($message);
+            throw new ValueRuleViolation($message);
         }
 
         // DNS check (A/MX records)
         if ($constraint->dns && !checkdnsrr($domain) && !checkdnsrr($domain, 'A')) {
-            throw new ConstraintViolation($message);
+            throw new ValueRuleViolation($message);
         }
     }
 }
diff --git a/src/Validation/FlagValidation.php b/src/Validation/FlagValidation.php
@@ -4,8 +4,8 @@
 
 namespace Norvica\Validation\Validation;
 
-use Norvica\Validation\Constraint\Flag;
-use Norvica\Validation\Exception\ConstraintViolation;
+use Norvica\Validation\Rule\Flag;
+use Norvica\Validation\Exception\ValueRuleViolation;
 
 final class FlagValidation
 {
@@ -14,7 +14,7 @@ public function __invoke(bool $value, Flag $constraint): void
         if ($value !== $constraint->value) {
             $parameter = $constraint->value ? 'true' : 'false';
 
-            throw new ConstraintViolation("Value must be {$parameter}");
+            throw new ValueRuleViolation("Value must be {$parameter}");
         }
     }
 }