Merge pull request #74 from programmatordev/YAPV-58-create-isfalse-rule

Create IsFalse rule

docs/03-rules.md

@@ -12,6 +12,7 @@
 
 - [Blank](03-rules_blank.md)
 - [Count](03-rules_count.md)
+- [IsFalse](03-rules_is-false.md)
 - [IsNull](03-rules_is-null.md)
 - [IsTrue](03-rules_is-true.md)
 - [NotBlank](03-rules_not-blank.md)

docs/03-rules_is-false.md

@@ -0,0 +1,37 @@
+# IsFalse
+
+Validates that a value is `false`.
+
+Check the [IsTrue](03-rules_is-true.md) rule for a `true` validation.
+
+```php
+IsFalse(
+    ?string $message = null
+);
+```
+
+## Basic Usage
+
+```php
+// anything else will be false
+Validator::isFalse()->validate(false); // true
+```
+
+## Options
+
+### `message`
+
+type: `?string` default: `The {{ name }} value should be false, {{ value }} given.`
+
+Message that will be shown if the value is false.
+
+The following parameters are available:
+
+| Parameter     | Description               |
+|---------------|---------------------------|
+| `{{ value }}` | The current invalid value |
+| `{{ name }}`  | Name of the invalid value |
+
+## Changelog
+
+- `1.3.0` Created

docs/03-rules_is-true.md

@@ -2,6 +2,8 @@
 
 Validates that a value is `true`.
 
+Check the [IsFalse](03-rules_is-false.md) rule for a `false` validation.
+
 ```php
 IsTrue(
     ?string $message = null

src/ChainedValidatorInterface.php

@@ -80,6 +80,10 @@ public function greaterThanOrEqual(
         ?string $message = null
     ): ChainedValidatorInterface&Validator;
 
+    public function isFalse(
+        ?string $message = null
+    ): ChainedValidatorInterface&Validator;
+
     public function isNull(
         ?string $message = null
     ): ChainedValidatorInterface&Validator;

src/Exception/IsFalseException.php

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

src/Rule/IsFalse.php

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

src/StaticValidatorInterface.php

@@ -120,6 +120,10 @@ public static function notBlank(
         ?string $message = null
     ): ChainedValidatorInterface&Validator;
 
+    public static function isFalse(
+        ?string $message = null
+    ): ChainedValidatorInterface&Validator;
+
     public static function notNull(
         ?string $message = null
     ): ChainedValidatorInterface&Validator;

tests/IsFalseTest.php

@@ -0,0 +1,43 @@
+<?php
+
+namespace ProgrammatorDev\Validator\Test;
+
+use ProgrammatorDev\Validator\Exception\IsFalseException;
+use ProgrammatorDev\Validator\Rule\IsFalse;
+use ProgrammatorDev\Validator\Test\Util\TestRuleFailureConditionTrait;
+use ProgrammatorDev\Validator\Test\Util\TestRuleMessageOptionTrait;
+use ProgrammatorDev\Validator\Test\Util\TestRuleSuccessConditionTrait;
+
+class IsFalseTest extends AbstractTest
+{
+    use TestRuleFailureConditionTrait;
+    use TestRuleSuccessConditionTrait;
+    use TestRuleMessageOptionTrait;
+
+    public static function provideRuleFailureConditionData(): \Generator
+    {
+        $exception = IsFalseException::class;
+        $message = '/The (.*) value should be false, (.*) given\./';
+
+        yield 'int' => [new IsFalse(), 1, $exception, $message];
+        yield 'string' => [new IsFalse(), 'string', $exception, $message];
+        yield 'true' => [new IsFalse(), true, $exception, $message];
+        yield 'array' => [new IsFalse(), [], $exception, $message];
+    }
+
+    public static function provideRuleSuccessConditionData(): \Generator
+    {
+        yield 'false' => [new IsFalse(), false];
+    }
+
+    public static function provideRuleMessageOptionData(): \Generator
+    {
+        yield 'message' => [
+            new IsFalse(
+                message: '{{ name }} | {{ value }}'
+            ),
+            true,
+            'test | true'
+        ];
+    }
+}