Use native Doctrine mapping tools (#29)

Author: Firehed

.github/codecov.yml

@@ -0,0 +1,8 @@
+coverage:
+  status:
+    patch: false
+    project:
+      default: false
+      src:
+        paths: src
+        threshold: 5%

README.md

@@ -13,10 +13,30 @@ A Doctrine mocking library for testing
 In your unit tests that need an Entity Manager, use a `new \Firehed\Mocktrine\InMemoryEntityManager`. Done!
 
 Any object with Doctrine's entity annotations (`@Entity`, `@Id`, `@Column`, etc) should work without modification.
-Only annotation-based entity classes are supported; XML and Yaml are not.
 
 This library aims to provide as much type information as possible, so that static analysis tools (such as PHPStan) work well without additional plugins.
 
+### Mapping support
+
+As of version 0.5, any mapping driver supported by Doctrine can be used with this library.
+The `InMemoryEntityManager` accepts the driver as an optional parameter.
+
+```diff
+- $em = new Mocktrine\InMemoryEntityManager();
++ $em = new Mocktrine\InMemoryEntityManager(
++     \Doctrine\ORM\Mapping\Driver\AttributeDriver(['src/Model']),
++ );
+```
+
+You can also grab the value directly from your Doctrine config:
+```php
+$config = Setup::createAnnotationMetadataDriverConfiguration(...)
+$driver = $config->getMetadataDriverImpl();
+$em = new Mocktrine\InMemoryEntityManager($driver)
+```
+
+If a driver is not provided, it will default to the `SimpleAnnotationReader` that's used via `Setup::createAnnotationMetadataConfiguration`.
+
 ## Supported features
 
 The following methods on Doctrine's `EntityManagerInterface` should all work as expected:

composer.json

@@ -4,6 +4,7 @@
     "type": "library",
     "require": {
         "php": "^7.4 || ^8.0",
+        "doctrine/annotations": "^1.10",
         "doctrine/collections": "^1.6",
         "doctrine/orm": "^2.7",
         "doctrine/persistence": "^1.3 || ^2.0",

src/CriteriaEvaluator.php

@@ -12,10 +12,10 @@
     Expression,
     Value,
 };
+use Doctrine\Persistence\Mapping\ClassMetadata;
 use DomainException;
 use ReflectionClass;
 use UnexpectedValueException;
-use phpDocumentor\Reflection\DocBlockFactory;
 
 use function array_filter;
 use function array_map;
@@ -44,37 +44,24 @@
  */
 class CriteriaEvaluator
 {
-    private static ?DocBlockFactory $docBlockFactory = null;
-
-    /** @var class-string<Entity> */
-    private string $className;
+    /** @var ClassMetadata<Entity> */
+    private ClassMetadata $metadata;
 
     /** @var \ReflectionProperty[] */
     private array $reflectionProperties;
 
     /**
-     * @param class-string<Entity> $className
+     * @param ClassMetadata<Entity> $metadata
      */
-    public function __construct(string $className)
+    public function __construct(ClassMetadata $metadata)
     {
+        $this->metadata = $metadata;
+        $className = $metadata->getName();
         $rc = new ReflectionClass($className);
-        $this->className = $className;
-
-        if (!self::$docBlockFactory) {
-            self::$docBlockFactory = DocBlockFactory::createInstance();
-        }
-
-        foreach ($rc->getProperties() as $rp) {
-            $docComment = $rp->getDocComment();
-            assert($docComment !== false);
-
-            $docblock = self::$docBlockFactory->create($docComment);
-            // TODO: support other relations
-            // TODO: support PHP 8 annotations if Doctrine ORM ends up doing so
-            if ($docblock->hasTag('Column')) {
-                $rp->setAccessible(true);
-                $this->reflectionProperties[$rp->getName()] = $rp;
-            }
+        foreach ($metadata->getFieldNames() as $fieldName) {
+            $rp = $rc->getProperty($fieldName);
+            $rp->setAccessible(true);
+            $this->reflectionProperties[$fieldName] = $rp;
         }
     }
 
@@ -243,7 +230,7 @@ private function getValueOfProperty(object $entity, string $property)
             throw new UnexpectedValueException(sprintf(
                 'Property "%s" is not a mapped field on class "%s"',
                 $property,
-                $this->className,
+                $this->metadata->getName(),
             ));
         }
         return $this->reflectionProperties[$property]->getValue($entity);
@@ -264,7 +251,7 @@ private function sortResults(array $results, array $orderBy): array
                 throw new UnexpectedValueException(sprintf(
                     'Sort field "%s" is not a mapped field on class "%s"',
                     $property,
-                    $this->className,
+                    $this->metadata->getName(),
                 ));
             }
         }

