Add DCG command generator

Author: Chi-teck

src/Command/Console/DcgCommand.php

@@ -9,18 +9,12 @@
 use DrupalCodeGenerator\GeneratorType;
 use DrupalCodeGenerator\Utils;
 use DrupalCodeGenerator\Validator\RegExp;
+use DrupalCodeGenerator\Validator\Required;
 
-/**
- * Generates DCG command.
- *
- * @todo Clean-up.
- */
 #[Generator(
   name: 'console:dcg-command',
   description: 'Generates DCG command',
   aliases: ['dcg-command'],
-  // @todo Enable the generator once it is updated.
-  hidden: TRUE,
   templatePath: Application::TEMPLATE_PATH . '/Console/_dcg-command',
   type: GeneratorType::MODULE_COMPONENT,
   label: 'DCG command',
@@ -33,31 +27,30 @@ final class DcgCommand extends BaseGenerator {
   protected function generate(array &$vars, Assets $assets): void {
     $ir = $this->createInterviewer($vars);
 
-    $command_name_validator = new RegExp('/^[a-z][a-z0-9-_:]*[a-z0-9]$/', 'The value is not correct command name.');
-    $vars['command_name'] = $ir->ask('Command name', 'custom:example', $command_name_validator);
+    $vars['machine_name'] = $ir->askMachineName();
+    $vars['name'] = $ir->askName();
+    $generator_name_validator = new RegExp('/^[a-z][a-z0-9-_:]*[a-z0-9]$/', 'The value is not correct generator name.');
+    $vars['generator']['name'] = $ir->ask('Generator name', '{machine_name}:example', $generator_name_validator);
+    $vars['generator']['description'] = $ir->ask('Generator description', validator: new Required());
 
-    $vars['description'] = $ir->ask('Command description');
-
-    $sub_names = \explode(':', $vars['command_name']);
+    $sub_names = \explode(':', $vars['generator']['name']);
     $short_name = \array_pop($sub_names);
 
-    $alias_validator = new RegExp('/^[a-z0-9][a-z0-9_]+$/', 'The value is not correct alias name.');
-    $vars['alias'] = $ir->ask('Command alias', $short_name, $alias_validator);
-
-    $vars['class'] = Utils::camelize($short_name);
-    $vars['namespace'] = 'DrupalCodeGenerator';
+    $vars['class'] = $ir->askClass(default: Utils::camelize($short_name));
     $vars['template_name'] = $short_name;
 
-    $vars['path'] = '';
-    $file_path = '';
-    if ($sub_names) {
-      $vars['namespace'] .= '\\' . \implode('\\', $sub_names);
-      $file_path = \implode(\DIRECTORY_SEPARATOR, $sub_names);
-      $vars['path'] = '/' . $file_path;
+    // Make service name using the following guides.
+    // `foo:example` -> `foo.example` (not `foo:foo_example`)
+    // `foo` -> `foo.foo` (not `foo`)
+    $service_name = Utils::removePrefix($vars['generator']['name'], $vars['machine_name'] . ':');
+    if (!$service_name) {
+      $service_name = $vars['generator']['name'];
     }
+    $vars['service_name'] = $vars['machine_name'] . '.' . \str_replace([':', '-'], '_', $service_name);
 
-    $assets->addFile($file_path . '/{class}.php', 'command.twig');
-    $assets->addFile($file_path . '/{template_name}.twig', 'template.twig');
+    $assets->addServicesFile('drush.services.yml')->template('drush.services.twig');
+    $assets->addFile('src/Generator/{class}.php', 'generator.twig');
+    $assets->addFile('templates/generator/{template_name}.twig', 'template.twig');
   }
 
 }

templates/Console/_dcg-command/command.twig

@@ -0,0 +1,5 @@
+services:
+  {{ service_name }}:
+    class: Drupal\{{ machine_name }}\Generator\{{ class }}
+    tags:
+      -  { name: drush.generator.v3 }

templates/Console/_dcg-command/drush.services.twig

@@ -0,0 +1,31 @@
+<?php declare(strict_types = 1);
+
+namespace Drupal\{{ machine_name }}\Generator;
+
+use DrupalCodeGenerator\Asset\AssetCollection as Assets;
+use DrupalCodeGenerator\Attribute\Generator;
+use DrupalCodeGenerator\Command\BaseGenerator;
+use DrupalCodeGenerator\GeneratorType;
+
+#[Generator(
+  name: '{{ generator.name }}',
+  description: '{{ generator.description }}',
+  templatePath: __DIR__ . '/../../templates/generator',
+  type: GeneratorType::MODULE_COMPONENT,
+)]
+final class {{ class }} extends BaseGenerator {
+
+  /**
+   * {@inheritdoc}
+   */
+  protected function generate(array &$vars, Assets $assets): void {
+    $ir = $this->createInterviewer($vars);
+
+    $vars['machine_name'] = $ir->askMachineName();
+    $vars['name'] = $ir->askName();
+    $vars['class'] = $ir->askClass(default: '{machine_name|camelize}');
+
+    $assets->addFile('src/{class}.php', '{{ template_name }}.twig');
+  }
+
+}

