feat(console): support dynamic style injections (#703)

Author: innocenzi

composer.json

@@ -117,6 +117,7 @@
             "Tempest\\Cache\\Tests\\": "src/Tempest/Cache/tests",
             "Tempest\\Clock\\Tests\\": "src/Tempest/Clock/tests",
             "Tempest\\CommandBus\\Tests\\": "src/Tempest/CommandBus/tests",
+            "Tempest\\Console\\Tests\\": "src/Tempest/Console/tests",
             "Tempest\\Container\\Tests\\": "src/Tempest/Container/tests",
             "Tempest\\Core\\Tests\\": "src/Tempest/Core/tests",
             "Tempest\\Database\\Tests\\": "src/Tempest/Database/tests",

src/Tempest/Console/composer.json

@@ -21,6 +21,11 @@
             "Tempest\\Console\\": "src"
         }
     },
+    "autoload-dev": {
+        "psr-4": {
+            "Tempest\\Console\\Tests\\": "tests"
+        }
+    },
     "bin": [
         "bin/tempest"
     ]

src/Tempest/Console/src/Highlight/DynamicTokenType.php

@@ -0,0 +1,46 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Tempest\Console\Highlight;
+
+use Tempest\Highlight\Themes\TerminalStyle;
+use Tempest\Highlight\Tokens\TokenType;
+use function Tempest\Support\str;
+
+final readonly class DynamicTokenType implements TokenType
+{
+    public function __construct(
+        private string $style,
+    ) {
+    }
+
+    public function getStyle(): TerminalStyle
+    {
+        $normalizedStyle = str($this->style)
+            ->lower()
+            ->replace(['_', '-'], '');
+
+        foreach (TerminalStyle::cases() as $case) {
+            $normalizedCase = str($case->name)
+                ->lower()
+                ->replace(['_', '-'], '');
+
+            if ($normalizedCase->equals($normalizedStyle)) {
+                return $case;
+            }
+        }
+
+        return TerminalStyle::RESET;
+    }
+
+    public function getValue(): string
+    {
+        return '';
+    }
+
+    public function canContain(TokenType $other): bool
+    {
+        return false;
+    }
+}

src/Tempest/Console/src/Highlight/TempestConsoleLanguage/Injections/DynamicInjection.php

@@ -0,0 +1,60 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Tempest\Console\Highlight\TempestConsoleLanguage\Injections;
+
+use Tempest\Console\Highlight\ConsoleTokenType;
+use Tempest\Console\Highlight\DynamicTokenType;
+use Tempest\Highlight\Highlighter;
+use Tempest\Highlight\Injection;
+use Tempest\Highlight\ParsedInjection;
+use function Tempest\Support\str;
+
+final readonly class DynamicInjection implements Injection
+{
+    public function getTokenType(): ConsoleTokenType
+    {
+        return ConsoleTokenType::COMMENT;
+    }
+
+    public function parse(string $content, Highlighter $highlighter): ParsedInjection
+    {
+        $pattern = '/(?<match>\<style=\"(?<styles>(?:[a-z-]+\s*)+)\"\>(.|\n)*\<\/style\>)/';
+
+        $result = preg_replace_callback(
+            pattern: $pattern,
+            callback: function ($matches) use ($highlighter, $pattern) {
+                $theme = $highlighter->getTheme();
+                $content = $matches['match'];
+                $styles = $matches['styles'];
+                $before = '';
+                $after = '';
+
+                foreach (explode(' ', $styles) as $style) {
+                    $token = new DynamicTokenType($style);
+                    $before .= $theme->before($token);
+                    $after .= $theme->after($token);
+                }
+
+                $result = str_replace(
+                    search: $content,
+                    replace: str($content)
+                        ->replaceFirst("<style=\"{$styles}\">", $before)
+                        ->replaceLast("</style>", $after)
+                        ->toString(),
+                    subject: $matches[0],
+                );
+
+                if (preg_match($pattern, $result)) {
+                    return $this->parse($result, $highlighter)->content;
+                }
+
+                return $result;
+            },
+            subject: $content,
+        );
+
+        return new ParsedInjection($result ?? $content);
+    }
+}

src/Tempest/Console/src/Highlight/TempestConsoleLanguage/TempestConsoleLanguage.php

@@ -5,6 +5,7 @@
 namespace Tempest\Console\Highlight\TempestConsoleLanguage;
 
 use Tempest\Console\Highlight\TempestConsoleLanguage\Injections\CommentInjection;
+use Tempest\Console\Highlight\TempestConsoleLanguage\Injections\DynamicInjection;
 use Tempest\Console\Highlight\TempestConsoleLanguage\Injections\EmphasizeInjection;
 use Tempest\Console\Highlight\TempestConsoleLanguage\Injections\ErrorInjection;
 use Tempest\Console\Highlight\TempestConsoleLanguage\Injections\H1Injection;
@@ -39,6 +40,7 @@ public function getInjections(): array
             new H1Injection(),
             new H2Injection(),
             new SuccessInjection(),
