Merge pull request #22 from geekcell/feat/maker-controller

Maker Command - Controller

Author: janvt

README.md

@@ -206,5 +206,26 @@ Usage:
   make:ddd:query|command [<name>]
 
 Arguments:
-  name                               The name of the query|command class (e.g. Customer)
+  name                     The name of the query|command class (e.g. Customer)
+```
+
+### Controller
+
+This command can be used to generate a controller with optional `QueryBus` and `CommandBus` dependencies.
+
+#### Command Output
+
+```bash
+Description:
+  Creates a new controller class
+
+Usage:
+  make:ddd:controller [options] [--] [<name>]
+
+Arguments:
+  name                       The name of the model class (e.g. Customer)
+
+Options:
+      --include-query-bus    Add a query bus dependency
+      --include-command-bus  Add a command bus dependency
 ```

config/services.yaml

@@ -35,6 +35,13 @@ services:
         tags:
             - { name: maker.command }
 
+    GeekCell\DddBundle\Maker\MakeController:
+        class: GeekCell\DddBundle\Maker\MakeController
+        arguments:
+            - '@maker.file_manager'
+        tags:
+            - { name: maker.command }
+
     GeekCell\DddBundle\Maker\Doctrine\DoctrineConfigUpdater:
         class: GeekCell\DddBundle\Maker\Doctrine\DoctrineConfigUpdater
         public: false

src/Maker/MakeController.php

@@ -0,0 +1,173 @@
+<?php
+
+declare(strict_types=1);
+
+namespace GeekCell\DddBundle\Maker;
+
+use GeekCell\Ddd\Contracts\Application\CommandBus;
+use GeekCell\Ddd\Contracts\Application\QueryBus;
+use Symfony\Bundle\FrameworkBundle\Controller\AbstractController;
+use Symfony\Bundle\MakerBundle\FileManager;
+use Symfony\Bundle\MakerBundle\InputConfiguration;
+use Symfony\Bundle\MakerBundle\DependencyBuilder;
+use Symfony\Bundle\MakerBundle\ConsoleStyle;
+use Symfony\Bundle\MakerBundle\Generator;
+use Symfony\Bundle\MakerBundle\InputAwareMakerInterface;
+use Symfony\Bundle\MakerBundle\Maker\AbstractMaker;
+use Symfony\Bundle\MakerBundle\Util\UseStatementGenerator;
+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\HttpFoundation\Response;
+use Symfony\Component\Routing\Annotation\Route;
+
+final class MakeController extends AbstractMaker implements InputAwareMakerInterface
+{
+    const NAMESPACE_PREFIX = 'Infrastructure\\Http\\Controller\\';
+    const CONFIG_PATH = 'config/routes/ddd.yaml';
+
+    public function __construct(private FileManager $fileManager)
+    {
+    }
+
+    /**
+     * @inheritDoc
+     */
+    public static function getCommandName(): string
+    {
+        return 'make:ddd:controller';
+    }
+
+    /**
+     * @inheritDoc
+     */
+    public static function getCommandDescription(): string
+    {
+        return 'Creates a new controller class';
+    }
+
+    /**
+     * @inheritDoc
+     */
+    public function configureCommand(Command $command, InputConfiguration $inputConfig): void
+    {
+        $command
+            ->addArgument(
+                'name',
+                InputArgument::REQUIRED,
+                'The name of the controller class (e.g. <fg=yellow>Customer</>)',
+            )
+            ->addOption(
+                'include-query-bus',
+                null,
+                InputOption::VALUE_REQUIRED,
+                'Add a query bus dependency.',
+                false
+            )
+            ->addOption(
+                'include-command-bus',
+                null,
+                InputOption::VALUE_REQUIRED,
+                'Add a command bus dependency.',
+                false
+            )
+        ;
+    }
+
+    /**
+     * @inheritDoc
+     */
+    public function configureDependencies(DependencyBuilder $dependencies, InputInterface $input = null): void
+    {
+    }
+
+    /**
+     * @inheritDoc
+     */
+    public function interact(InputInterface $input, ConsoleStyle $io, Command $command): void
+    {
+        if (false === $input->getOption('include-query-bus')) {
+            $includeQueryBus = $io->confirm(
+                'Do you want to add a query bus dependency?',
+                false,
+            );
+            $input->setOption('include-query-bus', $includeQueryBus);
+        }
+
+        if (false === $input->getOption('include-command-bus')) {
+            $includeCommandBus = $io->confirm(
+                'Do you want to add a command bus dependency?',
+                false,
+            );
+            $input->setOption('include-command-bus', $includeCommandBus);
+        }
+    }
+
+    /**
+     * @inheritDoc
+     */
+    public function generate(InputInterface $input, ConsoleStyle $io, Generator $generator): void
+    {
+        $classNameDetails = $generator->createClassNameDetails(
+            $input->getArgument('name'),
+            self::NAMESPACE_PREFIX,
+            'Controller',
+        );
+
+        $classesToImport = [
+            AbstractController::class,
+            Route::class,
+            Response::class
+        ];
+
+        $routeName = lcfirst($input->getArgument('name'));
+        $templateVars = [
+            'route_name' => $routeName,
+            'route_name_snake' => strtolower(
+                preg_replace(
+                    ["/([A-Z]+)/", "/_([A-Z]+)([A-Z][a-z])/"],
+                    ["_$1", "_$1_$2"],
+                    $routeName
+                )
+            ),
+            'dependencies' => []
+        ];
+
+        if ($input->getOption('include-query-bus')) {
+            $templateVars['dependencies'][] = 'private QueryBus $queryBus';
+            $classesToImport[] = QueryBus::class;
+        }
+
+        if ($input->getOption('include-command-bus')) {
+            $templateVars['dependencies'][] = 'private CommandBus $commandBus';
+            $classesToImport[] = CommandBus::class;
+        }
+
+        $templateVars['use_statements'] = new UseStatementGenerator($classesToImport);
+
+        $templatePath = __DIR__.'/../Resources/skeleton/controller/Controller.tpl.php';
+        $generator->generateClass(
+            $classNameDetails->getFullName(),
+            $templatePath,
+            $templateVars,
+        );
+
+        // ensure controller config has been created
+        if (!$this->fileManager->fileExists(self::CONFIG_PATH)) {
+            $templatePathConfig = __DIR__ . '/../Resources/skeleton/controller/RouteConfig.tpl.php';
+            $generator->generateFile(
+                self::CONFIG_PATH,
+                $templatePathConfig,
+                [
+                    'path' => '../../src/Infrastructure/Http/Controller/',
+                    'namespace' => str_replace('\\' . $classNameDetails->getShortName(), '', $classNameDetails->getFullName())
+                ]
+            );
+        }
+
+        $generator->writeChanges();
+
+        $this->writeSuccessMessage($io);
+    }
+}

src/Maker/MakeModel.php

@@ -154,7 +154,6 @@ public function interact(InputInterface $input, ConsoleStyle $io, Command $comma
                     $modelName,
                     $useSuffix ? 'Model' : '',
                 ),
-                true,
             );
             $input->setOption('aggregate-root', $asAggregateRoot);
         }

src/Resources/skeleton/controller/Controller.tpl.php

@@ -0,0 +1,19 @@
+<?= "<?php\n" ?>
+
+namespace <?= $namespace; ?>;
+
+<?= $use_statements ?>
+
+class <?= $class_name ?> extends AbstractController
+{
+<?php if (count($dependencies) > 0): ?>
+    public function __construct(<?= implode(', ', $dependencies ) ?>)
+    {}
+
+<?php endif; ?>
+    #[Route('/<?= $route_name_snake ?>', name: '<?= $route_name_snake ?>')]
+    public function <?= $route_name ?>(): Response
+    {
+        return new Response();
+    }
+}

src/Resources/skeleton/controller/RouteConfig.tpl.php

@@ -0,0 +1,5 @@
+controllers:
+    resource:
+        path: <?= $path ?><?= "\n" ?>
+        namespace: <?= $namespace ?><?= "\n" ?>
+    type: attribute