Add ViewTemplateRenderer::class. (#25)

composer.json

@@ -19,18 +19,21 @@
         "yiisoft/aliases": "^3.0",
         "yiisoft/arrays": "^3.0",
         "yiisoft/data-response": "^2.0",
-        "yiisoft/mailer": "^5.0",
         "yiisoft/mailer-symfony": "^3.0",
+        "yiisoft/mailer": "^5.0",
         "yiisoft/router-fastroute": "^3.0",
         "yiisoft/router": "^3.0",
         "yiisoft/session": "^2.0",
-        "yiisoft/translator": "^3.0"
+        "yiisoft/translator-message-php": "^1.1",
+        "yiisoft/translator": "^3.0",
+        "yiisoft/view": "^8.0"
     },
     "require-dev": {
         "httpsoft/http-message": "^1.0",
+        "infection/infection": "^0.27",
         "maglnet/composer-require-checker": "^4.3",
-        "phpunit/phpunit": "^10.0",
-        "roave/infection-static-analysis-plugin": "^1.28",
+        "phpunit/phpunit": "^10.1",
+        "roave/infection-static-analysis-plugin": "^1.31",
         "vimeo/psalm": "^5.4",
         "yii-tools/support": "^1.0@dev",
         "yiisoft/config": "^1.3",
@@ -66,6 +69,10 @@
                     "common/*.php",
                     "../tests/data/config/common/*.php"
                 ],
+                "di-web": [
+                    "$di",
+                    "web/*.php"
+                ],
                 "application-params": "../tests/data/config/application-params.php",
                 "params":  "../tests/data/config/params.php"
             }

src/ViewTemplateRenderer.php

@@ -0,0 +1,73 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Yii\Service;
+
+use Psr\Http\Message\ResponseInterface;
+use Yiisoft\Aliases\Aliases;
+use Yiisoft\DataResponse\DataResponseFactoryInterface;
+use Yiisoft\View\ViewContextInterface;
+use Yiisoft\View\WebView;
+
+final class ViewTemplateRenderer implements ViewContextInterface
+{
+    private string $layout = '@layout/main.php';
+    private array $layoutParameters = [];
+    private string $viewPath = '@views';
+
+    public function __construct(
+        private readonly Aliases $aliases,
+        private readonly DataResponseFactoryInterface $dataResponse,
+        private readonly WebView $webView,
+    ) {
+    }
+
+    public function getViewPath(): string
+    {
+        return $this->findAliases($this->viewPath);
+    }
+
+    public function render(string $view, array $viewParameters = [], array $layoutParameters = []): ResponseInterface
+    {
+        $content = $this->renderView($view, $viewParameters);
+
+        $parameters = ['content' => $content, ...$layoutParameters, ...$this->layoutParameters];
+
+        $layout = $this->findAliases($this->layout);
+
+        $content = $this->webView->renderFile($layout, $parameters);
+
+        return $this->dataResponse->createResponse($content);
+    }
+
+    public function withLayoutParameters(array $parameters): self
+    {
+        $new = clone $this;
+        $new->layoutParameters = $parameters;
+
+        return $new;
+    }
+
+    public function withViewPath(string $path): self
+    {
+        $new = clone $this;
+        $new->viewPath = $path;
+
+        return $new;
+    }
+
+    private function findAliases(string $aliases): string
+    {
+        if (substr($aliases, 0, 1) === '@') {
+            return $this->aliases->get($aliases);
+        }
+
+        return $aliases;
+    }
+
+    private function renderView(string $view, array $viewParameters): string
+    {
+        return $this->webView->withContext($this)->render($view, $viewParameters);
+    }
+}

tests/Support/TestTrait.php

@@ -8,6 +8,7 @@
 use Yii\Service\Mailer;
 use Yii\Service\ParameterInterface;
 use Yii\Service\Redirect;
+use Yii\Service\ViewTemplateRenderer;
 use Yiisoft\Aliases\Aliases;
 use Yiisoft\Config\Config;
 use Yiisoft\Config\ConfigPaths;
@@ -24,6 +25,7 @@ trait TestTrait
     private Mailer $mailer;
     private ParameterInterface $parameter;
     private Redirect $redirect;
+    private ViewTemplateRenderer $viewTemplateRenderer;
     protected bool $writeToFiles = true;
 
     public function setup(): void
@@ -33,7 +35,14 @@ public function setup(): void
 
     public function tearDown(): void
     {
-        unset($this->aliases, $this->logger, $this->mailer, $this->parameter, $this->redirect);
+        unset(
+            $this->aliases,
+            $this->logger,
+            $this->mailer,
+            $this->parameter,
+            $this->redirect,
+            $this->viewTemplateRenderer,
+        );
     }
 
     private function createContainer(): void
