Integrating StimulusBundle for Stimulus helpers instead of Encore

Author: weaverryan

.github/build-packages.php

@@ -1,21 +1,43 @@
 <?php
 
-$dir = __DIR__.'/../src/LiveComponent';
-$flags = JSON_PRETTY_PRINT | JSON_UNESCAPED_SLASHES | JSON_UNESCAPED_UNICODE;
+require __DIR__.'/../vendor/autoload.php';
 
-$json = ltrim(file_get_contents($dir.'/composer.json'));
-if (null === $package = json_decode($json)) {
-    passthru("composer validate $dir/composer.json");
-    exit(1);
-}
+use Symfony\Component\Finder\Finder;
+
+$finder = (new Finder())
+    ->in(__DIR__.'/../src/*/')
+    ->depth(0)
+    ->name('composer.json')
+;
+
+foreach ($finder as $composerFile) {
+    $json = file_get_contents($composerFile->getPathname());
+    if (null === $packageData = json_decode($json, true)) {
+        passthru(sprintf('composer validate %s', $composerFile->getPathname()));
+        exit(1);
+    }
 
-$package->repositories[] = [
-    'type' => 'path',
-    'url' => '../TwigComponent',
-];
+    $repositories = [];
 
-$json = preg_replace('/\n    "repositories": \[\n.*?\n    \],/s', '', $json);
-$json = rtrim(json_encode(['repositories' => $package->repositories], $flags), "\n}").','.substr($json, 1);
-$json = preg_replace('/"symfony\/ux-twig-component": "(\^[\d]+\.[\d]+)"/s', '"symfony/ux-twig-component": "@dev"', $json);
-file_put_contents($dir.'/composer.json', $json);
+    if (isset($packageData['require']['symfony/ux-twig-component'])) {
+        $repositories[] = [
+            'type' => 'path',
+            'url' => '../TwigComponent',
+        ];
+        $packageData['require']['symfony/ux-twig-component'] = '@dev';
+    }
 
+    if (isset($packageData['require']['symfony/stimulus-bundle'])) {
+        $repositories[] = [
+            'type' => 'path',
+            'url' => '../StimulusBundle',
+        ];
+        $packageData['require']['symfony/stimulus-bundle'] = '@dev';
+    }
+    if (count($repositories) > 0) {
+        $packageData['repositories'] = $repositories;
+    }
+
+    $json = json_encode($packageData, \JSON_PRETTY_PRINT | \JSON_UNESCAPED_SLASHES | \JSON_UNESCAPED_UNICODE);
+    file_put_contents($composerFile->getPathname(), $json."\n");
+}

README.md

