Merge pull request #33 from netgen-layouts/twig39

Support yield rendering strategy in Twig 3.9+
netgen-layouts · Sep 6, 2024 · e22c56d · e22c56d
2 parents 0c9f786 + 4098776
commit e22c56d
Show file tree

Hide file tree

Showing 15 changed files with 133 additions and 30 deletions.
diff --git a/bundles/LayoutsBundle/Templating/Twig/Node/DefaultContext.php b/bundles/LayoutsBundle/Templating/Twig/Node/DefaultContext.php
@@ -4,15 +4,17 @@
 
 namespace Netgen\Bundle\LayoutsBundle\Templating\Twig\Node;
 
+use Twig\Attribute\YieldReady;
 use Twig\Compiler;
 use Twig\Node\Expression\AbstractExpression;
 use Twig\Node\Node;
 
+#[YieldReady]
 final class DefaultContext extends Node
 {
-    public function __construct(AbstractExpression $expr, int $line = 0, ?string $tag = null)
+    public function __construct(AbstractExpression $expr, int $line = 0)
     {
-        parent::__construct(['expr' => $expr], [], $line, $tag);
+        parent::__construct(['expr' => $expr], [], $line);
     }
 
     public function compile(Compiler $compiler): void

diff --git a/bundles/LayoutsBundle/Templating/Twig/Node/RenderZone.php b/bundles/LayoutsBundle/Templating/Twig/Node/RenderZone.php
@@ -8,22 +8,25 @@
 use Netgen\Layouts\API\Values\Layout\Zone;
 use Netgen\Layouts\View\Twig\ContextualizedTwigTemplate;
 use Netgen\Layouts\View\ViewInterface;
+use Twig\Attribute\YieldReady;
 use Twig\Compiler;
+use Twig\Environment;
 use Twig\Node\Expression\AbstractExpression;
 use Twig\Node\Node;
 
 use const PHP_EOL;
 
+#[YieldReady]
 final class RenderZone extends Node
 {
-    public function __construct(AbstractExpression $zone, ?AbstractExpression $context = null, int $line = 0, ?string $tag = null)
+    public function __construct(AbstractExpression $zone, ?AbstractExpression $context = null, int $line = 0)
     {
         $nodes = ['zone' => $zone];
         if ($context instanceof AbstractExpression) {
             $nodes['context'] = $context;
         }
 
-        parent::__construct($nodes, [], $line, $tag);
+        parent::__construct($nodes, [], $line);
     }
 
     public function compile(Compiler $compiler): void
@@ -36,9 +39,8 @@ public function compile(Compiler $compiler): void
             ->write('$nglZoneIdentifier = $nglZone instanceof ' . Zone::class . ' ? $nglZone->getIdentifier() : $nglZone;' . PHP_EOL);
 
         $this->compileContextNode($compiler);
-
         $compiler->write('$nglTemplate = new ' . ContextualizedTwigTemplate::class . '($this, $context, $blocks);' . PHP_EOL);
-        $compiler->write('$this->env->getRuntime("' . RenderingRuntime::class . '")->displayZone($context["nglayouts"]->getLayout(), $nglZoneIdentifier, $nglContext, $nglTemplate);' . PHP_EOL);
+        $this->compileRenderNode($compiler);
     }
 
     /**
@@ -62,4 +64,15 @@ private function compileContextNode(Compiler $compiler): void
 
         $compiler->write('$nglContext = ' . ViewInterface::class . '::CONTEXT_DEFAULT;' . PHP_EOL);
     }
+
+    private function compileRenderNode(Compiler $compiler): void
+    {
+        if (Environment::VERSION_ID >= 30900) {
+            $compiler->write('yield $this->env->getRuntime("' . RenderingRuntime::class . '")->renderZone($context["nglayouts"]->getLayout(), $nglZoneIdentifier, $nglContext, $nglTemplate);' . PHP_EOL);
+
+            return;
+        }
+
+        $compiler->write('echo $this->env->getRuntime("' . RenderingRuntime::class . '")->renderZone($context["nglayouts"]->getLayout(), $nglZoneIdentifier, $nglContext, $nglTemplate);' . PHP_EOL);
+    }
 }
diff --git a/bundles/LayoutsBundle/Templating/Twig/Runtime/HelpersRuntime.php b/bundles/LayoutsBundle/Templating/Twig/Runtime/HelpersRuntime.php
@@ -19,9 +19,11 @@
 use Ramsey\Uuid\Uuid;
 use Throwable;
 use Twig\Environment;
+use Twig\Extension\CoreExtension;
 
 use function array_unshift;
 use function is_string;
+use function method_exists;
 use function twig_date_converter;
 
 final class HelpersRuntime
@@ -121,7 +123,11 @@ public function getCountryFlag(string $countryCode): string
      */
     public function formatDateTime(Environment $twig, $dateTime, string $dateFormat = 'medium', string $timeFormat = 'medium'): string
     {
-        $dateTime = twig_date_converter($twig, $dateTime);
+        $coreExtension = $twig->getExtension(CoreExtension::class);
+
+        $dateTime = method_exists($coreExtension, 'convertDate') ?
+            $coreExtension->convertDate($dateTime) :
+            twig_date_converter($twig, $dateTime);
 
         $formatValues = [
             'none' => IntlDateFormatter::NONE,

diff --git a/bundles/LayoutsBundle/Templating/Twig/Runtime/RenderingRuntime.php b/bundles/LayoutsBundle/Templating/Twig/Runtime/RenderingRuntime.php
@@ -159,9 +159,9 @@ public function renderValue(array $context, $value, array $parameters = [], ?str
     }
 
     /**
-     * Displays the provided zone.
+     * Renders the provided zone.
      */
-    public function displayZone(Layout $layout, string $zoneIdentifier, string $viewContext, ContextualizedTwigTemplate $twigTemplate): void
+    public function renderZone(Layout $layout, string $zoneIdentifier, string $viewContext, ContextualizedTwigTemplate $twigTemplate): string
     {
         $locales = null;
 
@@ -178,7 +178,7 @@ public function displayZone(Layout $layout, string $zoneIdentifier, string $view
             $locales,
         );
 
-        echo $this->renderValue(
+        return $this->renderValue(
             [],
             new ZoneReference($layout, $zoneIdentifier),
             [

diff --git a/bundles/LayoutsBundle/Templating/Twig/TokenParser/DefaultContext.php b/bundles/LayoutsBundle/Templating/Twig/TokenParser/DefaultContext.php
@@ -17,7 +17,7 @@ public function parse(Token $token): Node
 
         $this->parser->getStream()->expect(Token::BLOCK_END_TYPE);
 
-        return new DefaultContextNode($expression, $token->getLine(), $this->getTag());
+        return new DefaultContextNode($expression, $token->getLine());
     }
 
     public function getTag(): string

diff --git a/bundles/LayoutsBundle/Templating/Twig/TokenParser/RenderZone.php b/bundles/LayoutsBundle/Templating/Twig/TokenParser/RenderZone.php
@@ -45,7 +45,7 @@ public function parse(Token $token): Node
 
         $stream->expect(Token::BLOCK_END_TYPE);
 
-        return new RenderZoneNode($zone, $context, $token->getLine(), $this->getTag());
+        return new RenderZoneNode($zone, $context, $token->getLine());
     }
 
     public function getTag(): string

diff --git a/composer.json b/composer.json
@@ -44,7 +44,7 @@
         "symfony/twig-bundle": "^3.4.47 || ^5.4 || ^6.2",
         "symfony/validator": "^3.4.47 || ^5.4 || ^6.2",
         "symfony/yaml": "^3.4.47 || ^5.4 || ^6.2",
-        "twig/twig": "^2.15 || ^3.4",
+        "twig/twig": "^2.15 || ^3.9",
         "sensio/framework-extra-bundle": "^5.4 || ^6.2",
         "doctrine/dbal": "^2.13 || ^3.5",
         "doctrine/doctrine-bundle": "^1.12 || ^2.7",

diff --git a/phpstan.neon b/phpstan.neon
@@ -7,6 +7,7 @@ parameters:
     treatPhpDocTypesAsCertain: false
     dynamicConstantNames:
         - Symfony\Component\HttpKernel\Kernel::VERSION_ID
+        - Twig\Environment::VERSION_ID
 
     ignoreErrors:
         # Doctrine DBAL
@@ -49,10 +50,6 @@ parameters:
         - "#Call to function method_exists\\(\\) with Symfony\\\\Component\\\\HttpFoundation\\\\Request and 'getContentTypeFormat' will always evaluate to true.#"
         - "#Call to function method_exists\\(\\) with Symfony\\\\Component\\\\DependencyInjection\\\\ContainerBuilder and 'registerAttributeFo…' will always evaluate to true.#"
 
-        -
-            message: '#twig_date_converter not found.#'
-            path: bundles/LayoutsBundle/Templating/Twig/Runtime/HelpersRuntime.php
-
         # Netgen Layouts specifics
 
         - "#Call to function method_exists\\(\\) with Netgen\\\\Layouts\\\\Layout\\\\Resolver\\\\(Condition|Target)TypeInterface and '(export|import)' will always evaluate to true.#"

diff --git a/phpstan.tests.neon b/phpstan.tests.neon
@@ -9,6 +9,7 @@ parameters:
     treatPhpDocTypesAsCertain: false
     dynamicConstantNames:
         - Symfony\Component\HttpKernel\Kernel::VERSION_ID
+        - Twig\Environment::MAJOR_VERSION
 
     excludePaths:
         - tests/application/public/bundles/
@@ -53,6 +54,8 @@ parameters:
             message: '#Undefined variable: \$this#'
             path: tests/lib/Transfer/Output/Visitor/Integration
 
+        - "#Call to function method_exists\\(\\) with .* and 'setNodeTag' will always evaluate to true.#"
+
         -
             message: "#Offset 'db' does not exist on array#"
             path: tests/lib/Persistence/Doctrine/DatabaseTrait.php
diff --git a/tests/bundles/LayoutsBundle/Templating/Twig/Extension/RenderingExtensionTwigTest.php b/tests/bundles/LayoutsBundle/Templating/Twig/Extension/RenderingExtensionTwigTest.php
@@ -54,7 +54,7 @@ protected function setUp(): void
     }
 
     /**
-     * @covers \Netgen\Bundle\LayoutsBundle\Templating\Twig\Runtime\RenderingRuntime::displayZone
+     * @covers \Netgen\Bundle\LayoutsBundle\Templating\Twig\Runtime\RenderingRuntime::renderZone
      *
      * @dataProvider getTests
      *
@@ -74,7 +74,7 @@ public function testIntegration($file, $message, $condition, $templates, $except
     }
 
     /**
-     * @covers \Netgen\Bundle\LayoutsBundle\Templating\Twig\Runtime\RenderingRuntime::displayZone
+     * @covers \Netgen\Bundle\LayoutsBundle\Templating\Twig\Runtime\RenderingRuntime::renderZone
      *
      * @dataProvider getTests
      *
@@ -97,7 +97,7 @@ public function testIntegrationWithLocale($file, $message, $condition, $template
     }
 
     /**
-     * @covers \Netgen\Bundle\LayoutsBundle\Templating\Twig\Runtime\RenderingRuntime::displayZone
+     * @covers \Netgen\Bundle\LayoutsBundle\Templating\Twig\Runtime\RenderingRuntime::renderZone
      *
      * @dataProvider getLegacyTests
      *

diff --git a/tests/bundles/LayoutsBundle/Templating/Twig/Node/DefaultContextTest.php b/tests/bundles/LayoutsBundle/Templating/Twig/Node/DefaultContextTest.php
@@ -5,6 +5,7 @@
 namespace Netgen\Bundle\LayoutsBundle\Tests\Templating\Twig\Node;
 
 use Netgen\Bundle\LayoutsBundle\Templating\Twig\Node\DefaultContext;
+use Twig\Environment;
 use Twig\Node\Expression\ConstantExpression;
 use Twig\Node\Expression\NameExpression;
 
@@ -13,6 +14,13 @@
  */
 final class DefaultContextTest extends NodeTestBase
 {
+    protected function setUp(): void
+    {
+        if (Environment::MAJOR_VERSION === 2) {
+            self::markTestSkipped('Test requires twig/twig 3.9 to run');
+        }
+    }
+
     /**
      * @covers \Netgen\Bundle\LayoutsBundle\Templating\Twig\Node\DefaultContext::__construct
      */

diff --git a/tests/bundles/LayoutsBundle/Templating/Twig/Node/RenderZoneTest.php b/tests/bundles/LayoutsBundle/Templating/Twig/Node/RenderZoneTest.php
@@ -9,15 +9,24 @@
 use Netgen\Layouts\API\Values\Layout\Zone;
 use Netgen\Layouts\View\Twig\ContextualizedTwigTemplate;
 use Netgen\Layouts\View\ViewInterface;
+use Twig\Environment;
 use Twig\Node\Expression\ConstantExpression;
 use Twig\Node\Expression\NameExpression;
 
 /**
  * @covers \Netgen\Bundle\LayoutsBundle\Templating\Twig\Node\RenderZone::compile
  * @covers \Netgen\Bundle\LayoutsBundle\Templating\Twig\Node\RenderZone::compileContextNode
+ * @covers \Netgen\Bundle\LayoutsBundle\Templating\Twig\Node\RenderZone::compileRenderNode
  */
 final class RenderZoneTest extends NodeTestBase
 {
+    protected function setUp(): void
+    {
+        if (Environment::MAJOR_VERSION === 2) {
+            self::markTestSkipped('Test requires twig/twig 3.9 to run');
+        }
+    }
+
     /**
      * @covers \Netgen\Bundle\LayoutsBundle\Templating\Twig\Node\RenderZone::__construct
      */
@@ -69,7 +78,7 @@ public static function getTests(): array
                 \$nglZoneIdentifier = \$nglZone instanceof {$zoneClass} ? \$nglZone->getIdentifier() : \$nglZone;
                 \$nglContext = {$contextNodeGetter};
                 \$nglTemplate = new {$templateClass}(\$this, \$context, \$blocks);
-                \$this->env->getRuntime("{$runtimeClass}")->displayZone(\$context["nglayouts"]->getLayout(), \$nglZoneIdentifier, \$nglContext, \$nglTemplate);
+                yield \$this->env->getRuntime("{$runtimeClass}")->renderZone(\$context["nglayouts"]->getLayout(), \$nglZoneIdentifier, \$nglContext, \$nglTemplate);
                 EOT,
                 $environment,
             ],
@@ -81,7 +90,7 @@ public static function getTests(): array
                 \$nglZoneIdentifier = \$nglZone instanceof {$zoneClass} ? \$nglZone->getIdentifier() : \$nglZone;
                 \$nglContext = {$contextNodeGetter};
                 \$nglTemplate = new {$templateClass}(\$this, \$context, \$blocks);
-                \$this->env->getRuntime("{$runtimeClass}")->displayZone(\$context["nglayouts"]->getLayout(), \$nglZoneIdentifier, \$nglContext, \$nglTemplate);
+                yield \$this->env->getRuntime("{$runtimeClass}")->renderZone(\$context["nglayouts"]->getLayout(), \$nglZoneIdentifier, \$nglContext, \$nglTemplate);
                 EOT,
                 $environment,
             ],
@@ -93,7 +102,7 @@ public static function getTests(): array
                 \$nglZoneIdentifier = \$nglZone instanceof {$zoneClass} ? \$nglZone->getIdentifier() : \$nglZone;
                 \$nglContext = {$viewInterface}::CONTEXT_DEFAULT;
                 \$nglTemplate = new {$templateClass}(\$this, \$context, \$blocks);
-                \$this->env->getRuntime("{$runtimeClass}")->displayZone(\$context["nglayouts"]->getLayout(), \$nglZoneIdentifier, \$nglContext, \$nglTemplate);
+                yield \$this->env->getRuntime("{$runtimeClass}")->renderZone(\$context["nglayouts"]->getLayout(), \$nglZoneIdentifier, \$nglContext, \$nglTemplate);
                 EOT,
                 $environment,
             ],
@@ -105,7 +114,7 @@ public static function getTests(): array
                 \$nglZoneIdentifier = \$nglZone instanceof {$zoneClass} ? \$nglZone->getIdentifier() : \$nglZone;
                 \$nglContext = {$viewInterface}::CONTEXT_DEFAULT;
                 \$nglTemplate = new {$templateClass}(\$this, \$context, \$blocks);
-                \$this->env->getRuntime("{$runtimeClass}")->displayZone(\$context["nglayouts"]->getLayout(), \$nglZoneIdentifier, \$nglContext, \$nglTemplate);
+                yield \$this->env->getRuntime("{$runtimeClass}")->renderZone(\$context["nglayouts"]->getLayout(), \$nglZoneIdentifier, \$nglContext, \$nglTemplate);
                 EOT,
                 $environment,
             ],

diff --git a/tests/bundles/LayoutsBundle/Templating/Twig/Runtime/RenderingRuntimeTest.php b/tests/bundles/LayoutsBundle/Templating/Twig/Runtime/RenderingRuntimeTest.php
@@ -4,13 +4,17 @@
 
 namespace Netgen\Bundle\LayoutsBundle\Tests\Templating\Twig\Runtime;
 
+use Doctrine\Common\Collections\ArrayCollection;
 use Exception;
 use Netgen\Bundle\LayoutsBundle\Templating\Twig\Runtime\RenderingRuntime;
 use Netgen\Layouts\API\Service\BlockService;
 use Netgen\Layouts\API\Values\Block\Block;
+use Netgen\Layouts\API\Values\Block\BlockList;
 use Netgen\Layouts\API\Values\Block\Placeholder;
 use Netgen\Layouts\API\Values\Collection\Item;
 use Netgen\Layouts\API\Values\Collection\Slot;
+use Netgen\Layouts\API\Values\Layout\Layout;
+use Netgen\Layouts\API\Values\Layout\Zone;
 use Netgen\Layouts\API\Values\LayoutResolver\RuleCondition;
 use Netgen\Layouts\Block\BlockDefinition;
 use Netgen\Layouts\Collection\Result\ManualItem;
@@ -21,6 +25,7 @@
 use Netgen\Layouts\Tests\Stubs\ErrorHandler;
 use Netgen\Layouts\View\RendererInterface;
 use Netgen\Layouts\View\Twig\ContextualizedTwigTemplate;
+use Netgen\Layouts\View\View\ZoneView\ZoneReference;
 use Netgen\Layouts\View\ViewInterface;
 use PHPUnit\Framework\MockObject\MockObject;
 use PHPUnit\Framework\TestCase;
@@ -60,6 +65,54 @@ protected function setUp(): void
         );
     }
 
