feature #59 Adding a new MakerInterface, instead of extending AbstractCommand (weaverryan)

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

Discussion
----------

Adding a new MakerInterface, instead of extending AbstractCommand

Hi guys!

This diff looks big, but it makes no visible changes to the bundle. This only changes the way that custom maker commands are created: instead of extending from a base class and overriding methods, you'll implement the new `MakerInterface`. The reason behind this is simple: we need to tag a stable release and having a concrete interface gives us more flexibility going forward (i.e. we could add other optional interfaces for more functionality, deprecate this interface in favor of a new one, etc).

There are 2 powerful functional tests that pretty much cover everything. One actually tries all of the Maker classes to make sure they work (that existed before) and another tests that all Makers are wired correctly in the container.

The most important thing to look at is the new `MakerInterface`.

Cheers!

Commits
-------

8690210 adding public const explictly
34f8bbd adding phpcs rules and using short arrays
e3f5fa8 README tweak
22b7555 fabbot
0af6178 adding interface docs
c631196 updating README
1d22c8c Adding a new MakerInterface, instead of extending AbstractCommand

Author: weaverryan

.php_cs.dist

@@ -0,0 +1,18 @@
+<?php
+
+if (!file_exists(__DIR__.'/src')) {
+    exit(0);
+}
+return PhpCsFixer\Config::create()
+    ->setRules(array(
+        '@Symfony' => true,
+        '@Symfony:risky' => true,
+        'array_syntax' => array('syntax' => 'short'),
+        'protected_to_private' => false,
+    ))
+    ->setRiskyAllowed(true)
+    ->setFinder(
+        PhpCsFixer\Finder::create()
+            ->in(__DIR__.'/src')
+    )
+;

README.md

@@ -1,13 +1,27 @@
-SymfonyMakerBundle
-==================
+The Symfony MakerBundle
+=======================
 
-Symfony Maker helps you creating empty commands, controllers, form classes,
-tests and more so you can forget about the required boilerplate code. This
-bundle is an alternative to [SensioGeneratorBundle][1] for modern Symfony
-applications and requires using Symfony 3.4 or newer and [Symfony Flex][2].
+The MakerBundle is the fastest way to generate the most common code you'll
+need in a Symfony app: commands, controllers, form classes, event susbcribers
+and more! This bundle is an alternative to [SensioGeneratorBundle][1] for modern
+Symfony applications and requires Symfony 3.4 or newer and [Symfony Flex][2].
 
-[Read the docs][3]
+[Read the documentation][3]
+
+Backwards Compatibility Promise
+-------------------------------
+
+This bundle shares the [backwards compatibility promise][4] from
+Symfony. But, with a few clarifications.
+
+A) The input arguments or options to a command *may* change between
+   minor releases. If you're using the commands in an automated,
+   scripted way, be aware of this.
+
+B) The generated code itself may change between minor releases. This
+   will allow us to continuously improve the generated code!
 
 [1]: https://github.com/sensiolabs/SensioGeneratorBundle
 [2]: https://symfony.com/doc/current/setup/flex.html
 [3]: src/Resources/doc/index.rst
+[4]: http://symfony.com/doc/current/contributing/code/bc.html

src/Command/AbstractCommand.php renamed to src/Command/MakerCommand.php

@@ -15,79 +15,54 @@
 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\MakerInterface;
 use Symfony\Bundle\MakerBundle\Validator;
 use Symfony\Component\Console\Command\Command;
 use Symfony\Component\Console\Input\InputInterface;
 use Symfony\Component\Console\Output\OutputInterface;
-use Symfony\Flex\Recipe;
 
 /**
- * @author Javier Eguiluz <[email protected]>
- * @author Ryan Weaver <[email protected]>
+ * Used as the Command class for the makers.
+ *
+ * @internal
  */
