Merge pull request #341 from CPS-IT/0.8/render-helper

[FEATURE] Introduce `render` helper

Classes/Exception/InvalidConfigurationException.php

@@ -0,0 +1,38 @@
+<?php
+
+declare(strict_types=1);
+
+/*
+ * This file is part of the TYPO3 CMS extension "handlebars".
+ *
+ * Copyright (C) 2024 Elias Häußler <e.haeussler@familie-redlich.de>
+ *
+ * This program is free software: you can redistribute it and/or modify
+ * it under the terms of the GNU General Public License as published by
+ * the Free Software Foundation, either version 2 of the License, or
+ * (at your option) any later version.
+ *
+ * This program is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+ * GNU General Public License for more details.
+ *
+ * You should have received a copy of the GNU General Public License
+ * along with this program. If not, see <https://www.gnu.org/licenses/>.
+ */
+
+namespace Fr\Typo3Handlebars\Exception;
+
+/**
+ * InvalidConfigurationException
+ *
+ * @author Elias Häußler <e.haeussler@familie-redlich.de>
+ * @license GPL-2.0-or-later
+ */
+final class InvalidConfigurationException extends \Exception
+{
+    public static function create(string $path): self
+    {
+        return new self(sprintf('The configuration for path "%s" is missing or invalid.', $path), 1631118231);
+    }
+}

Classes/Renderer/Helper/RenderHelper.php

@@ -0,0 +1,123 @@
+<?php
+
+declare(strict_types=1);
+
+/*
+ * This file is part of the TYPO3 CMS extension "handlebars".
+ *
+ * Copyright (C) 2024 Elias Häußler <e.haeussler@familie-redlich.de>
+ *
+ * This program is free software: you can redistribute it and/or modify
+ * it under the terms of the GNU General Public License as published by
+ * the Free Software Foundation, either version 2 of the License, or
+ * (at your option) any later version.
+ *
+ * This program is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+ * GNU General Public License for more details.
+ *
+ * You should have received a copy of the GNU General Public License
+ * along with this program. If not, see <https://www.gnu.org/licenses/>.
+ */
+
+namespace Fr\Typo3Handlebars\Renderer\Helper;
+
+use Fr\Typo3Handlebars\DataProcessing;
+use Fr\Typo3Handlebars\Exception;
+use Fr\Typo3Handlebars\Renderer;
+use LightnCandy\SafeString;
+use TYPO3\CMS\Core;
+use TYPO3\CMS\Frontend;
+
+/**
+ * RenderHelper
+ *
+ * @author Elias Häußler <e.haeussler@familie-redlich.de>
+ * @license GPL-2.0-or-later
+ * @see https://github.com/frctl/fractal/blob/main/packages/handlebars/src/helpers/render.js
+ */
+class RenderHelper implements HelperInterface
+{
+    public function __construct(
+        protected readonly Renderer\RendererInterface $renderer,
+        protected readonly Core\TypoScript\TypoScriptService $typoScriptService,
+        protected readonly Frontend\ContentObject\ContentObjectRenderer $contentObjectRenderer,
+    ) {}
+
+    /**
+     * @throws Exception\InvalidConfigurationException
+     */
+    public function evaluate(string $name): SafeString
+    {
+        // Get helper options
+        $arguments = \func_get_args();
+        array_shift($arguments);
+        $options = array_pop($arguments);
+
+        // Resolve data
+        $rootData = $options['data']['root'];
+        $merge = (bool)($options['hash']['merge'] ?? false);
+        $renderUncached = (bool)($options['hash']['uncached'] ?? false);
+
+        // Fetch custom context
+        // ====================
+        // Custom contexts can be defined as helper argument, e.g.
+        // {{render '@foo' customContext}}
+        $context = reset($arguments);
+        if (!\is_array($context)) {
+            $context = [];
+        }
+
+        // Fetch default context
+        // =====================
+        // Default contexts can be defined by using the template name when rendering a
+        // specific template, e.g. if $name = '@foo' then $rootData['@foo'] is requested
+        $defaultContext = $rootData[$name] ?? [];
+
+        // Resolve context
+        // ===============
+        // Use default context as new context if no custom context is given, otherwise
+        // merge both contexts in case merge=true is passed as helper option, e.g.
+        // {{render '@foo' customContext merge=true}}
+        if ($context === []) {
+            $context = $defaultContext;
+        } elseif ($merge) {
+            Core\Utility\ArrayUtility::mergeRecursiveWithOverrule($defaultContext, $context);
+            $context = $defaultContext;
+        }
+
+        if ($renderUncached) {
+            $content = $this->registerUncachedTemplateBlock($name, $context);
+        } else {
+            $content = $this->renderer->render($name, $context);
+        }
+
+        return new SafeString($content);
+    }
+
+    /**
+     * @param array<string, mixed> $context
+     * @throws Exception\InvalidConfigurationException
+     */
+    protected function registerUncachedTemplateBlock(string $templateName, array $context): string
+    {
+        $processorClass = $context['_processor'] ?? null;
+
+        // Check whether the required data processor is valid
+        if (!\is_string($processorClass) || !\in_array(DataProcessing\DataProcessorInterface::class, class_implements($processorClass) ?: [])) {
+            throw Exception\InvalidConfigurationException::create('_processor');
+        }
+
+        // Do not pass data processor reference as context to requested data processor
+        unset($context['_processor']);
+
+        return $this->contentObjectRenderer->cObjGetSingle('USER_INT', [
+            'userFunc' => $processorClass . '->process',
+            'userFunc.' => [
+                'templatePath' => $templateName,
+                'context.' => $this->typoScriptService->convertPlainArrayToTypoScriptArray($context),
+            ],
+        ]);
+    }
+}

