MakeFactory::getCommandDescription() - Code Metrics - Inspection of "make:factory auto defaults for non-nullable 1-1/n-..." - zenstruck/foundry - Measure and Improve Code Quality continuously with Scrutinizer

Passed

Pull Request — master (#221)

unknown

created 2021-12-11 21:25 UTC

MakeFactory::getCommandDescription() A

↳ Parent: MakeFactory

Complexity

Conditions	1
Paths	1

Size

Total Lines	3
Code Lines	1

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	1
CRAP Score	1.125

Importance

Changes

Metric	Value
eloc	1
c	0
b	0
f	0
dl	0
loc	3
ccs	1
cts	2
cp	0.5
rs	10
cc	1
nc	1
nop	0
crap	1.125

<?php

namespace Zenstruck\Foundry\Bundle\Maker;

use Doctrine\ORM\EntityManagerInterface;
use Doctrine\Persistence\ManagerRegistry;
use Symfony\Bundle\MakerBundle\ConsoleStyle;
use Symfony\Bundle\MakerBundle\DependencyBuilder;
use Symfony\Bundle\MakerBundle\Exception\RuntimeCommandException;
use Symfony\Bundle\MakerBundle\Generator;
use Symfony\Bundle\MakerBundle\InputConfiguration;
use Symfony\Bundle\MakerBundle\Maker\AbstractMaker;
use Symfony\Component\Console\Command\Command;
use Symfony\Component\Console\Input\InputArgument;
use Symfony\Component\Console\Input\InputInterface;
use Symfony\Component\Console\Input\InputOption;
use Symfony\Component\Finder\Finder;
use Zenstruck\Foundry\ModelFactory;

/**
 * @author Kevin Bond <[email protected]>
 */
final class MakeFactory extends AbstractMaker
{
    private const ORM_DEFAULTS = [
        'ARRAY' => '[],',
        'ASCII_STRING' => 'self::faker()->text(),',
        'BIGINT' => 'self::faker()->randomNumber(),',
        'BLOB' => 'self::faker()->text(),',
        'BOOLEAN' => 'self::faker()->boolean(),',
        'DATE' => 'self::faker()->datetime(),',
        'DATE_MUTABLE' => 'self::faker()->datetime(),',
        'DATE_IMMUTABLE' => 'self::faker()->datetime(),',
        'DATETIME_MUTABLE' => 'self::faker()->datetime(),',
        'DATETIME_IMMUTABLE' => 'self::faker()->datetime(),',
        'DATETIMETZ_MUTABLE' => 'self::faker()->datetime(),',
        'DATETIMETZ_IMMUTABLE' => 'self::faker()->datetime(),',
        'DECIMAL' => 'self::faker()->randomFloat(),',
        'FLOAT' => 'self::faker()->randomFloat(),',
        'INTEGER' => 'self::faker()->randomNumber(),',
        'JSON' => '[],',
        'JSON_ARRAY' => '[],',
        'SIMPLE_ARRAY' => '[],',
        'SMALLINT' => 'self::faker()->randomNumber(1, 32767),',
        'STRING' => 'self::faker()->text(),',
        'TEXT' => 'self::faker()->text(),',
        'TIME_MUTABLE' => 'self::faker()->datetime(),',
        'TIME_IMMUTABLE' => 'self::faker()->datetime(),',
    ];

    /** @var ManagerRegistry */
    private $managerRegistry;

    /** @var string[] */
    private $entitiesWithFactories;

    public function __construct(ManagerRegistry $managerRegistry, \Traversable $factories)
    {
        $this->managerRegistry = $managerRegistry;
        $this->entitiesWithFactories = \array_map(
            static function(ModelFactory $factory) {
                return $factory::getEntityClass();
            },
            \iterator_to_array($factories)
        );
    }

    public static function getCommandName(): string
    {
        return 'make:factory';
    }

    public static function getCommandDescription(): string
    {
        return 'Creates a Foundry model factory for a Doctrine entity class';
    }

    public function configureCommand(Command $command, InputConfiguration $inputConfig): void
    {
        $command
            ->setDescription(self::getCommandDescription())
            ->addArgument('entity', InputArgument::OPTIONAL, 'Entity class to create a factory for')
            ->addOption('namespace', null, InputOption::VALUE_REQUIRED, 'Customize the namespace for generated factories', 'Factory')
            ->addOption('test', null, InputOption::VALUE_NONE, 'Create in <fg=yellow>tests/</> instead of <fg=yellow>src/</>')
            ->addOption('all-fields', null, InputOption::VALUE_NONE, 'Create defaults for all entity fields, not only required fields')
        ;

        $inputConfig->setArgumentAsNonInteractive('entity');
    }

    public function interact(InputInterface $input, ConsoleStyle $io, Command $command): void
    {
        if ($input->getArgument('entity')) {
            return;
        }

        if (!$input->getOption('test')) {
            $io->text('// Note: pass <fg=yellow>--test</> if you want to generate factories in your <fg=yellow>tests/</> directory');
            $io->newLine();
        }

        if (!$input->getOption('all-fields')) {
            $io->text('// Note: pass <fg=yellow>--all-fields</> if you want to generate default values for all fields, not only required fields');
            $io->newLine();
        }

        $argument = $command->getDefinition()->getArgument('entity');
        $entity = $io->choice($argument->getDescription(), $this->entityChoices());

        $input->setArgument('entity', $entity);
    }

    public function generate(InputInterface $input, ConsoleStyle $io, Generator $generator): void
    {
        $class = $input->getArgument('entity');

        if (!\class_exists($class)) {
            $class = $generator->createClassNameDetails($class, 'Entity\\')->getFullName();
        }

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

        $namespace = $input->getOption('namespace');

        // strip maker's root namespace if set
        if (0 === \mb_strpos($namespace, $generator->getRootNamespace())) {
            $namespace = \mb_substr($namespace, \mb_strlen($generator->getRootNamespace()));
        }

        $namespace = \trim($namespace, '\\');

        // if creating in tests dir, ensure namespace prefixed with Tests\
        if ($input->getOption('test') && 0 !== \mb_strpos($namespace, 'Tests\\')) {
            $namespace = 'Tests\\'.$namespace;
        }

        $entity = new \ReflectionClass($class);
        $factory = $generator->createClassNameDetails($entity->getShortName(), $namespace, 'Factory');

        $repository = new \ReflectionClass($this->managerRegistry->getRepository($entity->getName()));

        if (0 !== \mb_strpos($repository->getName(), $generator->getRootNamespace())) {
            // not using a custom repository
            $repository = null;
        }

        $generator->generateClass(
            $factory->getFullName(),
            __DIR__.'/../Resources/skeleton/Factory.tpl.php',
            [
                'entity' => $entity,
                'defaultProperties' => $this->defaultPropertiesFor($entity->getName(), $input->getOption('all-fields')),
                'repository' => $repository,
            ]
        );

        $generator->writeChanges();

        $this->writeSuccessMessage($io);

        $io->text([
            'Next: Open your new factory and set default values/states.',
            'Find the documentation at https://symfony.com/bundles/ZenstruckFoundryBundle/current/index.html#model-factories',
        ]);
    }

    public function configureDependencies(DependencyBuilder $dependencies): void
    {
        // noop
    }

    private function entityChoices(): array
    {
        $choices = [];

        foreach ($this->managerRegistry->getManagers() as $manager) {
            foreach ($manager->getMetadataFactory()->getAllMetadata() as $metadata) {
                if (!\in_array($metadata->getName(), $this->entitiesWithFactories, true)) {
                    $choices[] = $metadata->getName();
                }
            }
        }

        \sort($choices);

        if (empty($choices)) {
            throw new RuntimeCommandException('No entities found.');
        }

        return $choices;
    }

    private function defaultPropertiesFor(string $class, bool $allFields): iterable
    {
        $em = $this->managerRegistry->getManagerForClass($class);

        if (!$em instanceof EntityManagerInterface) {
            return [];
        }

        $metadata = $em->getClassMetadata($class);
        $ids = $metadata->getIdentifierFieldNames();

        // TODO cleanup the code
        // TODO class exist dont relay on fix namespaces
        // TODO write some tests
        // TODO test with kind of possible relations
        // If Factory exist for related entities populate too with auto defaults
        $relatedEntities = $metadata->associationMappings;
        foreach ($relatedEntities as $item) {
            // if joinColumns is not written entity is default nullable ($nullable = true;)
            // @see vendor/doctrine/orm/lib/Doctrine/ORM/Mapping/JoinColumn.php LINE 28
            if (!\array_key_exists('joinColumns', $item)) {
                continue;
            }

            // if this key is available its a ManyToMany relation but its optional, Key must not be present to be ManyToMany
            if (\array_key_exists('joinTable', $item)) {
                continue;
            }

            if (true === $item['joinColumns'][0]['nullable']) {
                continue;
            }

            $joinedColumns = $item['joinColumns'];

            $fieldName = $item['fieldName'];

            $targetEntityArray = \explode('\\', $item['targetEntity']);
            $targetEntity = \end($targetEntityArray);
            $factory = \ucfirst($targetEntity).'Factory';

            if ($this->isFactory($factory)) {
                yield \lcfirst($fieldName) => \ucfirst($targetEntity).'Factory::createOne(),';
            }
        }

        foreach ($metadata->fieldMappings as $property) {
            // ignore identifiers and nullable fields
            if ((!$allFields && ($property['nullable'] ?? false)) || \in_array($property['fieldName'], $ids, true)) {
                continue;
            }

            $type = \mb_strtoupper($property['type']);
            $value = "null, // TODO add {$type} ORM type manually";

            if (\array_key_exists($type, self::ORM_DEFAULTS)) {
                $value = self::ORM_DEFAULTS[$type];
            }

            yield $property['fieldName'] => $value;
        }
    }

    private function isFactory($factory)
    {
        $dirs = [];
        if (\is_dir('src')) {
            $dirs[] = 'app/';
        }

        if (\is_dir('src')) {
            $dirs[] = 'src/';
        }

        if (\is_dir('Tests')) {
            $dirs[] = 'Tests/';
        }

        if (\is_dir('tests')) {
            $dirs[] = 'tests/';
        }

        $finder = new Finder();
        $finder->in($dirs)->files()->name($factory.'.php');

        if (\count(\iterator_to_array($finder)) > 0) {
            return true;
        }

        return false;
    }
}


1		<?php
2
3		namespace Zenstruck\Foundry\Bundle\Maker;
4
5		use Doctrine\ORM\EntityManagerInterface;
6		use Doctrine\Persistence\ManagerRegistry;
7		use Symfony\Bundle\MakerBundle\ConsoleStyle;
8		use Symfony\Bundle\MakerBundle\DependencyBuilder;
9		use Symfony\Bundle\MakerBundle\Exception\RuntimeCommandException;
10		use Symfony\Bundle\MakerBundle\Generator;
11		use Symfony\Bundle\MakerBundle\InputConfiguration;
12		use Symfony\Bundle\MakerBundle\Maker\AbstractMaker;
13		use Symfony\Component\Console\Command\Command;
14		use Symfony\Component\Console\Input\InputArgument;
15		use Symfony\Component\Console\Input\InputInterface;
16		use Symfony\Component\Console\Input\InputOption;
17		use Symfony\Component\Finder\Finder;
18		use Zenstruck\Foundry\ModelFactory;
19
20		/**
21		* @author Kevin Bond <[email protected]>
22		*/
23		final class MakeFactory extends AbstractMaker
24		{
25	20	private const ORM_DEFAULTS = [
26		'ARRAY' => '[],',
27	20	'ASCII_STRING' => 'self::faker()->text(),',
28	20	'BIGINT' => 'self::faker()->randomNumber(),',
29		'BLOB' => 'self::faker()->text(),',
30	4	'BOOLEAN' => 'self::faker()->boolean(),',
31		'DATE' => 'self::faker()->datetime(),',
32	4	'DATE_MUTABLE' => 'self::faker()->datetime(),',
33		'DATE_IMMUTABLE' => 'self::faker()->datetime(),',
34		'DATETIME_MUTABLE' => 'self::faker()->datetime(),',
35	20	'DATETIME_IMMUTABLE' => 'self::faker()->datetime(),',
36		'DATETIMETZ_MUTABLE' => 'self::faker()->datetime(),',
37		'DATETIMETZ_IMMUTABLE' => 'self::faker()->datetime(),',
38	20	'DECIMAL' => 'self::faker()->randomFloat(),',
39	20	'FLOAT' => 'self::faker()->randomFloat(),',
40	20	'INTEGER' => 'self::faker()->randomNumber(),',
41		'JSON' => '[],',
42		'JSON_ARRAY' => '[],',
43	20	'SIMPLE_ARRAY' => '[],',
44	20	'SMALLINT' => 'self::faker()->randomNumber(1, 32767),',
45		'STRING' => 'self::faker()->text(),',
46	20	'TEXT' => 'self::faker()->text(),',
47		'TIME_MUTABLE' => 'self::faker()->datetime(),',
48	20	'TIME_IMMUTABLE' => 'self::faker()->datetime(),',
49	12	];
50
51		/** @var ManagerRegistry */
52	8	private $managerRegistry;
53	4
54	4	/** @var string[] */
55		private $entitiesWithFactories;
56
57	8	public function __construct(ManagerRegistry $managerRegistry, \Traversable $factories)
58	8	{
59		$this->managerRegistry = $managerRegistry;
60	8	$this->entitiesWithFactories = \array_map(
61	8	static function(ModelFactory $factory) {
62		return $factory::getEntityClass();
63	20	},
64		\iterator_to_array($factories)
65	20	);
66		}
67	20
68	4	public static function getCommandName(): string
69		{
70		return 'make:factory';
71	20	}
72	4
73		public static function getCommandDescription(): string
74		{
75	16	return 'Creates a Foundry model factory for a Doctrine entity class';
76	16	}
77	16
78	16	public function configureCommand(Command $command, InputConfiguration $inputConfig): void
79	16	{
80		$command
81		->setDescription(self::getCommandDescription())
82	16	->addArgument('entity', InputArgument::OPTIONAL, 'Entity class to create a factory for')
83		->addOption('namespace', null, InputOption::VALUE_REQUIRED, 'Customize the namespace for generated factories', 'Factory')
84	16	->addOption('test', null, InputOption::VALUE_NONE, 'Create in <fg=yellow>tests/</> instead of <fg=yellow>src/</>')
85		->addOption('all-fields', null, InputOption::VALUE_NONE, 'Create defaults for all entity fields, not only required fields')
86	16	;
87
88		$inputConfig->setArgumentAsNonInteractive('entity');
89	16	}
90	16
91	16	public function interact(InputInterface $input, ConsoleStyle $io, Command $command): void
92		{
93	16	if ($input->getArgument('entity')) {
94	16	return;
95		}
96
97		if (!$input->getOption('test')) {
98	16	$io->text('// Note: pass <fg=yellow>--test</> if you want to generate factories in your <fg=yellow>tests/</> directory');
99		$io->newLine();
100	16	}
101
102	16	if (!$input->getOption('all-fields')) {
103	16	$io->text('// Note: pass <fg=yellow>--all-fields</> if you want to generate default values for all fields, not only required fields');
104		$io->newLine();
105		}
106	16
107		$argument = $command->getDefinition()->getArgument('entity');
108	20	$entity = $io->choice($argument->getDescription(), $this->entityChoices());
109
110		$input->setArgument('entity', $entity);
111	20	}
112
113	8	public function generate(InputInterface $input, ConsoleStyle $io, Generator $generator): void
114		{
115	8	$class = $input->getArgument('entity');
116
117	8	if (!\class_exists($class)) {
118	8	$class = $generator->createClassNameDetails($class, 'Entity\\')->getFullName();
119	8	}
120
121		if (!\class_exists($class)) {
122		throw new RuntimeCommandException(\sprintf('Entity "%s" not found.', $input->getArgument('entity')));
123	8	}
124
125	8	$namespace = $input->getOption('namespace');
126
127		// strip maker's root namespace if set
128		if (0 === \mb_strpos($namespace, $generator->getRootNamespace())) {
129		$namespace = \mb_substr($namespace, \mb_strlen($generator->getRootNamespace()));
130		}
131
132		$namespace = \trim($namespace, '\\');
133
134		// if creating in tests dir, ensure namespace prefixed with Tests\
135		if ($input->getOption('test') && 0 !== \mb_strpos($namespace, 'Tests\\')) {
136		$namespace = 'Tests\\'.$namespace;
137		}
138
139		$entity = new \ReflectionClass($class);
140		$factory = $generator->createClassNameDetails($entity->getShortName(), $namespace, 'Factory');
141
142		$repository = new \ReflectionClass($this->managerRegistry->getRepository($entity->getName()));
143
144		if (0 !== \mb_strpos($repository->getName(), $generator->getRootNamespace())) {
145		// not using a custom repository
146		$repository = null;
147		}
148
149		$generator->generateClass(
150		$factory->getFullName(),
151		__DIR__.'/../Resources/skeleton/Factory.tpl.php',
152		[
153		'entity' => $entity,
154		'defaultProperties' => $this->defaultPropertiesFor($entity->getName(), $input->getOption('all-fields')),
155		'repository' => $repository,
156		]
157		);
158
159		$generator->writeChanges();
160
161		$this->writeSuccessMessage($io);
162
163		$io->text([
164		'Next: Open your new factory and set default values/states.',
165		'Find the documentation at https://symfony.com/bundles/ZenstruckFoundryBundle/current/index.html#model-factories',
166		]);
167		}
168
169		public function configureDependencies(DependencyBuilder $dependencies): void
170		{
171		// noop
172		}
173
174		private function entityChoices(): array
175		{
176		$choices = [];
177
178		foreach ($this->managerRegistry->getManagers() as $manager) {
179		foreach ($manager->getMetadataFactory()->getAllMetadata() as $metadata) {
180		if (!\in_array($metadata->getName(), $this->entitiesWithFactories, true)) {
181		$choices[] = $metadata->getName();
182		}
183		}
184		}
185
186		\sort($choices);
187
188		if (empty($choices)) {
189		throw new RuntimeCommandException('No entities found.');
190		}
191
192		return $choices;
193		}
194
195		private function defaultPropertiesFor(string $class, bool $allFields): iterable
196		{
197		$em = $this->managerRegistry->getManagerForClass($class);
198
199		if (!$em instanceof EntityManagerInterface) {
200		return [];
201		}
202
203		$metadata = $em->getClassMetadata($class);
204		$ids = $metadata->getIdentifierFieldNames();
205
206		// TODO cleanup the code
207		// TODO class exist dont relay on fix namespaces
208		// TODO write some tests
209		// TODO test with kind of possible relations
210		// If Factory exist for related entities populate too with auto defaults
211		$relatedEntities = $metadata->associationMappings;
212		foreach ($relatedEntities as $item) {
213		// if joinColumns is not written entity is default nullable ($nullable = true;)
214		// @see vendor/doctrine/orm/lib/Doctrine/ORM/Mapping/JoinColumn.php LINE 28
215		if (!\array_key_exists('joinColumns', $item)) {
216		continue;
217		}
218
219		// if this key is available its a ManyToMany relation but its optional, Key must not be present to be ManyToMany
220		if (\array_key_exists('joinTable', $item)) {
221		continue;
222		}
223
224		if (true === $item['joinColumns'][0]['nullable']) {
225		continue;
226		}
227
228		$joinedColumns = $item['joinColumns'];
		0 ignored issues – show Unused Code introduced 2021-12-11 12:03 UTC by Report Bug Copy Issue Report The assignment to `$joinedColumns` is dead and can be removed. Loading history...
229		$fieldName = $item['fieldName'];
230
231		$targetEntityArray = \explode('\\', $item['targetEntity']);
232		$targetEntity = \end($targetEntityArray);
233		$factory = \ucfirst($targetEntity).'Factory';
234
235		if ($this->isFactory($factory)) {
236		yield \lcfirst($fieldName) => \ucfirst($targetEntity).'Factory::createOne(),';
237		}
238		}
239
240		foreach ($metadata->fieldMappings as $property) {
241		// ignore identifiers and nullable fields
242		if ((!$allFields && ($property['nullable'] ?? false)) \|\| \in_array($property['fieldName'], $ids, true)) {
243		continue;
244		}
245
246		$type = \mb_strtoupper($property['type']);
247		$value = "null, // TODO add {$type} ORM type manually";
248
249		if (\array_key_exists($type, self::ORM_DEFAULTS)) {
250		$value = self::ORM_DEFAULTS[$type];
251		}
252
253		yield $property['fieldName'] => $value;
254		}
255		}
256
257		private function isFactory($factory)
258		{
259		$dirs = [];
260		if (\is_dir('src')) {
261		$dirs[] = 'app/';
262		}
263
264		if (\is_dir('src')) {
265		$dirs[] = 'src/';
266		}
267
268		if (\is_dir('Tests')) {
269		$dirs[] = 'Tests/';
270		}
271
272		if (\is_dir('tests')) {
273		$dirs[] = 'tests/';
274		}
275
276		$finder = new Finder();
277		$finder->in($dirs)->files()->name($factory.'.php');
278
279		if (\count(\iterator_to_array($finder)) > 0) {
280		return true;
281		}
282
283		return false;
284		}
285		}
286

zenstruck / foundry

Pull Request — master (#221)

MakeFactory::getCommandDescription() A

Complexity

Size

Duplication

Code Coverage

Importance

Duplication Side-by-Side

Filter issues like