[TwigHooks] Implement autoprefixing feature (#4)

This PR introduces the autoprefixing feature. Previously we were forced
to pass the whole hook name while declaring it. From now, we can

a) pass a magic `_prefixes` variable along with the **hook context (!)**

```twig
{% hook 'base' with {
    _prefixes: ['app', 'sylius_twig_hooks']
} %}
```

b) automatically resolve the `prefixes` passed with the
`HookableMetadata` and prefix the short hook name.

```twig
{# considering there are `app.index, twig_hooks.index` prefixes in the metadata object #}

{% hook 'content' %} 

{# will produce app.index.content and twig_hooks.index.content keeping the order of prefixes #}
```

This feature will be documented more detailed later.

composer.json

@@ -31,6 +31,7 @@
         "phpstan/phpstan-symfony": "^1.3",
         "phpunit/phpunit": "^9.6",
         "symfony/console": "^5.4 || ^6.0",
+        "symfony/debug-bundle": "^5.4 || ^6.0",
         "symfony/dom-crawler": "^5.4 || ^6.0",
         "symfony/dotenv": "^5.4 || ^6.0",
         "symfony/flex": "^2.4",

config/bundles.php

@@ -6,4 +6,5 @@
     Symfony\UX\TwigComponent\TwigComponentBundle::class => ['all' => true],
     Sylius\TwigHooks\TwigHooksBundle::class => ['all' => true],
     Symfony\Bundle\WebProfilerBundle\WebProfilerBundle::class => ['dev' => true, 'test' => true],
+    Symfony\Bundle\DebugBundle\DebugBundle::class => ['dev' => true],
 ];

config/packages/debug.yaml

@@ -0,0 +1,5 @@
+when@dev:
+    debug:
+        # Forwards VarDumper Data clones to a centralized server allowing to inspect dumps on CLI or in your browser.
+        # See the "server:dump" command to start a new server.
+        dump_destination: "tcp://%env(VAR_DUMPER_SERVER)%"

config/packages/twig.yaml

@@ -1,6 +1,9 @@
 twig:
     default_path: '%kernel.project_dir%/templates'
 
+twig_component:
+    anonymous_template_directory: 'components/'
+
 when@test:
     twig:
         strict_variables: true

config/packages/twig_hooks.yaml

@@ -0,0 +1,5 @@
+twig_hooks:
+    hooks:
+        'app.base':
+            content:
+                template: 'base/content.html.twig'

monorepo-builder.php

