Improve output

tempestphp · Apr 5, 2024 · 0f06e64 · 0f06e64
1 parent a704ccb
commit 0f06e64
Show file tree

Hide file tree

Showing 10 changed files with 229 additions and 107 deletions.
diff --git a/src/Actions/RenderConsoleCommand.php b/src/Actions/RenderConsoleCommand.php
@@ -6,11 +6,14 @@
 
 use ReflectionParameter;
 use Tempest\Console\ConsoleCommand;
+use Tempest\Console\ConsoleOutput;
 use Tempest\Console\ConsoleStyle;
 
 final readonly class RenderConsoleCommand
 {
-    public function __invoke(ConsoleCommand $consoleCommand): string
+    public function __construct(private ConsoleOutput $output) {}
+
+    public function __invoke(ConsoleCommand $consoleCommand): void
     {
         $parts = [ConsoleStyle::FG_DARK_BLUE($consoleCommand->getName())];
 
@@ -22,7 +25,7 @@ public function __invoke(ConsoleCommand $consoleCommand): string
             $parts[] = "- {$consoleCommand->getDescription()}";
         }
 
-        return implode(' ', $parts);
+        $this->output->writeln(' ' . implode(' ', $parts));
     }
 
     private function renderParameter(ReflectionParameter $parameter): string

diff --git a/src/Actions/RenderConsoleCommandOverview.php b/src/Actions/RenderConsoleCommandOverview.php
@@ -6,27 +6,26 @@
 
 use Tempest\AppConfig;
 use Tempest\Console\ConsoleConfig;
-use Tempest\Console\ConsoleStyle;
+use Tempest\Console\ConsoleOutput;
+use Tempest\Console\ConsoleOutputType;
 
 final readonly class RenderConsoleCommandOverview
 {
     public function __construct(
+        private ConsoleOutput $output,
         private AppConfig $appConfig,
         private ConsoleConfig $consoleConfig,
     ) {
     }
 
-    public function __invoke(): string
+    public function __invoke(): void
     {
-        $lines = [
-            ConsoleStyle::BOLD(ConsoleStyle::BG_DARK_BLUE(" {$this->consoleConfig->name} ")),
-        ];
-
-        if ($this->appConfig->discoveryCache) {
-            $lines[] = ConsoleStyle::BG_RED(' Discovery cache is enabled! ');
-        }
-
-        $lines[] = '';
+        $this->output
+            ->writeln($this->consoleConfig->name, ConsoleOutputType::H1)
+            ->when(
+                expression: $this->appConfig->discoveryCache,
+                callback: fn (ConsoleOutput $output) => $output->error('Discovery cache is enabled!')
+            );
 
         /** @var \Tempest\Console\ConsoleCommand[][] $commands */
         $commands = [];
@@ -42,16 +41,13 @@ public function __invoke(): string
         ksort($commands);
 
         foreach ($commands as $group => $commandsForGroup) {
-            $lines[] = ConsoleStyle::BOLD(ConsoleStyle::BG_BLUE(' ' . ucfirst($group) . ' '));
+            $this->output
+                ->writeln()
+                ->writeln(ucfirst($group), ConsoleOutputType::H2);
 
             foreach ($commandsForGroup as $consoleCommand) {
-                $renderedConsoleCommand = (new RenderConsoleCommand())($consoleCommand);
-                $lines[] = "  {$renderedConsoleCommand}";
+                (new RenderConsoleCommand($this->output))($consoleCommand);
             }
-
-            $lines[] = '';
         }
-
-        return implode(PHP_EOL, $lines);
     }
 }