+            new DynamicInjection(),
         ];
     }
 

src/Tempest/Console/src/Highlight/TempestTerminalTheme.php

@@ -16,6 +16,10 @@
 
     public function before(TokenType $tokenType): string
     {
+        if ($tokenType instanceof DynamicTokenType) {
+            return $this->style($tokenType->getStyle());
+        }
+
         return match ($tokenType) {
             TokenTypeEnum::KEYWORD => $this->style(TerminalStyle::FG_DARK_BLUE),
             TokenTypeEnum::PROPERTY => $this->style(TerminalStyle::FG_DARK_GREEN),

src/Tempest/Console/tests/TempestConsoleLanguage/Injections/DynamicInjectionTest.php

@@ -0,0 +1,38 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Tempest\Console\Tests\TempestConsoleLanguage\Injections;
+
+use PHPUnit\Framework\Attributes\Test;
+use PHPUnit\Framework\Attributes\TestWith;
+use PHPUnit\Framework\TestCase;
+use Tempest\Console\Highlight\TempestConsoleLanguage\Injections\DynamicInjection;
+use Tempest\Console\Highlight\TempestTerminalTheme;
+use Tempest\Highlight\Highlighter;
+
+/**
+ * @internal
+ */
+final class DynamicInjectionTest extends TestCase
+{
+    #[TestWith(['<style="fg-cyan">foo</style>', "\e[96mfoo\e[0m"])]
+    #[TestWith(['<style="bg-red">foo</style>', "\e[101mfoo\e[0m"])]
+    #[TestWith(['<style="bold">foo</style>', "\e[1mfoo\e[0m"])]
+    #[TestWith(['<style="underline">foo</style>', "\e[4mfoo\e[0m"])]
+    #[TestWith(['<style="reset">foo</style>', "\e[0mfoo\e[0m"])]
+    #[TestWith(['<style="reverse-text">foo</style>', "\e[7mfoo\e[0m"])]
+    #[TestWith(['<style="bg-darkcyan fg-cyan underline">Tempest</style>', "\e[46m\e[96m\e[4mTempest\e[0m\e[0m\e[0m"])]
+    #[TestWith(['<style="bg-dark-cyan fg-cyan underline">Tempest</style>', "\e[46m\e[96m\e[4mTempest\e[0m\e[0m\e[0m"])]
+    #[TestWith(['<style="fg-cyan"><style="bg-dark-red">foo</style></style>', "\e[96m\e[41mfoo\e[0m\e[0m"])]
+    #[Test]
+    public function language(string $content, string $expected): void
+    {
+        $highlighter = new Highlighter(new TempestTerminalTheme());
+
+        $this->assertSame(
+            $expected,
+            (new DynamicInjection())->parse($content, $highlighter)->content,
+        );
+    }
+}

tests/Integration/Console/Highlight/TempestConsoleLanguage/TempestConsoleLanguageTest.php

@@ -0,0 +1,38 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Tests\Tempest\Integration\Console\Highlight\LogLanguage;
+
+use PHPUnit\Framework\Attributes\Test;
+use PHPUnit\Framework\Attributes\TestWith;
+use PHPUnit\Framework\TestCase;
+use Tempest\Console\Highlight\TempestConsoleLanguage\TempestConsoleLanguage;
+use Tempest\Console\Highlight\TempestTerminalTheme;
+use Tempest\Highlight\Highlighter;
+
+/**
+ * @internal
+ */
+final class TempestConsoleLanguageTest extends TestCase
+{
+    #[TestWith(['<style="fg-cyan">foo</style>', "\e[96mfoo\e[0m"])]
+    #[TestWith(['<style="bg-red">foo</style>', "\e[101mfoo\e[0m"])]
+    #[TestWith(['<style="bold">foo</style>', "\e[1mfoo\e[0m"])]
+    #[TestWith(['<style="underline">foo</style>', "\e[4mfoo\e[0m"])]
+    #[TestWith(['<style="reset">foo</style>', "\e[0mfoo\e[0m"])]
+    #[TestWith(['<style="reverse-text">foo</style>', "\e[7mfoo\e[0m"])]
+    #[TestWith(['<style="bg-darkcyan fg-cyan underline">Tempest</style>', "\e[46m\e[96m\e[4mTempest\e[0m\e[0m\e[0m"])]
+    #[TestWith(['<style="bg-dark-cyan fg-cyan underline">Tempest</style>', "\e[46m\e[96m\e[4mTempest\e[0m\e[0m\e[0m"])]
+    #[TestWith(['<style="fg-cyan"><style="bg-dark-red">foo</style></style>', "\e[96m\e[41mfoo\e[0m\e[0m"])]
+    #[Test]
+    public function language(string $content, string $expected): void
+    {
+        $highlighter = new Highlighter(new TempestTerminalTheme());
+
+        $this->assertSame(
+            $expected,
+            $highlighter->parse($content, new TempestConsoleLanguage())
+        );
+    }
+}