Change how data is passed to the component hookables

Author: jakubtobiasz

composer.json

@@ -18,6 +18,7 @@
         "php": "^8.1",
         "symfony/config": "^5.4 || ^6.0",
         "symfony/dependency-injection": "^5.4 || ^6.0",
+        "symfony/expression-language": "^5.4 || ^6.0",
         "symfony/http-kernel": "^5.4 || ^6.0",
         "symfony/stopwatch": "^5.4 || ^6.0",
         "symfony/ux-twig-component": "^2.12",

src/TwigHooks/config/services.php

@@ -3,11 +3,13 @@
 namespace Symfony\Component\DependencyInjection\Loader\Configurator;
 
 use Sylius\TwigHooks\Hook\NameGenerator\TemplateNameGenerator;
+use Sylius\TwigHooks\Provider\ComponentDataProvider;
 use Sylius\TwigHooks\Provider\DefaultConfigurationProvider;
 use Sylius\TwigHooks\Provider\DefaultDataProvider;
 use Sylius\TwigHooks\Registry\HookablesRegistry;
 use Sylius\TwigHooks\Twig\HooksExtension;
 use Sylius\TwigHooks\Twig\Runtime\HooksRuntime;
+use Symfony\Component\ExpressionLanguage\ExpressionLanguage;
 
 return static function (ContainerConfigurator $configurator): void {
     $configurator->import(__DIR__ . '/services/*.php');
@@ -16,6 +18,12 @@
 
     $services->set('twig_hooks.provider.default_data', DefaultDataProvider::class);
 
+    $services->set('twig_hooks.provider.component_data', ComponentDataProvider::class)
+        ->args([
+            inline_service(ExpressionLanguage::class),
+        ])
+    ;
+
     $services->set('twig_hooks.provider.default_configuration', DefaultConfigurationProvider::class);
 
     $services->set('twig_hooks.registry.hookables', HookablesRegistry::class)

src/TwigHooks/config/services/hookable_renderer.php

@@ -21,7 +21,7 @@
     $services->set('twig_hooks.renderer.hookable.component', HookableComponentRenderer::class)
         ->args([
             service('ux.twig_component.component_renderer'),
-            service('twig_hooks.provider.default_data'),
+            service('twig_hooks.provider.component_data'),
             service('twig_hooks.provider.default_configuration'),
         ])
         ->tag('twig_hooks.hookable_renderer')

src/TwigHooks/src/Provider/ComponentDataProvider.php

@@ -0,0 +1,43 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Sylius\TwigHooks\Provider;
+
+use Sylius\TwigHooks\Hookable\AbstractHookable;
+use Symfony\Component\ExpressionLanguage\ExpressionLanguage;
+
+final class ComponentDataProvider implements DataProviderInterface
+{
+    public function __construct (
+        private ExpressionLanguage $expressionLanguage,
+    ) {
+    }
+
+    public function provide(AbstractHookable $hookable, array $hookData): array
+    {
+        return $this->mapArrayRecursively(function (mixed $value) use ($hookData): mixed {
+            if (is_string($value) && str_starts_with($value, '@=')) {
+                return $this->expressionLanguage->evaluate(substr($value, 2), ['data' => $hookData]);
+            }
+
+            return $value;
+        }, $hookable->getData());
+    }
+
+    /**
+     * @param array<array-key, mixed> $array
+     * @return array<array-key, mixed>
+     */
+    private function mapArrayRecursively(callable $callback, array $array): array
+    {
+        $result = [];
+        foreach ($array as $key => $value) {
+            $result[$key] = is_array($value)
+                ? $this->mapArrayRecursively($callback, $value)
+                : $callback($value);
+        }
+
+        return $result;
+    }
+}

src/TwigHooks/tests/Unit/Provider/ComponentDataProviderTest.php

@@ -0,0 +1,50 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Tests\Sylius\TwigHooks\Unit\Provider;
+
+use PHPUnit\Framework\TestCase;
+use Sylius\TwigHooks\Provider\ComponentDataProvider;
+use Sylius\TwigHooks\Provider\DataProviderInterface;
+use Symfony\Component\ExpressionLanguage\ExpressionLanguage;
+use Tests\Sylius\TwigHooks\Utils\MotherObject\BaseHookableMotherObject;
+
+final class ComponentDataProviderTest extends TestCase
+{
+    public function testItReturnsEmptyArrayWhenNoDataIsProvidedOnHookable(): void
+    {
+        $hookable = BaseHookableMotherObject::some();
+
+        $dataProvider = $this->createTestSubject();
+
+        $this->assertSame([], $dataProvider->provide($hookable, []));
+        $this->assertSame([], $dataProvider->provide($hookable, ['some' => 'data']));
+    }
+
+    public function testItReturnsDataFromHookable(): void
+    {
+        $hookable = BaseHookableMotherObject::withData(['some' => 'data']);
+
+        $dataProvider = $this->createTestSubject();
+
+        $this->assertSame(['some' => 'data'], $dataProvider->provide($hookable, []));
+        $this->assertSame(['some' => 'data'], $dataProvider->provide($hookable, ['more' => 'data']));
+    }
+
+    public function testItPassesTemplateLevelDataToExpressionLanguage(): void
+    {
+        $hookable = BaseHookableMotherObject::withData(['some_key' => '@=data["some"]']);
+
+        $dataProvider = $this->createTestSubject();
+
+        $this->assertSame(['some_key' => 'data'], $dataProvider->provide($hookable, ['some' => 'data']));
+    }
+
+    private function createTestSubject(): DataProviderInterface
+    {
+        return new ComponentDataProvider(
+            new ExpressionLanguage(),
+        );
+    }
+}