Merge pull request #19 from geekcell/feat/maker-query

Maker Command - Query

Author: janvt

README.md

@@ -186,3 +186,25 @@ Options:
  --with-identity=WITH-IDENTITY Whether an identity value object should be created
  --with-suffix Adds the suffix "Model" to the model class name
 ```
+
+### Query / Command
+
+These commands can be used to generate:
+
+- A query and query handler class.
+- A command and command handler class.
+
+The query / command generated is just an empty class. The handler class is registered as a message handler for the configured [Symfony Messenger](https://symfony.com/doc/current/messenger.html).
+
+#### Command Output
+
+```bash
+Description:
+ Creates a new query|command class and handler
+
+Usage:
+ make:ddd:query|command [<name>]
+
+Arguments:
+ name The name of the query|command class (e.g. Customer)
+```

config/services.yaml

@@ -25,9 +25,10 @@ services:
  tags:
  - { name: maker.command }
 
- maker.maker.make_model:
- alias: GeekCell\DddBundle\Maker\MakeModel
- public: true
+ GeekCell\DddBundle\Maker\MakeQuery:
+ class: GeekCell\DddBundle\Maker\MakeQuery
+ tags:
+ - { name: maker.command }
 
  GeekCell\DddBundle\Maker\Doctrine\DoctrineConfigUpdater:
  class: GeekCell\DddBundle\Maker\Doctrine\DoctrineConfigUpdater

src/Maker/MakeQuery.php

@@ -0,0 +1,144 @@
+<?php
+
+declare(strict_types=1);
+
+namespace GeekCell\DddBundle\Maker;
+
+use GeekCell\Ddd\Contracts\Application\Query;
+use GeekCell\Ddd\Contracts\Application\QueryHandler;
+use GeekCell\Ddd\Domain\Collection;
+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\ClassNameDetails;
+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\Messenger\Attribute\AsMessageHandler;
+
+const NAMESPACE_PREFIX = 'Application\\Query\\';
+
+final class MakeQuery extends AbstractMaker implements InputAwareMakerInterface
+{
+ public function __construct() {}
+
+ /**
+ * @inheritDoc
+ */
+ public static function getCommandName(): string
+ {
+ return 'make:ddd:query';
+ }
+
+ /**
+ * @inheritDoc
+ */
+ public static function getCommandDescription(): string
+ {
+ return 'Creates a new query class and handler';
+ }
+
+ /**
+ * @inheritDoc
+ */
+ public function configureCommand(Command $command, InputConfiguration $inputConfig): void
+ {
+ $command
+ ->addArgument(
+ 'name',
+ InputArgument::REQUIRED,
+ 'The name of the query class (e.g. <fg=yellow>Customer</>)',
+ )
+ ;
+ }
+
+ /**
+ * @inheritDoc
+ */
+ public function configureDependencies(DependencyBuilder $dependencies, InputInterface $input = null): void
+ {
+ }
+
+ /**
+ * @inheritDoc
+ */
+ public function interact(InputInterface $input, ConsoleStyle $io, Command $command): void
+ {
+ }
+
+ /**
+ * @inheritDoc
+ */
+ public function generate(InputInterface $input, ConsoleStyle $io, Generator $generator): void
+ {
+ $queryClassNameDetails = $generator->createClassNameDetails(
+ $input->getArgument('name'),
+ NAMESPACE_PREFIX,
+ 'Query',
+ );
+
+ $this->generateQuery($queryClassNameDetails, $generator);
+ $this->generateQueryHandler($queryClassNameDetails, $generator);
+
+ $this->writeSuccessMessage($io);
+ }
+
+ /**
+ * @param ClassNameDetails $queryClassNameDetails
+ * @param Generator $generator
+ * @return void
+ */
+ private function generateQuery(ClassNameDetails $queryClassNameDetails, Generator $generator): void
+ {
+ $templateVars = [
+ 'use_statements' => new UseStatementGenerator([
+ Query::class,
+ ]),
+ ];
+
+ $templatePath = __DIR__.'/../Resources/skeleton/query/Query.tpl.php';
+ $generator->generateClass(
+ $queryClassNameDetails->getFullName(),
+ $templatePath,
+ $templateVars,
+ );
+
+ $generator->writeChanges();
+ }
+
+ /**
+ * @param ClassNameDetails $queryClassNameDetails
+ * @param Generator $generator
+ * @return void
+ */
+ private function generateQueryHandler(ClassNameDetails $queryClassNameDetails, Generator $generator): void
+ {
+ $classNameDetails = $generator->createClassNameDetails(
+ $queryClassNameDetails->getShortName(),
+ NAMESPACE_PREFIX,
+ 'Handler',
+ );
+
+ $templateVars = [
+ 'use_statements' => new UseStatementGenerator([
+ QueryHandler::class,
+ Collection::class,
+ AsMessageHandler::class
+ ]),
+ 'query_class_name' => $queryClassNameDetails->getShortName()
+ ];
+
+ $templatePath = __DIR__.'/../Resources/skeleton/query/QueryHandler.tpl.php';
+ $generator->generateClass(
+ $classNameDetails->getFullName(),
+ $templatePath,
+ $templateVars,
+ );
+
+ $generator->writeChanges();
+ }
+}

src/Resources/skeleton/query/Query.tpl.php

@@ -0,0 +1,9 @@
+<?= "<?php\n" ?>
+
+namespace <?= $namespace; ?>;
+
+<?= $use_statements ?>
+
+class <?= $class_name ?> implements Query
+{
+}

src/Resources/skeleton/query/QueryHandler.tpl.php

@@ -0,0 +1,13 @@
+<?= "<?php\n" ?>
+
+namespace <?= $namespace; ?>;
+
+<?= $use_statements ?>
+
+#[AsMessageHandler]
+class <?= $class_name ?> implements QueryHandler
+{
+ public function __invoke(<?= $query_class_name ?> $query): Collection
+ {
+ }
+}