@@ -47,7 +56,7 @@ private function createContainer(): void
             MailerInterface::class => $this->writeToFiles ? FileMailer::class : SymfonyMailer::class,
         ];
 
-        $definitions = array_merge($config->get('di'), $mailerInterfaceOverride);
+        $definitions = array_merge($config->get('di-web'), $mailerInterfaceOverride);
         $containerConfig = ContainerConfig::create()->withDefinitions(array_merge($definitions));
         $container = new Container($containerConfig);
 
@@ -56,5 +65,6 @@ private function createContainer(): void
         $this->mailer = $container->get(Mailer::class);
         $this->parameter = $container->get(ParameterInterface::class);
         $this->redirect = $container->get(Redirect::class);
+        $this->viewTemplateRenderer = $container->get(ViewTemplateRenderer::class);
     }
 }

tests/ViewTemplateRenderer/ImmutabilityTest.php

@@ -0,0 +1,21 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Yii\Service\Tests\ViewTemplateRenderer;
+
+use PHPUnit\Framework\TestCase;
+use Yii\Service\Tests\Support\TestTrait;
+
+final class ImmutabilityTest extends TestCase
+{
+    use TestTrait;
+
+    public function testImmutability(): void
+    {
+        $viewTemplateRenderer = $this->viewTemplateRenderer;
+
+        $this->assertNotSame($viewTemplateRenderer, $viewTemplateRenderer->withLayoutParameters([]));
+        $this->assertNotSame($viewTemplateRenderer, $viewTemplateRenderer->withViewPath(''));
+    }
+}

tests/ViewTemplateRenderer/Test.php

@@ -0,0 +1,73 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Yii\Service\Tests\ViewTemplateRenderer;
+
+use PHPUnit\Framework\TestCase;
+use Yii\Service\Tests\Support\TestTrait;
+use Yii\Support\Assert;
+use Yiisoft\DataResponse\DataResponse;
+
+final class Test extends TestCase
+{
+    use TestTrait;
+
+    public function testRender(): void
+    {
+        $this->aliases->set('@layout', dirname(__DIR__) . '/data/resources/view');
+
+        /** @var DataResponse $dataResponse */
+        $dataResponse = $this->viewTemplateRenderer
+            ->withViewPath(dirname(__DIR__) . '/data/resources/view')
+            ->render('view', ['title' => 'View'], ['title' => 'Layout']);
+
+        Assert::equalsWithoutLE(
+            <<<HTML
+            <!DOCTYPE html>
+            <html>
+            <head>
+                    <title>Layout</title>
+            </head>
+            <body>
+
+            <h1>View</h1>
+
+            </body>
+            </html>
+
+            HTML,
+            $dataResponse->getData(),
+        );
+    }
+
+    public function testWithLayoutParameters(): void
+    {
+        $this->aliases->set('@layout', dirname(__DIR__) . '/data/resources/view');
+
+        /** @var DataResponse $dataResponse */
+        $dataResponse = $this->viewTemplateRenderer
+            ->withViewPath(dirname(__DIR__) . '/data/resources/view')
+            ->withLayoutParameters(['csrfToken' => 'test'])
+            ->render('view', ['title' => 'View'], ['title' => 'Layout']);
+
+        Assert::equalsWithoutLE(
+            <<<HTML
+            <!DOCTYPE html>
+            <html>
+            <head>
+                    <meta name="csrf-token" content="test">
+                    <title>Layout</title>
+            </head>
+            <body>
+
+            <h1>View</h1>
+
+            </body>
+            </html>
+
+            HTML,
+            $dataResponse->getData(),
+        );
+    }
+}

tests/data/config/common/stream-factory.php

@@ -0,0 +1,10 @@
+<?php
+
+declare(strict_types=1);
+
+use HttpSoft\Message\StreamFactory;
+use Psr\Http\Message\StreamFactoryInterface;
+
+return [
+    StreamFactoryInterface::class => StreamFactory::class,
+];

tests/data/resources/view/main.php

@@ -0,0 +1,26 @@
+<?php
+/**
+ * @var $this \Yiisoft\View\WebView
+ * @var $content string
+ * @var string|null $csrfToken
+ */
+$csrfToken = $csrfToken ?? null;
+?>
+<?php $this->beginPage(); ?>
+<!DOCTYPE html>
+<html>
+<head>
+    <?php if ($csrfToken !== null): ?>
+    <meta name="csrf-token" content="<?= $csrfToken ?>">
+    <?php endif ?>
+    <title><?= $title ?></title>
+</head>
+<body>
+<?php $this->beginBody(); ?>
+
+<?= $content ?>
+
+<?php $this->endBody(); ?>
+</body>
+</html>
+<?php $this->endPage();

tests/data/resources/view/view.php

@@ -0,0 +1,5 @@
+<?php
+
+/** @var string $title */
+?>
+<h1><?= $title ?></h1>