From 471fa7dbd52a9887d1fa40ffdfb392de737cec72 Mon Sep 17 00:00:00 2001
From: Brent Roose <brent.roose@gmail.com>
Date: Tue, 19 Mar 2024 11:59:06 +0100
Subject: [PATCH] Add yaml

---
 src/Highlighter.php                           |  3 +
 .../Patterns/YamlArrayBracketsPattern.php     | 26 +++++++++
 .../Yaml/Patterns/YamlColonPattern.php        | 27 +++++++++
 .../Yaml/Patterns/YamlCommentPattern.php      | 26 +++++++++
 .../Yaml/Patterns/YamlDashPattern.php         | 26 +++++++++
 .../YamlDoubleAccoladesValuePattern.php       | 26 +++++++++
 .../Patterns/YamlDoubleQuoteValuePattern.php  | 26 +++++++++
 .../Patterns/YamlObjectBracketsPattern.php    | 26 +++++++++
 .../Yaml/Patterns/YamlPipePattern.php         | 26 +++++++++
 .../Yaml/Patterns/YamlPropertyPattern.php     | 27 +++++++++
 .../Patterns/YamlSingleQuoteValuePattern.php  | 26 +++++++++
 .../Yaml/Patterns/YamlVariablePattern.php     | 26 +++++++++
 src/Languages/Yaml/YamlLanguage.php           | 46 ++++++++++++++++
 src/Themes/highlight-light-lite.css           |  2 +-
 tests/Languages/Yaml/YamlLanguageTest.php     | 55 +++++++++++++++++++
 tests/test.md                                 | 28 ++++------
 16 files changed, 405 insertions(+), 17 deletions(-)
 create mode 100644 src/Languages/Yaml/Patterns/YamlArrayBracketsPattern.php
 create mode 100644 src/Languages/Yaml/Patterns/YamlColonPattern.php
 create mode 100644 src/Languages/Yaml/Patterns/YamlCommentPattern.php
 create mode 100644 src/Languages/Yaml/Patterns/YamlDashPattern.php
 create mode 100644 src/Languages/Yaml/Patterns/YamlDoubleAccoladesValuePattern.php
 create mode 100644 src/Languages/Yaml/Patterns/YamlDoubleQuoteValuePattern.php
 create mode 100644 src/Languages/Yaml/Patterns/YamlObjectBracketsPattern.php
 create mode 100644 src/Languages/Yaml/Patterns/YamlPipePattern.php
 create mode 100644 src/Languages/Yaml/Patterns/YamlPropertyPattern.php
 create mode 100644 src/Languages/Yaml/Patterns/YamlSingleQuoteValuePattern.php
 create mode 100644 src/Languages/Yaml/Patterns/YamlVariablePattern.php
 create mode 100644 src/Languages/Yaml/YamlLanguage.php
 create mode 100644 tests/Languages/Yaml/YamlLanguageTest.php

diff --git a/src/Highlighter.php b/src/Highlighter.php
index 24f5419..e4f2cb2 100644
--- a/src/Highlighter.php
+++ b/src/Highlighter.php
@@ -9,6 +9,7 @@
 use Tempest\Highlight\Languages\Html\HtmlLanguage;
 use Tempest\Highlight\Languages\Php\PhpLanguage;
 use Tempest\Highlight\Languages\Sql\SqlLanguage;
+use Tempest\Highlight\Languages\Yaml\YamlLanguage;
 use Tempest\Highlight\Themes\CssTheme;
 use Tempest\Highlight\Tokens\GroupTokens;
 use Tempest\Highlight\Tokens\ParseTokens;
@@ -28,6 +29,8 @@ public function __construct(
             ->setLanguage('html', new HtmlLanguage())
             ->setLanguage('sql', new SqlLanguage())
             ->setLanguage('blade', new BladeLanguage())
+            ->setLanguage('yaml', new YamlLanguage())
+            ->setLanguage('yml', new YamlLanguage())
             ->setLanguage('css', new CssLanguage());
     }
 