@@ -13,6 +13,7 @@
         ],
         ComposerJsonSection::REQUIRE_DEV => [
             'phpstan/phpstan' => '^1.10',
+            'symfony/debug-bundle' => '^5.4 || ^6.0',
             'symfony/flex' => '^2.4',
             'symfony/phpunit-bridge' => '^5.4 || ^6.0',
             'symplify/monorepo-builder' => '11.2.*',

phpstan-baseline.neon

@@ -0,0 +1,6 @@
+parameters:
+	ignoreErrors:
+		-
+			message: "#^Unsafe usage of new static\\(\\)\\.$#"
+			count: 1
+			path: src/TwigHooks/src/Hookable/AbstractHookable.php

phpstan.neon

@@ -1,4 +1,5 @@
 includes:
+    - phpstan-baseline.neon
     - vendor/phpstan/phpstan-symfony/extension.neon
     - vendor/phpstan/phpstan-symfony/rules.neon
 

src/TwigHooks/config/services.php

@@ -3,9 +3,9 @@
 namespace Symfony\Component\DependencyInjection\Loader\Configurator;
 
 use Sylius\TwigHooks\Hook\NameGenerator\TemplateNameGenerator;
-use Sylius\TwigHooks\Provider\ComponentDataProvider;
+use Sylius\TwigHooks\Provider\ComponentContextProvider;
 use Sylius\TwigHooks\Provider\DefaultConfigurationProvider;
-use Sylius\TwigHooks\Provider\DefaultDataProvider;
+use Sylius\TwigHooks\Provider\DefaultContextProvider;
 use Sylius\TwigHooks\Registry\HookablesRegistry;
 use Sylius\TwigHooks\Twig\HooksExtension;
 use Sylius\TwigHooks\Twig\Runtime\HooksRuntime;
@@ -16,9 +16,9 @@
 
     $services = $configurator->services();
 
-    $services->set('twig_hooks.provider.default_data', DefaultDataProvider::class);
+    $services->set('twig_hooks.provider.default_context', DefaultContextProvider::class);
 
-    $services->set('twig_hooks.provider.component_data', ComponentDataProvider::class)
+    $services->set('twig_hooks.provider.component_data', ComponentContextProvider::class)
         ->args([
             inline_service(ExpressionLanguage::class),
         ])

src/TwigHooks/config/services/hook_renderer.php

@@ -12,6 +12,8 @@
         ->args([
             service('twig_hooks.registry.hookables'),
             service('twig_hooks.renderer.hookable'),
+            service('twig_hooks.provider.default_context'),
+            service('twig_hooks.provider.default_configuration'),
         ])
         ->alias(HookRendererInterface::class, 'twig_hooks.renderer.hook')
     ;

src/TwigHooks/config/services/hookable_renderer.php

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

src/TwigHooks/src/DependencyInjection/TwigHooksExtension.php

@@ -16,15 +16,11 @@ public function load(array $configs, ContainerBuilder $container): void
         $loader = new PhpFileLoader($container, new FileLocator(dirname(__DIR__, 2) . '/config'));
         $loader->load('services.php');
 
-        if ($container->getParameter('kernel.debug')) {
+        if ($container->hasParameter('kernel.debug') && $container->getParameter('kernel.debug')) {
             $loader->load('services/debug/twig_events.php');
         }
 
         $configuration = $this->getConfiguration([], $container);
-        if ($configuration === null) {
-            return;
-        }
-
         $config = $this->processConfiguration($configuration, $configs);
 
         $this->registerHooks($container, $config['hooks'], $config['supported_hookable_types']);

src/TwigHooks/src/Hook/Metadata/HookMetadata.php

@@ -0,0 +1,16 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Sylius\TwigHooks\Hook\Metadata;
+
+use Symfony\Component\DependencyInjection\ParameterBag\ParameterBagInterface;
+
+class HookMetadata
+{
+    public function __construct(
+        public readonly string $name,
+        public readonly ParameterBagInterface $context,
+    ) {
+    }
+}

src/TwigHooks/src/Hook/Renderer/Debug/HookDebugCommentRenderer.php

@@ -12,12 +12,12 @@ public function __construct(private HookRendererInterface $innerRenderer)
     {
     }
 
-    public function render(array $hooksNames, array $data = []): string
+    public function render(array $hookNames, array $hookContext = []): string
     {
         $renderedParts = [];
-        $renderedParts[] = $this->getOpeningDebugComment($hooksNames);
-        $renderedParts[] = trim($this->innerRenderer->render($hooksNames, $data));
-        $renderedParts[] = $this->getClosingDebugComment($hooksNames);
+        $renderedParts[] = $this->getOpeningDebugComment($hookNames);
+        $renderedParts[] = trim($this->innerRenderer->render($hookNames, $hookContext));
+        $renderedParts[] = $this->getClosingDebugComment($hookNames);
 
         return implode(PHP_EOL, $renderedParts);
     }

src/TwigHooks/src/Hook/Renderer/Debug/HookProfilerRenderer.php

@@ -17,15 +17,15 @@ public function __construct (
     ) {
     }
 
-    public function render(array $hooksNames, array $data = []): string
+    public function render(array $hookNames, array $hookContext = []): string
     {
-        $this->profile?->registerHookStart($hooksNames);
-        $this->stopwatch?->start(md5(serialize($hooksNames)));
+        $this->profile?->registerHookStart($hookNames);
+        $this->stopwatch?->start(md5(serialize($hookNames)));
 
-        $rendered = $this->innerRenderer->render($hooksNames, $data);
+        $rendered = $this->innerRenderer->render($hookNames, $hookContext);
 
         $this->profile?->registerHookEnd(
-            $this->stopwatch?->stop(md5(serialize($hooksNames)))->getDuration(),
+            $this->stopwatch?->stop(md5(serialize($hookNames)))->getDuration(),
         );
 
         return $rendered;

src/TwigHooks/src/Hook/Renderer/HookRenderer.php

@@ -4,24 +4,42 @@
 
 namespace Sylius\TwigHooks\Hook\Renderer;
 
+use Sylius\TwigHooks\Hook\Metadata\HookMetadata;
+use Sylius\TwigHooks\Hookable\Metadata\HookableMetadata;
 use Sylius\TwigHooks\Hookable\Renderer\HookableRendererInterface;
+use Sylius\TwigHooks\Provider\ConfigurationProviderInterface;
+use Sylius\TwigHooks\Provider\ContextProviderInterface;
 use Sylius\TwigHooks\Registry\HookablesRegistry;
+use Symfony\Component\DependencyInjection\ParameterBag\ParameterBag;
 
 final class HookRenderer implements HookRendererInterface
 {
     public function __construct(
-        private HookablesRegistry $hookablesRegistry,
-        private HookableRendererInterface $compositeHookableRenderer,
+        private readonly HookablesRegistry $hookablesRegistry,
+        private readonly HookableRendererInterface $compositeHookableRenderer,
+        private readonly ContextProviderInterface $contextProvider,
+        private readonly ConfigurationProviderInterface $configurationProvider,
     ) {
     }
 
-    public function render(array|string $hooksNames, array $data = []): string
+    /**
+     * @param array<string> $hookNames
+     * @param array<string, mixed> $hookContext
+     */
+    public function render(array $hookNames, array $hookContext = []): string
     {
-        $hookables = $this->hookablesRegistry->getEnabledFor($hooksNames);
+        $hookables = $this->hookablesRegistry->getEnabledFor($hookNames);
         $renderedHookables = [];
 
         foreach ($hookables as $hookable) {
-            $renderedHookables[] = $this->compositeHookableRenderer->render($hookable, $data);
+            $hookMetadata = new HookMetadata($hookable->getHookName(), new ParameterBag($hookContext));
+
+            $context = $this->contextProvider->provide($hookable, $hookContext);
+            $configuration = $this->configurationProvider->provide($hookable);
+
+            $hookableMetadata = new HookableMetadata($hookMetadata, new ParameterBag($context), new ParameterBag($configuration), $hookNames);
+
+            $renderedHookables[] = $this->compositeHookableRenderer->render($hookable, $hookableMetadata);
         }
 
         return implode(PHP_EOL, $renderedHookables);

src/TwigHooks/src/Hook/Renderer/HookRendererInterface.php

@@ -7,8 +7,8 @@
 interface HookRendererInterface
 {
     /**
-     * @param array<string> $hooksNames
-     * @param array<string, mixed> $data
+     * @param array<string> $hookNames
+     * @param array<string, mixed> $hookContext
      */
-    public function render(array $hooksNames, array $data = []): string;
+    public function render(array $hookNames, array $hookContext = []): string;
 }

src/TwigHooks/src/Hookable/Metadata/HookableMetadata.php

@@ -0,0 +1,32 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Sylius\TwigHooks\Hookable\Metadata;
+
+use Sylius\TwigHooks\Hook\Metadata\HookMetadata;
+use Symfony\Component\DependencyInjection\ParameterBag\ParameterBagInterface;
+
+class HookableMetadata
+{
+    /**
+     * @param array<string> $prefixes
+     */
+    public function __construct(
+        public readonly HookMetadata $renderedBy,
+        public readonly ParameterBagInterface $context,
+        public readonly ParameterBagInterface $configuration,
+        public readonly array $prefixes = [],
+    ) {
+        foreach ($prefixes as $prefix) {
+            if (!is_string($prefix)) {
+                throw new \InvalidArgumentException('Parent name must be a string.');
+            }
+        }
+    }
+
+    public function hasPrefixes(): bool
+    {
+        return count($this->prefixes) > 0;
+    }
+}

src/TwigHooks/src/Hookable/Renderer/CompositeHookableRenderer.php

@@ -5,6 +5,7 @@
 namespace Sylius\TwigHooks\Hookable\Renderer;
 
 use Sylius\TwigHooks\Hookable\AbstractHookable;
+use Sylius\TwigHooks\Hookable\Metadata\HookableMetadata;
 use Sylius\TwigHooks\Hookable\Renderer\Exception\NoSupportedRendererException;
 
 final class CompositeHookableRenderer implements HookableRendererInterface
@@ -28,11 +29,11 @@ public function __construct (iterable $renderers)
         }
     }
 
-    public function render(AbstractHookable $hookable, array $hookData = []): string
+    public function render(AbstractHookable $hookable, HookableMetadata $metadata): string
     {
         foreach ($this->renderers as $renderer) {
             if ($renderer->supports($hookable)) {
-                return $renderer->render($hookable, $hookData);
+                return $renderer->render($hookable, $metadata);
             }
         }
 

src/TwigHooks/src/Hookable/Renderer/Debug/HookableDebugCommentRenderer.php

@@ -5,19 +5,20 @@
 namespace Sylius\TwigHooks\Hookable\Renderer\Debug;
 
 use Sylius\TwigHooks\Hookable\AbstractHookable;
+use Sylius\TwigHooks\Hookable\Metadata\HookableMetadata;
 use Sylius\TwigHooks\Hookable\Renderer\HookableRendererInterface;
 
 final class HookableDebugCommentRenderer implements HookableRendererInterface
 {
-    public function __construct(private HookableRendererInterface $innerRenderer)
+    public function __construct(private readonly HookableRendererInterface $innerRenderer)
     {
     }
 
-    public function render(AbstractHookable $hookable, array $hookData = []): string
+    public function render(AbstractHookable $hookable, HookableMetadata $metadata): string
     {
         $renderedParts = [];
         $renderedParts[] = $this->getOpeningDebugComment($hookable);
-        $renderedParts[] = trim($this->innerRenderer->render($hookable, $hookData));
+        $renderedParts[] = trim($this->innerRenderer->render($hookable, $metadata));
         $renderedParts[] = $this->getClosingDebugComment($hookable);
 
         return implode(PHP_EOL, $renderedParts);

src/TwigHooks/src/Hookable/Renderer/Debug/HookableProfilerRenderer.php

@@ -5,6 +5,7 @@
 namespace Sylius\TwigHooks\Hookable\Renderer\Debug;
 
 use Sylius\TwigHooks\Hookable\AbstractHookable;
+use Sylius\TwigHooks\Hookable\Metadata\HookableMetadata;
 use Sylius\TwigHooks\Hookable\Renderer\HookableRendererInterface;
 use Sylius\TwigHooks\Profiler\Profile;
 use Symfony\Component\Stopwatch\Stopwatch;
@@ -18,12 +19,12 @@ public function __construct (
     ) {
     }
 
-    public function render(AbstractHookable $hookable, array $hookData = []): string
+    public function render(AbstractHookable $hookable, HookableMetadata $metadata): string
     {
         $this->profile?->registerHookableRenderStart($hookable);
         $this->stopwatch?->start($hookable->getId());
 
-        $rendered = $this->innerRenderer->render($hookable, $hookData);
+        $rendered = $this->innerRenderer->render($hookable, $metadata);
 
         $this->profile?->registerHookableRenderEnd(
             $this->stopwatch?->stop($hookable->getId())->getDuration(),

src/TwigHooks/src/Hookable/Renderer/HookableComponentRenderer.php

@@ -5,38 +5,32 @@
 namespace Sylius\TwigHooks\Hookable\Renderer;
 
 use Sylius\TwigHooks\Hookable\AbstractHookable;
-use Sylius\TwigHooks\Hookable\HookableComponent;
-use Sylius\TwigHooks\Provider\ConfigurationProviderInterface;
-use Sylius\TwigHooks\Provider\DataProviderInterface;
+use Sylius\TwigHooks\Hookable\Metadata\HookableMetadata;
 use Symfony\UX\TwigComponent\ComponentRendererInterface;
 
 final class HookableComponentRenderer implements SupportableHookableRendererInterface
 {
     public const HOOKABLE_CONFIGURATION_PARAMETER = 'hookableConfiguration';
 
-    public const HOOKABLE_DATA_PARAMETER = 'hookableData';
-
     public function __construct(
-        private ComponentRendererInterface $componentRenderer,
-        private DataProviderInterface $dataProvider,
-        private ConfigurationProviderInterface $configurationProvider,
+        private readonly ComponentRendererInterface $componentRenderer,
     ) {
     }
 
-    public function render(AbstractHookable $hookable, array $hookData = []): string
+    public function render(AbstractHookable $hookable, HookableMetadata $metadata): string
     {
         if (!$this->supports($hookable)) {
             throw new \InvalidArgumentException(
                 sprintf('Hookable must be the "%s" type, but "%s" given.', AbstractHookable::TYPE_COMPONENT, $hookable->getType()),
             );
         }
 
-        $data = $this->dataProvider->provide($hookable, $hookData);
-        $configuration = $this->configurationProvider->provide($hookable);
+        $context = $metadata->context->all();
+        $configuration = $metadata->configuration->all();
 
         return $this->componentRenderer->createAndRender($hookable->getTarget(), [
             self::HOOKABLE_CONFIGURATION_PARAMETER => $configuration,
-            ...$data,
+            ...$context,
         ]);
     }