Add RegexIterator

Signed-off-by: Nathanael Esayeas <[email protected]>

psalm-baseline.xml

@@ -9,6 +9,7 @@
     <LessSpecificReturnType>
       <code><![CDATA[Generator]]></code>
       <code><![CDATA[RecursiveIteratorIterator]]></code>
+      <code><![CDATA[RegexIterator]]></code>
       <code><![CDATA[non-empty-string]]></code>
       <code><![CDATA[string]]></code>
     </LessSpecificReturnType>

src/Filesystem.php

@@ -688,6 +688,20 @@ public function recursiveRegexIterator(
         );
     }
 
+    /**
+     * @throws FilesystemExceptionInterface
+     */
+    #[Override]
+    public function regexIterator(string $directory, string $pattern): RegexIterator
+    {
+        return $this->safely(
+            static fn (FilesystemInterface $filesystem): RegexIterator => new RegexIterator(
+                $filesystem->recursiveIteratorIterator($filesystem->recursiveDirectoryIterator($directory)),
+                $pattern,
+            )
+        );
+    }
+
     /**
      * @throws FilesystemExceptionInterface
      */

src/Interface/FilesystemInterface.php

@@ -117,6 +117,8 @@ public function recursiveRegexIterator(
         int $mode = RegexIterator::GET_MATCH,
     ): RecursiveRegexIterator;
 
+    public function regexIterator(string $directory, string $pattern): RegexIterator;
+
     public function relative(string $from, string $to): string;
 
     public function size(string $path): int;

tests/Unit/FilesystemTest.php

@@ -813,6 +813,21 @@ public function testRecursiveRegexIterator(): void
         self::fail('Should have found a file.');
     }
 
+    /**
+     * @throws Throwable
+     */
+    public function testRegexIterator(): void
+    {
+        $filesystem = Filesystem::new();
+
+        $totalNumberOfTests = 40; // in the tests/Unit directory
+
+        self::assertCount(
+            $totalNumberOfTests,
+            \iterator_to_array($filesystem->regexIterator(__DIR__, '#\.php#iu')),
+        );
+    }
+
     /**
      * @throws Throwable
      */