feat(console): add make:initializer command (#771)

Co-authored-by: Brent Roose <[email protected]>

Author: gturpin-dev

src/Tempest/Container/src/Commands/MakeInitializerCommand.php

@@ -0,0 +1,62 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Tempest\Container\Commands;
+
+use Tempest\Console\ConsoleArgument;
+use Tempest\Console\ConsoleCommand;
+use Tempest\Container\Singleton;
+use Tempest\Container\Stubs\InitializerStub;
+use Tempest\Core\PublishesFiles;
+use Tempest\Generation\ClassManipulator;
+use Tempest\Generation\DataObjects\StubFile;
+use Tempest\Generation\Exceptions\FileGenerationAbortedException;
+use Tempest\Generation\Exceptions\FileGenerationFailedException;
+
+final class MakeInitializerCommand
+{
+    use PublishesFiles;
+
+    #[ConsoleCommand(
+        name: 'make:initializer',
+        description: 'Creates a new initializer class',
+        aliases: ['initializer:make', 'initializer:create', 'create:initializer'],
+    )]
+    public function __invoke(
+        #[ConsoleArgument(
+            help: 'The name of the initializer class to create',
+        )]
+        string $className,
+        #[ConsoleArgument(
+            name: 'singleton',
+            help: 'Whether the initializer should be a singleton',
+        )]
+        bool $isSingleton = false,
+    ): void {
+        $suggestedPath = $this->getSuggestedPath($className);
+        $targetPath = $this->promptTargetPath($suggestedPath);
+        $shouldOverride = $this->askForOverride($targetPath);
+
+        try {
+            $this->stubFileGenerator->generateClassFile(
+                stubFile: StubFile::from(InitializerStub::class),
+                targetPath: $targetPath,
+                shouldOverride: $shouldOverride,
+                manipulations: [
+                    function (ClassManipulator $stubClass) use ($isSingleton) {
+                        if ($isSingleton) {
+                            $stubClass->addMethodAttribute('initialize', Singleton::class);
+                        }
+
+                        return $stubClass;
+                    },
+                ]
+            );
+
+            $this->console->success(sprintf('Initializer successfully created at "%s".', $targetPath));
+        } catch (FileGenerationAbortedException|FileGenerationFailedException $e) {
+            $this->console->error($e->getMessage());
+        }
+    }
+}

src/Tempest/Container/src/Stubs/InitializerStub.php

@@ -0,0 +1,16 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Tempest\Container\Stubs;
+
+use Tempest\Container\Container;
+use Tempest\Container\Initializer;
+
+final class InitializerStub implements Initializer
+{
+    public function initialize(Container $container): mixed
+    {
+        return null;
+    }
+}

src/Tempest/Database/src/Commands/MakeModelCommand.php

@@ -32,7 +32,6 @@ public function __invoke(
         $shouldOverride = $this->askForOverride($targetPath);
 
         try {
-
             $this->stubFileGenerator->generateClassFile(
                 stubFile: StubFile::from(DatabaseModelStub::class),
                 targetPath: $targetPath,

tests/Integration/Container/Commands/MakeInitializerCommandTest.php

@@ -0,0 +1,88 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Tests\Tempest\Integration\Container\Commands;
+
+use PHPUnit\Framework\Attributes\DataProvider;
+use PHPUnit\Framework\Attributes\Test;
+use Tempest\Core\ComposerNamespace;
+use Tests\Tempest\Integration\FrameworkIntegrationTestCase;
+
+/**
+ * @internal
+ */
+class MakeInitializerCommandTest extends FrameworkIntegrationTestCase
+{
+    protected function setUp(): void
+    {
+        parent::setUp();
+
+        $this->installer->configure(
+            __DIR__ . '/install',
+            new ComposerNamespace('App\\', __DIR__ . '/install/App')
+        );
+    }
+
+    protected function tearDown(): void
+    {
+        $this->installer->clean();
+
+        parent::tearDown();
+    }
+
+    #[Test]
+    #[DataProvider('command_input_provider')]
+    public function make_command(
+        string $commandArgs,
+        string $expectedPath,
+        string $expectedNamespace
+    ): void {
+        $this->console
+            ->call("make:initializer {$commandArgs}")
+            ->submit();
+
+        $this->installer
+            ->assertFileExists($expectedPath)
+            ->assertFileContains($expectedPath, 'namespace ' . $expectedNamespace . ';')
+            ->assertFileExists($expectedPath, 'implements Initializer')
+            ->assertFileContains($expectedPath, 'public function initialize');
+    }
+
+    public static function command_input_provider(): array
+    {
+        return [
+            'make_with_defaults' => [
+                'commandArgs' => 'BookInitializer',
+                'expectedPath' => 'App/BookInitializer.php',
+                'expectedNamespace' => 'App',
+            ],
+            'make_with_other_namespace' => [
+                'commandArgs' => 'Initializers\\BookInitializer',
+                'expectedPath' => 'App/Initializers/BookInitializer.php',
+                'expectedNamespace' => 'App\\Initializers',
+            ],
+            'make_with_input_path' => [
+                'commandArgs' => 'Initializers/BookInitializer',
+                'expectedPath' => 'App/Initializers/BookInitializer.php',
+                'expectedNamespace' => 'App\\Initializers',
+            ],
+        ];
+    }
+
+    #[Test]
+    public function make_singleton_command(): void
+    {
+        $this->console
+            ->call("make:initializer BookInitializer --singleton")
+            ->submit();
+
+        $this->installer
+            ->assertFileExists('App/BookInitializer.php')
+            ->assertFileContains('App/BookInitializer.php', 'namespace App;')
+            ->assertFileContains('App/BookInitializer.php', 'implements Initializer')
+            ->assertFileContains('App/BookInitializer.php', 'public function initialize')
+            ->assertFileContains('App/BookInitializer.php', 'use Tempest\Container\Singleton')
+            ->assertFileContains('App/BookInitializer.php', '#[Singleton]');
+    }
+}