diff --git a/src/ConsoleApplication.php b/src/ConsoleApplication.php
@@ -57,10 +57,8 @@ public function run(): void
         try {
             $commandName = $this->args[1] ?? null;
 
-            $output = $this->container->get(ConsoleOutput::class);
-
             if (! $commandName) {
-                $output->writeln($this->container->get(RenderConsoleCommandOverview::class)());
+                $this->container->get(RenderConsoleCommandOverview::class)();
 
                 return;
             }

diff --git a/src/ConsoleOutput.php b/src/ConsoleOutput.php
@@ -6,13 +6,17 @@
 
 interface ConsoleOutput
 {
-    public function write(string $line): void;
+    public function delimiter(string $delimiter): ConsoleOutput;
 
-    public function writeln(string $line): void;
+    public function write(string $line, ConsoleOutputType $type = ConsoleOutputType::DEFAULT): ConsoleOutput;
 
-    public function info(string $line): void;
+    public function writeln(string $line = '', ConsoleOutputType $type = ConsoleOutputType::DEFAULT): ConsoleOutput;
 
-    public function error(string $line): void;
+    public function info(string $line): ConsoleOutput;
 
-    public function success(string $line): void;
+    public function error(string $line): ConsoleOutput;
+
+    public function success(string $line): ConsoleOutput;
+
+    public function when(mixed $expression, callable $callback): ConsoleOutput;
 }
diff --git a/src/ConsoleOutputType.php b/src/ConsoleOutputType.php
@@ -0,0 +1,52 @@
+<?php
+
+namespace Tempest\Console;
+
+enum ConsoleOutputType
+{
+    case DEFAULT;
+    case INFO;
+    case ERROR;
+    case SUCCESS;
+    case COMMENT;
+    case H1;
+    case H2;
+
+    public function style(string $input): string
+    {
+        return match ($this) {
+            self::INFO => ConsoleStyle::FG_DARK_BLUE($input),
+            self::ERROR => ConsoleStyle::BOLD(ConsoleStyle::FG_WHITE(ConsoleStyle::BG_RED(ConsoleStyle::FG_WHITE($this->error($input))))),
+            self::SUCCESS => ConsoleStyle::BOLD(ConsoleStyle::FG_DARK_GREEN($input)),
+            self::H1 => ConsoleStyle::BOLD(ConsoleStyle::FG_WHITE(ConsoleStyle::BG_DARK_BLUE($this->header($input)))),
+            self::H2 => ConsoleStyle::BG_BLUE($this->header($input)),
+            self::COMMENT => ConsoleStyle::FG_GRAY($this->comment($input)),
+            default => $input,
+        };
+    }
+
+    private function header(string $input): string
+    {
+        return " {$input} ";
+    }
+
+    private function error(string $input): string
+    {
+        return " {$input} ";
+    }
+
+    private function comment(string $input): string
+    {
+        return implode(
+            PHP_EOL,
+            [
+                '/*',
+                ...array_map(
+                    fn (string $line) => "* {$line}",
+                    explode(PHP_EOL, $input),
+                ),
+                '*/'
+            ],
+        );
+    }
+}
diff --git a/src/GenericConsole.php b/src/GenericConsole.php
@@ -4,14 +4,25 @@
 
 namespace Tempest\Console;
 
-readonly class GenericConsole implements Console
+final class GenericConsole implements Console
 {
+    private string $delimiter = PHP_EOL;
+
     public function __construct(
-        private ConsoleInput $input,
-        private ConsoleOutput $output,
+        private readonly ConsoleInput $input,
+        private readonly ConsoleOutput $output,
     ) {
     }
 
+    public function delimiter(string $delimiter): ConsoleOutput
+    {
+        $clone = clone $this;
+
+        $this->delimiter = $delimiter;
+
+        return $clone;
+    }
+
     public function readln(): string
     {
         return $this->input->readln();
@@ -27,28 +38,33 @@ public function confirm(string $question, bool $default = false): bool
         return $this->input->confirm($question, $default);
     }
 
-    public function write(string $line): void
+    public function write(string $line, ConsoleOutputType $type = ConsoleOutputType::DEFAULT): ConsoleOutput
+    {
+        return $this->output->write($line, $type);
+    }
+
+    public function writeln(string $line = '', ConsoleOutputType $type = ConsoleOutputType::DEFAULT): ConsoleOutput
     {
-        $this->output->write($line);
+        return $this->output->writeln($line, $type);
     }
 
-    public function writeln(string $line): void
+    public function info(string $line): ConsoleOutput
     {
-        $this->output->writeln($line);
+        return $this->output->info($line);
     }
 
-    public function info(string $line): void
+    public function error(string $line): ConsoleOutput
     {
-        $this->output->info($line);
+        return $this->output->error($line);
     }
 
-    public function error(string $line): void
+    public function success(string $line): ConsoleOutput
     {
-        $this->output->error($line);
+        return $this->output->success($line);
     }
 
-    public function success(string $line): void
+    public function when(mixed $expression, callable $callback): ConsoleOutput
     {
-        $this->output->success($line);
+        return $this->output->when($expression, $callback);
     }
 }
diff --git a/src/GenericConsoleOutput.php b/src/GenericConsoleOutput.php
@@ -4,7 +4,72 @@
 
 namespace Tempest\Console;
 
-final readonly class GenericConsoleOutput implements ConsoleOutput
+final class GenericConsoleOutput implements ConsoleOutput
 {
-    use HandlesConsoleOutput;
+    public string $delimiter = PHP_EOL;
+
+    public function delimiter(string $delimiter): ConsoleOutput
+    {
+        $clone = clone $this;
+
+        $this->delimiter = $delimiter;
+
+        return $clone;
+    }
+
+    public function write(string $line, ConsoleOutputType $type = ConsoleOutputType::DEFAULT): ConsoleOutput
+    {
+        $this->writeToStdOut($type->style($line));
+
+        return $this;
+    }
+
+    public function writeln(string $line = '', ConsoleOutputType $type = ConsoleOutputType::DEFAULT): ConsoleOutput
+    {
+        $this->writeToStdOut($type->style($line) . $this->delimiter);
+
+        return $this;
+    }
+
+    public function info(string $line): ConsoleOutput
+    {
+        $this->writeln($line, ConsoleOutputType::INFO);
+
+        return $this;
+    }
+
+    public function error(string $line): ConsoleOutput
+    {
+        $this->writeln($line, ConsoleOutputType::ERROR);
+
+        return $this;
+    }
+
+    public function success(string $line): ConsoleOutput
+    {
+        $this->writeln($line, ConsoleOutputType::SUCCESS);
+
+        return $this;
+    }
+
+    public function when(mixed $expression, callable $callback): ConsoleOutput
+    {
+        if ($expression) {
+            $callback($this);
+        }
+
+        return $this;
+    }
+
+    private function writeToStdOut(string $content): void
+    {
+        $stdout = fopen('php://stdout', 'w');
+
+        fwrite(
+            $stdout,
+            ConsoleStyle::RESET($content),
+        );
+
+        fclose($stdout);
+    }
 }
diff --git a/src/HandlesConsoleOutput.php b/src/HandlesConsoleOutput.php