QA improvements

tempestphp · Apr 9, 2024 · 0db9af1 · 0db9af1
1 parent 9360ef1
commit 0db9af1
Show file tree

Hide file tree

Showing 25 changed files with 249 additions and 113 deletions.
diff --git a/app/Console/ComplexCommand.php b/app/Console/ComplexCommand.php
@@ -0,0 +1,14 @@
+<?php
+
+namespace App\Console;
+
+use Tempest\Console\ConsoleCommand;
+
+final readonly class ComplexCommand
+{
+    #[ConsoleCommand('complex')]
+    public function __invoke(string $a, string $b, string $c)
+    {
+
+    }
+}
diff --git a/app/Console/Hello.php b/app/Console/Hello.php
@@ -24,7 +24,8 @@ public function world(string $input)
     }
 
     #[ConsoleCommand(
-        aliases: ['t']
+        description: 'description',
+        aliases: ['t'],
     )]
     public function test(
         #[ConsoleArgument(

diff --git a/composer.json b/composer.json
@@ -28,7 +28,7 @@
     "autoload-dev": {
         "psr-4": {
             "App\\": "app/",
-            "Tests\\Tempest\\": "tests/"
+            "Tests\\Tempest\\Console\\": "tests/"
         }
     },
     "scripts": {

diff --git a/phpunit.xml b/phpunit.xml
@@ -9,8 +9,8 @@
         displayDetailsOnTestsThatTriggerWarnings="true"
 >
   <testsuites>
-    <testsuite name="Unit">
-      <directory suffix="Test.php">./tests/Unit</directory>
+    <testsuite name="Tests">
+      <directory suffix="Test.php">./tests</directory>
     </testsuite>
   </testsuites>
   <coverage />

diff --git a/src/ConsoleArgumentBag.php b/src/ConsoleArgumentBag.php
@@ -26,7 +26,7 @@ public function __construct(array $arguments)
 
         foreach (array_values($arguments) as $position => $argument) {
             $this->add(
-                ConsoleInputArgument::fromString($argument, $position)
+                ConsoleInputArgument::fromString($argument, $position),
             );
         }
     }
@@ -39,6 +39,25 @@ public function all(): array
         return $this->arguments;
     }
 
+    public function findFor(ConsoleArgumentDefinition $argumentDefinition): ?ConsoleInputArgument
+    {
+        foreach ($this->arguments as $argument) {
+            if ($argumentDefinition->matchesArgument($argument)) {
+                return $argument;
+            }
+        }
+
+        if ($argumentDefinition->hasDefault) {
+            return new ConsoleInputArgument(
+                name: $argumentDefinition->name,
+                value: $argumentDefinition->default,
+                position: $argumentDefinition->position,
+            );
+        }
+
+        return null;
+    }
+
     private function add(ConsoleInputArgument $argument): self
     {
         $this->arguments[] = $argument;

diff --git a/src/ConsoleArgumentDefinition.php b/src/ConsoleArgumentDefinition.php
@@ -17,7 +17,7 @@ public function __construct(
         public readonly int $position,
         public readonly ?string $description = null,
         public readonly array $aliases = [],
-        public readonly string $help = '',
+        public readonly ?string $help = null,
     ) {
     }
 

diff --git a/src/ConsoleCommandDefinition.php b/src/ConsoleCommandDefinition.php
@@ -9,6 +9,5 @@
     public function __construct(
         /** @var ConsoleArgumentDefinition[] */
         public array $argumentDefinitions,
-    ) {
-    }
+    ) {}
 }