templates/Console/_dcg-command/generator.twig

@@ -1,17 +1,18 @@
-{% verbatim %}<?php
+{% verbatim %}<?php declare(strict_types = 1);
 
 namespace Drupal\{{ machine_name }};
 
 /**
- * Some custom service of the {{ name }} module.
+ * @todo Add a description for this class.
  */
-class {{ class }} {
+final class {{ class }} {
 
   /**
-   * Method description.
+   * @todo Add a description for this method.
    */
-  public function meow() {
-    echo 'Meow!';
+  public function example(): void {
+
   }
 
-}{% endverbatim %}
+}
+{% endverbatim %}

templates/Console/_dcg-command/template.twig

@@ -12,13 +12,18 @@ final class DcgCommandTest extends GeneratorTestBase {
 
   protected string $fixtureDir = __DIR__ . '/_dcg_command';
 
+  /**
+   * Test callback.
+   */
   public function testGenerator(): void {
 
-    $this->markTestSkipped();
-
     $input = [
-      'custom:example',
-      'Some description',
+      'example',
+      'Example',
+      'example:foo-bar',
+      'Example generator.',
+      'FooBarGenerator',
+      'example',
       'example',
     ];
     $this->execute(DcgCommand::class, $input);
@@ -28,25 +33,35 @@ public function testGenerator(): void {
      Welcome to dcg-command generator!
     –––––––––––––––––––––––––––––––––––
 
-     Command name [custom:example]:
+     Module machine name:
+     ➤ 
+
+     Module name [Example]:
+     ➤ 
+
+     Generator name [example:example]:
      ➤ 
 
-     Command description:
+     Generator description:
      ➤ 
 
-     Command alias [example]:
+     Class [FooBar]:
      ➤ 
 
      The following directories and files have been created or updated:
     –––––––––––––––––––––––––––––––––––––––––––––––––––––––––––––––––––
-     • custom/Example.php
-     • custom/example.twig
+     • drush.services.yml
+     • example.info.yml
+     • src/Generator/FooBarGenerator.php
+     • templates/generator/foo-bar.twig
 
     TXT;
     $this->assertDisplay($expected_display);
 
-    $this->assertGeneratedFile('custom/Example.php');
-    $this->assertGeneratedFile('custom/example.twig');
+    $this->assertGeneratedFile('drush.services.yml');
+    $this->assertGeneratedFile('example.info.yml');
+    $this->assertGeneratedFile('src/Generator/FooBarGenerator.php');
+    $this->assertGeneratedFile('templates/generator/foo-bar.twig');
   }
 
 }

tests/functional/Generator/Console/DcgCommandTest.php

@@ -0,0 +1,5 @@
+services:
+  example.foo_bar:
+    class: Drupal\example\Generator\FooBarGenerator
+    tags:
+      -  { name: drush.generator.v3 }

tests/functional/Generator/Console/_dcg_command/custom/Example.php

@@ -0,0 +1,5 @@
+name: 'Example'
+type: module
+description: '@todo Add description.'
+package: '@todo Add package'
+core_version_requirement: ^10