Implement file regex search for ColocatedMappingDriver

Author: rela589n

UPGRADE.md

@@ -6,6 +6,31 @@ awareness about deprecated code.
 - Use of our low-overhead runtime deprecation API, details:
   https://github.com/doctrine/deprecations/
 
+# Upgrade to 4.1
+
+## Added `ColocatedMappingDriver::$fileRegex`
+
+It is now possible to find mapping files by regex rather than by extension:
+
+Before:
+
+```php
+$driver->setFileExtension('.php'); // Deprecated
+```
+
+After:
+
+```php
+$driver->setFileRegex('/^.+\.php$/');
+```
+
+## Deprecated `ColocatedMappingDriver::$fileExtension` in favor of `$fileRegex`
+
+Property `Doctrine\Persistence\Mapping\Driver\ColocatedMappingDriver::$fileExtension` and `getFileExtension()`,
+`setFileExtension()` methods are deprecated.
+You should use `Doctrine\Persistence\Mapping\Driver\ColocatedMappingDriver::$fileRegex` and `getFileRegex()`,
+`setFileRegex()` instead.
+
 # Upgrade to 4.0
 
 ## BC Break: Removed `StaticReflectionService`
@@ -89,7 +114,7 @@ Use `LifecycleEventArgs::getObject()` instead.
 
 - `AbstractClassMetadataFactory::getFqcnFromAlias()` is removed.
 - `ClassMetadataFactory` methods now require their `$className` argument to be an
-actual FQCN.
+  actual FQCN.
 
 ## BC Break: removed `ObjectManager::merge()`
 

src/Persistence/Mapping/Driver/ColocatedMappingDriver.php

@@ -43,7 +43,14 @@ trait ColocatedMappingDriver
      */
     protected array $excludePaths = [];
 
-    /** The file extension of mapping documents. */
+    /** The regex used to match mapping files. */
+    protected string $fileRegex = '/^.+\.php$/i';
+
+    /**
+     * The file extension of mapping documents.
+     *
+     * @deprecated Use {@see $fileRegex} instead.
+     */
     protected string $fileExtension = '.php';
 
     /**
@@ -94,16 +101,38 @@ public function getExcludePaths(): array
         return $this->excludePaths;
     }
 
-    /** Gets the file extension used to look for mapping files under. */
+    /** Gets the file regex used to look for mapping files under. */
+    public function getFileRegex(): string
+    {
+        return $this->fileRegex;
+    }
+
+    /** Sets the file regex used to look for mapping files with. */
+    public function setFileRegex(string $fileRegex): void
+    {
+        $this->fileRegex     = $fileRegex;
+        $this->fileExtension = '';
+    }
+
+    /**
+     * Gets the file extension used to look for mapping files under.
+     *
+     * @deprecated Use {@see getFileRegex()} instead.
+     */
     public function getFileExtension(): string
     {
         return $this->fileExtension;
     }
 
