[feature] allow factories to be defined as services (#53)

Author: kbond

README.md

@@ -35,8 +35,9 @@ to load fixtures or inside your tests, [where it has even more features](#using-
     8. [Instantiation](#instantiation)
     9. [Immutable](#immutable)
     10. [Doctrine Relationships](#doctrine-relationships)
-    11. [Anonymous Factories](#anonymous-factories)
-    12. [Without Persisting](#without-persisting)
+    11. [Factories as Services](#factories-as-services)
+    12. [Anonymous Factories](#anonymous-factories)
+    13. [Without Persisting](#without-persisting)
 4. [Using with DoctrineFixturesBundle](#using-with-doctrinefixturesbundle)
 5. [Using in your Tests](#using-in-your-tests)
     1. [Enable Foundry in your TestCase](#enable-foundry-in-your-testcase)
@@ -199,6 +200,13 @@ use Zenstruck\Foundry\Proxy;
  */
 final class PostFactory extends ModelFactory
 {
+    public function __construct()
+    {
+        parent::__construct();
+
+        // TODO inject services if required (https://github.com/zenstruck/foundry#factories-as-services)
+    }
+
     protected function getDefaults(): array
     {
         return [
@@ -277,6 +285,9 @@ $posts = PostFactory::randomSet(4); // array containing 4 "Post|Proxy" objects
 $posts = PostFactory::randomRange(0, 5); // array containing 0-5 "Post|Proxy" objects
 ```
 
+**WARNING**: Never instantiate your `ModelFactory` with the constructor (ie `new PostFactory()`). This will
+cause the factory to not be instantiated properly. Always instantiate with `PostFactory::new()`.
+
 ### Reusable Model Factory "States"
 
 You can add any methods you want to your model factories (ie static methods that create an object in a certain way) but
@@ -680,6 +691,71 @@ PostFactory::new()->many(3)->create(['tags' => TagFactory::new()->many(3)]);
 PostFactory::new()->many(3)->create(['tags' => TagFactory::new()->many(0, 3)]);
 ```
 
+### Factories as Services
+
+If your factories require dependencies, you can define them as a service. The following example demonstrates a very
+common use-case: encoding a password with the `UserPasswordEncoderInterface` service.
+
+```php
+// src/Factory/UserFactory.php
+
+namespace App\Story;
+
+use App\Entity\User;
+use Symfony\Component\Security\Core\Encoder\UserPasswordEncoderInterface;
+use Zenstruck\Foundry\ModelFactory;
+
+final class UserFactory extends ModelFactory
+{
+    private $passwordEncoder;
+
+    public function __construct(UserPasswordEncoderInterface $passwordEncoder)
+    {
+        parent::__construct();
+
+        $this->passwordEncoder = $passwordEncoder;
+    }
+
+    protected function getDefaults(): array
+    {
+        return [
+            'email' => self::faker()->unique()->safeEmail,
+            'password' => '1234',
+        ];
+    }
+
+    protected function initialize(): self
+    {
+        return $this
+            ->afterInstantiate(function(User $user) {
+                $user->setPassword($this->passwordEncoder->encodePassword($user, $user->getPassword()));
+            })
+        ;
+    }
+
+    protected static function getClass(): string
+    {
+        return User::class;
+    }
+}
+```
+
+If using a standard Symfony Flex app, this will be autowired/autoconfigured. If not, register the service and tag
+with `foundry.factory`.
+
+Use the factory as normal:
+
+```php
+UserFactory::new()->create(['password' => 'mypass'])->getPassword(); // "mypass" encoded
+UserFactory::new()->create()->getPassword(); // "1234" encoded (because "1234" is set as the default password)
+```
+
+**NOTES**:
+1. The provided bundle is required for factories as services.
+2. If using `make:factory --test`, factories will be created in the `tests/Factory` directory which is not
+autowired/autoconfigured in a standard Symfony Flex app. You will have to manually register these as
+services.
+
 ### Anonymous Factories
 
 Foundry can be used to create factories for entities that you don't have model factories for:
@@ -1172,6 +1248,27 @@ these tests to be unnecessarily slow. You can improve the speed by reducing the
             memory_cost: 10 # Lowest possible value for argon
     ```
 
+3. Pre-encode user passwords with a known value via `bin/console security:encode-password` and set this in
+`ModelFactory::getDefaults()`. Add the known value as a `const` on your factory:
+
+    ```php
+    class UserFactory extends ModelFactory
+    {
+        public const DEFAULT_PASSWORD = '1234'; // the password used to create the pre-encoded version below
+    
+        protected function getDefaults(): array
+        {
+            return [
+                // ...
+                'password' => '$argon2id$v=19$m=65536,t=4,p=1$pLFF3D2gnvDmxMuuqH4BrA$3vKfv0cw+6EaNspq9btVAYc+jCOqrmWRstInB2fRPeQ',
+            ];
+        }
+    }
+    ```
+
+    Now, in your tests, when you need access to the unencoded password for a user created with `UserFactory`, use
+    `UserFactory::DEFAULT_PASSWORD`.
+
 ### Using without the Bundle
 
 The provided bundle is not strictly required to use Foundry for tests. You can have all your factories, stories, and
@@ -1262,7 +1359,7 @@ PostStory::load(); // does nothing - already loaded
 
 ### Stories as Services
 
-If you stories require dependencies, you can define them as a service:
+If your stories require dependencies, you can define them as a service:
 
 ```php
 // src/Story/PostStory.php

src/Bundle/DependencyInjection/ZenstruckFoundryExtension.php

@@ -7,6 +7,7 @@
 use Symfony\Component\DependencyInjection\Loader\XmlFileLoader;
 use Symfony\Component\HttpKernel\DependencyInjection\ConfigurableExtension;
 use Zenstruck\Foundry\Configuration;
+use Zenstruck\Foundry\ModelFactory;
 use Zenstruck\Foundry\Story;
 
 /**
@@ -24,6 +25,10 @@ protected function loadInternal(array $mergedConfig, ContainerBuilder $container
             ->addTag('foundry.story')
         ;
 
+        $container->registerForAutoconfiguration(ModelFactory::class)
+            ->addTag('foundry.factory')
+        ;
+
         $this->configureFaker($mergedConfig['faker'], $container);
         $this->configureDefaultInstantiator($mergedConfig['instantiator'], $container);
 

src/Bundle/Resources/config/services.xml

@@ -13,6 +13,7 @@
         <service id="Zenstruck\Foundry\Configuration" public="true">
             <argument type="service" id="doctrine" />
             <argument type="service" id="Zenstruck\Foundry\StoryManager" />
+            <argument type="service" id="Zenstruck\Foundry\ModelFactoryManager" />
             <call method="setInstantiator">
                 <argument type="service" id="zenstruck_foundry.default_instantiator" />
             </call>
@@ -25,6 +26,10 @@
             <argument type="tagged_iterator" tag="foundry.story" />
         </service>
 
+        <service id="Zenstruck\Foundry\ModelFactoryManager">
+            <argument type="tagged_iterator" tag="foundry.factory" />
+        </service>
+
         <service id="Zenstruck\Foundry\Bundle\Maker\MakeFactory">
             <argument type="service" id="doctrine" />
             <tag name="maker.command" />

src/Bundle/Resources/skeleton/Factory.tpl.php

@@ -21,6 +21,13 @@
  */
 final class <?= $class_name ?> extends ModelFactory
 {
+    public function __construct()
+    {
+        parent::__construct();
+
+        // TODO inject services if required (https://github.com/zenstruck/foundry#factories-as-services)
+    }
+
     protected function getDefaults(): array
     {
         return [

src/Configuration.php

@@ -19,6 +19,9 @@ final class Configuration
     /** @var StoryManager */
     private $stories;
 
+    /** @var ModelFactoryManager */
+    private $factories;
+
     /** @var Faker\Generator */
     private $faker;
 
@@ -28,10 +31,11 @@ final class Configuration
     /** @var bool */
     private $defaultProxyAutoRefresh = false;
 
-    public function __construct(ManagerRegistry $managerRegistry, StoryManager $storyManager)
+    public function __construct(ManagerRegistry $managerRegistry, StoryManager $storyManager, ModelFactoryManager $factories)
     {
         $this->managerRegistry = $managerRegistry;
         $this->stories = $storyManager;
+        $this->factories = $factories;
         $this->faker = Faker\Factory::create();
         $this->instantiator = new Instantiator();
     }
@@ -41,6 +45,11 @@ public function stories(): StoryManager
         return $this->stories;
     }
 
+    public function factories(): ModelFactoryManager
+    {
+        return $this->factories;
+    }
+
     public function faker(): Faker\Generator
     {
         return $this->faker;

src/ModelFactory.php

@@ -7,7 +7,7 @@
  */
 abstract class ModelFactory extends Factory
 {
-    private function __construct()
+    public function __construct()
     {
         parent::__construct(static::getClass());
     }
@@ -23,7 +23,7 @@ final public static function new($defaultAttributes = [], string ...$states): se
             $defaultAttributes = [];
         }
 
-        $factory = new static();
+        $factory = self::configuration()->factories()->create(static::class);
         $factory = $factory
             ->withAttributes([$factory, 'getDefaults'])
             ->withAttributes($defaultAttributes)

src/ModelFactoryManager.php

@@ -0,0 +1,32 @@
+<?php
+
+namespace Zenstruck\Foundry;
+
+/**
+ * @internal
+ *
+ * @author Kevin Bond <kevinbond@gmail.com>
+ */
+final class ModelFactoryManager
+{
+    private $factories;
+
+    /**
+     * @param ModelFactory[] $factories
+     */
+    public function __construct(iterable $factories)
+    {
+        $this->factories = $factories;
+    }
+
+    public function create(string $class): ModelFactory
+    {
+        foreach ($this->factories as $factory) {
+            if ($class === \get_class($factory)) {
+                return $factory;
+            }
+        }
+
+        return new $class();
+    }
+}

src/Test/TestState.php

@@ -7,6 +7,7 @@
 use Psr\Container\NotFoundExceptionInterface;
 use Zenstruck\Foundry\Configuration;
 use Zenstruck\Foundry\Factory;
+use Zenstruck\Foundry\ModelFactoryManager;
 use Zenstruck\Foundry\StoryManager;
 
 /**
@@ -87,7 +88,7 @@ public static function bootFromContainer(ContainerInterface $container): Configu
         }
 
         try {
-            return self::bootFactory(new Configuration($container->get('doctrine'), new StoryManager([])));
+            return self::bootFactory(new Configuration($container->get('doctrine'), new StoryManager([]), new ModelFactoryManager([])));
         } catch (NotFoundExceptionInterface $e) {
             throw new \LogicException('Could not boot Foundry, is the DoctrineBundle installed/configured?', 0, $e);
         }

tests/Fixtures/Factories/CategoryServiceFactory.php

@@ -0,0 +1,32 @@
+<?php
+
+namespace Zenstruck\Foundry\Tests\Fixtures\Factories;
+
+use Zenstruck\Foundry\ModelFactory;
+use Zenstruck\Foundry\Tests\Fixtures\Entity\Category;
+use Zenstruck\Foundry\Tests\Fixtures\Service;
+
+/**
+ * @author Kevin Bond <kevinbond@gmail.com>
+ */
+final class CategoryServiceFactory extends ModelFactory
+{
+    private $service;
+
+    public function __construct(Service $service)
+    {
+        parent::__construct();
+
+        $this->service = $service;
+    }
+
+    protected static function getClass(): string
+    {
+        return Category::class;
+    }
+
+    protected function getDefaults(): array
+    {
+        return ['name' => $this->service->name];
+    }
+}

tests/Fixtures/Kernel.php

@@ -12,6 +12,8 @@
 use Symfony\Component\DependencyInjection\ContainerBuilder;
 use Symfony\Component\HttpKernel\Kernel as BaseKernel;
 use Symfony\Component\Routing\RouteCollectionBuilder;
+use Zenstruck\Foundry\Tests\Fixtures\Factories\CategoryFactory;
+use Zenstruck\Foundry\Tests\Fixtures\Factories\CategoryServiceFactory;
 use Zenstruck\Foundry\Tests\Fixtures\Stories\ServiceStory;
 use Zenstruck\Foundry\ZenstruckFoundryBundle;
 
@@ -56,6 +58,14 @@ protected function configureContainer(ContainerBuilder $c, LoaderInterface $load
             ->setAutoconfigured(true)
             ->setAutowired(true)
         ;
+        $c->register(CategoryFactory::class)
+            ->setAutoconfigured(true)
+            ->setAutowired(true)
+        ;
+        $c->register(CategoryServiceFactory::class)
+            ->setAutoconfigured(true)
+            ->setAutowired(true)
+        ;
 
         $c->loadFromExtension('framework', [
             'secret' => 'S3CRET',