From 0f47a804583a9288c3d2ead43fd84b38bc1c7c2d Mon Sep 17 00:00:00 2001
From: Dinh Quoc Han <dqh@dinhquochan.com>
Date: Wed, 11 Dec 2024 17:30:14 +0700
Subject: [PATCH] feat(view): add twig support (#841)

Co-authored-by: Brent Roose <brent.roose@gmail.com>
---
 composer.json                                 |  3 +-
 src/Tempest/View/src/Renderers/TwigConfig.php | 36 ++++++++++++++++
 .../View/src/Renderers/TwigInitializer.php    | 33 +++++++++++++++
 .../View/src/Renderers/TwigViewRenderer.php   | 25 +++++++++++
 .../Integration/View/TwigViewRendererTest.php | 41 +++++++++++++++++++
 tests/Integration/View/twig/base.twig         |  3 ++
 tests/Integration/View/twig/index.twig        |  5 +++
 7 files changed, 145 insertions(+), 1 deletion(-)
 create mode 100644 src/Tempest/View/src/Renderers/TwigConfig.php
 create mode 100644 src/Tempest/View/src/Renderers/TwigInitializer.php
 create mode 100644 src/Tempest/View/src/Renderers/TwigViewRenderer.php
 create mode 100644 tests/Integration/View/TwigViewRendererTest.php
 create mode 100644 tests/Integration/View/twig/base.twig
 create mode 100644 tests/Integration/View/twig/index.twig

diff --git a/composer.json b/composer.json
index 3866b1bda..df62c0952 100644
--- a/composer.json
+++ b/composer.json
@@ -50,7 +50,8 @@
         "rector/rector": "^2.0-rc2",
         "spatie/phpunit-snapshot-assertions": "^5.1.6",
         "spaze/phpstan-disallowed-calls": "^4.0",
-        "symplify/monorepo-builder": "^11.2"
+        "symplify/monorepo-builder": "^11.2",
+        "twig/twig": "^3.16"
     },
     "replace": {
         "tempest/auth": "self.version",
diff --git a/src/Tempest/View/src/Renderers/TwigConfig.php b/src/Tempest/View/src/Renderers/TwigConfig.php
new file mode 100644
index 000000000..af3584de6
--- /dev/null
+++ b/src/Tempest/View/src/Renderers/TwigConfig.php
@@ -0,0 +1,36 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Tempest\View\Renderers;
+
+final readonly class TwigConfig
+{
+    /**
+     * @see \Twig\Environment::__construct()
+     */
+    public function __construct(
+        public array $viewPaths = [],
+        public ?string $cachePath = null,
+        public bool $debug = false,
+        public string $charset = 'utf-8',
+        public bool $strictVariables = false,
+        public string $autoescape = 'html',
+        public ?bool $autoReload = null,
+        public int $optimizations = -1,
+    ) {
+    }
+
+    public function toArray(): array
+    {
+        return [
+            'debug' => $this->debug,
+            'charset' => $this->charset,
+            'strict_variables' => $this->strictVariables,
+            'autoescape' => $this->autoescape,
+            'cache' => $this->cachePath ?: false,
+            'auto_reload' => $this->autoReload,
+            'optimizations' => $this->optimizations,
+        ];
+    }
+}
diff --git a/src/Tempest/View/src/Renderers/TwigInitializer.php b/src/Tempest/View/src/Renderers/TwigInitializer.php
new file mode 100644
index 000000000..51b7e4a85
--- /dev/null
+++ b/src/Tempest/View/src/Renderers/TwigInitializer.php
@@ -0,0 +1,33 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Tempest\View\Renderers;
+
+use Tempest\Container\Container;
+use Tempest\Container\DynamicInitializer;
+use Tempest\Container\Singleton;
+use Tempest\Reflection\ClassReflector;
+use Twig\Environment;
+use Twig\Loader\FilesystemLoader;
+
+final readonly class TwigInitializer implements DynamicInitializer
+{
+    public function canInitialize(ClassReflector $class): bool
+    {
+        if (! class_exists(Environment::class)) {
+            return false;
+        }
+
+        return $class->getName() === Environment::class;
+    }
+
+    #[Singleton]
+    public function initialize(ClassReflector $class, Container $container): object
+    {
+        $twigConfig = $container->get(TwigConfig::class);
+        $twigLoader = new FilesystemLoader($twigConfig->viewPaths);
+
+        return new Environment($twigLoader, $twigConfig->toArray());
+    }
+}
diff --git a/src/Tempest/View/src/Renderers/TwigViewRenderer.php b/src/Tempest/View/src/Renderers/TwigViewRenderer.php
new file mode 100644
index 000000000..174e2a72b
--- /dev/null
+++ b/src/Tempest/View/src/Renderers/TwigViewRenderer.php
@@ -0,0 +1,25 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Tempest\View\Renderers;
+
+use Tempest\View\View;
+use Tempest\View\ViewRenderer;
+use Twig\Environment;
+
+final readonly class TwigViewRenderer implements ViewRenderer
+{
+    public function __construct(private Environment $twig)
+    {
+    }
+
+    public function render(View|string|null $view): string
+    {
+        if ($view === null) {
+            return '';
+        }
+
+        return trim($this->twig->render($view->getPath(), $view->getData()));
+    }
+}
diff --git a/tests/Integration/View/TwigViewRendererTest.php b/tests/Integration/View/TwigViewRendererTest.php
new file mode 100644
index 000000000..ceee66a88
--- /dev/null
+++ b/tests/Integration/View/TwigViewRendererTest.php
@@ -0,0 +1,41 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Tests\Tempest\Integration\View;
+
+use Tempest\View\Renderers\TwigConfig;
+use Tempest\View\Renderers\TwigViewRenderer;
+use Tempest\View\ViewConfig;
+use Tempest\View\ViewRenderer;
+use Tests\Tempest\Integration\FrameworkIntegrationTestCase;
+use function Tempest\view;
+
+/**
+ * @internal
+ */
+final class TwigViewRendererTest extends FrameworkIntegrationTestCase
+{
+    public function test_twig(): void
+    {
+        $viewConfig = $this->container->get(ViewConfig::class);
+
+        $viewConfig->rendererClass = TwigViewRenderer::class;
+
+        $this->container->config(new TwigConfig(
+            viewPaths: [__DIR__ . '/twig'],
+            cachePath: __DIR__ . '/../../../.cache/tempest/twig/cache',
+        ));
+
+        $renderer = $this->container->get(ViewRenderer::class);
+
+        $html = $renderer->render(view('index.twig', ...['foo' => 'bar']));
+
+        $this->assertStringEqualsStringIgnoringLineEndings(<<<HTML
+            <html>
+            <span>bar</span>
+            </html>
+            HTML
+            , $html);
+    }
+}
diff --git a/tests/Integration/View/twig/base.twig b/tests/Integration/View/twig/base.twig
new file mode 100644
index 000000000..d78025dd0
--- /dev/null
+++ b/tests/Integration/View/twig/base.twig
@@ -0,0 +1,3 @@
+<html>
+{% block content %}{% endblock %}
+</html>
diff --git a/tests/Integration/View/twig/index.twig b/tests/Integration/View/twig/index.twig
new file mode 100644
index 000000000..2ecf303ae
--- /dev/null
+++ b/tests/Integration/View/twig/index.twig
@@ -0,0 +1,5 @@
+{% extends "base.twig" %}
+
+{% block content %}
+<span>{{ foo }}</span>
+{% endblock %}