+    /**
+     * @covers \Netgen\Bundle\LayoutsBundle\Templating\Twig\Runtime\RenderingRuntime::__construct
+     * @covers \Netgen\Bundle\LayoutsBundle\Templating\Twig\Runtime\RenderingRuntime::getViewContext
+     * @covers \Netgen\Bundle\LayoutsBundle\Templating\Twig\Runtime\RenderingRuntime::renderZone
+     */
+    public function testRenderZone(): void
+    {
+        $zone = Zone::fromArray([]);
+        $blocks = new BlockList();
+        $layout = Layout::fromArray(['zones' => new ArrayCollection(['zone' => $zone])]);
+
+        $twigTemplate = new ContextualizedTwigTemplate($this->createMock(Template::class));
+
+        $this->blockServiceMock
+            ->expects(self::once())
+            ->method('loadZoneBlocks')
+            ->with(
+                self::identicalTo($zone),
+                self::isNull(),
+            )
+            ->willReturn($blocks);
+
+        $this->rendererMock
+            ->expects(self::once())
+            ->method('renderValue')
+            ->with(
+                self::isInstanceOf(ZoneReference::class),
+                self::identicalTo(ViewInterface::CONTEXT_DEFAULT),
+                self::identicalTo(
+                    [
+                        'blocks' => $blocks,
+                        'twig_template' => $twigTemplate,
+                    ],
+                ),
+            )
+            ->willReturn('rendered zone');
+
+        self::assertSame(
+            'rendered zone',
+            $this->runtime->renderZone(
+                $layout,
+                'zone',
+                ViewInterface::CONTEXT_DEFAULT,
+                $twigTemplate,
+            ),
+        );
+    }
+
     /**
      * @covers \Netgen\Bundle\LayoutsBundle\Templating\Twig\Runtime\RenderingRuntime::__construct
      * @covers \Netgen\Bundle\LayoutsBundle\Templating\Twig\Runtime\RenderingRuntime::getViewContext