Merge pull request #10 from programmatordev/YAPV-17-create-lessthanorequal-rule

Create LessThanOrEqual rule

Author: andrepimpao

src/ChainedValidatorInterface.php

@@ -23,6 +23,8 @@ public function greaterThanOrEqual(mixed $constraint, array $options = []): Chai
 
     public function lessThan(mixed $constraint, array $options = []): ChainedValidatorInterface;
 
+    public function lessThanOrEqual(mixed $constraint, array $options = []): ChainedValidatorInterface;
+
     public function choice(array $constraints, bool $multiple = false, ?int $minConstraint = null, ?int $maxConstraint = null, array $options = []): ChainedValidatorInterface;
 
     public function range(mixed $minConstraint, mixed $maxConstraint, array $options = []): ChainedValidatorInterface;

src/Exception/LessThanOrEqualException.php

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

src/Rule/LessThanOrEqual.php

@@ -0,0 +1,44 @@
+<?php
+
+namespace ProgrammatorDev\YetAnotherPhpValidator\Rule;
+
+use ProgrammatorDev\YetAnotherPhpValidator\Exception\LessThanOrEqualException;
+use ProgrammatorDev\YetAnotherPhpValidator\Rule\Util\AssertIsComparableTrait;
+use Symfony\Component\OptionsResolver\OptionsResolver;
+
+class LessThanOrEqual extends AbstractRule implements RuleInterface
+{
+    use AssertIsComparableTrait;
+
+    private array $options;
+
+    public function __construct(private readonly mixed $constraint, array $options = [])
+    {
+        $resolver = new OptionsResolver();
+
+        $resolver->setDefaults(['message' => 'The "{{ name }}" value should be less than or equal to "{{ constraint }}", "{{ value }}" given.']);
+
+        $resolver->setAllowedTypes('message', 'string');
+
+        $this->options = $resolver->resolve($options);
+    }
+
+    /**
+     * @throws LessThanOrEqualException
+     */
+    public function assert(mixed $value, string $name): void
+    {
+        $this->assertIsComparable($this->constraint, $value);
+
+        if (!($value <= $this->constraint)) {
+            throw new LessThanOrEqualException(
+                message: $this->options['message'],
+                parameters: [
+                    'value' => $value,
+                    'name' => $name,
+                    'constraint' => $this->constraint
+                ]
+            );
+        }
+    }
+}

src/StaticValidatorInterface.php

@@ -12,6 +12,8 @@ public static function greaterThanOrEqual(mixed $constraint, array $options = []
 
     public static function lessThan(mixed $constraint, array $options = []): ChainedValidatorInterface;
 
+    public static function lessThanOrEqual(mixed $constraint, array $options = []): ChainedValidatorInterface;
+
     public static function choice(array $constraints, bool $multiple = false, ?int $minConstraint = null, ?int $maxConstraint = null, array $options = []): ChainedValidatorInterface;
 
     public static function range(mixed $minConstraint, mixed $maxConstraint, array $options = []): ChainedValidatorInterface;

tests/LessThanOrEqualTest.php

@@ -0,0 +1,69 @@
+<?php
+
+namespace ProgrammatorDev\YetAnotherPhpValidator\Test;
+
+use ProgrammatorDev\YetAnotherPhpValidator\Exception\LessThanOrEqualException;
+use ProgrammatorDev\YetAnotherPhpValidator\Rule\LessThanOrEqual;
+use ProgrammatorDev\YetAnotherPhpValidator\Test\Util\TestRuleFailureConditionTrait;
+use ProgrammatorDev\YetAnotherPhpValidator\Test\Util\TestRuleMessageOptionTrait;
+use ProgrammatorDev\YetAnotherPhpValidator\Test\Util\TestRuleSuccessConditionTrait;
+use ProgrammatorDev\YetAnotherPhpValidator\Test\Util\TestRuleUnexpectedValueTrait;
+
+class LessThanOrEqualTest extends AbstractTest
+{
+    use TestRuleUnexpectedValueTrait;
+    use TestRuleFailureConditionTrait;
+    use TestRuleSuccessConditionTrait;
+    use TestRuleMessageOptionTrait;
+
+    public static function provideRuleUnexpectedValueData(): \Generator
+    {
+        $message = '/Cannot compare a type "(.*)" with a type "(.*)"/';
+
+        yield 'datetime constraint with int value' => [new LessThanOrEqual(new \DateTime()), 10, $message];
+        yield 'datetime constraint with float value' => [new LessThanOrEqual(new \DateTime()), 1.0, $message];
+        yield 'datetime constraint with string value' => [new LessThanOrEqual(new \DateTime()), 'a', $message];
+        yield 'int constraint with string value' => [new LessThanOrEqual(10), 'a', $message];
+        yield 'float constraint with string value' => [new LessThanOrEqual(1.0), 'a', $message];
+        yield 'array constraint' => [new LessThanOrEqual([10]), 10, $message];
+        yield 'null constraint' => [new LessThanOrEqual(null), 10, $message];
+    }
+
+    public static function provideRuleFailureConditionData(): \Generator
+    {
+        $exception = LessThanOrEqualException::class;
+        $message = '/The "(.*)" value should be less than or equal to "(.*)", "(.*)" given./';
+
+        yield 'datetime' => [new LessThanOrEqual(new \DateTime('today')), new \DateTime('tomorrow'), $exception, $message];
+        yield 'int' => [new LessThanOrEqual(10), 20, $exception, $message];
+        yield 'float' => [new LessThanOrEqual(10.0), 20.0, $exception, $message];
+        yield 'int with float' => [new LessThanOrEqual(10), 20.0, $exception, $message];
+        yield 'string' => [new LessThanOrEqual('a'), 'z', $exception, $message];
+    }
+
+    public static function provideRuleSuccessConditionData(): \Generator
+    {
+        yield 'datetime' => [new LessThanOrEqual(new \DateTime('today')), new \DateTime('yesterday')];
+        yield 'same datetime' => [new LessThanOrEqual(new \DateTime('today')), new \DateTime('today')];
+        yield 'int' => [new LessThanOrEqual(10), 1];
+        yield 'same int' => [new LessThanOrEqual(10), 10];
+        yield 'float' => [new LessThanOrEqual(10.0), 1.0];
+        yield 'same float' => [new LessThanOrEqual(10.0), 10.0];
+        yield 'int with float' => [new LessThanOrEqual(10), 1.0];
+        yield 'same int with float' => [new LessThanOrEqual(10), 10.0];
+        yield 'string' => [new LessThanOrEqual('z'), 'a'];
+        yield 'same string' => [new LessThanOrEqual('a'), 'a'];
+    }
+
+    public static function provideRuleMessageOptionData(): \Generator
+    {
+        yield 'message' => [
+            new LessThanOrEqual(
+                constraint: 10,
+                options: [
+                    'message' => 'The "{{ name }}" value "{{ value }}" is not less than or equal to "{{ constraint }}".'
+                ]
+            ), 20, 'The "test" value "20" is not less than or equal to "10".'
+        ];
+    }
+}