Merge pull request #5 from programmatordev/YAPV-15-add-notblank-normalizer

Add NotBlank normalizer

Author: andrepimpao

src/Rule/NotBlank.php

@@ -13,9 +13,13 @@ public function __construct(array $options = [])
     {
         $resolver = new OptionsResolver();
 
-        $resolver->setDefaults(['message' => 'The "{{ name }}" value should not be blank, "{{ value }}" given.']);
+        $resolver->setDefaults([
+            'message' => 'The "{{ name }}" value should not be blank, "{{ value }}" given.',
+            'normalizer' => null
+        ]);
 
         $resolver->setAllowedTypes('message', 'string');
+        $resolver->setAllowedTypes('normalizer', ['null', 'string', 'callable']);
 
         $this->options = $resolver->resolve($options);
     }
@@ -25,8 +29,16 @@ public function __construct(array $options = [])
      */
     public function assert(mixed $value, string $name): void
     {
+        // Keep original value for parameter
+        $input = $value;
+
+        // Call normalizer if provided
+        if ($this->options['normalizer'] !== null) {
+            $input = ($this->options['normalizer'])($input);
+        }
+
         // Do not allow null, false, [] and ''
-        if ($value === false || (empty($value) && $value != '0')) {
+        if ($input === false || (empty($input) && $input != '0')) {
             throw new NotBlankException(
                 message: $this->options['message'],
                 parameters: [

…Test/Util/TestRuleCustomMessageTrait.php …Test/Util/TestRuleMessageOptionTrait.phpsrc/Test/Util/TestRuleCustomMessageTrait.php renamed to src/Test/Util/TestRuleMessageOptionTrait.php src/Test/Util/TestRuleCustomMessageTrait.php renamed to src/Test/Util/TestRuleMessageOptionTrait.php

@@ -5,12 +5,12 @@
 use PHPUnit\Framework\Attributes\DataProvider;
 use ProgrammatorDev\YetAnotherPhpValidator\Rule\RuleInterface;
 
-trait TestRuleCustomMessageTrait
+trait TestRuleMessageOptionTrait
 {
-    public static abstract function provideRuleCustomMessageData(): \Generator;
+    public static abstract function provideRuleMessageOptionData(): \Generator;
 
-    #[DataProvider('provideRuleCustomMessageData')]
-    public function testRuleCustomMessage(RuleInterface $rule, mixed $value, string $exceptionMessage): void
+    #[DataProvider('provideRuleMessageOptionData')]
+    public function testRuleMessageOption(RuleInterface $rule, mixed $value, string $exceptionMessage): void
     {
         $this->expectExceptionMessage($exceptionMessage);
         $rule->assert($value, 'test');

tests/GreaterThanTest.php

@@ -4,15 +4,15 @@
 
 use ProgrammatorDev\YetAnotherPhpValidator\Exception\GreaterThanException;
 use ProgrammatorDev\YetAnotherPhpValidator\Rule\GreaterThan;
-use ProgrammatorDev\YetAnotherPhpValidator\Test\Util\TestRuleCustomMessageTrait;
+use ProgrammatorDev\YetAnotherPhpValidator\Test\Util\TestRuleMessageOptionTrait;
 use ProgrammatorDev\YetAnotherPhpValidator\Test\Util\TestRuleFailureConditionTrait;
 use ProgrammatorDev\YetAnotherPhpValidator\Test\Util\TestRuleSuccessConditionTrait;
 
 class GreaterThanTest extends AbstractTest
 {
     use TestRuleFailureConditionTrait;
     use TestRuleSuccessConditionTrait;
-    use TestRuleCustomMessageTrait;
+    use TestRuleMessageOptionTrait;
 
     public static function provideRuleFailureConditionData(): \Generator
     {
@@ -49,7 +49,7 @@ public static function provideRuleSuccessConditionData(): \Generator
         yield 'string' => [new GreaterThan('a'), 'z'];
     }
 
-    public static function provideRuleCustomMessageData(): \Generator
+    public static function provideRuleMessageOptionData(): \Generator
     {
         yield 'message' => [
             new GreaterThan(10, [

tests/LessThanTest.php

@@ -4,15 +4,15 @@
 
 use ProgrammatorDev\YetAnotherPhpValidator\Exception\LessThanException;
 use ProgrammatorDev\YetAnotherPhpValidator\Rule\LessThan;
-use ProgrammatorDev\YetAnotherPhpValidator\Test\Util\TestRuleCustomMessageTrait;
+use ProgrammatorDev\YetAnotherPhpValidator\Test\Util\TestRuleMessageOptionTrait;
 use ProgrammatorDev\YetAnotherPhpValidator\Test\Util\TestRuleFailureConditionTrait;
 use ProgrammatorDev\YetAnotherPhpValidator\Test\Util\TestRuleSuccessConditionTrait;
 
 class LessThanTest extends AbstractTest
 {
     use TestRuleFailureConditionTrait;
     use TestRuleSuccessConditionTrait;
-    use TestRuleCustomMessageTrait;
+    use TestRuleMessageOptionTrait;
 
     public static function provideRuleFailureConditionData(): \Generator
     {
@@ -49,7 +49,7 @@ public static function provideRuleSuccessConditionData(): \Generator
         yield 'string' => [new LessThan('z'), 'a'];
     }
 
-    public static function provideRuleCustomMessageData(): \Generator
+    public static function provideRuleMessageOptionData(): \Generator
     {
         yield 'message' => [
             new LessThan(10, [

tests/NotBlankTest.php

@@ -4,15 +4,15 @@
 
 use ProgrammatorDev\YetAnotherPhpValidator\Exception\NotBlankException;
 use ProgrammatorDev\YetAnotherPhpValidator\Rule\NotBlank;
-use ProgrammatorDev\YetAnotherPhpValidator\Test\Util\TestRuleCustomMessageTrait;
+use ProgrammatorDev\YetAnotherPhpValidator\Test\Util\TestRuleMessageOptionTrait;
 use ProgrammatorDev\YetAnotherPhpValidator\Test\Util\TestRuleFailureConditionTrait;
 use ProgrammatorDev\YetAnotherPhpValidator\Test\Util\TestRuleSuccessConditionTrait;
 
 class NotBlankTest extends AbstractTest
 {
     use TestRuleFailureConditionTrait;
     use TestRuleSuccessConditionTrait;
-    use TestRuleCustomMessageTrait;
+    use TestRuleMessageOptionTrait;
 
     public static function provideRuleFailureConditionData(): \Generator
     {
@@ -23,6 +23,8 @@ public static function provideRuleFailureConditionData(): \Generator
         yield 'false' => [new NotBlank(), false, $exception, $exceptionMessage];
         yield 'blank string' => [new NotBlank(), '', $exception, $exceptionMessage];
         yield 'blank array' => [new NotBlank(), [], $exception, $exceptionMessage];
+
+        yield 'normalizer whitespace' => [new NotBlank(['normalizer' => 'trim']), ' ', $exception, $exceptionMessage];
     }
 
     public static function provideRuleSuccessConditionData(): \Generator
@@ -42,7 +44,7 @@ public static function provideRuleSuccessConditionData(): \Generator
         yield 'zero number' => [new NotBlank(), 0];
     }
 
-    public static function provideRuleCustomMessageData(): \Generator
+    public static function provideRuleMessageOptionData(): \Generator
     {
         yield 'message' => [
             new NotBlank([