[symfony] Extract DriverFactoryInterface from TransportFactoryInterface.

pkg/amqp-ext/Symfony/AmqpTransportFactory.php

@@ -5,13 +5,14 @@
 use Enqueue\AmqpExt\AmqpConnectionFactory;
 use Enqueue\AmqpExt\AmqpContext;
 use Enqueue\AmqpExt\Client\AmqpDriver;
+use Enqueue\Symfony\DriverFactoryInterface;
 use Enqueue\Symfony\TransportFactoryInterface;
 use Symfony\Component\Config\Definition\Builder\ArrayNodeDefinition;
 use Symfony\Component\DependencyInjection\ContainerBuilder;
 use Symfony\Component\DependencyInjection\Definition;
 use Symfony\Component\DependencyInjection\Reference;
 
-class AmqpTransportFactory implements TransportFactoryInterface
+class AmqpTransportFactory implements TransportFactoryInterface, DriverFactoryInterface
 {
     /**
      * @var string

pkg/dbal/Symfony/DbalTransportFactory.php

@@ -6,13 +6,14 @@
 use Enqueue\Dbal\DbalConnectionFactory;
 use Enqueue\Dbal\DbalContext;
 use Enqueue\Dbal\ManagerRegistryConnectionFactory;
+use Enqueue\Symfony\DriverFactoryInterface;
 use Enqueue\Symfony\TransportFactoryInterface;
 use Symfony\Component\Config\Definition\Builder\ArrayNodeDefinition;
 use Symfony\Component\DependencyInjection\ContainerBuilder;
 use Symfony\Component\DependencyInjection\Definition;
 use Symfony\Component\DependencyInjection\Reference;
 
-class DbalTransportFactory implements TransportFactoryInterface
+class DbalTransportFactory implements TransportFactoryInterface, DriverFactoryInterface
 {
     /**
      * @var string

pkg/enqueue-bundle/DependencyInjection/EnqueueExtension.php

@@ -6,6 +6,7 @@
 use Enqueue\JobQueue\Job;
 use Enqueue\Null\Symfony\NullTransportFactory;
 use Enqueue\Symfony\DefaultTransportFactory;
+use Enqueue\Symfony\DriverFactoryInterface;
 use Enqueue\Symfony\TransportFactoryInterface;
 use Symfony\Component\Config\FileLocator;
 use Symfony\Component\Config\Resource\FileResource;
@@ -68,7 +69,9 @@ public function load(array $configs, ContainerBuilder $container)
             $loader->load('extensions/exclusive_command_extension.yml');
 
             foreach ($config['transport'] as $name => $transportConfig) {
-                $this->factories[$name]->createDriver($container, $transportConfig);
+                if ($this->factories[$name] instanceof DriverFactoryInterface) {
+                    $this->factories[$name]->createDriver($container, $transportConfig);
+                }
             }
 
             if (isset($config['transport']['default']['alias']) && false == isset($config['transport'][$config['transport']['default']['alias']])) {

pkg/enqueue-bundle/Tests/Unit/DependencyInjection/EnqueueExtensionTest.php

@@ -5,6 +5,7 @@
 use Enqueue\Bundle\DependencyInjection\Configuration;
 use Enqueue\Bundle\DependencyInjection\EnqueueExtension;
 use Enqueue\Bundle\Tests\Unit\Mocks\FooTransportFactory;
+use Enqueue\Bundle\Tests\Unit\Mocks\TransportFactoryWithoutDriverFactory;
 use Enqueue\Client\Producer;
 use Enqueue\Client\TraceableProducer;
 use Enqueue\Null\NullContext;
@@ -129,7 +130,10 @@ public function testShouldConfigureFooTransport()
             ],
         ]], $container);
 
+        self::assertTrue($container->hasDefinition('foo.connection_factory'));
         self::assertTrue($container->hasDefinition('foo.context'));
+        self::assertFalse($container->hasDefinition('foo.driver'));
+
         $context = $container->getDefinition('foo.context');
         self::assertEquals(\stdClass::class, $context->getClass());
         self::assertEquals([['foo_param' => 'aParam']], $context->getArguments());
@@ -176,10 +180,31 @@ public function testShouldLoadClientServicesWhenEnabled()
             ],
         ]], $container);
 
+        self::assertTrue($container->hasDefinition('foo.driver'));
         self::assertTrue($container->hasDefinition('enqueue.client.config'));
         self::assertTrue($container->hasDefinition('enqueue.client.producer'));
     }
 
+    public function testShouldNotCreateDriverIfFactoryDoesNotImplementDriverFactoryInterface()
+    {
+        $container = new ContainerBuilder();
+
+        $extension = new EnqueueExtension();
+        $extension->addTransportFactory(new TransportFactoryWithoutDriverFactory());
+
+        $extension->load([[
+            'client' => null,
+            'transport' => [
+                'default' => 'without_driver',
+                'without_driver' => [],
+            ],
+        ]], $container);
+
+        self::assertTrue($container->hasDefinition('without_driver.context'));
+        self::assertTrue($container->hasDefinition('without_driver.connection_factory'));
+        self::assertFalse($container->hasDefinition('without_driver.driver'));
+    }
+
     public function testShouldUseProducerByDefault()
     {
         $container = new ContainerBuilder();

pkg/enqueue-bundle/Tests/Unit/Mocks/FooTransportFactory.php

@@ -2,12 +2,13 @@
 
 namespace Enqueue\Bundle\Tests\Unit\Mocks;
 
+use Enqueue\Symfony\DriverFactoryInterface;
 use Enqueue\Symfony\TransportFactoryInterface;
 use Symfony\Component\Config\Definition\Builder\ArrayNodeDefinition;
 use Symfony\Component\DependencyInjection\ContainerBuilder;
 use Symfony\Component\DependencyInjection\Definition;
 
-class FooTransportFactory implements TransportFactoryInterface
+class FooTransportFactory implements TransportFactoryInterface, DriverFactoryInterface
 {
     /**
      * @var string

pkg/enqueue-bundle/Tests/Unit/Mocks/TransportFactoryWithoutDriverFactory.php

@@ -0,0 +1,68 @@
+<?php
+
+namespace Enqueue\Bundle\Tests\Unit\Mocks;
+
+use Enqueue\Symfony\TransportFactoryInterface;
+use Symfony\Component\Config\Definition\Builder\ArrayNodeDefinition;
+use Symfony\Component\DependencyInjection\ContainerBuilder;
+use Symfony\Component\DependencyInjection\Definition;
+
+class TransportFactoryWithoutDriverFactory implements TransportFactoryInterface
+{
+    /**
+     * @var string
+     */
+    private $name;
+
+    /**
+     * @param string $name
+     */
+    public function __construct($name = 'without_driver')
+    {
+        $this->name = $name;
+    }
+
+    /**
+     * {@inheritdoc}
+     */
+    public function addConfiguration(ArrayNodeDefinition $builder)
+    {
+    }
+
+    /**
+     * {@inheritdoc}
+     */
+    public function createConnectionFactory(ContainerBuilder $container, array $config)
+    {
+        $factoryId = 'without_driver.connection_factory';
+
+        $container->setDefinition($factoryId, new Definition(\stdClass::class, [$config]));
+
+        return $factoryId;
+    }
+
+    /**
+     * {@inheritdoc}
+     */
+    public function createContext(ContainerBuilder $container, array $config)
+    {
+        $contextId = 'without_driver.context';
+
+        $container->setDefinition($contextId, new Definition(\stdClass::class, [$config]));
+
+        return $contextId;
+    }
+
+    public function createDriver(ContainerBuilder $container, array $config)
+    {
+        throw new \LogicException('It should not be called. The method will be removed');
+    }
+
+    /**
+     * {@inheritdoc}
+     */
+    public function getName()
+    {
+        return $this->name;
+    }
+}

