Simplifying bundle extension/config definition

Author: yceruto

Bundle/AbstractBundle.php

@@ -0,0 +1,50 @@
+<?php
+
+/*
+ * This file is part of the Symfony package.
+ *
+ * (c) Fabien Potencier <fabien@symfony.com>
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
+
+namespace Symfony\Component\HttpKernel\Bundle;
+
+use Symfony\Component\Config\Definition\Configurator\DefinitionConfigurator;
+use Symfony\Component\DependencyInjection\Container;
+use Symfony\Component\DependencyInjection\ContainerBuilder;
+use Symfony\Component\DependencyInjection\Extension\ConfigurableExtensionInterface;
+use Symfony\Component\DependencyInjection\Extension\ExtensionInterface;
+use Symfony\Component\DependencyInjection\Loader\Configurator\ContainerConfigurator;
+
+/**
+ * A Bundle that provides configuration hooks.
+ *
+ * @author Yonel Ceruto <yonelceruto@gmail.com>
+ */
+abstract class AbstractBundle extends Bundle implements ConfigurableExtensionInterface
+{
+    protected string $extensionAlias = '';
+
+    public function configure(DefinitionConfigurator $definition): void
+    {
+    }
+
+    public function prependExtension(ContainerConfigurator $container, ContainerBuilder $builder): void
+    {
+    }
+
+    public function loadExtension(array $config, ContainerConfigurator $container, ContainerBuilder $builder): void
+    {
+    }
+
+    public function getContainerExtension(): ?ExtensionInterface
+    {
+        if ('' === $this->extensionAlias) {
+            $this->extensionAlias = Container::underscore(preg_replace('/Bundle$/', '', $this->getName()));
+        }
+
+        return $this->extension ??= new BundleExtension($this, $this->extensionAlias);
+    }
+}

Bundle/BundleExtension.php

@@ -0,0 +1,67 @@
+<?php
+
+/*
+ * This file is part of the Symfony package.
+ *
+ * (c) Fabien Potencier <fabien@symfony.com>
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
+
+namespace Symfony\Component\HttpKernel\Bundle;
+
+use Symfony\Component\Config\Definition\Configuration;
+use Symfony\Component\Config\Definition\ConfigurationInterface;
+use Symfony\Component\DependencyInjection\ContainerBuilder;
+use Symfony\Component\DependencyInjection\Extension\ConfigurableExtensionInterface;
+use Symfony\Component\DependencyInjection\Extension\Extension;
+use Symfony\Component\DependencyInjection\Extension\ExtensionTrait;
+use Symfony\Component\DependencyInjection\Extension\PrependExtensionInterface;
+use Symfony\Component\DependencyInjection\Loader\Configurator\ContainerConfigurator;
+
+/**
+ * @author Yonel Ceruto <yonelceruto@gmail.com>
+ *
+ * @internal
+ */
+class BundleExtension extends Extension implements PrependExtensionInterface
+{
+    use ExtensionTrait;
+
+    public function __construct(
+        private ConfigurableExtensionInterface $subject,
+        private string $alias,
+    ) {
+    }
+
+    public function getConfiguration(array $config, ContainerBuilder $container): ?ConfigurationInterface
+    {
+        return new Configuration($this->subject, $container, $this->getAlias());
+    }
+
+    public function getAlias(): string
+    {
+        return $this->alias;
+    }
+
+    public function prepend(ContainerBuilder $container): void
+    {
+        $callback = function (ContainerConfigurator $configurator) use ($container) {
+            $this->subject->prependExtension($configurator, $container);
+        };
+
+        $this->executeConfiguratorCallback($container, $callback, $this->subject);
+    }
+
+    public function load(array $configs, ContainerBuilder $container): void
+    {
+        $config = $this->processConfiguration($this->getConfiguration([], $container), $configs);
+
+        $callback = function (ContainerConfigurator $configurator) use ($config, $container) {
+            $this->subject->loadExtension($config, $configurator, $container);
+        };
+
+        $this->executeConfiguratorCallback($container, $callback, $this->subject);
+    }
+}

CHANGELOG.md

@@ -9,6 +9,7 @@ CHANGELOG
  * Deprecate StreamedResponseListener, it's not needed anymore
  * Add `Profiler::isEnabled()` so collaborating collector services may elect to omit themselves.
  * Add the `UidValueResolver` argument value resolver
+ * Add `AbstractBundle` class for DI configuration/definition on a single file
 
 6.0
 ---

Tests/DependencyInjection/MergeExtensionConfigurationPassTest.php

@@ -13,8 +13,10 @@
 
 use PHPUnit\Framework\TestCase;
 use Symfony\Component\DependencyInjection\ContainerBuilder;
+use Symfony\Component\DependencyInjection\ParameterBag\ParameterBag;
 use Symfony\Component\HttpKernel\DependencyInjection\Extension;
 use Symfony\Component\HttpKernel\DependencyInjection\MergeExtensionConfigurationPass;