-abstract class AbstractCommand extends Command
+final class MakerCommand extends Command
 {
-    /** @var ConsoleStyle */
-    protected $io;
-    /** @var InputInterface */
-    protected $input;
+    private $maker;
     private $generator;
+    private $inputConfig;
+    /** @var ConsoleStyle */
+    private $io;
     private $checkDependencies = true;
-    private $nonInteractiveArguments = [];
 
-    public function __construct(Generator $generator)
+    public function __construct(MakerInterface $maker, Generator $generator)
     {
-        parent::__construct();
+        $this->maker = $maker;
         $this->generator = $generator;
-    }
-
-    /**
-     * Returns the values used to fill in the skeleton files of the generated
-     * code and the success/error messages as pairs of param_name => param_value.
-     * (e.g. ['user' => 'Jane', 'project_dir' => realpath(__DIR__.'/..')])
-     */
-    abstract protected function getParameters(): array;
-
-    /**
-     * Returns the list of files to generate as pairs of skeleton_filepath => generated_filepath
-     * Skeleton files must be absolute paths and generated paths are relative to the app.
-     * (e.g. [__DIR__.'/../Resources/skeleton/command/Command.php.txt' => 'src/Command/'.$params['command_class_name'].'.php'])
-     */
-    abstract protected function getFiles(array $params): array;
-
-    /**
-     * Optional information displayed to the user after all files have been generated.
-     */
-    abstract protected function writeNextStepsMessage(array $params, ConsoleStyle $io);
+        $this->inputConfig = new InputConfiguration();
 
-    /**
-     * Defines the optional or required dependencies of the maker command, which are
-     * checked before running the command and used to display actionable error messages.
-     */
-    abstract protected function configureDependencies(DependencyBuilder $dependencies);
+        parent::__construct();
+    }
 
-    /**
-     * Call in configure() to disable the automatic interactive prompt for an arg.
-     */
-    protected function setArgumentAsNonInteractive(string $argumentName)
+    protected function configure()
     {
-        $this->nonInteractiveArguments[] = $argumentName;
+        $this->maker->configureCommand($this, $this->inputConfig);
     }
 
     protected function initialize(InputInterface $input, OutputInterface $output)
     {
         $this->io = new ConsoleStyle($input, $output);
-        $this->input = $input;
 
         if ($this->checkDependencies) {
             if (!class_exists(Recipe::class)) {
                 throw new RuntimeCommandException(sprintf('The generator commands require your app to use Symfony Flex & a Flex directory structure. See https://symfony.com/doc/current/setup/flex.html'));
             }
 
             $dependencies = new DependencyBuilder();
-            $this->configureDependencies($dependencies);
+            $this->maker->configureDependencies($dependencies);
             if ($missingPackages = $dependencies->getMissingDependencies()) {
-                throw new RuntimeCommandException(sprintf("Missing package%s: to use the %s command, run: \n\ncomposer require %s", count($missingPackages) === 1 ? '' : 's', $this->getName(), implode(' ', $missingPackages)));
+                throw new RuntimeCommandException(sprintf("Missing package%s: to use the %s command, run: \n\ncomposer require %s", 1 === count($missingPackages) ? '' : 's', $this->getName(), implode(' ', $missingPackages)));
             }
         }
     }
@@ -99,28 +74,30 @@ protected function interact(InputInterface $input, OutputInterface $output)
                 continue;
             }
 
-            if (in_array($argument->getName(), $this->nonInteractiveArguments, true)) {
+            if (in_array($argument->getName(), $this->inputConfig->getNonInteractiveArguments(), true)) {
                 continue;
             }
 
             $value = $this->io->ask($argument->getDescription(), $argument->getDefault(), [Validator::class, 'notBlank']);
             $input->setArgument($argument->getName(), $value);
         }
+
+        $this->maker->interact($input, $this->io, $this);
     }
 
     protected function execute(InputInterface $input, OutputInterface $output)
     {
         $this->generator->setIO($this->io);
-        $params = $this->getParameters();
-        $this->generator->generate($params, $this->getFiles($params));
+        $params = $this->maker->getParameters($input);
+        $this->generator->generate($params, $this->maker->getFiles($params));
 
         $this->io->newLine();
         $this->io->writeln(' <bg=green;fg=white>          </>');
         $this->io->writeln(' <bg=green;fg=white> Success! </>');
         $this->io->writeln(' <bg=green;fg=white>          </>');
         $this->io->newLine();
 
-        $this->writeNextStepsMessage($params, $this->io);
+        $this->maker->writeNextStepsMessage($params, $this->io);
     }
 
     /**
@@ -130,12 +107,4 @@ public function setCheckDependencies(bool $checkDeps)
     {
         $this->checkDependencies = $checkDeps;
     }
-
-    /**
-     * @internal Used for testing commands
-     */
-    public function setGenerator(Generator $generator)
-    {
-        $this->generator = $generator;
-    }
 }

src/DependencyInjection/CompilerPass/MakeCommandRegistrationPass.php

