feat: skip readonly properties on entities when generating factories

composer.json

@@ -22,6 +22,7 @@
         "symfony/deprecation-contracts": "^2.2|^3.0",
         "symfony/framework-bundle": "^6.4|^7.0",
         "symfony/property-access": "^6.4|^7.0",
+        "symfony/property-info": "^6.4|^7.0",
         "symfony/var-exporter": "^6.4.9|~7.0.9|^7.1.2",
         "zenstruck/assert": "^1.4"
     },

src/Maker/Factory/FactoryGenerator.php

@@ -32,6 +32,9 @@ final class FactoryGenerator
     public const PHPSTAN_PATH = '/vendor/phpstan/phpstan/phpstan';
     public const PSALM_PATH = '/vendor/vimeo/psalm/psalm';
 
+    /** @var string[]|true */
+    private array|bool $forceProperties = [];
+
     /** @param \Traversable<int, DefaultPropertiesGuesser> $defaultPropertiesGuessers */
     public function __construct(
         private ?PersistenceManager $persistenceManager,
@@ -150,6 +153,7 @@ private function createMakeFactoryData(Generator $generator, string $class, Make
             $this->staticAnalysisTool(),
             $persisted ?? false,
             $makeFactoryQuery->addPhpDoc(),
+            $this->forceProperties
         );
     }
 
@@ -161,4 +165,12 @@ private function staticAnalysisTool(): string
             default => MakeFactoryData::STATIC_ANALYSIS_TOOL_NONE,
         };
     }
+
+    public function alwaysForce(string ...$properties): self
+    {
+        $clone = clone $this;
+        $clone->forceProperties = $properties ?: true;
+
+        return $clone;
+    }
 }

src/Maker/Factory/MakeFactoryData.php

@@ -16,7 +16,8 @@
 use Symfony\Bundle\MakerBundle\Str;
 use Symfony\Bundle\MakerBundle\Util\ClassNameDetails;
 use Symfony\Component\PropertyInfo\Extractor\ReflectionExtractor;
-use Symfony\Component\PropertyInfo\PropertyInfoExtractor;
+use Symfony\Component\PropertyInfo\PropertyAccessExtractorInterface;
+use Symfony\Component\PropertyInfo\PropertyInitializableExtractorInterface;
 use Zenstruck\Foundry\ObjectFactory;
 use Zenstruck\Foundry\Persistence\PersistentProxyObjectFactory;
 use Zenstruck\Foundry\Persistence\Proxy;
@@ -31,13 +32,19 @@ final class MakeFactoryData
     public const STATIC_ANALYSIS_TOOL_PHPSTAN = 'phpstan';
     public const STATIC_ANALYSIS_TOOL_PSALM = 'psalm';
 
+    /**
+     * @var null|PropertyAccessExtractorInterface&PropertyInitializableExtractorInterface
+     */
+    private static mixed $propertyInfo = null;
+
     /** @var list<string> */
     private array $uses;
     /** @var array<string, string> */
     private array $defaultProperties = [];
     /** @var list<MakeFactoryPHPDocMethod> */
     private array $methodsInPHPDoc;
