QA

tempestphp · May 30, 2024 · 2f472ab · 2f472ab
1 parent 2553899
commit 2f472ab
Show file tree

Hide file tree

Showing 12 changed files with 230 additions and 36 deletions.
diff --git a/src/Actions/CompleteConsoleCommandArguments.php b/src/Actions/CompleteConsoleCommandArguments.php
@@ -1,34 +1,44 @@
 <?php
 
+declare(strict_types=1);
+
 namespace Tempest\Console\Actions;
 
+use Tempest\Console\CompletesConsoleCommand;
 use Tempest\Console\ConsoleCommand;
-use Tempest\Console\HasConsole;
 use Tempest\Console\Input\ConsoleArgumentBag;
 
-final readonly class CompleteConsoleCommandArguments
+final readonly class CompleteConsoleCommandArguments implements CompletesConsoleCommand
 {
-    use HasConsole;
-
-    public function __invoke(
+    public function complete(
         ConsoleCommand $command,
         ConsoleArgumentBag $argumentBag,
         int $current,
-    ): void {
+    ): array {
         $definitions = $command->getArgumentDefinitions();
 
+        $last = $argumentBag->last();
+
+        if ($last && $last->value === null) {
+            return [];
+        }
+
+        $completions = [];
+
         foreach ($definitions as $definition) {
             if ($definition->type !== 'array' && $argumentBag->has($definition->name)) {
                 continue;
             }
 
-            $this->write("--{$definition->name}");
+            $argument = "--{$definition->name}";
 
             if ($definition->type !== 'bool') {
-                $this->write('=');
+                $argument .= '=';
             }
 
-            $this->writeln();
+            $completions[] = $argument;
         }
+
+        return $completions;
     }
-}
+}
diff --git a/src/Actions/CompleteConsoleCommandNames.php b/src/Actions/CompleteConsoleCommandNames.php
@@ -1,34 +1,33 @@
 <?php
 
+declare(strict_types=1);
+
 namespace Tempest\Console\Actions;
 
-use Tempest\Console\Console;
 use Tempest\Console\ConsoleConfig;
-use Tempest\Console\HasConsole;
 use Tempest\Console\Input\ConsoleArgumentBag;
 
 final readonly class CompleteConsoleCommandNames
 {
-    use HasConsole;
-
     public function __construct(
-        private Console $console,
         private ConsoleConfig $consoleConfig,
-    ) {}
+    ) {
+    }
 
-    public function __invoke(
-        ConsoleArgumentBag $argumentBag,
-        int $current,
-    ): void
+    public function complete(ConsoleArgumentBag $argumentBag, int $current): array
     {
         $currentCommandName = $argumentBag->getCommandName();
 
+        $completions = [];
+
         foreach ($this->consoleConfig->commands as $name => $definition) {
             if (! str_starts_with($name, $currentCommandName)) {
                 continue;
             }
 
-            $this->writeln($name);
+            $completions[] = $name;
         }
+
+        return $completions;
     }
-}
+}
diff --git a/src/Commands/CompleteCommand.php b/src/Commands/CompleteCommand.php
@@ -4,7 +4,6 @@
 
 namespace Tempest\Console\Commands;
 
-use ReflectionMethod;
 use Tempest\Console\Actions\CompleteConsoleCommandArguments;
 use Tempest\Console\Actions\CompleteConsoleCommandNames;
 use Tempest\Console\Console;
@@ -37,25 +36,26 @@ public function __invoke(
         $commandName = $input[1] ?? null;
 
         $command = $this->consoleConfig->commands[$commandName] ?? null;
+
         $argumentBag = new ConsoleArgumentBag($input);
 
         if (! $command) {
-            $this->container->get(CompleteConsoleCommandNames::class)($argumentBag, $current);
+            $completions = $this->container->get(CompleteConsoleCommandNames::class)->complete($argumentBag, $current);
+
+            $this->writeln(implode(PHP_EOL, $completions));
 
             return;
         }
 
         $complete = match(true) {
-            is_array($command->complete) => new ReflectionMethod(...$command->complete),
-            is_string($command->complete) && class_exists($command->complete) => new ReflectionMethod($command->complete, '__invoke'),
-            default => new ReflectionMethod(CompleteConsoleCommandArguments::class, '__invoke'),
+            is_string($command->complete) && class_exists($command->complete) => $this->container->get($command->complete),
+            default => $this->container->get(CompleteConsoleCommandArguments::class),
         };
 
-        $complete->invoke(
-            $this->container->get($complete->getDeclaringClass()->getName()),
+        $this->writeln(implode(PHP_EOL, $complete->complete(
             $command,
             $argumentBag,
             $current,
-        );
+        )));
     }
 }