diff --git a/src/Languages/Yaml/Patterns/YamlArrayBracketsPattern.php b/src/Languages/Yaml/Patterns/YamlArrayBracketsPattern.php
new file mode 100644
index 0000000..af29785
--- /dev/null
+++ b/src/Languages/Yaml/Patterns/YamlArrayBracketsPattern.php
@@ -0,0 +1,26 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Tempest\Highlight\Languages\Yaml\Patterns;
+
+use Tempest\Highlight\IsPattern;
+use Tempest\Highlight\Pattern;
+use Tempest\Highlight\PatternTest;
+use Tempest\Highlight\Tokens\TokenType;
+
+#[PatternTest(input: 'branches: [main]', output: ['[', ']'])]
+final readonly class YamlArrayBracketsPattern implements Pattern
+{
+    use IsPattern;
+
+    public function getPattern(): string
+    {
+        return '(?<match>(\[|\]))';
+    }
+
+    public function getTokenType(): TokenType
+    {
+        return TokenType::PROPERTY;
+    }
+}
diff --git a/src/Languages/Yaml/Patterns/YamlColonPattern.php b/src/Languages/Yaml/Patterns/YamlColonPattern.php
new file mode 100644
index 0000000..3241622
--- /dev/null
+++ b/src/Languages/Yaml/Patterns/YamlColonPattern.php
@@ -0,0 +1,27 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Tempest\Highlight\Languages\Yaml\Patterns;
+
+use Tempest\Highlight\IsPattern;
+use Tempest\Highlight\Pattern;
+use Tempest\Highlight\PatternTest;
+use Tempest\Highlight\Tokens\TokenType;
+
+#[PatternTest(input: '- name: Setup problem matchers |', output: ':')]
+#[PatternTest(input: '- { link: "/blog/new-in-php-83" }', output: ':')]
+final readonly class YamlColonPattern implements Pattern
+{
+    use IsPattern;
+
+    public function getPattern(): string
+    {
+        return '/^[\-\{\s\w]*(?<match>:)/m';
+    }
+
+    public function getTokenType(): TokenType
+    {
+        return TokenType::PROPERTY;
+    }
+}
diff --git a/src/Languages/Yaml/Patterns/YamlCommentPattern.php b/src/Languages/Yaml/Patterns/YamlCommentPattern.php
new file mode 100644
index 0000000..e6725e1
--- /dev/null
+++ b/src/Languages/Yaml/Patterns/YamlCommentPattern.php
@@ -0,0 +1,26 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Tempest\Highlight\Languages\Yaml\Patterns;
+
+use Tempest\Highlight\IsPattern;
+use Tempest\Highlight\Pattern;
+use Tempest\Highlight\PatternTest;
+use Tempest\Highlight\Tokens\TokenType;
+
+#[PatternTest(input: '# comment', output: '# comment')]
+final readonly class YamlCommentPattern implements Pattern
+{
+    use IsPattern;
+
+    public function getPattern(): string
+    {
+        return '(?<match>\#(.)*)';
+    }
+
+    public function getTokenType(): TokenType
+    {
+        return TokenType::COMMENT;
+    }
+}
diff --git a/src/Languages/Yaml/Patterns/YamlDashPattern.php b/src/Languages/Yaml/Patterns/YamlDashPattern.php
new file mode 100644
index 0000000..7283c07
--- /dev/null
+++ b/src/Languages/Yaml/Patterns/YamlDashPattern.php
@@ -0,0 +1,26 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Tempest\Highlight\Languages\Yaml\Patterns;
+
+use Tempest\Highlight\IsPattern;
+use Tempest\Highlight\Pattern;
+use Tempest\Highlight\PatternTest;
+use Tempest\Highlight\Tokens\TokenType;
+
+#[PatternTest(input: '- name: Setup problem matchers |', output: '-')]
+final readonly class YamlDashPattern implements Pattern
+{
+    use IsPattern;
+
+    public function getPattern(): string
+    {
+        return '/^[\s]*(?<match>-)/m';
+    }
+
+    public function getTokenType(): TokenType
+    {
+        return TokenType::PROPERTY;
+    }
+}
diff --git a/src/Languages/Yaml/Patterns/YamlDoubleAccoladesValuePattern.php b/src/Languages/Yaml/Patterns/YamlDoubleAccoladesValuePattern.php
new file mode 100644
index 0000000..6c66096
--- /dev/null
+++ b/src/Languages/Yaml/Patterns/YamlDoubleAccoladesValuePattern.php
@@ -0,0 +1,26 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Tempest\Highlight\Languages\Yaml\Patterns;
+
+use Tempest\Highlight\IsPattern;
+use Tempest\Highlight\Pattern;
+use Tempest\Highlight\PatternTest;
+use Tempest\Highlight\Tokens\TokenType;
+
+#[PatternTest(input: 'runs-on: ${{ matrix.os }}', output: ['{{', '}}'])]
+final readonly class YamlDoubleAccoladesValuePattern implements Pattern
+{
+    use IsPattern;
+
+    public function getPattern(): string
+    {
+        return '(?<match>(\{\{|\}\}))';
+    }
+
+    public function getTokenType(): TokenType
+    {
+        return TokenType::VALUE;
+    }
+}
diff --git a/src/Languages/Yaml/Patterns/YamlDoubleQuoteValuePattern.php b/src/Languages/Yaml/Patterns/YamlDoubleQuoteValuePattern.php
new file mode 100644
index 0000000..97831c7
--- /dev/null
+++ b/src/Languages/Yaml/Patterns/YamlDoubleQuoteValuePattern.php
@@ -0,0 +1,26 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Tempest\Highlight\Languages\Yaml\Patterns;
+
+use Tempest\Highlight\IsPattern;
+use Tempest\Highlight\Pattern;
+use Tempest\Highlight\PatternTest;
+use Tempest\Highlight\Tokens\TokenType;
+
+#[PatternTest(input: 'bar: "baz"', output: 'baz')]
+final readonly class YamlDoubleQuoteValuePattern implements Pattern
+{
+    use IsPattern;
+
+    public function getPattern(): string
+    {
+        return '\"(?<match>(.|\n)*?)\"';
+    }
+
+    public function getTokenType(): TokenType
+    {
+        return TokenType::VALUE;
+    }
+}
diff --git a/src/Languages/Yaml/Patterns/YamlObjectBracketsPattern.php b/src/Languages/Yaml/Patterns/YamlObjectBracketsPattern.php
new file mode 100644
index 0000000..a59392d
--- /dev/null
+++ b/src/Languages/Yaml/Patterns/YamlObjectBracketsPattern.php
@@ -0,0 +1,26 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Tempest\Highlight\Languages\Yaml\Patterns;
+
+use Tempest\Highlight\IsPattern;
+use Tempest\Highlight\Pattern;
+use Tempest\Highlight\PatternTest;
+use Tempest\Highlight\Tokens\TokenType;
+
+#[PatternTest(input: 'branches: { link: "/blog/new-in-php-83", title: "Whats new in PHP 8.3" }', output: ['{', '}'])]
+final readonly class YamlObjectBracketsPattern implements Pattern
+{
+    use IsPattern;
+
+    public function getPattern(): string
+    {
+        return '(?<match>(\{|\}))';
+    }
+
+    public function getTokenType(): TokenType
+    {
+        return TokenType::PROPERTY;
+    }
+}
diff --git a/src/Languages/Yaml/Patterns/YamlPipePattern.php b/src/Languages/Yaml/Patterns/YamlPipePattern.php
new file mode 100644
index 0000000..79e883f
--- /dev/null
+++ b/src/Languages/Yaml/Patterns/YamlPipePattern.php
@@ -0,0 +1,26 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Tempest\Highlight\Languages\Yaml\Patterns;
+
+use Tempest\Highlight\IsPattern;
+use Tempest\Highlight\Pattern;
+use Tempest\Highlight\PatternTest;
+use Tempest\Highlight\Tokens\TokenType;
+
+#[PatternTest(input: '- name: Setup problem matchers |', output: '|')]
+final readonly class YamlPipePattern implements Pattern
+{
+    use IsPattern;
+
+    public function getPattern(): string
+    {
+        return '/^[-\s\w\:]+(?<match>\|)/m';
+    }
+
+    public function getTokenType(): TokenType
+    {
+        return TokenType::PROPERTY;
+    }
+}
diff --git a/src/Languages/Yaml/Patterns/YamlPropertyPattern.php b/src/Languages/Yaml/Patterns/YamlPropertyPattern.php
new file mode 100644
index 0000000..e88ff2c
--- /dev/null
+++ b/src/Languages/Yaml/Patterns/YamlPropertyPattern.php
@@ -0,0 +1,27 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Tempest\Highlight\Languages\Yaml\Patterns;
+
+use Tempest\Highlight\IsPattern;
+use Tempest\Highlight\Pattern;
+use Tempest\Highlight\PatternTest;
+use Tempest\Highlight\Tokens\TokenType;
+
+#[PatternTest(input: 'name: Fix Styling', output: 'name')]
+#[PatternTest(input: 'property-name: value', output: 'property-name')]
+final readonly class YamlPropertyPattern implements Pattern
+{
+    use IsPattern;
+
+    public function getPattern(): string
+    {
+        return '(?<match>[\w-]+)\:';
+    }
+
+    public function getTokenType(): TokenType
+    {
+        return TokenType::KEYWORD;
+    }
+}
diff --git a/src/Languages/Yaml/Patterns/YamlSingleQuoteValuePattern.php b/src/Languages/Yaml/Patterns/YamlSingleQuoteValuePattern.php
new file mode 100644
index 0000000..f6e92b7
--- /dev/null
+++ b/src/Languages/Yaml/Patterns/YamlSingleQuoteValuePattern.php
@@ -0,0 +1,26 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Tempest\Highlight\Languages\Yaml\Patterns;
+
+use Tempest\Highlight\IsPattern;
+use Tempest\Highlight\Pattern;
+use Tempest\Highlight\PatternTest;
+use Tempest\Highlight\Tokens\TokenType;
+
+#[PatternTest(input: "bar: 'baz'", output: 'baz')]
+final readonly class YamlSingleQuoteValuePattern implements Pattern
+{
+    use IsPattern;
+
+    public function getPattern(): string
+    {
+        return '\'(?<match>(.|\n)*?)\'';
+    }
+
+    public function getTokenType(): TokenType
+    {
+        return TokenType::VALUE;
+    }
+}
diff --git a/src/Languages/Yaml/Patterns/YamlVariablePattern.php b/src/Languages/Yaml/Patterns/YamlVariablePattern.php
new file mode 100644
index 0000000..aee42e0
--- /dev/null
+++ b/src/Languages/Yaml/Patterns/YamlVariablePattern.php
@@ -0,0 +1,26 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Tempest\Highlight\Languages\Yaml\Patterns;
+
+use Tempest\Highlight\IsPattern;
+use Tempest\Highlight\Pattern;
+use Tempest\Highlight\PatternTest;
+use Tempest\Highlight\Tokens\TokenType;
+
+#[PatternTest(input: 'runs-on: ${{ matrix.os }}', output: ' matrix.os ')]
+final readonly class YamlVariablePattern implements Pattern
+{
+    use IsPattern;
+
+    public function getPattern(): string
+    {
+        return '\$\{\{(?<match>[\w\s\.]+)\}\}';
+    }
+
+    public function getTokenType(): TokenType
+    {
+        return TokenType::PROPERTY;
+    }
+}
diff --git a/src/Languages/Yaml/YamlLanguage.php b/src/Languages/Yaml/YamlLanguage.php
new file mode 100644
index 0000000..c0d38e9
--- /dev/null
+++ b/src/Languages/Yaml/YamlLanguage.php
@@ -0,0 +1,46 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Tempest\Highlight\Languages\Yaml;
+
+use Tempest\Highlight\Languages\Base\BaseLanguage;
+use Tempest\Highlight\Languages\Yaml\Patterns\YamlArrayBracketsPattern;
+use Tempest\Highlight\Languages\Yaml\Patterns\YamlColonPattern;
+use Tempest\Highlight\Languages\Yaml\Patterns\YamlCommentPattern;
+use Tempest\Highlight\Languages\Yaml\Patterns\YamlDashPattern;
+use Tempest\Highlight\Languages\Yaml\Patterns\YamlDoubleAccoladesValuePattern;
+use Tempest\Highlight\Languages\Yaml\Patterns\YamlDoubleQuoteValuePattern;
+use Tempest\Highlight\Languages\Yaml\Patterns\YamlObjectBracketsPattern;
+use Tempest\Highlight\Languages\Yaml\Patterns\YamlPipePattern;
+use Tempest\Highlight\Languages\Yaml\Patterns\YamlPropertyPattern;
+use Tempest\Highlight\Languages\Yaml\Patterns\YamlSingleQuoteValuePattern;
+use Tempest\Highlight\Languages\Yaml\Patterns\YamlVariablePattern;
+
+class YamlLanguage extends BaseLanguage
+{
+    public function getInjections(): array
+    {
+        return [
+            ...parent::getInjections(),
+        ];
+    }
+
+    public function getPatterns(): array
+    {
+        return [
+            ...parent::getPatterns(),
+            new YamlPropertyPattern(),
+            new YamlDashPattern(),
+            new YamlColonPattern(),
+            new YamlPipePattern(),
+            new YamlVariablePattern(),
+            new YamlArrayBracketsPattern(),
+            new YamlObjectBracketsPattern(),
+            new YamlDoubleQuoteValuePattern(),
+            new YamlSingleQuoteValuePattern(),
+            new YamlCommentPattern(),
+            new YamlDoubleAccoladesValuePattern(),
+        ];
+    }
+}
diff --git a/src/Themes/highlight-light-lite.css b/src/Themes/highlight-light-lite.css
index 5d337d6..ec8ce76 100644
--- a/src/Themes/highlight-light-lite.css
+++ b/src/Themes/highlight-light-lite.css
@@ -5,7 +5,7 @@
     --property-color: #34A853;
     --type-color: #EA4334;
     --generic-color: #9d3af6;
