Skip to content

Commit 18ea4fb

Browse files
nikophilnikophil
authored
feat(make:factory): create factory for not-persisted objects (zenstruck#343)
1 parent 64786fc commit 18ea4fb

10 files changed

+435
-64
lines changed

‎.php-cs-fixer.dist.php

+1-1
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@
33
$finder = PhpCsFixer\Finder::create()
44
->in([__DIR__.'/src', __DIR__.'/tests'])
55
->notName('*.tpl.php')
6-
->exclude('Fixtures/Maker')
6+
->exclude('Fixtures/')
77
;
88

99
$config = new PhpCsFixer\Config();

‎src/Bundle/Maker/MakeFactory.php

+113-25
Original file line numberDiff line numberDiff line change
@@ -17,14 +17,15 @@
1717
use Symfony\Component\Console\Input\InputArgument;
1818
use Symfony\Component\Console\Input\InputInterface;
1919
use Symfony\Component\Console\Input\InputOption;
20+
use Symfony\Component\HttpKernel\KernelInterface;
2021
use Zenstruck\Foundry\ModelFactory;
2122

2223
/**
2324
* @author Kevin Bond <[email protected]>
2425
*/
2526
final class MakeFactory extends AbstractMaker
2627
{
27-
private const DEFAULTS = [
28+
private const DEFAULTS_FOR_PERSISTED = [
2829
'ARRAY' => '[],',
2930
'ASCII_STRING' => 'self::faker()->text({length}),',
3031
'BIGINT' => 'self::faker()->randomNumber(),',
@@ -50,10 +51,20 @@ final class MakeFactory extends AbstractMaker
5051
'TIME_IMMUTABLE' => '\DateTimeImmutable::createFromMutable(self::faker()->datetime()),',
5152
];
5253

54+
private const DEFAULTS_FOR_NOT_PERSISTED = [
55+
'array' => '[],',
56+
'string' => 'self::faker()->text(),',
57+
'int' => 'self::faker()->randomNumber(),',
58+
'float' => 'self::faker()->randomFloat(),',
59+
'bool' => 'self::faker()->boolean(),',
60+
\DateTime::class => 'self::faker()->dateTime(),',
61+
\DateTimeImmutable::class => '\DateTimeImmutable::createFromMutable(self::faker()->dateTime()),',
62+
];
63+
5364
/** @var string[] */
54-
private array $entitiesWithFactories = [];
65+
private array $entitiesWithFactories;
5566

56-
public function __construct(private ManagerRegistry $managerRegistry, \Traversable $factories, private string $projectDir)
67+
public function __construct(private ManagerRegistry $managerRegistry, \Traversable $factories, private string $projectDir, private KernelInterface $kernel)
5768
{
5869
$this->entitiesWithFactories = \array_map(
5970
static fn(ModelFactory $factory): string => $factory::getEntityClass(),
@@ -68,7 +79,7 @@ public static function getCommandName(): string
6879

6980
public static function getCommandDescription(): string
7081
{
71-
return 'Creates a Foundry model factory for a Doctrine entity class';
82+
return 'Creates a Foundry model factory for a Doctrine entity class or a regular object';
7283
}
7384

7485
public function configureDependencies(DependencyBuilder $dependencies): void
@@ -80,18 +91,26 @@ public function configureCommand(Command $command, InputConfiguration $inputConf
8091
{
8192
$command
8293
->setDescription(self::getCommandDescription())
83-
->addArgument('entity', InputArgument::OPTIONAL, 'Entity class to create a factory for')
94+
->addArgument('class', InputArgument::OPTIONAL, 'Entity, Document or class to create a factory for')
8495
->addOption('namespace', null, InputOption::VALUE_REQUIRED, 'Customize the namespace for generated factories', 'Factory')
8596
->addOption('test', null, InputOption::VALUE_NONE, 'Create in <fg=yellow>tests/</> instead of <fg=yellow>src/</>')
8697
->addOption('all-fields', null, InputOption::VALUE_NONE, 'Create defaults for all entity fields, not only required fields')
98+
->addOption('not-persisted', null, InputOption::VALUE_NONE, 'Create a factory for an object not managed by Doctrine')
8799
;
88100

89-
$inputConfig->setArgumentAsNonInteractive('entity');
101+
$inputConfig->setArgumentAsNonInteractive('class');
90102
}
91103

92104
public function interact(InputInterface $input, ConsoleStyle $io, Command $command): void
93105
{
94-
if ($input->getArgument('entity')) {
106+
if (!$this->doctrineEnabled() && !$input->getOption('not-persisted')) {
107+
$io->text('// Note: Doctrine not enabled: auto-activating <fg=yellow>--not-persisted</> option.');
108+
$io->newLine();
109+
110+
$input->setOption('not-persisted', true);
111+
}
112+
113+
if ($input->getArgument('class')) {
95114
return;
96115
}
97116

@@ -105,16 +124,30 @@ public function interact(InputInterface $input, ConsoleStyle $io, Command $comma
105124
$io->newLine();
106125
}
107126

108-
$argument = $command->getDefinition()->getArgument('entity');
109-
$entity = $io->choice($argument->getDescription(), \array_merge($this->entityChoices(), ['All']));
127+
if ($input->getOption('not-persisted')) {
128+
$class = $io->ask(
129+
'Not persisted class to create a factory for',
130+
validator: static function(string $class) {
131+
if (!\class_exists($class)) {
132+
throw new RuntimeCommandException("Given class \"{$class}\" does not exist.");
133+
}
134+
135+
return $class;
136+
}
137+
);
138+
} else {
139+
$argument = $command->getDefinition()->getArgument('class');
140+
141+
$class = $io->choice($argument->getDescription(), \array_merge($this->entityChoices(), ['All']));
142+
}
110143

111-
$input->setArgument('entity', $entity);
144+
$input->setArgument('class', $class);
112145
}
113146

114147
public function generate(InputInterface $input, ConsoleStyle $io, Generator $generator): void
115148
{
116-
$entity = $input->getArgument('entity');
117-
$classes = 'All' === $entity ? $this->entityChoices() : [$entity];
149+
$class = $input->getArgument('class');
150+
$classes = 'All' === $class ? $this->entityChoices() : [$class];
118151

119152
foreach ($classes as $class) {
120153
$this->generateFactory($class, $input, $io, $generator);
@@ -131,7 +164,7 @@ private function generateFactory(string $class, InputInterface $input, ConsoleSt
131164
}
132165

133166
if (!\class_exists($class)) {
134-
throw new RuntimeCommandException(\sprintf('Entity "%s" not found.', $input->getArgument('entity')));
167+
throw new RuntimeCommandException(\sprintf('Class "%s" not found.', $input->getArgument('class')));
135168
}
136169

137170
$namespace = $input->getOption('namespace');
@@ -148,24 +181,29 @@ private function generateFactory(string $class, InputInterface $input, ConsoleSt
148181
$namespace = 'Tests\\'.$namespace;
149182
}
150183

151-
$entity = new \ReflectionClass($class);
152-
$factory = $generator->createClassNameDetails($entity->getShortName(), $namespace, 'Factory');
184+
$object = new \ReflectionClass($class);
185+
$factory = $generator->createClassNameDetails($object->getShortName(), $namespace, 'Factory');
153186

154-
$repository = new \ReflectionClass($this->managerRegistry->getRepository($entity->getName()));
187+
if (!$input->getOption('not-persisted')) {
188+
$repository = new \ReflectionClass($this->managerRegistry->getRepository($object->getName()));
155189

156-
if (0 !== \mb_strpos($repository->getName(), $generator->getRootNamespace())) {
157-
// not using a custom repository
158-
$repository = null;
190+
if (0 !== \mb_strpos($repository->getName(), $generator->getRootNamespace())) {
191+
// not using a custom repository
192+
$repository = null;
193+
}
159194
}
160195

161196
$generator->generateClass(
162197
$factory->getFullName(),
163198
__DIR__.'/../Resources/skeleton/Factory.tpl.php',
164199
[
165-
'entity' => $entity,
166-
'defaultProperties' => $this->defaultPropertiesFor($entity->getName(), $input->getOption('all-fields')),
167-
'repository' => $repository,
200+
'object' => $object,
201+
'defaultProperties' => $input->getOption('not-persisted')
202+
? $this->defaultPropertiesForNotPersistedObject($object->getName(), $input->getOption('all-fields'))
203+
: $this->defaultPropertiesForPersistedObject($object->getName(), $input->getOption('all-fields')),
204+
'repository' => $repository ?? null,
168205
'phpstanEnabled' => $this->phpstanEnabled(),
206+
'persisted' => !$input->getOption('not-persisted'),
169207
]
170208
);
171209

@@ -210,7 +248,7 @@ private function entityChoices(): array
210248
/**
211249
* @param class-string $class
212250
*/
213-
private function defaultPropertiesFor(string $class, bool $allFields): iterable
251+
private function defaultPropertiesForPersistedObject(string $class, bool $allFields): iterable
214252
{
215253
$em = $this->managerRegistry->getManagerForClass($class);
216254

@@ -234,16 +272,66 @@ private function defaultPropertiesFor(string $class, bool $allFields): iterable
234272
$value = "null, // TODO add {$type} {$dbType} type manually";
235273
$length = $property['length'] ?? '';
236274

237-
if (\array_key_exists($type, self::DEFAULTS)) {
238-
$value = self::DEFAULTS[$type];
275+
if (\array_key_exists($type, self::DEFAULTS_FOR_PERSISTED)) {
276+
$value = self::DEFAULTS_FOR_PERSISTED[$type];
239277
}
240278

241279
yield $property['fieldName'] => \str_replace('{length}', (string) $length, $value);
242280
}
243281
}
244282

283+
/**
284+
* @param class-string $class
285+
*/
286+
private function defaultPropertiesForNotPersistedObject(string $class, bool $allFields): iterable
287+
{
288+
$object = new \ReflectionClass($class);
289+
290+
foreach ($object->getProperties() as $property) {
291+
// ignore identifiers and nullable fields
292+
if (!$allFields && ($property->hasDefaultValue() || !$property->hasType() || $property->getType()?->allowsNull())) {
293+
continue;
294+
}
295+
296+
$type = null;
297+
$reflectionType = $property->getType();
298+
if ($reflectionType instanceof \ReflectionNamedType) {
299+
$type = $reflectionType->getName();
300+
}
301+
302+
$value = \sprintf('null, // TODO add %svalue manually', $type ? "{$type} " : '');
303+
304+
if (\array_key_exists($type ?? '', self::DEFAULTS_FOR_NOT_PERSISTED)) {
305+
$value = self::DEFAULTS_FOR_NOT_PERSISTED[$type];
306+
}
307+
308+
yield $property->getName() => $value;
309+
}
310+
}
311+
245312
private function phpstanEnabled(): bool
246313
{
247314
return \file_exists("{$this->projectDir}/vendor/phpstan/phpstan/phpstan");
248315
}
316+
317+
private function doctrineEnabled(): bool
318+
{
319+
try {
320+
$this->kernel->getBundle('DoctrineBundle');
321+
322+
$ormEnabled = true;
323+
} catch (\InvalidArgumentException) {
324+
$ormEnabled = false;
325+
}
326+
327+
try {
328+
$this->kernel->getBundle('DoctrineMongoDBBundle');
329+
330+
$odmEnabled = true;
331+
} catch (\InvalidArgumentException) {
332+
$odmEnabled = false;
333+
}
334+
335+
return $ormEnabled || $odmEnabled;
336+
}
249337
}

‎src/Bundle/Resources/config/services.xml

+1
Original file line numberDiff line numberDiff line change
@@ -44,6 +44,7 @@
4444
<argument type="service" id="Zenstruck\Foundry\ChainManagerRegistry" />
4545
<argument type="tagged_iterator" tag="foundry.factory" />
4646
<argument>%kernel.project_dir%</argument>
47+
<argument type="service" id="kernel" />
4748
<tag name="maker.command" />
4849
</service>
4950

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

+41-33
Original file line numberDiff line numberDiff line change
@@ -2,49 +2,54 @@
22

33
namespace <?= $namespace; ?>;
44

5-
use <?= $entity->getName() ?>;
6-
<?php if ($repository): ?>use <?= $repository->getName() ?>;
5+
use <?= $object->getName() ?>;
6+
<?php if ($persisted && $repository): ?>use <?= $repository->getName() ?>;
77
use Zenstruck\Foundry\RepositoryProxy;
88
<?php endif ?>
99
use Zenstruck\Foundry\ModelFactory;
1010
use Zenstruck\Foundry\Proxy;
1111

1212
/**
13-
* @extends ModelFactory<<?= $entity->getShortName() ?>>
13+
* @extends ModelFactory<<?= $object->getShortName() ?>>
1414
*
15-
* @method <?= $entity->getShortName() ?>|Proxy create(array|callable $attributes = [])
16-
* @method static <?= $entity->getShortName() ?>|Proxy createOne(array $attributes = [])
17-
* @method static <?= $entity->getShortName() ?>|Proxy find(object|array|mixed $criteria)
18-
* @method static <?= $entity->getShortName() ?>|Proxy findOrCreate(array $attributes)
19-
* @method static <?= $entity->getShortName() ?>|Proxy first(string $sortedField = 'id')
20-
* @method static <?= $entity->getShortName() ?>|Proxy last(string $sortedField = 'id')
21-
* @method static <?= $entity->getShortName() ?>|Proxy random(array $attributes = [])
22-
* @method static <?= $entity->getShortName() ?>|Proxy randomOrCreate(array $attributes = [])
23-
* @method static <?= $entity->getShortName() ?>[]|Proxy[] all()
24-
* @method static <?= $entity->getShortName() ?>[]|Proxy[] createMany(int $number, array|callable $attributes = [])
25-
* @method static <?= $entity->getShortName() ?>[]|Proxy[] createSequence(array|callable $sequence)
26-
* @method static <?= $entity->getShortName() ?>[]|Proxy[] findBy(array $attributes)
27-
* @method static <?= $entity->getShortName() ?>[]|Proxy[] randomRange(int $min, int $max, array $attributes = [])
28-
* @method static <?= $entity->getShortName() ?>[]|Proxy[] randomSet(int $number, array $attributes = [])
15+
* @method <?= $object->getShortName() ?>|Proxy create(array|callable $attributes = [])
16+
* @method static <?= $object->getShortName() ?>|Proxy createOne(array $attributes = [])
17+
<?php if ($persisted): ?> * @method static <?= $object->getShortName() ?>|Proxy find(object|array|mixed $criteria)
18+
* @method static <?= $object->getShortName() ?>|Proxy findOrCreate(array $attributes)
19+
* @method static <?= $object->getShortName() ?>|Proxy first(string $sortedField = 'id')
20+
* @method static <?= $object->getShortName() ?>|Proxy last(string $sortedField = 'id')
21+
* @method static <?= $object->getShortName() ?>|Proxy random(array $attributes = [])
22+
* @method static <?= $object->getShortName() ?>|Proxy randomOrCreate(array $attributes = [])
23+
* @method static <?= $object->getShortName() ?>[]|Proxy[] all()
24+
<?php endif ?>
25+
* @method static <?= $object->getShortName() ?>[]|Proxy[] createMany(int $number, array|callable $attributes = [])
26+
* @method static <?= $object->getShortName() ?>[]|Proxy[] createSequence(array|callable $sequence)
27+
<?php if ($persisted): ?> * @method static <?= $object->getShortName() ?>[]|Proxy[] findBy(array $attributes)
28+
* @method static <?= $object->getShortName() ?>[]|Proxy[] randomRange(int $min, int $max, array $attributes = [])
29+
* @method static <?= $object->getShortName() ?>[]|Proxy[] randomSet(int $number, array $attributes = [])
2930
<?php if ($repository): ?> * @method static <?= $repository->getShortName() ?>|RepositoryProxy repository()
3031
<?php endif ?>
32+
<?php endif ?>
3133
<?php if ($phpstanEnabled): ?> *
32-
* @phpstan-method Proxy<<?= $entity->getShortName() ?>> create(array|callable $attributes = [])
33-
* @phpstan-method static Proxy<<?= $entity->getShortName() ?>> createOne(array $attributes = [])
34-
* @phpstan-method static Proxy<<?= $entity->getShortName() ?>> find(object|array|mixed $criteria)
35-
* @phpstan-method static Proxy<<?= $entity->getShortName() ?>> findOrCreate(array $attributes)
36-
* @phpstan-method static Proxy<<?= $entity->getShortName() ?>> first(string $sortedField = 'id')
37-
* @phpstan-method static Proxy<<?= $entity->getShortName() ?>> last(string $sortedField = 'id')
38-
* @phpstan-method static Proxy<<?= $entity->getShortName() ?>> random(array $attributes = [])
39-
* @phpstan-method static Proxy<<?= $entity->getShortName() ?>> randomOrCreate(array $attributes = [])
40-
* @phpstan-method static list<Proxy<<?= $entity->getShortName() ?>>> all()
41-
* @phpstan-method static list<Proxy<<?= $entity->getShortName() ?>>> createMany(int $number, array|callable $attributes = [])
42-
* @phpstan-method static list<Proxy<<?= $entity->getShortName() ?>>> createSequence(array|callable $sequence)
43-
* @phpstan-method static list<Proxy<<?= $entity->getShortName() ?>>> findBy(array $attributes)
44-
* @phpstan-method static list<Proxy<<?= $entity->getShortName() ?>>> randomRange(int $min, int $max, array $attributes = [])
45-
* @phpstan-method static list<Proxy<<?= $entity->getShortName() ?>>> randomSet(int $number, array $attributes = [])
34+
* @phpstan-method Proxy<<?= $object->getShortName() ?>> create(array|callable $attributes = [])
35+
* @phpstan-method static Proxy<<?= $object->getShortName() ?>> createOne(array $attributes = [])
36+
<?php if ($persisted): ?> * @phpstan-method static Proxy<<?= $object->getShortName() ?>> find(object|array|mixed $criteria)
37+
* @phpstan-method static Proxy<<?= $object->getShortName() ?>> findOrCreate(array $attributes)
38+
* @phpstan-method static Proxy<<?= $object->getShortName() ?>> first(string $sortedField = 'id')
39+
* @phpstan-method static Proxy<<?= $object->getShortName() ?>> last(string $sortedField = 'id')
40+
* @phpstan-method static Proxy<<?= $object->getShortName() ?>> random(array $attributes = [])
41+
* @phpstan-method static Proxy<<?= $object->getShortName() ?>> randomOrCreate(array $attributes = [])
42+
* @phpstan-method static list<Proxy<<?= $object->getShortName() ?>>> all()
43+
<?php endif ?>
44+
* @phpstan-method static list<Proxy<<?= $object->getShortName() ?>>> createMany(int $number, array|callable $attributes = [])
45+
* @phpstan-method static list<Proxy<<?= $object->getShortName() ?>>> createSequence(array|callable $sequence)
46+
<?php if ($persisted): ?>
47+
* @phpstan-method static list<Proxy<<?= $object->getShortName() ?>>> findBy(array $attributes)
48+
* @phpstan-method static list<Proxy<<?= $object->getShortName() ?>>> randomRange(int $min, int $max, array $attributes = [])
49+
* @phpstan-method static list<Proxy<<?= $object->getShortName() ?>>> randomSet(int $number, array $attributes = [])
4650
<?php if ($repository): ?> * @phpstan-method static RepositoryProxy<<?= $repository->getShortName() ?>> repository()
4751
<?php endif ?>
52+
<?php endif ?>
4853
<?php endif ?>
4954
*/
5055
final class <?= $class_name ?> extends ModelFactory
@@ -81,12 +86,15 @@ protected function getDefaults(): array
8186
protected function initialize(): self
8287
{
8388
return $this
84-
// ->afterInstantiate(function(<?= $entity->getShortName() ?> $<?= lcfirst($entity->getShortName()) ?>): void {})
89+
<?php if (!$persisted): ?>
90+
->withoutPersisting()
91+
<?php endif ?>
92+
// ->afterInstantiate(function(<?= $object->getShortName() ?> $<?= lcfirst($object->getShortName()) ?>): void {})
8593
;
8694
}
8795

8896
protected static function getClass(): string
8997
{
90-
return <?= $entity->getShortName() ?>::class;
98+
return <?= $object->getShortName() ?>::class;
9199
}
92100
}

0 commit comments

Comments
 (0)