Add RegexRule validation with evaluation logic and corresponding tests

Author: Fa-BRAIK

src/Validation/Rules/RegexRule.php

@@ -0,0 +1,57 @@
+<?php
+
+namespace Nuxtifyts\PhpDto\Validation\Rules;
+
+use Nuxtifyts\PhpDto\Exceptions\ValidationRuleException;
+
+class RegexRule implements ValidationRule
+{
+    public string $pattern;
+
+    /** @var 0 | 256 | 512 | 768 */
+    public int $flags = 0;
+
+    public int $offset = 0;
+
+    public string $name {
+        get {
+            return 'regex';
+        }
+    }
+
+    public function evaluate(mixed $value): bool
+    {
+        return is_string($value) 
+            && preg_match(
+                pattern: $this->pattern, 
+                subject: $value,
+                flags: $this->flags,
+                offset: $this->offset
+            );
+    }
+
+    /** 
+     * @param ?array<string, mixed> $parameters
+     * 
+     * @throws ValidationRuleException
+     */
+    public static function make(?array $parameters = null): self
+    {
+        $instance = new self();
+
+        $pattern = $parameters['pattern'] ?? null;
+
+        if (!is_string($pattern) || @preg_match($pattern, '') === false) {
+            throw ValidationRuleException::invalidParameters();
+        }
+
+        $instance->pattern = $pattern;
+
+        return $instance;
+    }
+
+    public function validationMessage(): string
+    {
+        return 'The :attribute field does not match the required pattern.';
+    }
+}

tests/Unit/Validation/RegexRuleTest.php

@@ -0,0 +1,72 @@
+<?php
+
+namespace Nuxtifyts\PhpDto\Tests\Unit\Validation;
+
+use Throwable;
+use PHPUnit\Framework\Attributes\Test;
+use PHPUnit\Framework\Attributes\CoversClass;
+use Nuxtifyts\PhpDto\Validation\Rules\RegexRule;
+use Nuxtifyts\PhpDto\Validation\Rules\ValidationRule;
+use Nuxtifyts\PhpDto\Exceptions\ValidationRuleException;
+
+#[CoversClass(RegexRule::class)]
+#[CoversClass(ValidationRuleException::class)]
+class RegexRuleTest extends ValidationRuleTestCase
+{
+    /** 
+     *  @throws Throwable
+     */
+    #[Test]
+    public function validate_validation_message(): void
+    {
+        $rule = RegexRule::make(['pattern' => '/^test$/']);
+
+        self::assertEquals(
+            'The :attribute field does not match the required pattern.',
+            $rule->validationMessage()
+        );
+    }
+
+     /**
+     * @return array<string, array{
+     *     validationRuleClassString: class-string<ValidationRule>,
+     *     makeParams: ?array<string, mixed>,
+     *     expectedMakeException: ?class-string<ValidationRuleException>,
+     *     valueToBeEvaluated: mixed,
+     *     expectedResult: bool
+     * }>
+     */
+    public static function data_provider(): array
+    {
+        return [
+            'Will evaluate false when value is not a valid regex string' => [
+                'validationRuleClassString' => RegexRule::class,
+                'makeParams' => ['pattern' => '/^test$/'],
+                'expectedMakeException' => null,
+                'valueToBeEvaluated' => 'not-a-valid-regex-string',
+                'expectedResult' => false
+            ],
+            'Will evaluate true when a valid regex string is provided' => [
+                'validationRuleClassString' => RegexRule::class,
+                'makeParams' => ['pattern' => '/^test$/'],
+                'expectedMakeException' => null,
+                'valueToBeEvaluated' => 'test',
+                'expectedResult' => true
+            ],
+            'Will evaluate false when a non string value is provided' => [
+                'validationRuleClassString' => RegexRule::class,
+                'makeParams' => ['pattern' => '/^test$/'],
+                'expectedMakeException' => null,
+                'valueToBeEvaluated' => 123,
+                'expectedResult' => false
+            ],
+            'Will throw an exception if the pattern is not a valid regex' => [
+                'validationRuleClassString' => RegexRule::class,
+                'makeParams' => ['pattern' => '/^test'],
+                'expectedMakeException' => ValidationRuleException::class,
+                'valueToBeEvaluated' => 'test',
+                'expectedResult' => false
+            ],
+        ];
+    }
+}