@@ -15,8 +15,9 @@ to build the chart in PHP. The JavaScript is handled for you automatically.
 **That's Symfony UX.**
 
 Symfony UX leverages [Stimulus](https://stimulus.hotwired.dev/) for JavaScript
-and the [Stimulus Bridge](https://github.com/symfony/stimulus-bridge) for
-integrating it into [Webpack Encore](https://github.com/symfony/webpack-encore).
+and can integrate with [Webpack Encore](https://github.com/symfony/webpack-encore)
+(with the help of [Stimulus Bridge](https://github.com/symfony/stimulus-bridge))
+or with [AssetMapper](https://symfony.com/doc/current/frontend/asset-mapper.html)
 
 ## Resources
 

composer.json

@@ -3,6 +3,7 @@
     "license": "MIT",
     "require-dev": {
         "symfony/filesystem": "^5.2|^6.0",
+        "symfony/finder": "^5.4|^6.0",
         "php-cs-fixer/shim": "^3.13"
     }
 }

src/Chartjs/composer.json

@@ -28,21 +28,20 @@
         }
     },
     "require": {
-        "php": ">=7.2.5",
+        "php": ">=8.0",
         "symfony/config": "^4.4.17|^5.0|^6.0",
         "symfony/dependency-injection": "^4.4.17|^5.0|^6.0",
-        "symfony/http-kernel": "^4.4.17|^5.0|^6.0"
+        "symfony/http-kernel": "^4.4.17|^5.0|^6.0",
+        "symfony/stimulus-bundle": "^2.9"
     },
     "require-dev": {
         "symfony/framework-bundle": "^4.4.17|^5.0|^6.0",
         "symfony/phpunit-bridge": "^5.2|^6.0",
         "symfony/twig-bundle": "^4.4.17|^5.0|^6.0",
-        "symfony/var-dumper": "^4.4.17|^5.0|^6.0",
-        "symfony/webpack-encore-bundle": "^1.11"
+        "symfony/var-dumper": "^4.4.17|^5.0|^6.0"
     },
     "conflict": {
-        "symfony/flex": "<1.13",
-        "symfony/webpack-encore-bundle": "<1.11"
+        "symfony/flex": "<1.13"
     },
     "extra": {
         "thanks": {

src/Chartjs/doc/index.rst

@@ -74,8 +74,7 @@ and create charts in PHP::
 All options and data are provided as-is to Chart.js. You can read
 `Chart.js documentation`_ to discover them all.
 
-Once created in PHP, a chart can be displayed using Twig if installed
-(requires `Symfony Webpack Encore`_):
+Once created in PHP, a chart can be displayed using Twig:
 
 .. code-block:: html+twig
 
@@ -244,7 +243,6 @@ the Symfony framework: https://symfony.com/doc/current/contributing/code/bc.html
 .. _`the Symfony UX initiative`: https://symfony.com/ux
 .. _`@symfony/stimulus-bridge`: https://github.com/symfony/stimulus-bridge
 .. _`Chart.js documentation`: https://www.chartjs.org/docs/latest/
-.. _`Symfony Webpack Encore`: https://symfony.com/doc/current/frontend/encore/installation.html
 .. _`Symfony UX configured in your app`: https://symfony.com/doc/current/frontend/ux.html
 .. _`a lot of plugins`: https://github.com/chartjs/awesome#plugins
 .. _`zoom plugin`: https://www.chartjs.org/chartjs-plugin-zoom/latest/

src/Chartjs/src/DependencyInjection/ChartjsExtension.php

@@ -20,7 +20,7 @@
 use Symfony\UX\Chartjs\Builder\ChartBuilder;
 use Symfony\UX\Chartjs\Builder\ChartBuilderInterface;
 use Symfony\UX\Chartjs\Twig\ChartExtension;
-use Symfony\WebpackEncoreBundle\Twig\StimulusTwigExtension;
+use Symfony\UX\StimulusBundle\Dto\StimulusAttributes;
 use Twig\Environment;
 
 /**
@@ -42,14 +42,12 @@ public function load(array $configs, ContainerBuilder $container)
             ->setPublic(false)
         ;
 
-        if (class_exists(Environment::class) && class_exists(StimulusTwigExtension::class)) {
-            $container
-                ->setDefinition('chartjs.twig_extension', new Definition(ChartExtension::class))
-                ->addArgument(new Reference('webpack_encore.twig_stimulus_extension'))
-                ->addTag('twig.extension')
-                ->setPublic(false)
-            ;
-        }
+        $container
+            ->setDefinition('chartjs.twig_extension', new Definition(ChartExtension::class))
+            ->addArgument(new Reference('stimulus.helper'))
+            ->addTag('twig.extension')
+            ->setPublic(false)
+        ;
     }
 
     public function prepend(ContainerBuilder $container)

src/Chartjs/src/Twig/ChartExtension.php

@@ -12,8 +12,7 @@
 namespace Symfony\UX\Chartjs\Twig;
 
 use Symfony\UX\Chartjs\Model\Chart;
-use Symfony\WebpackEncoreBundle\Dto\StimulusControllersDto;
-use Symfony\WebpackEncoreBundle\Twig\StimulusTwigExtension;
+use Symfony\UX\StimulusBundle\Helper\StimulusHelper;
 use Twig\Environment;
 use Twig\Extension\AbstractExtension;
 use Twig\TwigFunction;
@@ -27,7 +26,7 @@ class ChartExtension extends AbstractExtension
 {
     private $stimulus;
 
-    public function __construct(StimulusTwigExtension $stimulus)
+    public function __construct(StimulusHelper $stimulus)
     {
         $this->stimulus = $stimulus;
     }
@@ -49,15 +48,9 @@ public function renderChart(Environment $env, Chart $chart, array $attributes =
         }
         $controllers['@symfony/ux-chartjs/chart'] = ['view' => $chart->createView()];
 
-        if (class_exists(StimulusControllersDto::class)) {
-            $dto = new StimulusControllersDto($env);
-            foreach ($controllers as $name => $controllerValues) {
-                $dto->addController($name, $controllerValues);
-            }
-
-            $html = '<canvas '.$dto.' ';
-        } else {
-            $html = '<canvas '.$this->stimulus->renderStimulusController($env, $controllers).' ';
+        $stimulusAttributes = $this->stimulus->createStimulusAttributes();
+        foreach ($controllers as $name => $controllerValues) {
+            $stimulusAttributes->addController($name, $controllerValues);
         }
 
         foreach ($chart->getAttributes() as $name => $value) {
@@ -66,12 +59,12 @@ public function renderChart(Environment $env, Chart $chart, array $attributes =
             }
 
             if (true === $value) {
-                $html .= $name.'="'.$name.'" ';
+                $stimulusAttributes->addAttribute($name, $name);
             } elseif (false !== $value) {
-                $html .= $name.'="'.$value.'" ';
+                $stimulusAttributes->addAttribute($name, $value);
             }
         }
 
-        return trim($html).'></canvas>';
+        return sprintf('<canvas %s></canvas>', $stimulusAttributes);
     }
 }

src/Chartjs/tests/ChartjsBundleTest.php

@@ -24,18 +24,9 @@
  */
 class ChartjsBundleTest extends TestCase
 {
-    public function provideKernels()
-    {
-        yield 'empty' => [new EmptyAppKernel('test', true)];
-        yield 'framework' => [new FrameworkAppKernel('test', true)];
-        yield 'twig' => [new TwigAppKernel('test', true)];
-    }
-
-    /**
-     * @dataProvider provideKernels
-     */
-    public function testBootKernel(Kernel $kernel)
+    public function testBootKernel()
     {
+        $kernel = new TwigAppKernel('test', true);
         $kernel->boot();
         $this->assertArrayHasKey('ChartjsBundle', $kernel->getBundles());
     }