feat: introduce "in-memory" behavior

composer.json

@@ -44,7 +44,12 @@
     },
     "autoload": {
         "psr-4": { "Zenstruck\\Foundry\\": "src/" },
-        "files": ["src/functions.php", "src/Persistence/functions.php", "src/phpunit_helper.php"]
+        "files": [
+            "src/functions.php",
+            "src/Persistence/functions.php",
+            "src/phpunit_helper.php",
+            "src/InMemory/functions.php"
+        ]
     },
     "autoload-dev": {
         "psr-4": {

src/Configuration.php

@@ -36,11 +36,13 @@ final class Configuration
     /** @var \Closure():self|self|null */
     private static \Closure|self|null $instance = null;
 
+    private bool $inMemory = false;
+
     /**
      * @param InstantiatorCallable $instantiator
      */
     public function __construct(
-        public readonly FactoryRegistry $factories,
+        public readonly FactoryRegistryInterface $factories,
         public readonly Faker\Generator $faker,
         callable $instantiator,
         public readonly StoryRegistry $stories,
@@ -90,4 +92,14 @@ public static function shutdown(): void
         StoryRegistry::reset();
         self::$instance = null;
     }
+
+    public function enableInMemory(): void
+    {
+        $this->inMemory = true;
+    }
+
+    public function isInMemoryEnabled(): bool
+    {
+        return $this->inMemory;
+    }
 }

src/Exception/CannotCreateFactory.php

@@ -0,0 +1,16 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Zenstruck\Foundry\Exception;
+
+/**
+ * @author Nicolas PHILIPPE <nikophil@gmail.com>
+ */
+final class CannotCreateFactory extends \LogicException
+{
+    public static function argumentCountError(\ArgumentCountError $e): static
+    {
+        return new self('Factories with dependencies (services) cannot be created before foundry is booted.', previous: $e);
+    }
+}

src/Factory.php

@@ -12,6 +12,7 @@
 namespace Zenstruck\Foundry;
 
 use Faker;
+use Zenstruck\Foundry\Exception\CannotCreateFactory;
 
 /**
  * @author Kevin Bond <kevinbond@gmail.com>
@@ -33,7 +34,6 @@ public function __construct()
     {
     }
 
-
     /**
      * @param Attributes $attributes
      */
@@ -46,7 +46,7 @@ final public static function new(array|callable $attributes = []): static
         try {
             $factory ??= new static(); // @phpstan-ignore-line
         } catch (\ArgumentCountError $e) {
-            throw new \LogicException('Factories with dependencies (services) cannot be created before foundry is booted.', previous: $e);
+            throw CannotCreateFactory::argumentCountError($e);
         }
 
         return $factory->initialize()->with($attributes);

src/FactoryRegistry.php

@@ -11,12 +11,14 @@
 
 namespace Zenstruck\Foundry;
 
+use Zenstruck\Foundry\Exception\CannotCreateFactory;
+
 /**
  * @author Kevin Bond <kevinbond@gmail.com>
  *
  * @internal
  */
-final class FactoryRegistry
+final class FactoryRegistry implements FactoryRegistryInterface
 {
     /**
      * @param Factory<mixed>[] $factories
@@ -25,21 +27,18 @@ public function __construct(private iterable $factories)
     {
     }
 
-    /**
-     * @template T of Factory
-     *
-     * @param class-string<T> $class
-     *
-     * @return T|null
-     */
-    public function get(string $class): ?Factory
+    public function get(string $class): Factory
     {
         foreach ($this->factories as $factory) {
             if ($class === $factory::class) {
                 return $factory; // @phpstan-ignore-line
             }
         }
 
-        return null;
+        try {
+            return new $class();
+        } catch (\ArgumentCountError $e) {
+            throw CannotCreateFactory::argumentCountError($e);
+        }
     }
 }

src/FactoryRegistryInterface.php

@@ -0,0 +1,29 @@
+<?php
+
+/*
+ * This file is part of the zenstruck/foundry package.
+ *
+ * (c) Kevin Bond <kevinbond@gmail.com>
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
+
+namespace Zenstruck\Foundry;
+
+/**
+ * @author Nicolas PHILIPPE <nikophil@gmail.com>
+ *
+ * @internal
+ */
+interface FactoryRegistryInterface
+{
+    /**
+     * @template T of Factory
+     *
+     * @param class-string<T> $class
+     *
+     * @return T
+     */
+    public function get(string $class): Factory;
+}

src/InMemory/AsInMemoryRepository.php

@@ -0,0 +1,22 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Zenstruck\Foundry\InMemory;
+
+// todo: remove this attribute in favor to interface?
+#[\Attribute(\Attribute::TARGET_CLASS)]
+/**
+ * @author Nicolas PHILIPPE <nikophil@gmail.com>
+ */
+final class AsInMemoryRepository
+{
+    public function __construct(
+        public readonly string $class
+    )
+    {
+        if (!class_exists($this->class)) {
+            throw new \InvalidArgumentException("Wrong definition for \"AsInMemoryRepository\" attribute: class \"{$this->class}\" does not exist.");
+        }
+    }
+}

src/InMemory/DependencyInjection/InMemoryCompilerPass.php

@@ -0,0 +1,52 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Zenstruck\Foundry\InMemory\DependencyInjection;
+
+use Symfony\Component\DependencyInjection\Compiler\CompilerPassInterface;
+use Symfony\Component\DependencyInjection\Compiler\ServiceLocatorTagPass;
+use Symfony\Component\DependencyInjection\ContainerBuilder;
+use Symfony\Component\DependencyInjection\Reference;
+use Zenstruck\Foundry\InMemory\InMemoryFactoryRegistry;
+
+/**
+ * @internal
+ * @author Nicolas PHILIPPE <nikophil@gmail.com>
+ */
+final class InMemoryCompilerPass implements CompilerPassInterface
+{
+    public function process(ContainerBuilder $container): void
+    {
+        // create a service locator with all "in memory" repositories, indexed by target class
+        $inMemoryRepositoriesServices = $container->findTaggedServiceIds('foundry.in_memory.repository');
+        $inMemoryRepositoriesLocator = ServiceLocatorTagPass::register(
+            $container,
+            array_combine(
+                array_map(
+                    static function (array $tags) {
+                        if (\count($tags) !== 1) {
+                            throw new \LogicException('Cannot have multiple tags "foundry.in_memory.repository" on a service!');
+                        }
+
+                        return $tags[0]['class'] ?? throw new \LogicException('Invalid tag definition of "foundry.in_memory.repository".');
+                    },
+                    array_values($inMemoryRepositoriesServices)
+                ),
+                array_map(
+                    static fn(string $inMemoryRepositoryId) => new Reference($inMemoryRepositoryId),
+                    array_keys($inMemoryRepositoriesServices)
+                ),
+            )
+        );
+
+        // todo: should we check we only have a 1 repository per class?
+
+        $container->register('.zenstruck_foundry.in_memory.factory_registry')
+            ->setClass(InMemoryFactoryRegistry::class)
+            ->setDecoratedService('.zenstruck_foundry.factory_registry')
+            ->setArgument('$decorated', $container->getDefinition('.zenstruck_foundry.factory_registry'))
+            ->setArgument('$inMemoryRepositories', $inMemoryRepositoriesLocator)
+        ;
+    }
+}

src/InMemory/GenericInMemoryRepository.php

@@ -0,0 +1,43 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Zenstruck\Foundry\InMemory;
+
+/**
+ * @template T of object
+ * @implements InMemoryRepository<T>
+ * @author Nicolas PHILIPPE <nikophil@gmail.com>
+ *
+ * This class will be used when a specific "in-memory" repository does not exist for a given class.
+ */
+final class GenericInMemoryRepository implements InMemoryRepository
+{
+    /**
+     * @var list<T>
+     */
+    private array $elements = [];
+
+    /**
+     * @param class-string<T> $class
+     */
+    public function __construct(
+        private readonly string $class
+    )
+    {
+    }
+
+    /**
+     * @param T $element
+     */
+    public function _save(object $element): void
+    {
+        if (!$element instanceof $this->class) {
+            throw new \InvalidArgumentException(sprintf('Given object of class "%s" is not an instance of expected "%s"', $element::class, $this->class));
+        }
+
+        if (!in_array($element, $this->elements, true)) {
+            $this->elements[] = $element;
+        }
+    }
+}

src/InMemory/InMemoryFactoryRegistry.php

@@ -0,0 +1,73 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Zenstruck\Foundry\InMemory;
+
+use Symfony\Component\DependencyInjection\ServiceLocator;
+use Zenstruck\Foundry\Configuration;
+use Zenstruck\Foundry\Factory;
+use Zenstruck\Foundry\FactoryRegistryInterface;
+use Zenstruck\Foundry\Persistence\PersistentObjectFactory;
+
+/**
+ * @internal
+ * @template T of object
+ * @author Nicolas PHILIPPE <nikophil@gmail.com>
+ */
+final class InMemoryFactoryRegistry implements FactoryRegistryInterface
+{
+    /**
+     * @var array<class-string<T>, GenericInMemoryRepository<T>>
+     */
+    private array $genericInMemoryRepositories = [];
+
+    public function __construct( // @phpstan-ignore-line
+        private readonly FactoryRegistryInterface $decorated,
+        /** @var ServiceLocator<InMemoryRepository> */
+        private readonly ServiceLocator $inMemoryRepositories,
+    ) {
+    }
+
+    /**
+     * @template TFactory of Factory
+     *
+     * @param class-string<TFactory> $class
+     *
+     * @return TFactory
+     */
+    public function get(string $class): Factory
+    {
+        $factory = $this->decorated->get($class);
+
+        if (!$factory instanceof PersistentObjectFactory) { // todo shall we support ObjectFactory as well?
+            return $factory;
+        }
+
+        $configuration = Configuration::instance();
+
+        if (!$configuration->isInMemoryEnabled()) {
+            return $factory;
+        }
+
+        return $factory->withoutPersisting()
+            ->afterInstantiate(
+                fn(object $object) => $this->findInMemoryRepository($factory)->_save($object) // @phpstan-ignore-line
+            );
+    }
+
+    /**
+     * @param PersistentObjectFactory<T> $factory
+     *
+     * @return InMemoryRepository<T>
+     */
+    private function findInMemoryRepository(PersistentObjectFactory $factory): InMemoryRepository
+    {
+        $targetClass = $factory::class();
+        if (!$this->inMemoryRepositories->has($targetClass)) {
+            return $this->genericInMemoryRepositories[$targetClass] ??= new GenericInMemoryRepository($targetClass);
+        }
+
+        return $this->inMemoryRepositories->get($targetClass);
+    }
+}

src/InMemory/InMemoryRepository.php

@@ -0,0 +1,18 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Zenstruck\Foundry\InMemory;
+
+/**
+ * @author Nicolas PHILIPPE <nikophil@gmail.com>
+ *
+ * @template T of object
+ */
+interface InMemoryRepository
+{
+    /**
+     * @param T $element
+     */
+    public function _save(object $element): void;
+}

src/InMemory/functions.php

@@ -0,0 +1,22 @@
+<?php
+
+/*
+ * This file is part of the zenstruck/foundry package.
+ *
+ * (c) Kevin Bond <kevinbond@gmail.com>
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
+
+namespace Zenstruck\Foundry\InMemory;
+
+use Zenstruck\Foundry\Configuration;
+
+/**
+ * Enable "in memory" repositories globally.
+ */
+function enable_in_memory(): void
+{
+    Configuration::instance()->enableInMemory();
+}