Maker Commands (#20)

feat: add maker commands

---------

Co-authored-by: Pascal Cremer <[email protected]>

Author: janvt

.github/workflows/test.yml

@@ -0,0 +1,14 @@
+name: Tests
+
+on: [push]
+
+jobs:
+    unit-test:
+        runs-on: ubuntu-latest
+        steps:
+        - uses: actions/checkout@v3
+        - uses: php-actions/composer@v6
+        - name: PHPUnit Tests
+          uses: php-actions/phpunit@v9
+          with:
+            configuration: tests/phpunit.xml

.php-cs-fixer.php

@@ -1,7 +1,10 @@
 <?php
 
 $finder = PhpCsFixer\Finder::create()
-    ->exclude(['var', 'vendor', 'migrations', 'fixtures'])
+    ->exclude([
+        'src/Resources/skeleton',
+        'vendor'
+    ])
     ->in(__DIR__)
 ;
 

README.md

@@ -153,3 +153,99 @@ class Logger extends Facade
 ```
 
 Although facades are better testable than regular singletons, it is highly recommended to only use them sparringly and always prefer normal dependency injection when possible.
+
+## Generator Commands
+
+This bundle adds several [maker bundle](https://symfony.com/bundles/SymfonyMakerBundle/current/index.html) commands to generate commonly used components.
+
+### Model / Repository
+
+This command can be used to generate:
+
+- The domain model class.
+- A repository class for the model.
+- The model's identity class as value object (optional).
+- A Doctrine database entity configuration, either as annotation or separate config file (optional).
+- A custom Doctrine type for the model's identity class (optional).
+
+#### Command Output
+
+```bash
+Description:
+  Creates a new domain model class
+
+Usage:
+  make:ddd:model [options] [--] [<name>]
+
+Arguments:
+  name                               The name of the model class (e.g. Customer)
+
+Options:
+      --aggregate-root               Marks the model as aggregate root
+      --entity=ENTITY                Use this model as Doctrine entity
+      --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)
+```
+
+### 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
+```
+
+### Resource
+
+This command can be used to generate an [Api Platform](https://api-platform.com/) resource. Minimum required version is [2.7](https://api-platform.com/docs/core/upgrade-guide/#api-platform-2730) for the PHP attributes support.
+
+#### Command Output
+
+```bash
+Description:
+  Creates a new API Platform resource
+
+Usage:
+  make:ddd:resource [options] [--] [<name>]
+
+Arguments:
+  name            The name of the model class to create the resource for (e.g. Customer). Model must exist already.
+
+Options:
+      --config    Config flavor to create (attribute|xml).
+```

composer.json

@@ -29,11 +29,12 @@
         "phpunit/phpunit": "^9.5",
         "symfony/framework-bundle": "^6.0",
         "symfony/yaml": "^6.0",
-        "symfony/filesystem": "^6.0"
+        "symfony/filesystem": "^6.0",
+        "symfony/maker-bundle": "^1.48"
     },
     "autoload": {
         "psr-4": {
-            "GeekCell\\DddBundle\\": "src"
+            "GeekCell\\DddBundle\\": "src/"
         }
     },
     "autoload-dev": {

composer.lock

@@ -10,3 +10,44 @@ services:
         arguments:
             - '@Symfony\Component\Messenger\MessageBusInterface'
         public: true
+
+    GeekCell\DddBundle\Maker\MakeModel:
+        class: GeekCell\DddBundle\Maker\MakeModel
+        arguments:
+            - '@GeekCell\DddBundle\Maker\Doctrine\DoctrineConfigUpdater'
+            - '@maker.file_manager'
+        tags:
+            - { name: maker.command }
+
+    GeekCell\DddBundle\Maker\MakeQuery:
+        class: GeekCell\DddBundle\Maker\MakeQuery
+        tags:
+            - { name: maker.command }
+
+    GeekCell\DddBundle\Maker\MakeCommand:
+        class: GeekCell\DddBundle\Maker\MakeCommand
+        tags:
+            - { name: maker.command }
+
+    GeekCell\DddBundle\Maker\MakeController:
+        class: GeekCell\DddBundle\Maker\MakeController
+        arguments:
+            - '@maker.file_manager'
+        tags:
+            - { name: maker.command }
+
+    GeekCell\DddBundle\Maker\MakeResource:
+        class: GeekCell\DddBundle\Maker\MakeResource
+        arguments:
+            - '@maker.file_manager'
+            - '@GeekCell\DddBundle\Maker\Doctrine\ApiPlatformConfigUpdator'
+        tags:
+            - { name: maker.command }
+
+    GeekCell\DddBundle\Maker\Doctrine\DoctrineConfigUpdater:
+        class: GeekCell\DddBundle\Maker\Doctrine\DoctrineConfigUpdater
+        public: false
+
+    GeekCell\DddBundle\Maker\Doctrine\ApiPlatformConfigUpdator:
+        class: GeekCell\DddBundle\Maker\ApiPlatform\ApiPlatformConfigUpdater
+        public: false

config/services.yaml

@@ -8,4 +8,5 @@ parameters:
         - src
         - tests
     excludePaths:
+        - src/Resources/skeleton
         - vendor/

phpstan.neon

@@ -0,0 +1,41 @@
+<?php
+
+declare(strict_types=1);
+
+namespace GeekCell\DddBundle\Maker;
+
+use Assert;
+use Assert\AssertionFailedException;
+use Symfony\Bundle\MakerBundle\Util\YamlSourceManipulator;
+
+abstract class AbstractBaseConfigUpdater
+{
+    private ?YamlSourceManipulator $manipulator;
+
+    /**
+     * Creates a YamlSourceManipulator from a YAML source.
+     *
+     * @param string $yamlSource
+     * @return array<string, string|string[]>
+     */
+    protected function read(string $yamlSource): array
+    {
+        $this->manipulator = new YamlSourceManipulator($yamlSource);
+        return $this->manipulator->getData();
+    }
+
+    /**
+     * Returns the updated YAML contents for the given data.
+     *
+     * @param array<string, string|string[]> $yamlData
+     * @return string
+     * @throws AssertionFailedException
+     */
+    protected function write(array $yamlData): string
+    {
+        Assert\Assertion::notNull($this->manipulator);
+        $this->manipulator->setData($yamlData);
+
+        return $this->manipulator->getContents();
+    }
+}