Tests/Functional/Fixtures/test_extension/Classes/DefaultContextAwareConfigurationTrait.php

@@ -0,0 +1,49 @@
+<?php
+
+declare(strict_types=1);
+
+/*
+ * This file is part of the TYPO3 CMS extension "handlebars".
+ *
+ * Copyright (C) 2024 Elias Häußler <e.haeussler@familie-redlich.de>
+ *
+ * This program is free software: you can redistribute it and/or modify
+ * it under the terms of the GNU General Public License as published by
+ * the Free Software Foundation, either version 2 of the License, or
+ * (at your option) any later version.
+ *
+ * This program is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+ * GNU General Public License for more details.
+ *
+ * You should have received a copy of the GNU General Public License
+ * along with this program. If not, see <https://www.gnu.org/licenses/>.
+ */
+
+namespace Fr\Typo3Handlebars\TestExtension;
+
+use TYPO3\CMS\Core;
+
+/**
+ * DefaultContextAwareConfigurationTrait
+ *
+ * @author Elias Häußler <e.haeussler@familie-redlich.de>
+ * @license GPL-2.0-or-later
+ */
+trait DefaultContextAwareConfigurationTrait
+{
+    /**
+     * @return array<string, mixed>
+     */
+    protected function getDefaultContextFromConfiguration(): array
+    {
+        if (!isset($this->configuration['userFunc.']['context.'])) {
+            return [];
+        }
+
+        return (new Core\TypoScript\TypoScriptService())->convertTypoScriptArrayToPlainArray(
+            $this->configuration['userFunc.']['context.'],
+        );
+    }
+}

Tests/Functional/Fixtures/test_extension/Classes/DummyNonCacheableProcessor.php

@@ -0,0 +1,46 @@
+<?php
+
+declare(strict_types=1);
+
+/*
+ * This file is part of the TYPO3 CMS extension "handlebars".
+ *
+ * Copyright (C) 2024 Elias Häußler <e.haeussler@familie-redlich.de>
+ *
+ * This program is free software: you can redistribute it and/or modify
+ * it under the terms of the GNU General Public License as published by
+ * the Free Software Foundation, either version 2 of the License, or
+ * (at your option) any later version.
+ *
+ * This program is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+ * GNU General Public License for more details.
+ *
+ * You should have received a copy of the GNU General Public License
+ * along with this program. If not, see <https://www.gnu.org/licenses/>.
+ */
+
+namespace Fr\Typo3Handlebars\TestExtension;
+
+use Fr\Typo3Handlebars\DataProcessing;
+
+/**
+ * DummyNonCacheableProcessor
+ *
+ * @author Elias Häußler <e.haeussler@familie-redlich.de>
+ * @license GPL-2.0-or-later
+ */
+final class DummyNonCacheableProcessor extends DataProcessing\AbstractDataProcessor
+{
+    use DefaultContextAwareConfigurationTrait;
+    use TemplatePathAwareConfigurationTrait;
+
+    protected function render(): string
+    {
+        return json_encode([
+            'templatePath' => $this->getTemplatePathFromConfiguration(),
+            'context' => $this->getDefaultContextFromConfiguration(),
+        ], JSON_THROW_ON_ERROR);
+    }
+}

Tests/Functional/Fixtures/test_extension/Classes/TemplatePathAwareConfigurationTrait.php

@@ -0,0 +1,47 @@
+<?php
+
+declare(strict_types=1);
+
+/*
+ * This file is part of the TYPO3 CMS extension "handlebars".
+ *
+ * Copyright (C) 2024 Elias Häußler <e.haeussler@familie-redlich.de>
+ *
+ * This program is free software: you can redistribute it and/or modify
+ * it under the terms of the GNU General Public License as published by
+ * the Free Software Foundation, either version 2 of the License, or
+ * (at your option) any later version.
+ *
+ * This program is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+ * GNU General Public License for more details.
+ *
+ * You should have received a copy of the GNU General Public License
+ * along with this program. If not, see <https://www.gnu.org/licenses/>.
+ */
+
+namespace Fr\Typo3Handlebars\TestExtension;
+
+use Fr\Typo3Handlebars\Exception;
+
+/**
+ * TemplatePathAwareConfigurationTrait
+ *
+ * @author Elias Häußler <e.haeussler@familie-redlich.de>
+ * @license GPL-2.0-or-later
+ */
+trait TemplatePathAwareConfigurationTrait
+{
+    protected function getTemplatePathFromConfiguration(): string
+    {
+        if (!isset($this->configuration['userFunc.']['templatePath'])) {
+            throw new Exception\InvalidTemplateFileException(
+                'Missing or invalid template path in configuration array.',
+                1641990786
+            );
+        }
+
+        return (string)$this->configuration['userFunc.']['templatePath'];
+    }
+}