@@ -0,0 +1,35 @@
+<?php
+
+namespace Symfony\Bundle\MakerBundle\DependencyInjection\CompilerPass;
+
+use Symfony\Bundle\MakerBundle\Command\MakerCommand;
+use Symfony\Bundle\MakerBundle\MakerInterface;
+use Symfony\Bundle\MakerBundle\Str;
+use Symfony\Component\DependencyInjection\Compiler\CompilerPassInterface;
+use Symfony\Component\DependencyInjection\ContainerBuilder;
+use Symfony\Component\DependencyInjection\Exception\InvalidArgumentException;
+use Symfony\Component\DependencyInjection\Reference;
+
+class MakeCommandRegistrationPass implements CompilerPassInterface
+{
+    public const MAKER_TAG = 'maker.command';
+
+    public function process(ContainerBuilder $container)
+    {
+        foreach ($container->findTaggedServiceIds(self::MAKER_TAG) as $id => $tags) {
+            $def = $container->getDefinition($id);
+            $class = $container->getParameterBag()->resolveValue($def->getClass());
+            if (!is_subclass_of($class, MakerInterface::class)) {
+                throw new InvalidArgumentException(sprintf('Service "%s" must implement interface "%s".', $id, MakerInterface::class));
+            }
+
+            $container->register(
+                sprintf('maker.auto_command.%s', Str::asTwigVariable($class::getCommandName())),
+                MakerCommand::class
+            )->setArguments([
+                new Reference($id),
+                new Reference('maker.generator'),
+            ])->addTag('console.command', ['command' => $class::getCommandName()]);
+        }
+    }
+}

src/DependencyInjection/MakerExtension.php

@@ -11,6 +11,8 @@
 
 namespace Symfony\Bundle\MakerBundle\DependencyInjection;
 
+use Symfony\Bundle\MakerBundle\DependencyInjection\CompilerPass\MakeCommandRegistrationPass;
+use Symfony\Bundle\MakerBundle\MakerInterface;
 use Symfony\Component\Config\FileLocator;
 use Symfony\Component\DependencyInjection\ContainerBuilder;
 use Symfony\Component\DependencyInjection\Loader;
@@ -19,7 +21,7 @@
 /**
  * This is the class that loads and manages your bundle configuration.
  *
- * @link http://symfony.com/doc/current/cookbook/bundles/extension.html
+ * @see http://symfony.com/doc/current/cookbook/bundles/extension.html
  */
 class MakerExtension extends Extension
 {
@@ -30,5 +32,9 @@ public function load(array $configs, ContainerBuilder $container)
     {
         $loader = new Loader\XmlFileLoader($container, new FileLocator(__DIR__.'/../Resources/config'));
         $loader->load('services.xml');
+        $loader->load('makers.xml');
+
+        $container->registerForAutoconfiguration(MakerInterface::class)
+            ->addTag(MakeCommandRegistrationPass::MAKER_TAG);
     }
 }

src/EventRegistry.php

@@ -28,6 +28,9 @@
 use Symfony\Component\Security\Http\Event\InteractiveLoginEvent;
 use Symfony\Component\Security\Http\Event\SwitchUserEvent;
 
+/**
+ * @internal
+ */
 class EventRegistry
 {
     // list of *known* events to always include (if they exist)

src/FileManager.php

@@ -17,18 +17,20 @@
 /**
  * @author Javier Eguiluz <[email protected]>
  * @author Ryan Weaver <[email protected]>
+ *
+ * @internal
  */
-class FileManager
+final class FileManager
 {
     private $fs;
     private $rootDirectory;
     /** @var SymfonyStyle */
     private $io;
 
-    public function __construct(Filesystem $fs, string $rootDirectory = null)
+    public function __construct(Filesystem $fs, string $rootDirectory)
     {
         $this->fs = $fs;
-        $this->rootDirectory = $rootDirectory ?: getcwd();
+        $this->rootDirectory = $rootDirectory;
     }
 
     public function setIO(SymfonyStyle $io): void

src/Generator.php

@@ -17,8 +17,10 @@
 /**
  * @author Javier Eguiluz <[email protected]>
  * @author Ryan Weaver <[email protected]>
+ *
+ * @internal
  */
-class Generator
+final class Generator
 {
     private $fileManager;
     private $io;

src/InputConfiguration.php

@@ -0,0 +1,24 @@
+<?php
+
+namespace Symfony\Bundle\MakerBundle;
+
+final class InputConfiguration
+{
+    private $nonInteractiveArguments = [];
+
+    /**
+     * Call in MakerInterface::configureCommand() to disable the automatic interactive
+     * prompt for an argument.
+     *
+     * @param string $argumentName
+     */
+    public function setArgumentAsNonInteractive(string $argumentName)
+    {
+        $this->nonInteractiveArguments[] = $argumentName;
+    }
+
+    public function getNonInteractiveArguments(): array
+    {
+        return $this->nonInteractiveArguments;
+    }
+}