+use Symfony\Component\HttpKernel\Tests\Fixtures\AcmeFooBundle\AcmeFooBundle;
 
 class MergeExtensionConfigurationPassTest extends TestCase
 {
@@ -31,6 +33,27 @@ public function testAutoloadMainExtension()
         $this->assertTrue($container->hasDefinition('loaded.foo'));
         $this->assertTrue($container->hasDefinition('not_loaded.bar'));
     }
+
+    public function testFooBundle()
+    {
+        $bundle = new AcmeFooBundle();
+
+        $container = new ContainerBuilder(new ParameterBag([
+            'kernel.environment' => 'test',
+            'kernel.build_dir' => sys_get_temp_dir(),
+        ]));
+        $container->registerExtension(new LoadedExtension());
+        $container->registerExtension($bundle->getContainerExtension());
+
+        $configPass = new MergeExtensionConfigurationPass(['loaded', 'acme_foo']);
+        $configPass->process($container);
+
+        $this->assertSame([[], ['bar' => 'baz']], $container->getExtensionConfig('loaded'), '->prependExtension() prepends an extension config');
+        $this->assertTrue($container->hasDefinition('acme_foo.foo'), '->loadExtension() registers a service');
+        $this->assertTrue($container->hasDefinition('acme_foo.bar'), '->loadExtension() imports a service');
+        $this->assertTrue($container->hasParameter('acme_foo.config'), '->loadExtension() sets a parameter');
+        $this->assertSame(['foo' => 'bar', 'ping' => 'pong'], $container->getParameter('acme_foo.config'), '->loadConfiguration() defines and loads configurations');
+    }
 }
 
 class LoadedExtension extends Extension

Tests/Fixtures/AcmeFooBundle/AcmeFooBundle.php

@@ -0,0 +1,49 @@
+<?php
+
+/*
+ * This file is part of the Symfony package.
+ *
+ * (c) Fabien Potencier <fabien@symfony.com>
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
+
+namespace Symfony\Component\HttpKernel\Tests\Fixtures\AcmeFooBundle;
+
+use Symfony\Component\Config\Definition\Configurator\DefinitionConfigurator;
+use Symfony\Component\DependencyInjection\ContainerBuilder;
+use Symfony\Component\DependencyInjection\Loader\Configurator\ContainerConfigurator;
+use Symfony\Component\HttpKernel\Bundle\AbstractBundle;
+
+class AcmeFooBundle extends AbstractBundle
+{
+    public function configure(DefinitionConfigurator $definition): void
+    {
+        $definition->rootNode()
+            ->children()
+                ->scalarNode('foo')->defaultValue('bar')->end()
+            ->end()
+        ;
+
+        $definition->import('Resources/config/definition.php');
+    }
+
+    public function prependExtension(ContainerConfigurator $container, ContainerBuilder $builder): void
+    {
+        $container->extension('loaded', ['bar' => 'baz']);
+    }
+
+    public function loadExtension(array $config, ContainerConfigurator $container, ContainerBuilder $builder): void
+    {
+        $container->parameters()
+            ->set('acme_foo.config', $config)
+        ;
+
+        $container->services()
+            ->set('acme_foo.foo', \stdClass::class)
+        ;
+
+        $container->import('Resources/config/services.php');
+    }
+}

Tests/Fixtures/AcmeFooBundle/Resources/config/definition.php

@@ -0,0 +1,11 @@
+<?php
+
+use Symfony\Component\Config\Definition\Configurator\DefinitionConfigurator;
+
+return static function (DefinitionConfigurator $definition) {
+    $definition->rootNode()
+        ->children()
+            ->scalarNode('ping')->defaultValue('pong')->end()
+        ->end()
+    ;
+};

Tests/Fixtures/AcmeFooBundle/Resources/config/services.php

@@ -0,0 +1,9 @@
+<?php
+
+use Symfony\Component\DependencyInjection\Loader\Configurator\ContainerConfigurator;
+
+return static function (ContainerConfigurator $container) {
+    $container->services()
+        ->set('acme_foo.bar', \stdClass::class)
+    ;
+};

composer.json

@@ -25,7 +25,7 @@
     },
     "require-dev": {
         "symfony/browser-kit": "^5.4|^6.0",
-        "symfony/config": "^5.4|^6.0",
+        "symfony/config": "^6.1",
         "symfony/console": "^5.4|^6.0",
         "symfony/css-selector": "^5.4|^6.0",
         "symfony/dependency-injection": "^6.1",
@@ -48,10 +48,10 @@
     "conflict": {
         "symfony/browser-kit": "<5.4",
         "symfony/cache": "<5.4",
-        "symfony/config": "<5.4",
+        "symfony/config": "<6.1",
         "symfony/console": "<5.4",
         "symfony/form": "<5.4",
-        "symfony/dependency-injection": "<5.4",
+        "symfony/dependency-injection": "<6.1",
         "symfony/doctrine-bridge": "<5.4",
         "symfony/http-client": "<5.4",
         "symfony/mailer": "<5.4",