diff --git a/src/CompletesConsoleCommand.php b/src/CompletesConsoleCommand.php
@@ -0,0 +1,16 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Tempest\Console;
+
+use Tempest\Console\Input\ConsoleArgumentBag;
+
+interface CompletesConsoleCommand
+{
+    public function complete(
+        ConsoleCommand $command,
+        ConsoleArgumentBag $argumentBag,
+        int $current,
+    ): array;
+}
diff --git a/src/ConsoleCommand.php b/src/ConsoleCommand.php
@@ -5,7 +5,6 @@
 namespace Tempest\Console;
 
 use Attribute;
-use Closure;
 use ReflectionMethod;
 use Tempest\Console\Input\ConsoleArgumentDefinition;
 
@@ -25,7 +24,9 @@ public function __construct(
         /** @var array<array-key, class-string<\Tempest\Console\ConsoleMiddleware>> */
         public readonly array $middleware = [],
         public readonly bool $hidden = false,
-        public string|array|Closure|null $complete = null,
+
+        /** @var class-string<\Tempest\Console\CompletesConsoleCommand>|null */
+        public readonly string|null $complete = null,
     ) {
     }
 

diff --git a/src/Input/ConsoleArgumentBag.php b/src/Input/ConsoleArgumentBag.php
@@ -60,6 +60,11 @@ public function all(): array
         return $this->arguments;
     }
 
+    public function last(): ?ConsoleInputArgument
+    {
+        return $this->arguments[array_key_last($this->arguments)] ?? null;
+    }
+
     public function has(string ...$names): bool
     {
         foreach ($this->arguments as $argument) {

diff --git a/src/Input/ConsoleInputArgument.php b/src/Input/ConsoleInputArgument.php
@@ -56,18 +56,23 @@ public function matches(string $name): bool
      */
     private static function parseNamedArgument(string $argument): array
     {
-        $parts = explode('=', str_replace('--', '', $argument));
+        preg_match('/--(?<name>[\w]+)((?<hasValue>=)\"?(?<value>(.*?))(\"|$))?/', $argument, $matches);
 
-        $key = $parts[0];
+        $name = $matches['name'] ?? null;
+        $hasValue = $matches['hasValue'] ?? null;
+        $value = $matches['value'] ?? null;
 
-        $value = $parts[1] ?? true;
+        if (! $hasValue) {
+            return [$name, true];
+        }
 
         $value = match ($value) {
             'true' => true,
             'false' => false,
+            '' => null,
             default => $value,
         };
 
-        return [$key, $value];
+        return [$name, $value];
     }
 }
diff --git a/src/Testing/ConsoleTester.php b/src/Testing/ConsoleTester.php
@@ -107,6 +107,22 @@ public function call(string|Closure|array $command): self
         return $clone;
     }
 
+    public function complete(?string $command = null): self
+    {
+        if ($command) {
+            $input = explode(' ', $command);
+
+            $inputString = implode(' ', array_map(
+                fn (string $item) => "--input=\"{$item}\"",
+                $input
+            ));
+        } else {
+            $inputString = '';
+        }
+
+        return $this->call("_complete --current=0 --input=\"./tempest\" {$inputString}");
+    }
+
     public function input(int|string|Key $input): self
     {
         $this->output->clear();
@@ -152,6 +168,11 @@ public function assertSee(string $text): self
         return $this->assertContains($text);
     }
 