-    /** Sets the file extension used to look for mapping files under. */
+    /**
+     * Sets the file extension used to look for mapping files under.
+     *
+     * @deprecated Use {@see setFileRegex()} instead.
+     */
     public function setFileExtension(string $fileExtension): void
     {
         $this->fileExtension = $fileExtension;
+        $this->fileRegex     = '/^.+' . preg_quote($fileExtension) . '$/i';
     }
 
     /**
@@ -145,7 +174,7 @@ public function getAllClassNames(): array
                     new RecursiveDirectoryIterator($path, FilesystemIterator::SKIP_DOTS),
                     RecursiveIteratorIterator::LEAVES_ONLY,
                 ),
-                '/^.+' . preg_quote($this->fileExtension) . '$/i',
+                $this->fileRegex,
                 RecursiveRegexIterator::GET_MATCH,
             );
 

tests/Persistence/Mapping/ColocatedMappingDriverTest.php

@@ -4,14 +4,16 @@
 
 namespace Doctrine\Tests\Persistence\Mapping;
 
+use Doctrine\Entity;
+use Doctrine\EntityFixture;
 use Doctrine\Persistence\Mapping\ClassMetadata;
 use Doctrine\Persistence\Mapping\Driver\ColocatedMappingDriver;
 use Doctrine\Persistence\Mapping\Driver\MappingDriver;
 use Doctrine\TestClass;
 use Generator;
 use PHPUnit\Framework\TestCase;
 
-use function array_values;
+use function sort;
 
 class ColocatedMappingDriverTest extends TestCase
 {
@@ -44,6 +46,18 @@ public function testAddGetExcludePaths(): void
         ], $driver->getExcludePaths());
     }
 
+    public function testGetSetFileRegex(): void
+    {
+        $driver = $this->createDriver(__DIR__ . '/_files/colocated');
+        self::assertSame('/^.+\.php$/i', $driver->getFileRegex());
+
+        $driver->setFileRegex('/^(?!.*Test\.php$).*\.php$/');
+
+        self::assertSame('/^(?!.*Test\.php$).*\.php$/', $driver->getFileRegex());
+        self::assertSame('', $driver->getFileExtension());
+    }
+
+    /** @deprecated */
     public function testGetSetFileExtension(): void
     {
         $driver = $this->createDriver(__DIR__ . '/_files/colocated');
@@ -52,6 +66,7 @@ public function testGetSetFileExtension(): void
         $driver->setFileExtension('.php1');
 
         self::assertSame('.php1', $driver->getFileExtension());
+        self::assertSame('/^.+\.php1$/i', $driver->getFileRegex());
     }
 
     /** @dataProvider pathProvider */
@@ -61,7 +76,18 @@ public function testGetAllClassNames(string $path): void
 
         $classes = $driver->getAllClassNames();
 
-        self::assertSame([TestClass::class], $classes);
+        sort($classes);
+        self::assertSame([Entity::class, EntityFixture::class], $classes);
+    }
+
+    public function testGetAllClassNamesWithRegex(): void
+    {
+        $noFixturesRegex = '/^(?!.*Fixture\.php$).*\.php$/';
+        $driver          = $this->createDriver(__DIR__ . '/_files/colocated', $noFixturesRegex);
+
+        $classes = $driver->getAllClassNames();
+
+        self::assertSame([Entity::class], $classes);
     }
 
     /** @return Generator<string, array{string}> */
@@ -71,20 +97,29 @@ public static function pathProvider(): Generator
         yield 'winding path' => [__DIR__ . '/../Mapping/_files/colocated'];
     }
 
-    private function createDriver(string $path): MyDriver
+    private function createDriver(string $path, string|null $fileRegex = null): MyDriver
     {
-        return new MyDriver($path);
+        return new MyDriver([$path], $fileRegex);
     }
 }
 
 final class MyDriver implements MappingDriver
 {
     use ColocatedMappingDriver;
 
-    /** @param string ...$paths One or multiple paths where mapping classes can be found. */
-    public function __construct(string ...$paths)
+    /**
+     * @param non-empty-list<string> $paths     One or multiple paths where mapping classes can be found.
+     * @param string|null            $fileRegex The regex used to look for mapping files with.
+     */
+    public function __construct(array $paths, string|null $fileRegex = null)
     {
-        $this->addPaths(array_values($paths));
+        $this->addPaths($paths);
+
+        if ($fileRegex === null) {
+            return;
+        }
+
+        $this->setFileRegex($fileRegex);
     }
 
     /**
@@ -96,6 +131,6 @@ public function loadMetadataForClass($className, ClassMetadata $metadata): void
 
     public function isTransient(string $className): bool
     {
-        return $className !== TestClass::class;
+        return $className === TestClass::class;
     }
 }

tests/Persistence/Mapping/_files/colocated/Entity.php

@@ -0,0 +1,9 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Doctrine;
+
+class Entity
+{
+}

tests/Persistence/Mapping/_files/colocated/EntityFixture.php

@@ -0,0 +1,9 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Doctrine;
+
+class EntityFixture
+{
+}

tests/Persistence/Mapping/_files/colocated/TestClass.php

@@ -7,7 +7,3 @@
 class TestClass
 {
 }
-
-class Entity
-{
-}