-    --value-color: #515248;
+    --value-color: #000;
     --comment-color: #888888;
 }
 
diff --git a/tests/Languages/Yaml/YamlLanguageTest.php b/tests/Languages/Yaml/YamlLanguageTest.php
new file mode 100644
index 0000000..5d0a2ff
--- /dev/null
+++ b/tests/Languages/Yaml/YamlLanguageTest.php
@@ -0,0 +1,55 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Tempest\Highlight\Tests\Languages\Yaml;
+
+use PHPUnit\Framework\Attributes\DataProvider;
+use PHPUnit\Framework\TestCase;
+use Tempest\Highlight\Highlighter;
+
+class YamlLanguageTest extends TestCase
+{
+    #[DataProvider('data')]
+    public function test_highlight(string $content, string $expected): void
+    {
+        $highlighter = new Highlighter();
+
+        $this->assertSame(
+            $expected,
+            $highlighter->parse($content, 'yaml'),
+        );
+    }
+
+    public static function data(): array
+    {
+        return [
+            [<<<TXT
+php-version-stats-january-2024:
+    date: 2024-01-29
+    string: "PHP version stats: January, 2024"
+    single-string: 'PHP version stats: January, 2024'
+    pipe: |
+      hello
+      world 
+    array: [ true ] #comment
+    object:
+      - { title: "a", link: "prop" }
+    runs-on: \${{ matrix.os }}
+TXT,
+            <<<TXT
+<span class="hl-keyword">php-version-stats-january-2024</span><span class="hl-property">:</span>
+    <span class="hl-keyword">date</span><span class="hl-property">:</span> 2024-01-29
+    <span class="hl-keyword">string</span><span class="hl-property">:</span> &quot;<span class="hl-value">PHP version stats: January, 2024</span>&quot;
+    <span class="hl-keyword">single-string</span><span class="hl-property">:</span> '<span class="hl-value">PHP version stats: January, 2024</span>'
+    <span class="hl-keyword">pipe</span><span class="hl-property">:</span> <span class="hl-property">|</span>
+      hello
+      world 
+    <span class="hl-keyword">array</span><span class="hl-property">:</span> <span class="hl-property">[</span> true <span class="hl-property">]</span> <span class="hl-comment">#comment</span>
+    <span class="hl-keyword">object</span><span class="hl-property">:</span>
+      <span class="hl-property">-</span> <span class="hl-property">{</span> <span class="hl-keyword">title</span><span class="hl-property">:</span> &quot;<span class="hl-value">a</span>&quot;, <span class="hl-keyword">link</span>: &quot;<span class="hl-value">prop</span>&quot; <span class="hl-property">}</span>
+    <span class="hl-keyword">runs-on</span><span class="hl-property">:</span> $<span class="hl-value">{{</span><span class="hl-property"> matrix.os </span><span class="hl-value">}}</span>
+TXT],
+        ];
+    }
+}
diff --git a/tests/test.md b/tests/test.md
index a1af176..5cb28b2 100644
--- a/tests/test.md
+++ b/tests/test.md
@@ -1,18 +1,14 @@
-```html
-<body>
-    <div>
-        <?php
-            $sql = <<<SQL
-            SELECT posts.*, authors.name  
-            FROM posts
-                INNER JOIN authors ON posts.author_id = authors.id
-            SQL;
-            
-            $posts = DB::get($sql);
-            
-            // Don't do this IRL :)
-        ?>
-    </div>
-</body>
+```yaml
+php-version-stats-january-2024:
+    date: 2024-01-29
+    string: "PHP version stats: January, 2024"
+    single-string: 'PHP version stats: January, 2024'
+    pipe: |
+      hello
+      world 
+    array: [ true ] #comment
+    object:
+      - { title: "a", link: "prop" }
+    runs-on: ${{ matrix.os }}
 ```