+    public function assertNotSee(string $text): self
+    {
+        return $this->assertDoesNotContain($text);
+    }
+
     public function assertContains(string $text): self
     {
         Assert::assertStringContainsString(

diff --git a/tests/Actions/CompleteConsoleCommandArgumentsTest.php b/tests/Actions/CompleteConsoleCommandArgumentsTest.php
@@ -0,0 +1,54 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Tests\Tempest\Console\Actions;
+
+use Tests\Tempest\Console\TestCase;
+
+/**
+ * @internal
+ * @small
+ */
+class CompleteConsoleCommandArgumentsTest extends TestCase
+{
+    public function test_arguments_are_printed(): void
+    {
+        $this->console
+            ->complete('completion:test')
+            ->assertSee("--value=" . PHP_EOL)
+            ->assertSee("--flag" . PHP_EOL)
+            ->assertSee("--items=" . PHP_EOL);
+    }
+
+    public function test_existing_arguments_are_skipped(): void
+    {
+        $this->console
+            ->complete('completion:test --flag')
+            ->assertNotSee('--flag');
+
+        $this->console
+            ->complete('completion:test --flag=false')
+            ->assertNotSee('--flag');
+
+        $this->console
+            ->complete('completion:test --value=bar')
+            ->assertNotSee('--value');
+    }
+
+    public function test_multiple_array_values_are_allowed(): void
+    {
+        $this->console
+            ->complete('completion:test --items=a')
+            ->assertSee('--items=');
+    }
+
+    public function test_open_flag_must_first_be_completed(): void
+    {
+        $this->console
+            ->complete('completion:test --items=')
+            ->assertNotSee("--value=" . PHP_EOL)
+            ->assertNotSee("--flag" . PHP_EOL)
+            ->assertNotSee("--items=" . PHP_EOL);
+    }
+}
diff --git a/tests/Commands/CompleteCommandTest.php b/tests/Commands/CompleteCommandTest.php
@@ -0,0 +1,31 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Tests\Tempest\Console\Commands;
+
+use Tests\Tempest\Console\TestCase;
+
+/**
+ * @internal
+ * @small
+ */
+class CompleteCommandTest extends TestCase
+{
+    public function test_complete_commands(): void
+    {
+        $this->console
+            ->complete()
+            ->assertSee('tail:server' . PHP_EOL)
+            ->assertSee('schedule:run' . PHP_EOL);
+    }
+
+    public function test_complete_arguments(): void
+    {
+        $this->console
+            ->complete('tail:')
+            ->assertSee('tail:server' . PHP_EOL)
+            ->assertSee('tail:project' . PHP_EOL)
+            ->assertSee('tail:debug' . PHP_EOL);
+    }
+}
diff --git a/tests/Fixtures/CompletionTestCommand.php b/tests/Fixtures/CompletionTestCommand.php
@@ -0,0 +1,16 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Tests\Tempest\Console\Fixtures;
+
+use Tempest\Console\ConsoleCommand;
+
+final readonly class CompletionTestCommand
+{
+    #[ConsoleCommand('completion:test')]
+    public function __invoke(string $value, bool $flag = false, array $items = [])
+    {
+        // TODO: Implement __invoke() method.
+    }
+}
diff --git a/tests/Input/ConsoleInputArgumentTest.php b/tests/Input/ConsoleInputArgumentTest.php
@@ -0,0 +1,36 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Tests\Tempest\Console\Input;
+
+use PHPUnit\Framework\TestCase;
+use Tempest\Console\Input\ConsoleInputArgument;
+
+/**
+ * @internal
+ * @small
+ */
+class ConsoleInputArgumentTest extends TestCase
+{
+    public function test_parse_named_arguments(): void
+    {
+        $input = ConsoleInputArgument::fromString('--flag=abc');
+        $this->assertSame('abc', $input->value);
+
+        $input = ConsoleInputArgument::fromString('--flag');
+        $this->assertTrue($input->value);
+
+        $input = ConsoleInputArgument::fromString('--flag=true');
+        $this->assertTrue($input->value);
+
+        $input = ConsoleInputArgument::fromString('--flag=false');
+        $this->assertFalse($input->value);
+
+        $input = ConsoleInputArgument::fromString('--flag=');
+        $this->assertNull($input->value);
+
+        $input = ConsoleInputArgument::fromString('--flag="abc"');
+        $this->assertSame('abc', $input->value);
+    }
+}