pkg/enqueue/Symfony/DefaultTransportFactory.php

@@ -14,7 +14,7 @@
 use Symfony\Component\DependencyInjection\ContainerBuilder;
 use function Enqueue\dsn_to_connection_factory;
 
-class DefaultTransportFactory implements TransportFactoryInterface
+class DefaultTransportFactory implements TransportFactoryInterface, DriverFactoryInterface
 {
     /**
      * @var string

pkg/enqueue/Symfony/DriverFactoryInterface.php

@@ -0,0 +1,21 @@
+<?php
+
+namespace Enqueue\Symfony;
+
+use Symfony\Component\DependencyInjection\ContainerBuilder;
+
+interface DriverFactoryInterface
+{
+    /**
+     * @param ContainerBuilder $container
+     * @param array            $config
+     *
+     * @return string The method must return a driver service id
+     */
+    public function createDriver(ContainerBuilder $container, array $config);
+
+    /**
+     * @return string
+     */
+    public function getName();
+}

pkg/enqueue/Symfony/TransportFactoryInterface.php

@@ -29,6 +29,8 @@ public function createConnectionFactory(ContainerBuilder $container, array $conf
     public function createContext(ContainerBuilder $container, array $config);
 
     /**
+     * @deprecated since 0.5 will be removed in 0.6. The method will be moved to DriverFactoryInterface
+     *
      * @param ContainerBuilder $container
      * @param array            $config
      *

pkg/fs/Symfony/FsTransportFactory.php

@@ -5,13 +5,14 @@
 use Enqueue\Fs\Client\FsDriver;
 use Enqueue\Fs\FsConnectionFactory;
 use Enqueue\Fs\FsContext;
+use Enqueue\Symfony\DriverFactoryInterface;
 use Enqueue\Symfony\TransportFactoryInterface;
 use Symfony\Component\Config\Definition\Builder\ArrayNodeDefinition;
 use Symfony\Component\DependencyInjection\ContainerBuilder;
 use Symfony\Component\DependencyInjection\Definition;
 use Symfony\Component\DependencyInjection\Reference;
 
-class FsTransportFactory implements TransportFactoryInterface
+class FsTransportFactory implements TransportFactoryInterface, DriverFactoryInterface
 {
     /**
      * @var string

pkg/null/Symfony/NullTransportFactory.php

@@ -5,13 +5,14 @@
 use Enqueue\Null\Client\NullDriver;
 use Enqueue\Null\NullConnectionFactory;
 use Enqueue\Null\NullContext;
+use Enqueue\Symfony\DriverFactoryInterface;
 use Enqueue\Symfony\TransportFactoryInterface;
 use Symfony\Component\Config\Definition\Builder\ArrayNodeDefinition;
 use Symfony\Component\DependencyInjection\ContainerBuilder;
 use Symfony\Component\DependencyInjection\Definition;
 use Symfony\Component\DependencyInjection\Reference;
 
-class NullTransportFactory implements TransportFactoryInterface
+class NullTransportFactory implements TransportFactoryInterface, DriverFactoryInterface
 {
     /**
      * @var string

pkg/redis/Symfony/RedisTransportFactory.php

@@ -5,13 +5,14 @@
 use Enqueue\Redis\Client\RedisDriver;
 use Enqueue\Redis\RedisConnectionFactory;
 use Enqueue\Redis\RedisContext;
+use Enqueue\Symfony\DriverFactoryInterface;
 use Enqueue\Symfony\TransportFactoryInterface;
 use Symfony\Component\Config\Definition\Builder\ArrayNodeDefinition;
 use Symfony\Component\DependencyInjection\ContainerBuilder;
 use Symfony\Component\DependencyInjection\Definition;
 use Symfony\Component\DependencyInjection\Reference;
 
-class RedisTransportFactory implements TransportFactoryInterface
+class RedisTransportFactory implements TransportFactoryInterface, DriverFactoryInterface
 {
     /**
      * @var string

pkg/sqs/Symfony/SqsTransportFactory.php

@@ -5,13 +5,14 @@
 use Enqueue\Sqs\Client\SqsDriver;
 use Enqueue\Sqs\SqsConnectionFactory;
 use Enqueue\Sqs\SqsContext;
+use Enqueue\Symfony\DriverFactoryInterface;
 use Enqueue\Symfony\TransportFactoryInterface;
 use Symfony\Component\Config\Definition\Builder\ArrayNodeDefinition;
 use Symfony\Component\DependencyInjection\ContainerBuilder;
 use Symfony\Component\DependencyInjection\Definition;
 use Symfony\Component\DependencyInjection\Reference;
 
-class SqsTransportFactory implements TransportFactoryInterface
+class SqsTransportFactory implements TransportFactoryInterface, DriverFactoryInterface
 {
     /**
      * @var string

pkg/stomp/Symfony/StompTransportFactory.php

@@ -5,13 +5,14 @@
 use Enqueue\Stomp\Client\StompDriver;
 use Enqueue\Stomp\StompConnectionFactory;
 use Enqueue\Stomp\StompContext;
+use Enqueue\Symfony\DriverFactoryInterface;
 use Enqueue\Symfony\TransportFactoryInterface;
 use Symfony\Component\Config\Definition\Builder\ArrayNodeDefinition;
 use Symfony\Component\DependencyInjection\ContainerBuilder;
 use Symfony\Component\DependencyInjection\Definition;
 use Symfony\Component\DependencyInjection\Reference;
 
-class StompTransportFactory implements TransportFactoryInterface
+class StompTransportFactory implements TransportFactoryInterface, DriverFactoryInterface
 {
     /**
      * @var string