Allowing use with WebpackEncoreBundle or StimulusBundle (#80)

* Allowing use with WebpackEncoreBundle or StimulusBundle

* swapping order so older one takes precedence if installed

Author: weaverryan

CHANGELOG.md

@@ -1,6 +1,11 @@
 CHANGELOG
 =========
 
+0.4.0
+-----
+
+* Support for `symfony/ux-turbo` 2.9 using `symfony/stimulus-bundle`
+
 0.3.6
 -----
 

src/DependencyInjection/CompilerPass/StimulusHelperPass.php

@@ -0,0 +1,42 @@
+<?php
+
+/*
+ * This file is part of the Mercure Component project.
+ *
+ * (c) Kévin Dunglas <[email protected]>
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
+
+declare(strict_types=1);
+
+namespace Symfony\Bundle\MercureBundle\DependencyInjection\CompilerPass;
+
+use Symfony\Component\DependencyInjection\Alias;
+use Symfony\Component\DependencyInjection\Compiler\CompilerPassInterface;
+use Symfony\Component\DependencyInjection\ContainerBuilder;
+use Symfony\UX\Turbo\Bridge\Mercure\Broadcaster;
+
+/**
+ * Registers a dynamic alias to use a service from WebpackEncoreBundle or StimulusBundle.
+ *
+ * Depending on the version of symfony/ux-turbo installed, one of these bundles
+ * will be available.
+ */
+final class StimulusHelperPass implements CompilerPassInterface
+{
+    public function process(ContainerBuilder $container)
+    {
+        if (!class_exists(Broadcaster::class)) {
+            return;
+        }
+
+        if ($container->hasDefinition('webpack_encore.twig_stimulus_extension')) {
+            $id = 'webpack_encore.twig_stimulus_extension';
+        } else {
+            $id = 'stimulus.helper';
+        }
+        $container->setAlias('turbo.mercure.stimulus_helper', new Alias($id));
+    }
+}

src/DependencyInjection/MercureExtension.php

@@ -213,7 +213,8 @@ public function load(array $configs, ContainerBuilder $container): void
             if (class_exists(Broadcaster::class)) {
                 $container->register("turbo.mercure.{$name}.renderer", TurboStreamListenRenderer::class)
                     ->addArgument(new Reference($hubId))
-                    ->addArgument(new Reference('webpack_encore.twig_stimulus_extension'))
+                    // uses an alias dynamically registered in a compiler pass
+                    ->addArgument(new Reference('turbo.mercure.stimulus_helper'))
                     ->addArgument(new Reference('turbo.id_accessor'))
                     ->addTag('turbo.renderer.stream_listen', ['transport' => $name]);
 

src/MercureBundle.php

@@ -13,6 +13,7 @@
 
 namespace Symfony\Bundle\MercureBundle;
 
+use Symfony\Bundle\MercureBundle\DependencyInjection\CompilerPass\StimulusHelperPass;
 use Symfony\Component\DependencyInjection\Compiler\CompilerPassInterface;
 use Symfony\Component\DependencyInjection\Compiler\PassConfig;
 use Symfony\Component\DependencyInjection\ContainerBuilder;
@@ -28,6 +29,8 @@ public function build(ContainerBuilder $container): void
     {
         parent::build($container);
 
+        $container->addCompilerPass(new StimulusHelperPass());
+
         $container->addCompilerPass(new class() implements CompilerPassInterface {
             public function process(ContainerBuilder $container): void
             {