Merge pull request #73 from programmatordev/YAPV-57-create-istrue-rule

Create IsTrue rule

Author: andrepimpao

docs/03-rules.md

@@ -13,6 +13,7 @@
 - [Blank](03-rules_blank.md)
 - [Count](03-rules_count.md)
 - [IsNull](03-rules_is-null.md)
+- [IsTrue](03-rules_is-true.md)
 - [NotBlank](03-rules_not-blank.md)
 - [NotNull](03-rules_not-null.md)
 - [Type](03-rules_type.md)

docs/03-rules_is-true.md

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

src/ChainedValidatorInterface.php

@@ -84,6 +84,10 @@ public function isNull(
         ?string $message = null
     ): ChainedValidatorInterface&Validator;
 
+    public function isTrue(
+        ?string $message = null
+    ): ChainedValidatorInterface&Validator;
+
     public function language(
         string $code = 'alpha-2',
         ?string $message = null

src/Exception/IsTrueException.php

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

src/Rule/IsTrue.php

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

src/StaticValidatorInterface.php

@@ -124,6 +124,10 @@ public static function notNull(
         ?string $message = null
     ): ChainedValidatorInterface&Validator;
 
+    public static function isTrue(
+        ?string $message = null
+    ): ChainedValidatorInterface&Validator;
+
     public static function optional(
         Validator $validator
     ): ChainedValidatorInterface&Validator;

tests/IsTrueTest.php

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