Merge pull request #2 from programmatordev/YAPV-6-create-notblank-rule

Create notBlank rule

Author: andrepimpao

phpunit.xml.dist

@@ -0,0 +1,23 @@
+<?xml version="1.0" encoding="UTF-8"?>
+
+<phpunit xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
+         xsi:noNamespaceSchemaLocation="vendor/phpunit/phpunit/phpunit.xsd"
+         colors="true"
+         bootstrap="vendor/autoload.php"
+         stopOnError="true"
+>
+    <php>
+        <ini name="memory_limit" value="-1" />
+        <ini name="error_reporting" value="-1" />
+        <ini name="log_errors_max_len" value="0" />
+        <ini name="zend.assertions" value="1" />
+        <ini name="assert.exception" value="1" />
+        <ini name="xdebug.show_exception_trace" value="0" />
+    </php>
+
+    <testsuites>
+        <testsuite name="Project Test Suite">
+            <directory>tests</directory>
+        </testsuite>
+    </testsuites>
+</phpunit>

src/ChainedValidatorInterface.php

@@ -17,7 +17,7 @@ public function assert(mixed $input, string $name): void;
 
     // --- Rules ---
 
-//    public function notBlank(): ChainedValidatorInterface;
-//
+    public function notBlank(?string $message = null): ChainedValidatorInterface;
+
 //    public function greaterThan(mixed $constraint): ChainedValidatorInterface;
 }

src/Exception/NotBlankException.php

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

src/Rule/NotBlank.php

@@ -0,0 +1,35 @@
+<?php
+
+namespace ProgrammatorDev\YetAnotherPhpValidator\Rule;
+
+use ProgrammatorDev\YetAnotherPhpValidator\Exception\NotBlankException;
+
+class NotBlank extends AbstractRule implements RuleInterface
+{
+    public function __construct(private ?string $message = null)
+    {
+        $this->message ??= 'The {{ name }} value should not be blank.';
+    }
+
+    /**
+     * @throws NotBlankException
+     */
+    public function validate(mixed $input): void
+    {
+        // Strip whitespace in case of a string
+        if (\is_string($input)) {
+            $input = trim($input);
+        }
+
+        // Do not allow null, false, [] and ''
+        if ($input === false || (empty($input) && $input != '0')) {
+            throw new NotBlankException(
+                message: $this->message,
+                parameters: [
+                    'input' => $input,
+                    'name' => $this->getName()
+                ]
+            );
+        }
+    }
+}

src/StaticValidatorInterface.php

@@ -4,7 +4,7 @@
 
 interface StaticValidatorInterface
 {
-//    public static function notBlank(): ChainedValidatorInterface;
-//
+    public static function notBlank(?string $message = null): ChainedValidatorInterface;
+
 //    public static function greaterThan(mixed $constraint): ChainedValidatorInterface;
 }

src/Test/AbstractTest.php

@@ -0,0 +1,7 @@
+<?php
+
+namespace ProgrammatorDev\YetAnotherPhpValidator\Test;
+
+use PHPUnit\Framework\TestCase;
+
+class AbstractTest extends TestCase {}

tests/NotBlankTest.php

@@ -0,0 +1,59 @@
+<?php
+
+namespace ProgrammatorDev\YetAnotherPhpValidator\Test;
+
+use PHPUnit\Framework\Attributes\DataProvider;
+use ProgrammatorDev\YetAnotherPhpValidator\Exception\NotBlankException;
+use ProgrammatorDev\YetAnotherPhpValidator\Validator;
+
+class NotBlankTest extends AbstractTest
+{
+    #[DataProvider('provideInvalidInputData')]
+    public function testNotBlankInvalidInput(mixed $input)
+    {
+        $validator = Validator::notBlank();
+
+        $this->assertFalse($validator->validate($input));
+
+        $this->expectException(NotBlankException::class);
+        $this->expectExceptionMessage('The "test" value should not be blank.');
+        $validator->assert($input, 'test');
+    }
+
+    public static function provideInvalidInputData(): \Generator
+    {
+        yield 'null' => [null];
+        yield 'false' => [false];
+        yield 'blank array' => [[]];
+        yield 'blank string' => [''];
+        yield 'whitespace' => [' '];
+    }
+
+    #[DataProvider('provideValidInputData')]
+    public function testNotBlankValidInput(mixed $input)
+    {
+        $validator = Validator::notBlank();
+
+        $this->assertTrue($validator->validate($input));
+
+        Validator::notBlank()->assert($input, 'test');
+    }
+
+    public static function provideValidInputData(): \Generator
+    {
+        yield 'true' => [true];
+        yield 'zero number' => [0];
+        yield 'zero string' => ['0'];
+        yield 'array' => [[0]];
+        yield 'string' => ['string'];
+    }
+
+    public function testNotBlankExceptionMessageParameters()
+    {
+        $this->expectExceptionMessage('The "test" value false is invalid. Must not be blank.');
+
+        Validator::notBlank(
+            message: 'The {{ name }} value {{ input }} is invalid. Must not be blank.'
+        )->assert(false, 'test');
+    }
+}