-    private PropertyInfoExtractor $propertyInfo;
+    /** @var string[]|true */
+    private array|bool $forceProperties;
 
     public function __construct(
         private \ReflectionClass $object,
@@ -46,6 +53,7 @@ public function __construct(
         private string $staticAnalysisTool,
         private bool $persisted,
         bool $withPhpDoc,
+        array|bool $forceProperties
     ) {
         $this->uses = [
             $this->getFactoryClass(),
@@ -65,14 +73,7 @@ public function __construct(
         }
 
         $this->methodsInPHPDoc = $withPhpDoc ? MakeFactoryPHPDocMethod::createAll($this) : [];
-        $reflectionExtractor = new ReflectionExtractor();
-        $this->propertyInfo = new PropertyInfoExtractor(
-            [],
-            [],
-            [],
-            [$reflectionExtractor],
-            [$reflectionExtractor]
-        );
+        $this->forceProperties = $forceProperties;
     }
 
     // @phpstan-ignore-next-line
@@ -167,12 +168,17 @@ public function getDefaultProperties(): array
         $defaultProperties = $this->defaultProperties;
         $clazz = $this->object->getName();
 
-        foreach ($defaultProperties as $propertyName => $propertyDefault) {
-            if ($this->propertyInfo->isWritable($clazz, $propertyName) || $this->propertyInfo->isInitializable($clazz, $propertyName)) {
-                continue;
+        $defaultProperties = array_filter($defaultProperties, function (string $propertyName) use ($clazz): bool {
+            if (true === $this->forceProperties) {
+                return true;
             }
-            unset($defaultProperties[$propertyName]);
-        }
+
+            if (is_array($this->forceProperties) && \in_array($propertyName, $this->forceProperties, true)) {
+                return true;
+            }
+
+            return self::propertyInfo()->isWritable($clazz, $propertyName) || self::propertyInfo()->isInitializable($clazz, $propertyName);
+        }, ARRAY_FILTER_USE_KEY);
 
         \ksort($defaultProperties);
 
@@ -209,4 +215,9 @@ public function addEnumDefaultProperty(string $propertyName, string $enumClass):
             "self::faker()->randomElement({$enumShortClassName}::cases()),",
         );
     }
+
+    private static function propertyInfo(): PropertyAccessExtractorInterface&PropertyInitializableExtractorInterface
+    {
+        return self::$propertyInfo ??= new ReflectionExtractor();
+    }
 }

src/ZenstruckFoundryBundle.php

@@ -341,6 +341,9 @@ private function configureInstantiator(array $config, ContainerBuilder $containe
             $container->getDefinition('.zenstruck_foundry.instantiator')
                 ->addMethodCall('alwaysForce', returnsClone: true)
             ;
+            $container->getDefinition('.zenstruck_foundry.maker.factory.generator')
+                ->addMethodCall('alwaysForce', returnsClone: true)
+            ;
         }
     }
 

tests/Fixture/Maker/expected/does_force_initialization_of_non_settable_with_always_force.php

@@ -0,0 +1,59 @@
+<?php
+
+/*
+ * This file is part of the zenstruck/foundry package.
+ *
+ * (c) Kevin Bond <[email protected]>
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
+
+namespace App\Factory;
+
+use Zenstruck\Foundry\ObjectFactory;
+use Zenstruck\Foundry\Tests\Fixture\ObjectWithNonWriteable;
+
+/**
+ * @extends ObjectFactory<ObjectWithNonWriteable>
+ */
+final class ObjectWithNonWriteableFactory extends ObjectFactory
+{
+    /**
+     * @see https://symfony.com/bundles/ZenstruckFoundryBundle/current/index.html#factories-as-services
+     *
+     * @todo inject services if required
+     */
+    public function __construct()
+    {
+    }
+
+    public static function class(): string
+    {
+        return ObjectWithNonWriteable::class;
+    }
+
+    /**
+     * @see https://symfony.com/bundles/ZenstruckFoundryBundle/current/index.html#model-factories
+     *
+     * @todo add your default values here
+     */
+    protected function defaults(): array|callable
+    {
+        return [
+            'baz' => self::faker()->sentence(),
+            'bar' => self::faker()->sentence(),
+            'foo' => self::faker()->sentence(),
+        ];
+    }
+
+    /**
+     * @see https://symfony.com/bundles/ZenstruckFoundryBundle/current/index.html#initialization
+     */
+    protected function initialize(): static
+    {
+        return $this
+            // ->afterInstantiate(function(ObjectWithNonWriteable $objectWithNonWriteable): void {})
+        ;
+    }
+}

tests/Integration/Maker/MakeFactoryTest.php

@@ -434,6 +434,18 @@ public function does_not_initialize_non_settable(): void
         $this->assertFileFromMakerSameAsExpectedFile(self::tempFile('src/Factory/ObjectWithNonWriteableFactory.php'));
     }
 
+    /**
+     * @test
+     */
+    public function does_force_initialization_of_non_settable_with_always_force(): void
+    {
+        $tester = $this->makeFactoryCommandTester();
+
+        $tester->execute(['class' => ObjectWithNonWriteable::class, '--no-persistence' => true]);
+
+        $this->assertFileFromMakerSameAsExpectedFile(self::tempFile('src/Factory/ObjectWithNonWriteableFactory.php'));
+    }
+
     private function emulateSCAToolEnabled(string $scaToolFilePath): void
     {
         \mkdir(\dirname($scaToolFilePath), 0777, true);