feat(console): add make:response command (tempestphp#760)

Author: gturpin-dev

src/Tempest/Http/src/Commands/MakeResponseCommand.php

@@ -0,0 +1,46 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Tempest\Http\Commands;
+
+use Tempest\Console\ConsoleArgument;
+use Tempest\Console\ConsoleCommand;
+use Tempest\Core\PublishesFiles;
+use Tempest\Generation\DataObjects\StubFile;
+use Tempest\Generation\Exceptions\FileGenerationAbortedException;
+use Tempest\Generation\Exceptions\FileGenerationFailedException;
+use Tempest\Http\Stubs\ResponseStub;
+
+final class MakeResponseCommand
+{
+    use PublishesFiles;
+
+    #[ConsoleCommand(
+        name: 'make:response',
+        description: 'Creates a new response class',
+        aliases: ['response:make', 'response:create', 'create:response'],
+    )]
+    public function __invoke(
+        #[ConsoleArgument(
+            help: 'The name of the response class to create',
+        )]
+        string $className,
+    ): void {
+        $suggestedPath = $this->getSuggestedPath($className);
+        $targetPath = $this->promptTargetPath($suggestedPath);
+        $shouldOverride = $this->askForOverride($targetPath);
+
+        try {
+            $this->stubFileGenerator->generateClassFile(
+                stubFile: StubFile::from(ResponseStub::class),
+                targetPath: $targetPath,
+                shouldOverride: $shouldOverride,
+            );
+
+            $this->success(sprintf('Response successfully created at "%s".', $targetPath));
+        } catch (FileGenerationAbortedException|FileGenerationFailedException $e) {
+            $this->error($e->getMessage());
+        }
+    }
+}

src/Tempest/Http/src/Stubs/ResponseStub.php

@@ -0,0 +1,20 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Tempest\Http\Stubs;
+
+use Tempest\Http\IsResponse;
+use Tempest\Http\Response;
+use Tempest\Http\Status;
+
+final class ResponseStub implements Response
+{
+    use IsResponse;
+
+    public function __construct()
+    {
+        $this->setStatus(Status::OK);
+        $this->addHeader('Content-Type', 'application/json');
+    }
+}

tests/Integration/Http/MakeResponseCommandTest.php

@@ -0,0 +1,72 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Tests\Tempest\Integration\Http;
+
+use PHPUnit\Framework\Attributes\DataProvider;
+use PHPUnit\Framework\Attributes\Test;
+use Tempest\Core\ComposerNamespace;
+use Tests\Tempest\Integration\FrameworkIntegrationTestCase;
+
+/**
+ * @internal
+ */
+final class MakeResponseCommandTest 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:response {$commandArgs}")
+            ->submit();
+
+        $this->installer
+            ->assertFileExists($expectedPath)
+            ->assertFileContains($expectedPath, 'namespace ' . $expectedNamespace . ';')
+            ->assertFileContains($expectedPath, 'implements Response')
+            ->assertFileContains($expectedPath, 'use IsResponse');
+    }
+
+    public static function command_input_provider(): array
+    {
+        return [
+            'make_with_defaults' => [
+                'commandArgs' => 'BookCreatedResponse',
+                'expectedPath' => 'App/BookCreatedResponse.php',
+                'expectedNamespace' => 'App',
+            ],
+            'make_with_other_namespace' => [
+                'commandArgs' => 'Responses\\BookCreatedResponse',
+                'expectedPath' => 'App/Responses/BookCreatedResponse.php',
+                'expectedNamespace' => 'App\\Responses',
+            ],
+            'make_with_input_path' => [
+                'commandArgs' => 'Responses/BookCreatedResponse',
+                'expectedPath' => 'App/Responses/BookCreatedResponse.php',
+                'expectedNamespace' => 'App\\Responses',
+            ],
+        ];
+    }
+}