src/CriteriaEvaluatorFactory.php

@@ -4,6 +4,8 @@
 
 namespace Firehed\Mocktrine;
 
+use Doctrine\Persistence\Mapping\ClassMetadata;
+
 use function array_key_exists;
 
 /**
@@ -19,13 +21,14 @@ class CriteriaEvaluatorFactory
     private static array $instances = [];
 
     /**
-     * @param class-string<Entity> $className
+     * @param ClassMetadata<Entity> $metadata
      * @return CriteriaEvaluator<Entity>
      */
-    public static function getInstance(string $className): CriteriaEvaluator
+    public static function getInstance(ClassMetadata $metadata): CriteriaEvaluator
     {
+        $className = $metadata->getName();
         if (!array_key_exists($className, self::$instances)) {
-            self::$instances[$className] = new CriteriaEvaluator($className);
+            self::$instances[$className] = new CriteriaEvaluator($metadata);
         }
         return self::$instances[$className];
     }

src/InMemoryEntityManager.php

@@ -4,6 +4,8 @@
 
 namespace Firehed\Mocktrine;
 
+use Doctrine\Common\Annotations\AnnotationRegistry;
+use Doctrine\Common\Annotations\SimpleAnnotationReader;
 use Doctrine\ORM\{
     Configuration,
     EntityManagerInterface,
@@ -16,12 +18,19 @@
     Query\ResultSetMapping,
     UnitOfWork,
 };
+use Doctrine\ORM\Mapping\{
+    Driver\AnnotationDriver,
+    Driver\DoctrineAnnotations,
+};
 use Doctrine\Persistence\Mapping\{
     ClassMetadata,
     ClassMetadataFactory,
+    Driver\MappingDriver,
 };
 use RuntimeException;
 
+use function class_exists;
+
 class InMemoryEntityManager implements EntityManagerInterface
 {
     /**
@@ -33,6 +42,17 @@ class InMemoryEntityManager implements EntityManagerInterface
      */
     private $repos = [];
 
+    /**
+     * Default instance, for performance
+     */
+    private static ?MappingDriver $defaultMappingDriver = null;
+
+    /**
+     * The mapping driver used for reading the Doctrine ORM mappings from
+     * entities.
+     */
+    private MappingDriver $mappingDriver;
+
     /**
      * @template Entity of object
      * @var array<class-string<Entity>, array<Entity>>
@@ -50,6 +70,20 @@ class InMemoryEntityManager implements EntityManagerInterface
      */
     private array $onFlushCallbacks = [];
 
+    public function __construct(?MappingDriver $driver = null)
+    {
+        if ($driver === null) {
+            // Doctrine's default
+            // `createAnnotationMetadataDriverConfiguration()` uses the simple
+            // annotation reader. This is configurable in Setup, but we will
+            // emulate the default case.
+            // If you would like different behavior, provide the driver
+            // directly.
+            $driver = self::getDefaultMappingDriver();
+        }
+        $this->mappingDriver = $driver;
+    }
+
     public function addOnFlushCallback(callable $callback): void
     {
         $this->onFlushCallbacks[] = $callback;
@@ -198,7 +232,6 @@ public function flush()
             }
             $idField = $repo->getIdField();
             $idType = $repo->getIdType();
-            assert($idField !== null);
             $rp = new \ReflectionProperty($className, $idField);
             $rp->setAccessible(true);
             foreach ($entities as $entity) {
@@ -228,7 +261,7 @@ public function getRepository($className)
     {
         // https://github.com/phpstan/phpstan/issues/2761
         if (!isset($this->repos[$className])) {
-            $this->repos[$className] = new InMemoryRepository($className);
+            $this->repos[$className] = new InMemoryRepository($className, $this->mappingDriver);
         }
 
         return $this->repos[$className];
@@ -631,4 +664,20 @@ public function hasFilters()
     {
         throw new RuntimeException(__METHOD__ . ' not yet implemented');
     }
+
+    private static function getDefaultMappingDriver(): MappingDriver
+    {
+        if (self::$defaultMappingDriver === null) {
+            // Hack: reproduce the logic of AnnotationRegistry::registerFile,
+            // which is a weird autoloader of sorts. By using class_exists
+            // instead of AnnotationRegistry::registerFile(), we're able to hit
+            // the file through normal Composer autoloading and avoid having to
+            // worry about the relative path to the vendor/ directory.
+            class_exists(DoctrineAnnotations::class);
+            $reader = new SimpleAnnotationReader();
+            $reader->addNamespace('Doctrine\ORM\Mapping');
+            self::$defaultMappingDriver = new AnnotationDriver($reader);
+        }
+        return self::$defaultMappingDriver;
+    }
 }