Introduce Symfony UX Turbo

Author: tgalopin

.github/workflows/test.yaml

@@ -34,6 +34,7 @@ jobs:
             - uses: shivammathur/setup-php@v2
               with:
                   php-version: '7.2'
+                  extensions: gd
             - name: Chartjs
               run: |
                   cd src/Chartjs
@@ -54,6 +55,11 @@ jobs:
                   cd src/LazyImage
                   composer update --prefer-lowest --prefer-dist --no-interaction --no-ansi --no-progress
                   php vendor/bin/simple-phpunit
+            - name: Turbo
+              run: |
+                  cd src/Turbo
+                  composer update --prefer-lowest --prefer-dist --no-interaction --no-ansi --no-progress
+                  php vendor/bin/simple-phpunit
 
     tests-php-high-deps:
         runs-on: ubuntu-latest
@@ -62,6 +68,7 @@ jobs:
             - uses: shivammathur/setup-php@v2
               with:
                   php-version: '8.0'
+                  extensions: gd
             - name: Chartjs
               run: |
                   cd src/Chartjs
@@ -86,6 +93,12 @@ jobs:
                   composer config platform.php 7.4.99
                   composer update --prefer-dist --no-interaction --no-ansi --no-progress
                   php vendor/bin/simple-phpunit
+            - name: Turbo
+              run: |
+                  cd src/Turbo
+                  composer config platform.php 7.4.99
+                  composer update --prefer-dist --no-interaction --no-ansi --no-progress
+                  php vendor/bin/simple-phpunit
 
     tests-js:
         runs-on: ubuntu-latest

README.md

@@ -34,6 +34,8 @@ integrating it into Webpack Encore.
     Improve image loading performances through lazy-loading and data-uri thumbnails
 -   [UX Swup](https://github.com/symfony/ux-swup):
     [Swup](https://swup.js.org/) page transition library integration for Symfony
+-   [UX Turbo](https://github.com/symfony/ux-turbo):
+    [Turbo](https://turbo.hotwire.dev) interactive and real-time UI library integration for Symfony
 
 ## Stimulus Tools around the World
 

src/Turbo/.gitattributes

@@ -0,0 +1,5 @@
+/.gitattributes export-ignore
+/.gitignore export-ignore
+/phpunit.xml.dist export-ignore
+/assets/test export-ignore
+/tests export-ignore

src/Turbo/.gitignore

@@ -0,0 +1,4 @@
+/vendor/
+.phpunit.result.cache
+.php_cs.cache
+composer.lock

src/Turbo/DependencyInjection/Configuration.php

@@ -0,0 +1,50 @@
+<?php
+
+/*
+ * This file is part of the Symfony package.
+ *
+ * (c) Fabien Potencier <[email protected]>
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
+
+namespace Symfony\UX\Turbo\DependencyInjection;
+
+use Symfony\Component\Config\Definition\Builder\TreeBuilder;
+use Symfony\Component\Config\Definition\ConfigurationInterface;
+
+/**
+ * @author Titouan Galopin <[email protected]>
+ *
+ * @internal
+ */
+class Configuration implements ConfigurationInterface
+{
+    public function getConfigTreeBuilder()
+    {
+        $treeBuilder = new TreeBuilder('turbo');
+        $rootNode = $treeBuilder->getRootNode();
+
+        $rootNode
+            ->children()
+                ->arrayNode('streams')
+                    ->info('Enable this section to use Turbo Streams')
+                    ->children()
+                        ->scalarNode('adapter')
+                            ->defaultNull()
+                            ->info('The service to use to create Turbo Streams')
+                        ->end()
+                        ->arrayNode('options')
+                            ->info('Key/value options passed to the adapter to create Turbo Streams')
+                            ->normalizeKeys(false)
+                            ->variablePrototype()
+                        ->end()
+                    ->end()
+                ->end()
+            ->end()
+        ;
+
+        return $treeBuilder;
+    }
+}

src/Turbo/DependencyInjection/TurboExtension.php

@@ -0,0 +1,71 @@
+<?php
+
+/*
+ * This file is part of the Symfony package.
+ *
+ * (c) Fabien Potencier <[email protected]>
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
+
+namespace Symfony\UX\Turbo\DependencyInjection;
+
+use Symfony\Component\DependencyInjection\ContainerBuilder;
+use Symfony\Component\DependencyInjection\Definition;
+use Symfony\Component\DependencyInjection\Reference;
+use Symfony\Component\HttpKernel\DependencyInjection\Extension;
+use Symfony\UX\Turbo\Streams\MercureStreamAdapter;
+use Symfony\UX\Turbo\Twig\FrameTwigExtension;
+use Symfony\UX\Turbo\Twig\StreamTwigExtension;
+use Symfony\WebpackEncoreBundle\Twig\StimulusTwigExtension;
+use Twig\Environment;
+
+/**
+ * @author Titouan Galopin <[email protected]>
+ *
+ * @internal
+ */
+class TurboExtension extends Extension
+{
+    public function load(array $configs, ContainerBuilder $container)
+    {
+        $configuration = new Configuration();
+        $config = $this->processConfiguration($configuration, $configs);
+
+        // Register Turbo Streams config
+        if (!empty($config['streams']['adapter'])) {
+            $this->registerStreamsConfig($config, $container);
+        }
+
+        // Add Twig extension
+        if (class_exists(Environment::class)) {
+            $container
+                ->setDefinition('turbo.twig.frame_extension', new Definition(FrameTwigExtension::class))
+                ->addTag('twig.extension')
+                ->setPublic(false)
+            ;
+
+            if (!empty($config['streams']['adapter']) && class_exists(StimulusTwigExtension::class)) {
+                $container
+                    ->setDefinition('turbo.twig.stream_extension', new Definition(StreamTwigExtension::class))
+                    ->addArgument(new Reference('webpack_encore.twig_stimulus_extension'))
+                    ->addArgument(new Reference('turbo.streams.adapter'))
+                    ->addArgument($config['streams']['options'] ?? [])
+                    ->addTag('twig.extension')
+                    ->setPublic(false)
+                ;
+            }
+        }
+    }
+
+    private function registerStreamsConfig(array $config, ContainerBuilder $container)
+    {
+        // Register native stream adapters
+        $container->setDefinition('turbo.streams.adapter.mercure', new Definition(MercureStreamAdapter::class))
+            ->setPublic(false);
+
+        // Wire configured adapter
+        $container->setAlias('turbo.streams.adapter', $config['streams']['adapter'])->setPublic(false);
+    }
+}