feature: allow to create objects in dataProvider thanks to lazy proxy

Author: nikophil

bin/console

@@ -2,9 +2,9 @@
 <?php
 
 use Symfony\Bundle\FrameworkBundle\Console\Application;
-use Zenstruck\Foundry\Tests\Fixtures\Kernel;
+use Zenstruck\Foundry\Tests\Fixture\TestKernel;
 
 require_once __DIR__ . '/../tests/bootstrap.php';
 
-$application = new Application(new Kernel('test', true));
+$application = new Application(new TestKernel('test', true));
 $application->run();

src/Persistence/IsProxy.php

@@ -112,6 +112,11 @@ public function _repository(): ProxyRepositoryDecorator
         return new ProxyRepositoryDecorator(parent::class);
     }
 
+    public function _initializeLazyObject(): void
+    {
+        $this->initializeLazyObject();
+    }
+
     private function _autoRefresh(): void
     {
         if (!$this->_getAutoRefresh()) {

src/Persistence/PersistentObjectFactory.php

@@ -203,7 +203,10 @@ final public static function truncate(): void
         static::repository()->truncate();
     }
 
-    final public function create(callable|array $attributes = []): object
+    /**
+     * @final
+     */
+    public function create(callable|array $attributes = []): object
     {
         $object = parent::create($attributes);
 

src/Persistence/PersistentProxyObjectFactory.php

@@ -13,6 +13,7 @@
 
 use Doctrine\Persistence\ObjectRepository;
 use Zenstruck\Foundry\Configuration;
+use Zenstruck\Foundry\Exception\FoundryNotBooted;
 use Zenstruck\Foundry\Factory;
 use Zenstruck\Foundry\Object\Instantiator;
 use Zenstruck\Foundry\FactoryCollection; // keep me!
@@ -36,6 +37,18 @@
  */
 abstract class PersistentProxyObjectFactory extends PersistentObjectFactory
 {
+    /**
+     * @return T&Proxy<T>
+     */
+    final public function create(callable|array $attributes = []): object
+    {
+        try {
+            return parent::create($attributes);
+        } catch (FoundryNotBooted) {
+            return ProxyGenerator::wrapFactory($this, $attributes);
+        }
+    }
+
     /**
      * @return class-string<T>
      */

src/Persistence/Proxy.php

@@ -49,4 +49,9 @@ public function _real(): object;
      * @return ProxyRepositoryDecorator<T,ObjectRepository<T>>
      */
     public function _repository(): ProxyRepositoryDecorator;
+
+    /**
+     * @internal
+     */
+    public function _initializeLazyObject(): void;
 }

src/Persistence/ProxyGenerator.php

@@ -15,11 +15,14 @@
 use Symfony\Component\VarExporter\LazyObjectInterface;
 use Symfony\Component\VarExporter\LazyProxyTrait;
 use Symfony\Component\VarExporter\ProxyHelper;
+use Zenstruck\Foundry\Factory;
 
 /**
  * @author Kevin Bond <[email protected]>
  *
  * @internal
+ *
+ * @phpstan-import-type Attributes from Factory
  */
 final class ProxyGenerator
 {
@@ -43,6 +46,19 @@ public static function wrap(object $object): Proxy
         return self::generateClassFor($object)::createLazyProxy(static fn() => $object); // @phpstan-ignore-line
     }
 
+    /**
+     * @template T of object
+     *
+     * @param PersistentProxyObjectFactory<T> $factory
+     * @phpstan-param Attributes $attributes
+     *
+     * @return T&Proxy<T>
+     */
+    public static function wrapFactory(PersistentProxyObjectFactory $factory, callable|array $attributes): Proxy
+    {
+        return self::generateClassFor($factory)::createLazyProxy(static fn() => $factory->create($attributes)); // @phpstan-ignore-line
+    }
+
     /**
      * @template T
      *
@@ -76,8 +92,8 @@ public static function unwrap(mixed $what): mixed
      */
     private static function generateClassFor(object $object): string
     {
-        /** @var class-string $class */
-        $class = $object instanceof DoctrineProxy ? \get_parent_class($object) : $object::class;
+        $class = self::extractClassName($object);
+
         $proxyClass = self::proxyClassNameFor($class);
 
         /** @var class-string<LazyObjectInterface&Proxy<T>&T> $proxyClass */
@@ -151,4 +167,16 @@ public static function proxyClassNameFor(string $class): string
     {
         return \str_replace('\\', '', $class).'Proxy';
     }
+
+    /**
+     * @return class-string
+     */
+    private static function extractClassName(object $object): string
+    {
+        if ($object instanceof PersistentProxyObjectFactory) {
+            return $object::class();
+        }
+
+        return $object instanceof DoctrineProxy ? \get_parent_class($object) : $object::class; // @phpstan-ignore return.type
+    }
 }

src/Persistence/functions.php

@@ -171,3 +171,12 @@ function enable_persisting(): void
 {
     Configuration::instance()->persistence()->enablePersisting();
 }
+
+function initialize_proxy_object(mixed $what): void
+{
+    match(true) {
+        $what instanceof Proxy => $what->_initializeLazyObject(),
+        is_array($what) => array_map(initialize_proxy_object(...), $what),
+        default => true // do nothing
+    };
+}

src/Test/Factories.php

@@ -14,7 +14,11 @@
 use PHPUnit\Framework\Attributes\After;
 use PHPUnit\Framework\Attributes\Before;
 use Symfony\Bundle\FrameworkBundle\Test\KernelTestCase;
+use Symfony\Component\VarExporter\LazyObjectInterface;
+use Webmozart\Assert\Assert;
 use Zenstruck\Foundry\Configuration;
+use Zenstruck\Foundry\Persistence\Proxy;
+use function Zenstruck\Foundry\Persistence\initialize_proxy_object;
 
 /**
  * @author Kevin Bond <[email protected]>
@@ -26,7 +30,16 @@ trait Factories
      * @before
      */
     #[Before]
-    public static function _bootFoundry(): void
+    public function _beforeHook(): void
+    {
+        $this->_bootFoundry();
+        $this->_loadDataProvidedProxies();
+    }
+
+    /**
+     * @internal
+     */
+    private function _bootFoundry(): void
     {
         if (!\is_subclass_of(static::class, KernelTestCase::class)) { // @phpstan-ignore-line
             // unit test
@@ -46,6 +59,20 @@ public static function _bootFoundry(): void
         });
     }
 
+    /**
+     * @internal
+     */
+    private function _loadDataProvidedProxies(): void
+    {
+        if (!\is_subclass_of(static::class, KernelTestCase::class)) { // @phpstan-ignore-line
+            return;
+        }
+
+        $providedData = method_exists($this, 'getProvidedData') ? $this->getProvidedData() : $this->providedData(); // @phpstan-ignore method.notFound
+
+        initialize_proxy_object($providedData);
+    }
+
     /**
      * @internal
      * @after

src/ZenstruckFoundryBundle.php

@@ -244,6 +244,11 @@ public function process(ContainerBuilder $container): void
         }
     }
 
+    public function shutdown(): void
+    {
+        Configuration::shutdown();
+    }
+
     /**
      * @param string[] $values
      */

tests/Integration/Mongo/GenericDocumentFactoryTest.php

@@ -23,7 +23,7 @@ final class GenericDocumentFactoryTest extends GenericFactoryTestCase
 {
     use RequiresMongo;
 
-    protected function factory(): GenericModelFactory
+    protected static function factory(): GenericDocumentFactory
     {
         return GenericDocumentFactory::new();
     }

tests/Integration/Mongo/GenericDocumentProxyFactoryTest.php

@@ -26,7 +26,7 @@ final class GenericDocumentProxyFactoryTest extends GenericProxyFactoryTestCase
 {
     use RequiresMongo;
 
-    protected function factory(): PersistentProxyObjectFactory
+    protected static function factory(): GenericProxyDocumentFactory
     {
         return GenericProxyDocumentFactory::new();
     }

tests/Integration/ORM/GenericEntityFactoryTest.php

@@ -23,7 +23,7 @@ final class GenericEntityFactoryTest extends GenericFactoryTestCase
 {
     use RequiresORM;
 
-    protected function factory(): GenericModelFactory
+    protected static function factory(): GenericEntityFactory
     {
         return GenericEntityFactory::new();
     }

tests/Integration/ORM/GenericEntityProxyFactoryTest.php

@@ -26,7 +26,7 @@ final class GenericEntityProxyFactoryTest extends GenericProxyFactoryTestCase
 {
     use RequiresORM;
 
-    protected function factory(): PersistentProxyObjectFactory
+    protected static function factory(): GenericProxyEntityFactory
     {
         return GenericProxyEntityFactory::new();
     }