feat: added blank rule

Author: andrepimpao

src/ChainedValidatorInterface.php

@@ -7,6 +7,11 @@
 
 interface ChainedValidatorInterface
 {
+    public function blank(
+        ?callable $normalizer = null,
+        ?string $message = null
+    ): ChainedValidatorInterface&Validator;
+
     public function choice(
         array $constraints,
         bool $multiple = false,

src/Exception/BlankException.php

@@ -0,0 +1,5 @@
+<?php
+
+namespace ProgrammatorDev\Validator\Exception;
+
+class BlankException extends ValidationException {}

src/Rule/Blank.php

@@ -0,0 +1,38 @@
+<?php
+
+namespace ProgrammatorDev\Validator\Rule;
+
+use ProgrammatorDev\Validator\Exception\BlankException;
+
+class Blank extends AbstractRule implements RuleInterface
+{
+    /** @var ?callable */
+    private $normalizer;
+    private string $message = 'The {{ name }} value should be blank, {{ value }} given.';
+
+    public function __construct(
+        ?callable $normalizer = null,
+        ?string $message = null
+    )
+    {
+        $this->normalizer = $normalizer;
+        $this->message = $message ?? $this->message;
+    }
+
+    public function assert(mixed $value, ?string $name = null): void
+    {
+        if ($this->normalizer !== null) {
+            $value = ($this->normalizer)($value);
+        }
+
+        if ($value !== null && $value !== false && $value !== '' && $value !== []) {
+            throw new BlankException(
+                message: $this->message,
+                parameters: [
+                    'value' => $value,
+                    'name' => $name
+                ]
+            );
+        }
+    }
+}

src/Rule/NotBlank.php

@@ -3,6 +3,7 @@
 namespace ProgrammatorDev\Validator\Rule;
 
 use ProgrammatorDev\Validator\Exception\NotBlankException;
+use ProgrammatorDev\Validator\Validator;
 
 class NotBlank extends AbstractRule implements RuleInterface
 {
@@ -19,17 +20,9 @@ public function __construct(
         $this->message = $message ?? $this->message;
     }
 
-    /**
-     * @throws NotBlankException
-     */
     public function assert(mixed $value, ?string $name = null): void
     {
-        if ($this->normalizer !== null) {
-            $value = ($this->normalizer)($value);
-        }
-
-        // Do not allow null, false, [] and ''
-        if ($value === false || (empty($value) && $value != '0')) {
+        if (Validator::blank(normalizer: $this->normalizer)->validate($value) === true) {
             throw new NotBlankException(
                 message: $this->message,
                 parameters: [

src/StaticValidatorInterface.php

@@ -6,6 +6,11 @@
 
 interface StaticValidatorInterface
 {
+    public static function blank(
+        ?callable $normalizer = null,
+        ?string $message = null
+    ): ChainedValidatorInterface&Validator;
+
     public static function choice(
         array $constraints,
         bool $multiple = false,

tests/BlankTest.php

@@ -0,0 +1,56 @@
+<?php
+
+namespace ProgrammatorDev\Validator\Test;
+
+use ProgrammatorDev\Validator\Exception\BlankException;
+use ProgrammatorDev\Validator\Rule\Blank;
+use ProgrammatorDev\Validator\Test\Util\TestRuleMessageOptionTrait;
+use ProgrammatorDev\Validator\Test\Util\TestRuleFailureConditionTrait;
+use ProgrammatorDev\Validator\Test\Util\TestRuleSuccessConditionTrait;
+
+class BlankTest extends AbstractTest
+{
+    use TestRuleFailureConditionTrait;
+    use TestRuleSuccessConditionTrait;
+    use TestRuleMessageOptionTrait;
+
+    public static function provideRuleFailureConditionData(): \Generator
+    {
+        $exception = BlankException::class;
+        $message = '/The (.*) value should be blank, (.*) given\./';
+
+        yield 'true' => [new Blank(), true, $exception, $message];
+
+        yield 'string' => [new Blank(), 'string', $exception, $message];
+        yield 'whitespace string' => [new Blank(), ' ', $exception, $message];
+        yield 'zero string' => [new Blank(), '0', $exception, $message];
+
+        yield 'array' => [new Blank(), ['string'], $exception, $message];
+        yield 'blank string array' => [new Blank(), [''], $exception, $message];
+        yield 'whitespace array' => [new Blank(), [' '], $exception, $message];
+        yield 'zero array' => [new Blank(), [0], $exception, $message];
+
+        yield 'number' => [new Blank(), 10, $exception, $message];
+        yield 'zero number' => [new Blank(), 0, $exception, $message];
+    }
+
+    public static function provideRuleSuccessConditionData(): \Generator
+    {
+        yield 'null' => [new Blank(), null];
+        yield 'false' => [new Blank(), false];
+        yield 'blank string' => [new Blank(), ''];
+        yield 'blank array' => [new Blank(), []];
+
+        yield 'normalizer whitespace' => [new Blank(normalizer: 'trim'), ' '];
+        yield 'normalizer whitespace function' => [new Blank(normalizer: fn($value) => trim($value)), ' '];
+    }
+
+    public static function provideRuleMessageOptionData(): \Generator
+    {
+        yield 'message' => [
+            new Blank(message: '{{ name }} | {{ value }}'),
+            'string',
+            'test | "string"'
+        ];
+    }
+}