feature #178 API Platform support: add an --api-resource flag for the make:entity command (dunglas)

This PR was squashed before being merged into the 1.0-dev branch (closes #178).

Discussion
----------

API Platform support: add an --api-resource flag for the make:entity command

This PR adds a new `--api-resource` flag to the `make:entity` command. It allows to automatically a REST endpoint with CRUD operations for the given resource class using API Platform:

![screencast](https://user-images.githubusercontent.com/57224/39909149-c6c386e6-54f1-11e8-83a2-bfcd10f5ed39.gif)

I need some guidance about how to add test for this (actually, a few tests are red locally on my Mac even on master).

Fixes #175.

Commits
-------

1c8cf9a Make the Generator class a service
3d2918a Add a functional test
e6ad344 Check if the class exists
ae7c296 Add an interactive question
37b3b9c API Platform support: add an --api-resource flag for the make:entity command

Author: weaverryan

src/Command/MakerCommand.php

@@ -38,12 +38,14 @@ final class MakerCommand extends Command
     /** @var ConsoleStyle */
     private $io;
     private $checkDependencies = true;
+    private $generator;
 
-    public function __construct(MakerInterface $maker, FileManager $fileManager)
+    public function __construct(MakerInterface $maker, FileManager $fileManager, Generator $generator)
     {
         $this->maker = $maker;
         $this->fileManager = $fileManager;
         $this->inputConfig = new InputConfiguration();
+        $this->generator = $generator;
 
         parent::__construct();
     }
@@ -60,7 +62,7 @@ protected function initialize(InputInterface $input, OutputInterface $output)
 
         if ($this->checkDependencies) {
             $dependencies = new DependencyBuilder();
-            $this->maker->configureDependencies($dependencies);
+            $this->maker->configureDependencies($dependencies, $input);
 
             if ($missingPackagesMessage = $dependencies->getMissingPackagesMessage($this->getName())) {
                 throw new RuntimeCommandException($missingPackagesMessage);
@@ -88,12 +90,10 @@ protected function interact(InputInterface $input, OutputInterface $output)
 
     protected function execute(InputInterface $input, OutputInterface $output)
     {
-        $generator = new Generator($this->fileManager, 'App\\');
-
-        $this->maker->generate($input, $this->io, $generator);
+        $this->maker->generate($input, $this->io, $this->generator);
 
         // sanity check for custom makers
-        if ($generator->hasPendingOperations()) {
+        if ($this->generator->hasPendingOperations()) {
             throw new \LogicException('Make sure to call the writeChanges() method on the generator.');
         }
     }

src/DependencyInjection/CompilerPass/MakeCommandRegistrationPass.php

@@ -38,6 +38,7 @@ public function process(ContainerBuilder $container)
             )->setArguments([
                 new Reference($id),
                 new Reference('maker.file_manager'),
+                new Reference('maker.generator'),
             ])->addTag('console.command', ['command' => $class::getCommandName()]);
         }
     }

src/InputAwareMakerInterface.php

@@ -0,0 +1,27 @@
+<?php
+
+/*
+ * This file is part of the Symfony MakerBundle package.
+ *
+ * (c) Fabien Potencier <[email protected]>
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
+
+namespace Symfony\Bundle\MakerBundle;
+
+use Symfony\Component\Console\Input\InputInterface;
+
+/**
+ * Lets the configureDependencies method access to the command's input.
+ *
+ * @author Kévin Dunglas <[email protected]>
+ */
+interface InputAwareMakerInterface extends MakerInterface
+{
+    /**
+     * {@inheritdoc}
+     */
+    public function configureDependencies(DependencyBuilder $dependencies, InputInterface $input = null);
+}

src/Maker/MakeEntity.php

@@ -11,6 +11,7 @@
 
 namespace Symfony\Bundle\MakerBundle\Maker;
 
+use ApiPlatform\Core\Annotation\ApiResource;
 use Doctrine\Bundle\DoctrineBundle\DoctrineBundle;
 use Doctrine\DBAL\Types\Type;
 use Doctrine\ORM\Mapping\Column;
@@ -20,6 +21,7 @@
 use Symfony\Bundle\MakerBundle\Doctrine\DoctrineHelper;
 use Symfony\Bundle\MakerBundle\Exception\RuntimeCommandException;
 use Symfony\Bundle\MakerBundle\Generator;
+use Symfony\Bundle\MakerBundle\InputAwareMakerInterface;
 use Symfony\Bundle\MakerBundle\InputConfiguration;
 use Symfony\Bundle\MakerBundle\Str;
 use Symfony\Bundle\MakerBundle\Doctrine\EntityRegenerator;
@@ -31,24 +33,34 @@
 use Symfony\Component\Console\Input\InputArgument;
 use Symfony\Component\Console\Input\InputInterface;
 use Symfony\Component\Console\Input\InputOption;
+use Symfony\Component\Console\Question\ConfirmationQuestion;
 use Symfony\Component\Console\Question\Question;
 use Symfony\Component\Finder\SplFileInfo;
 
 /**
  * @author Javier Eguiluz <[email protected]>
  * @author Ryan Weaver <[email protected]>
+ * @author Kévin Dunglas <[email protected]>
  */
-final class MakeEntity extends AbstractMaker
+final class MakeEntity extends AbstractMaker implements InputAwareMakerInterface
 {
     private $fileManager;
     private $doctrineHelper;
     private $projectDirectory;
+    private $generator;
 
-    public function __construct(FileManager $fileManager, string $projectDirectory, DoctrineHelper $doctrineHelper)
+    public function __construct(FileManager $fileManager, string $projectDirectory, DoctrineHelper $doctrineHelper, Generator $generator = null)
     {
         $this->fileManager = $fileManager;
         $this->projectDirectory = $projectDirectory;
         $this->doctrineHelper = $doctrineHelper;
+
+        if (null === $generator) {
+            @trigger_error(sprintf('Passing a "%s" instance as 4th argument is mandatory since version 1.5.', Generator::class), E_USER_DEPRECATED);
+            $this->generator = new Generator($fileManager, 'App\\');
+        } else {
+            $this->generator = $generator;
+        }
     }
 
     public static function getCommandName(): string
@@ -59,8 +71,9 @@ public static function getCommandName(): string
     public function configureCommand(Command $command, InputConfiguration $inputConf)
     {
         $command
-            ->setDescription('Creates or updates a Doctrine entity class')
+            ->setDescription('Creates or updates a Doctrine entity class, and optionally an API Platform resource')
             ->addArgument('name', InputArgument::OPTIONAL, sprintf('Class name of the entity to create or update (e.g. <fg=yellow>%s</>)', Str::asClassName(Str::getRandomTerm())))
+            ->addOption('api-resource', 'a', InputOption::VALUE_NONE, 'Mark this class as an API Platform resource (expose a CRUD API for it)')
             ->addOption('regenerate', null, InputOption::VALUE_NONE, 'Instead of adding new fields, simply generate the methods (e.g. getter/setter) for existing fields')
             ->addOption('overwrite', null, InputOption::VALUE_NONE, 'Overwrite any existing getter/setter methods')
             ->setHelp(file_get_contents(__DIR__.'/../Resources/help/MakeEntity.txt'))
@@ -106,6 +119,18 @@ public function interact(InputInterface $input, ConsoleStyle $io, Command $comma
         $value = $io->askQuestion($question);
 
         $input->setArgument('name', $value);
+
+        if (
+            !$input->getOption('api-resource') &&
+            class_exists(ApiResource::class) &&
+            !class_exists($this->generator->createClassNameDetails($value, 'Entity\\')->getFullName())
+        ) {
+            $description = $command->getDefinition()->getOption('api-resource')->getDescription();
+            $question = new ConfirmationQuestion($description, false);
+            $value = $io->askQuestion($question);
+
+            $input->setOption('api-resource', $value);
+        }
     }
 
     public function generate(InputInterface $input, ConsoleStyle $io, Generator $generator)
@@ -142,6 +167,7 @@ public function generate(InputInterface $input, ConsoleStyle $io, Generator $gen
                 'doctrine/Entity.tpl.php',
                 [
                     'repository_full_class_name' => $repositoryClassDetails->getFullName(),
+                    'api_resource' => $input->getOption('api-resource'),
                 ]
             );
 
@@ -269,8 +295,15 @@ public function generate(InputInterface $input, ConsoleStyle $io, Generator $gen
         ]);
     }
 
-    public function configureDependencies(DependencyBuilder $dependencies)
+    public function configureDependencies(DependencyBuilder $dependencies, InputInterface $input = null)
     {
+        if (null !== $input && $input->getOption('api-resource')) {
+            $dependencies->addClassDependency(
+                ApiResource::class,
+                'api'
+            );
+        }
+
         // guarantee DoctrineBundle
         $dependencies->addClassDependency(
             DoctrineBundle::class,

src/Resources/config/makers.xml

@@ -29,6 +29,7 @@
                 <argument type="service" id="maker.file_manager" />
                 <argument>%kernel.project_dir%</argument>
                 <argument type="service" id="maker.doctrine_helper" />
+                <argument type="service" id="maker.generator" />
                 <tag name="maker.command" />
             </service>
 

src/Resources/config/services.xml

@@ -26,5 +26,10 @@
             <service id="maker.doctrine_helper" class="Symfony\Bundle\MakerBundle\Doctrine\DoctrineHelper">
                 <argument type="service" id="doctrine" on-invalid="ignore"/>
             </service>
+
+            <service id="maker.generator" class="Symfony\Bundle\MakerBundle\Generator">
+                <argument type="service" id="maker.file_manager" />
+                <argument>App\</argument>
+            </service>
         </services>
 </container>

src/Resources/help/MakeEntity.txt

@@ -4,6 +4,11 @@ The <info>%command.name%</info> command creates or updates an entity and reposit
 
 If the argument is missing, the command will ask for the entity class name interactively.
 
+You can also mark this class as an API Platform resource. A hypermedia CRUD API will
+automatically be available for this entity class:
+
+<info>php %command.full_name% --api-resource</info>
+
 You can also generate all the getter/setter/adder/remover methods
 for the properties of existing entities:
 

src/Resources/skeleton/doctrine/Entity.tpl.php

@@ -2,9 +2,13 @@
 
 namespace <?= $namespace ?>;
 
+<?php if ($api_resource): ?>use ApiPlatform\Core\Annotation\ApiResource;
+<?php endif ?>
 use Doctrine\ORM\Mapping as ORM;
 
 /**
+<?php if ($api_resource): ?> * @ApiResource()
+<?php endif ?>
  * @ORM\Entity(repositoryClass="<?= $repository_full_class_name ?>")
  */
 class <?= $class_name."\n" ?>

tests/Command/MakerCommandTest.php

@@ -6,6 +6,7 @@
 use Symfony\Bundle\MakerBundle\Command\MakerCommand;
 use Symfony\Bundle\MakerBundle\DependencyBuilder;
 use Symfony\Bundle\MakerBundle\FileManager;
+use Symfony\Bundle\MakerBundle\Generator;
 use Symfony\Bundle\MakerBundle\MakerInterface;
 use Symfony\Component\Console\Tester\CommandTester;
 
@@ -26,7 +27,7 @@ public function testExceptionOnMissingDependencies()
 
         $fileManager = $this->createMock(FileManager::class);
 
-        $command = new MakerCommand($maker, $fileManager);
+        $command = new MakerCommand($maker, $fileManager, new Generator($fileManager, 'App\\'));
         // needed because it's normally set by the Application
         $command->setName('make:foo');
         $tester = new CommandTester($command);

tests/Maker/FunctionalTest.php

@@ -380,6 +380,30 @@ public function getCommandEntityTests()
             ->setRequiredPhpVersion(70100)
         ];
 
+        yield 'entity_new_api_resource' => [MakerTestDetails::createTest(
+            $this->getMakerInstance(MakeEntity::class),
+            [
+                // entity class name
+                'User',
+                // Mark the entity as an API Platform resource
+                'y',
+                // add not additional fields
+                '',
+            ])
+            ->addExtraDependencies('api')
+            ->setFixtureFilesPath(__DIR__.'/../fixtures/MakeEntity')
+            ->configureDatabase()
+            ->updateSchemaAfterCommand()
+            ->setRequiredPhpVersion(70100)
+            ->assert(function(string $output, string $directory) {
+                $this->assertFileExists($directory.'/src/Entity/User.php');
+
+                $content = file_get_contents($directory.'/src/Entity/User.php');
+                $this->assertContains('use ApiPlatform\Core\Annotation\ApiResource;', $content);
+                $this->assertContains('@ApiResource', $content);
+            })
+        ];
+
         yield 'entity_with_fields' => [MakerTestDetails::createTest(
             $this->getMakerInstance(MakeEntity::class),
             [