feat(console): improve rescuing enum console parameters (#809)

Author: innocenzi

src/Tempest/Console/src/Middleware/InvalidCommandMiddleware.php

@@ -4,6 +4,7 @@
 
 namespace Tempest\Console\Middleware;
 
+use BackedEnum;
 use Tempest\Console\Actions\ExecuteConsoleCommand;
 use Tempest\Console\Console;
 use Tempest\Console\ConsoleMiddleware;
@@ -15,6 +16,7 @@
 use Tempest\Console\Input\ConsoleInputArgument;
 use function Tempest\Support\str;
 use Tempest\Validation\Rules\Boolean;
+use Tempest\Validation\Rules\Enum;
 use Tempest\Validation\Rules\NotEmpty;
 use Tempest\Validation\Rules\Numeric;
 
@@ -44,17 +46,24 @@ private function retry(Invocation $invocation, InvalidCommandException $exceptio
 
         /** @var ConsoleArgumentDefinition $argument */
         foreach ($exception->invalidArguments as $argument) {
+            $isEnum = is_a($argument->type, BackedEnum::class, allow_string: true);
             $value = $this->console->ask(
                 question: str($argument->name)->snake(' ')->upperFirst()->toString(),
                 default: (string) $argument->default,
                 hint: $argument->help ?? $argument->description,
-                validation: [
+                options: $isEnum
+                    ? $argument->type
+                    : null,
+                validation: array_filter([
+                    $isEnum
+                        ? new Enum($argument->type)
+                        : new NotEmpty(),
                     match ($argument->type) {
                         'bool' => new Boolean(),
                         'int' => new Numeric(),
-                        default => new NotEmpty(),
+                        default => null,
                     },
-                ]
+                ])
             );
 
             $invocation->argumentBag->add(new ConsoleInputArgument(

tests/Integration/Console/Fixtures/IntEnumCommand.php

@@ -0,0 +1,21 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Tests\Tempest\Integration\Console\Fixtures;
+
+use Tempest\Console\Console;
+use Tempest\Console\ConsoleCommand;
+
+final readonly class IntEnumCommand
+{
+    public function __construct(private Console $console)
+    {
+    }
+
+    #[ConsoleCommand('int-enum-from-one-command')]
+    public function __invoke(TestIntEnumFromOne $enum): void
+    {
+        $this->console->writeln($enum->name);
+    }
+}

tests/Integration/Console/Fixtures/StringEnumCommand.php

@@ -0,0 +1,21 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Tests\Tempest\Integration\Console\Fixtures;
+
+use Tempest\Console\Console;
+use Tempest\Console\ConsoleCommand;
+
+final readonly class StringEnumCommand
+{
+    public function __construct(private Console $console)
+    {
+    }
+
+    #[ConsoleCommand('string-enum-command')]
+    public function __invoke(TestStringEnum $enum): void
+    {
+        $this->console->writeln($enum->value);
+    }
+}

tests/Integration/Console/Fixtures/TestIntEnumFromOne.php

@@ -0,0 +1,13 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Tests\Tempest\Integration\Console\Fixtures;
+
+// This doesn't start from zero
+enum TestIntEnumFromOne: int
+{
+    case A = 1;
+    case B = 2;
+    case C = 3;
+}

tests/Integration/Console/Middleware/InvalidCommandMiddlewareTest.php

@@ -5,6 +5,8 @@
 namespace Tests\Tempest\Integration\Console\Middleware;
 
 use Tests\Tempest\Integration\Console\Fixtures\ComplexCommand;
+use Tests\Tempest\Integration\Console\Fixtures\IntEnumCommand;
+use Tests\Tempest\Integration\Console\Fixtures\StringEnumCommand;
 use Tests\Tempest\Integration\FrameworkIntegrationTestCase;
 
 /**
@@ -22,4 +24,26 @@ public function test_provide_missing_input(): void
             ->submit('c')
             ->assertContains('abc');
     }
+
+    public function test_with_string_enum(): void
+    {
+        $this->console
+            ->call(StringEnumCommand::class)
+            ->assertContains('A')
+            ->assertContains('B')
+            ->assertContains('C')
+            ->input(1)
+            ->assertContains('b');
+    }
+
+    public function test_with_int_enum(): void
+    {
+        $this->console
+            ->call(IntEnumCommand::class)
+            ->assertContains('A')
+            ->assertContains('B')
+            ->assertContains('C')
+            ->input(1)
+            ->assertContains('B');
+    }
 }