diff --git a/src/ConsoleInputBuilder.php b/src/ConsoleInputBuilder.php
@@ -11,9 +11,7 @@ final class ConsoleInputBuilder
     public function __construct(
         protected ConsoleCommandDefinition $commandDefinition,
         protected ConsoleArgumentBag $argumentBag,
-    ) {
-
-    }
+    ) {}
 
     /**
      * @return array<ConsoleInputArgument>
@@ -22,64 +20,29 @@ public function __construct(
     public function build(): array
     {
         $validArguments = [];
+        $invalidDefinitions = [];
 
-        $passedArguments = $this->argumentBag->all();
-        $argumentDefinitionList = $this->commandDefinition->argumentDefinitions;
-
-        if (! $argumentDefinitionList && $passedArguments) {
-            throw UnresolvedArgumentsException::fromArguments($passedArguments);
-        }
+        $argumentDefinitions = $this->commandDefinition->argumentDefinitions;
 
-        foreach ($argumentDefinitionList as $definitionKey => $definitionArgument) {
-            $validArguments[] = $this->resolveArgument($definitionArgument, $passedArguments);
-            unset($argumentDefinitionList[$definitionKey]);
-        }
+        foreach ($argumentDefinitions as $argumentDefinition) {
+            $value = $this->argumentBag->findFor($argumentDefinition);
 
-        if (count($passedArguments) > 0 || count($argumentDefinitionList) > 0) {
-            throw UnresolvedArgumentsException::fromArguments([
-                ...$passedArguments,
-                ...$argumentDefinitionList,
-            ]);
-        }
+            if ($value === null) {
+                $invalidDefinitions[] = $argumentDefinition;
 
-        return $this->toValues($validArguments);
-    }
-
-    /**
-     * @param ConsoleInputArgument[] $validArguments
-     *
-     * @return array
-     */
-    private function toValues(array $validArguments): array
-    {
-        return array_map(
-            callback: fn (ConsoleInputArgument $argument) => $argument->value,
-            array: $validArguments
-        );
-    }
-
-    private function resolveArgument(ConsoleArgumentDefinition $argumentDefinition, array &$passedArguments): ?ConsoleInputArgument
-    {
-        foreach ($passedArguments as $key => $argument) {
-            if ($argumentDefinition->matchesArgument($argument)) {
-                unset($passedArguments[$key]);
-
-                return $argument;
+                continue;
             }
+
+            $validArguments[] = $value;
         }
 
-        /**
-         * In case there was no passed argument that matches this definition argument,
-         * we'll check if the definition argument has a default value.
-         */
-        if (! $argumentDefinition->hasDefault) {
-            return null;
+        if (count($invalidDefinitions)) {
+            throw new UnresolvedArgumentsException($invalidDefinitions);
         }
 
-        return new ConsoleInputArgument(
-            name: $argumentDefinition->name,
-            value: $argumentDefinition->default,
-            position: $argumentDefinition->position,
+        return array_map(
+            callback: fn (ConsoleInputArgument $argument) => $argument->value,
+            array: $validArguments,
         );
     }
 }
diff --git a/src/Exceptions/CommandNotFoundException.php b/src/Exceptions/CommandNotFoundException.php
@@ -5,6 +5,7 @@
 namespace Tempest\Console\Exceptions;
 
 use Tempest\Console\ConsoleOutput;
+use Tempest\Console\ConsoleStyle;
 
 final class CommandNotFoundException extends ConsoleException
 {
@@ -16,7 +17,7 @@ public function __construct(
     public function render(ConsoleOutput $output): void
     {
         $output->writeln(
-            sprintf('Command %s not found', $this->commandName),
+            sprintf('Command %s not found', ConsoleStyle::FG_DARK_RED(ConsoleStyle::UNDERLINE($this->commandName))),
         );
     }
 }
diff --git a/src/Exceptions/ConsoleExceptionHandler.php b/src/Exceptions/ConsoleExceptionHandler.php
@@ -25,7 +25,7 @@ public function handle(Throwable $throwable): void
             ->error($throwable::class)
             ->when(
                 expression: $throwable->getMessage(),
-                callback: fn (ConsoleOutput $output) => $output->writeln($throwable->getMessage()),
+                callback: fn (ConsoleOutput $output) => $output->error($throwable->getMessage()),
             )
             ->writeln();
 

diff --git a/src/Exceptions/UnresolvedArgumentsException.php b/src/Exceptions/UnresolvedArgumentsException.php
@@ -4,56 +4,24 @@
 
 namespace Tempest\Console\Exceptions;
 
-use Tempest\Console\ConsoleInputArgument;
 use Tempest\Console\ConsoleOutput;
 
 final class UnresolvedArgumentsException extends ConsoleException
 {
-    /** @var ConsoleInputArgument[] */
-    public array $arguments;
-
-    /**
-     * @param ConsoleInputArgument[] $arguments
-     *
-     * @return self
-     */
-    public static function fromArguments(array $arguments): self
-    {
-        $exception = new self('Unresolved arguments found');
-        $exception->setArguments(array_values($arguments));
-
-        return $exception;
-    }
-
-    /**
-     * @param ConsoleInputArgument[] $arguments
-     *
-     * @return $this
-     */
-    public function setArguments(array $arguments): self
-    {
-        $this->arguments = $arguments;
-
-        return $this;
-    }
-
-    /**
-     * @return ConsoleInputArgument[]
-     */
-    public function getArguments(): array
-    {
-        return $this->arguments;
-    }
+    public function __construct(
+        /** @var \Tempest\Console\ConsoleArgumentDefinition[] $invalidDefinitions */
+        private array $invalidDefinitions,
+    ) {}
 
     public function render(ConsoleOutput $output): void
     {
-        $output->error('Unresolved arguments found');
+        $output->error('Invalid command');
 
-        foreach ($this->arguments as $argument) {
+        foreach ($this->invalidDefinitions as $definition) {
             $output->writeln(
                 sprintf(
-                    'Argument %s is invalid',
-                    $argument->name ?? "#$argument->position",
+                    'Argument %s is missing',
+                    $definition->name,
                 ),
             );
         }

diff --git a/src/Testing/Console/ConsoleCommandTester.php b/src/Testing/Console/ConsoleCommandTester.php
@@ -15,16 +15,17 @@
 {
     public function __construct(private Container $container)
     {
-        $this->container->singleton(
-            ConsoleOutput::class,
-            fn () => $this->container->get(TestConsoleOutput::class)
-        );
     }
 
     public function call(string $command): TestConsoleHelper
     {
         $appConfig = $this->container->get(AppConfig::class);
 
+        $this->container->singleton(
+            ConsoleOutput::class,
+            fn () => $this->container->get(TestConsoleOutput::class)
+        );
+
         $appConfig->exceptionHandlers[] = $this->container->get(ConsoleExceptionHandler::class);
 
         $application = new ConsoleApplication(

diff --git a/src/Testing/Console/TestConsoleHelper.php b/src/Testing/Console/TestConsoleHelper.php
@@ -13,6 +13,20 @@ public function __construct(
     ) {
     }
 
+    public function print(): self
+    {
+        echo $this->output->getTextWithoutFormatting();
+
+        return $this;
+    }
+
+    public function printFormatted(): self
+    {
+        echo $this->output->getTextWithFormatting();
+
+        return $this;
+    }
+
     public function assertContains(string $text): self
     {
         Assert::assertStringContainsString(

diff --git a/tests/Actions/RenderConsoleCommandOverviewTest.php b/tests/Actions/RenderConsoleCommandOverviewTest.php
@@ -0,0 +1,20 @@
+<?php
+
+namespace Tests\Tempest\Console\Actions;
+
+use Tests\Tempest\Console\TestCase;
+
+class RenderConsoleCommandOverviewTest extends TestCase
+{
+    public function test_overview(): void
+    {
+        $this->console
+            ->call('')
+            ->assertContains('Tempest')
+            ->assertContains('General')
+            ->assertContains('Hello')
+            ->assertContains('hello:world <input>')
+            ->assertContains('hello:test [optionalValue=null] [--flag=false] - description')
+            ->assertContains('test:test');
+    }
+}
diff --git a/tests/Unit/Console/ArgumentBagTest.php → tests/ArgumentBagTest.php b/tests/Unit/Console/ArgumentBagTest.php → tests/ArgumentBagTest.php
@@ -2,7 +2,7 @@
 
 declare(strict_types=1);
 
-namespace Tests\Tempest\Unit\Console;
+namespace Tests\Tempest\Console;
 
 use PHPUnit\Framework\TestCase;
 use Tempest\Console\ConsoleArgumentBag;

diff --git a/.../Unit/Console/CommandInputBuilderTest.php → tests/CommandInputBuilderTest.php b/.../Unit/Console/CommandInputBuilderTest.php → tests/CommandInputBuilderTest.php
@@ -2,7 +2,7 @@
 
 declare(strict_types=1);
 
-namespace Tests\Tempest\Unit\Console;
+namespace Tests\Tempest\Console;
 
 use PHPUnit\Framework\TestCase;
 use Tempest\Console\ConsoleArgumentBag;

diff --git a/tests/Exceptions/CommandNotFoundExceptionTest.php b/tests/Exceptions/CommandNotFoundExceptionTest.php
@@ -0,0 +1,18 @@
+<?php
+
+namespace Tests\Tempest\Console\Exceptions;
+
+use Tempest\Console\ConsoleStyle;
+use Tests\Tempest\Console\TestCase;
+
+class CommandNotFoundExceptionTest extends TestCase
+{
+    public function test_console_exception_handler(): void
+    {
+        $this->console
+            ->call('foo:bar')
+            ->assertContains('Command foo:bar not found')
+            ->assertContainsFormattedText(ConsoleStyle::FG_DARK_RED(ConsoleStyle::UNDERLINE('foo:bar')))
+        ;
+    }
+}