Merge pull request #29 from xefi/feature/regex-strategy

✨ regex strategy

Author: martinsoenen

Diff for: src/Container/Traits/HasStrategies.php

@@ -2,6 +2,7 @@
 
 namespace Xefi\Faker\Container\Traits;
 
+use Xefi\Faker\Strategies\RegexStrategy;
 use Xefi\Faker\Strategies\UniqueStrategy;
 
 trait HasStrategies
@@ -28,6 +29,20 @@ public function unique(string $seed = '')
         return $this;
     }
 
+    /**
+     * Add a regex strategy.
+     *
+     * @param string $regex
+     *
+     * @return $this
+     */
+    public function regex(string $regex)
+    {
+        $this->strategies[] = new RegexStrategy($regex);
+
+        return $this;
+    }
+
     /**
      * Determine if a generated value passes the strategies.
      *

Diff for: src/Strategies/RegexStrategy.php

@@ -0,0 +1,25 @@
+<?php
+
+namespace Xefi\Faker\Strategies;
+
+class RegexStrategy extends Strategy
+{
+    protected string $regex;
+
+    public function __construct(string $regex)
+    {
+        $this->regex = $regex;
+    }
+
+    /**
+     * Handle the given strategy.
+     *
+     * @param $generatedValue
+     *
+     * @return bool
+     */
+    public function pass($generatedValue): bool
+    {
+        return (bool) preg_match($this->regex, $generatedValue);
+    }
+}

Diff for: tests/Unit/Strategies/RegexStrategyTest.php

@@ -0,0 +1,67 @@
+<?php
+
+namespace Strategies;
+
+use PHPUnit\Framework\Attributes\DataProvider;
+use Xefi\Faker\Exceptions\MaximumTriesReached;
+use Xefi\Faker\Faker;
+use Xefi\Faker\Strategies\RegexStrategy;
+use Xefi\Faker\Tests\Unit\TestCase;
+
+class RegexStrategyTest extends TestCase
+{
+    public function testRegexStrategyRegistered(): void
+    {
+        $faker = new Faker();
+
+        $container = $faker->regex('//');
+
+        $this->assertEquals(
+            [new RegexStrategy('//')],
+            $container->getStrategies()
+        );
+    }
+
+    public function testUniqueSingleTest(): void
+    {
+        $faker = new Faker();
+
+        $this->assertEquals(
+            'hello',
+            $faker->regex('//')->returnHello()
+        );
+    }
+
+    public function testUniqueThrowExceptionOnMaxRetriesReached(): void
+    {
+        $faker = new Faker();
+
+        $this->expectException(MaximumTriesReached::class);
+        $this->expectExceptionMessage('Maximum tries of 20000 reached without finding a value');
+
+        $faker->regex('/^\d$/')->returnHello();
+    }
+
+    public static function regexProvider(): array
+    {
+        return [
+            ['/\d/', 0, 9],
+            ['/\d+/', 0, 100],
+            ['/^[1-9]\d*$/', 1, 1000],
+            ['/^-?\d+$/', -100, 100],
+            ['/^[0-9]{1,3}$/', 0, 999],
+            ['/^[1-9][0-9]{2,5}$/', 100, 999999],
+            ['/^0$/', 0, 0],
+        ];
+    }
+
+    #[DataProvider('regexProvider')]
+    public function testMultipleRegexCases(string $regex, int $min, int $max): void
+    {
+        $faker = new Faker();
+
+        $result = $faker->regex($regex)->returnNumberBetween($min, $max);
+
+        $this->assertMatchesRegularExpression($regex, (string) $result);
+    }
+}