Merge pull request #150 from symfony-cmf/adapter_registration

dantleech · dantleech · commit 70ae5f2503ae · 2015-03-26T09:02:42.000Z
Sulu changes: Added possiblity to register custom adapters etc.
diff --git a/CmfRoutingAutoBundle.php b/CmfRoutingAutoBundle.php
@@ -14,15 +14,17 @@
 
 use Symfony\Component\HttpKernel\Bundle\Bundle;
 use Symfony\Component\DependencyInjection\ContainerBuilder;
-use Symfony\Cmf\Bundle\RoutingAutoBundle\DependencyInjection\Compiler\AutoRoutePass;
 use Doctrine\Bundle\PHPCRBundle\DependencyInjection\Compiler\DoctrinePhpcrMappingsPass;
+use Symfony\Cmf\Bundle\RoutingAutoBundle\DependencyInjection\Compiler\ServicePass;
+use Symfony\Cmf\Bundle\RoutingAutoBundle\DependencyInjection\Compiler\AdapterPass;
 
 class CmfRoutingAutoBundle extends Bundle
 {
     public function build(ContainerBuilder $container)
     {
         parent::build($container);
-        $container->addCompilerPass(new AutoRoutePass());
+        $container->addCompilerPass(new ServicePass());
+        $container->addCompilerPass(new AdapterPass());
         $this->buildPhpcrCompilerPass($container);
     }
 
@@ -40,16 +42,20 @@ private function buildPhpcrCompilerPass(ContainerBuilder $container)
             return;
         }
 
-        $container->addCompilerPass(
-            DoctrinePhpcrMappingsPass::createXmlMappingDriver(
-                array(
-                    realpath(__DIR__.'/Resources/config/doctrine-model') => 'Symfony\Cmf\Bundle\RoutingAutoBundle\Model',
-                ),
-                array('cmf_routing_auto.persistence.phpcr.manager_name'),
-                false,
-                array('CmfRoutingAutoBundle' => 'Symfony\Cmf\Bundle\RoutingAutoBundle\Model')
-            )
-        );
+        $bundles = $container->getParameter('kernel.bundles');
+
+        if (isset($bundles['CmfRoutingBundle'])) {
+            $container->addCompilerPass(
+                DoctrinePhpcrMappingsPass::createXmlMappingDriver(
+                    array(
+                        realpath(__DIR__.'/Resources/config/doctrine-model') => 'Symfony\Cmf\Bundle\RoutingAutoBundle\Model',
+                    ),
+                    array('cmf_routing_auto.persistence.phpcr.manager_name'),
+                    false,
+                    array('CmfRoutingAutoBundle' => 'Symfony\Cmf\Bundle\RoutingAutoBundle\Model')
+                )
+            );
+        }
     }
 
 }
diff --git a/DependencyInjection/CmfRoutingAutoExtension.php b/DependencyInjection/CmfRoutingAutoExtension.php
@@ -53,18 +53,29 @@ public function load(array $configs, ContainerBuilder $container)
         $container->setParameter('cmf_routing_auto.metadata.loader.resources', $resources);
 
         $hasProvider = false;
+
+        $adapterName = null;
+        if (isset($config['adapter'])) {
+            $adapterName = $config['adapter'];
+        }
+
         if ($this->isConfigEnabled($container, $config['persistence']['phpcr'])) {
             $hasProvider = true;
             $loader->load('phpcr-odm.xml');
+            if (null === $adapterName) {
+                $adapterName = 'doctrine_phpcr_odm';
+            }
             $container->setParameter('cmf_routing_auto.persistence.phpcr.route_basepath', $config['persistence']['phpcr']['route_basepath']);
         }
 
-        if (!$hasProvider) {
-            throw new InvalidConfigurationException(
-                'The RoutingAutoBundle requires that you enable one of the persistence layers in your application configuration. ' .
-                'See the documentation for more information'
-            );
+        if (false === $hasProvider && null === $adapterName) {
+            throw new InvalidConfigurationException(sprintf(
+                'No adapter has been configured, you either need to enable a persistence layer or '.
+                'explicitly specify an adapter using the "adapter" configuration key.'
+            ));
         }
+
+        $container->setParameter('cmf_routing_auto.adapter_name', $adapterName);
     }
 
     protected function findMappingFiles($bundles)
diff --git a/DependencyInjection/Compiler/AdapterPass.php b/DependencyInjection/Compiler/AdapterPass.php
@@ -0,0 +1,64 @@
+<?php
+
+/*
+ * This file is part of the Symfony CMF package.
+ *
+ * (c) 2011-2014 Symfony CMF
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
+
+
+namespace Symfony\Cmf\Bundle\RoutingAutoBundle\DependencyInjection\Compiler;
+
+use Symfony\Component\DependencyInjection\ContainerBuilder;
+use Symfony\Component\DependencyInjection\Compiler\CompilerPassInterface;
+use Symfony\Component\DependencyInjection\Reference;
+
+/**
+ * @author Daniel Leech <daniel@dantleech.com>
+ */
+class AdapterPass implements CompilerPassInterface
+{
+    public function process(ContainerBuilder $container)
+    {
+        if (!$container->hasDefinition(
+            'cmf_routing_auto.auto_route_manager'
+        )) {
+            return;
+        }
+
+        $adapter = $container->getParameter('cmf_routing_auto.adapter_name');
+        $adapterId = null;
+        $adapterNames = array();
+        $ids = $container->findTaggedServiceIds('cmf_routing_auto.adapter');
+
+        foreach ($ids as $id => $attributes) {
+            if (!isset($attributes[0]['alias'])) {
+                throw new \InvalidArgumentException(sprintf(
+                    'No "name" specified for auto route adapter "%s"',
+                    $id
+                ));
+            }
+
+            $alias = $attributes[0]['alias'];
+            $adapterNames[] = $alias;
+            if ($adapter === $alias) {
+                $adapterId = $id;
+                break;
+            }
+        }
+
+        if (null === $adapterId) {
+            throw new \RuntimeException(sprintf(
+                'Could not find configured adapter "%s", available adapters: "%s"',
+                $adapter,
+                implode('", "', $adapterNames)
+            ));
+        }
+
+        $managerDef = $container->getDefinition('cmf_routing_auto.auto_route_manager');
+        $container->setAlias('cmf_routing_auto.adapter', $adapterId);
+    }
+}
diff --git a/DependencyInjection/Compiler/ServicePass.php b/DependencyInjection/Compiler/ServicePass.php
@@ -19,7 +19,7 @@
 /**
  * @author Daniel Leech <daniel@dantleech.com>
  */
-class AutoRoutePass implements CompilerPassInterface
+class ServicePass implements CompilerPassInterface
 {
     public function process(ContainerBuilder $container)
     {
diff --git a/DependencyInjection/Configuration.php b/DependencyInjection/Configuration.php
@@ -26,7 +26,9 @@ public function getConfigTreeBuilder()
     {
         $treeBuilder = new TreeBuilder();
         $treeBuilder->root('cmf_routing_auto')
+            ->addDefaultsIfNotSet()
             ->children()
+                ->scalarNode('adapter')->info('Use a specific adapter, overrides any implicit selection')->end()
                 ->booleanNode('auto_mapping')->defaultTrue()->end()
                 ->arrayNode('mapping')
                     ->fixXmlConfig('resource')
diff --git a/Resources/config/auto_route.xml b/Resources/config/auto_route.xml
@@ -8,7 +8,6 @@
         <parameter key="cmf_routing_auto.phpcrodm_auto_route_listener.class">Symfony\Cmf\Bundle\RoutingAutoBundle\Doctrine\Phpcr\AutoRouteListener</parameter>
         <parameter key="cmf_routing_auto.auto_route_manager.class">Symfony\Cmf\Component\RoutingAuto\AutoRouteManager</parameter>
         <parameter key="cmf_routing_auto.service_registry.class">Symfony\Cmf\Component\RoutingAuto\ServiceRegistry</parameter>
-        <parameter key="cmf_routing_auto.adapter.phpcr_odm.class">Symfony\Cmf\Bundle\RoutingAutoBundle\Adapter\PhpcrOdmAdapter</parameter>
         <parameter key="cmf_routing_auto.uri_generator.class">Symfony\Cmf\Component\RoutingAuto\UriGenerator</parameter>
 
         <parameter key="cmf_routing_auto.metadata.loader.yaml.class">Symfony\Cmf\Component\RoutingAuto\Mapping\Loader\YmlFileLoader</parameter>
@@ -35,15 +34,15 @@
             id="cmf_routing_auto.auto_route_manager"
             class="Symfony\Cmf\Component\RoutingAuto\AutoRouteManager"
             >
-            <argument type="service" id="cmf_routing_auto.adapter.phpcr_odm"/>
+            <argument type="service" id="cmf_routing_auto.adapter" />
             <argument type="service" id="cmf_routing_auto.uri_generator" />
             <argument type="service" id="cmf_routing_auto.defunct_route_handler.delegating" />
         </service>
 
         <!-- URL Generator -->
         <service id="cmf_routing_auto.uri_generator" class="%cmf_routing_auto.uri_generator.class%">
             <argument type="service" id="cmf_routing_auto.metadata.factory" />
-            <argument type="service" id="cmf_routing_auto.adapter.phpcr_odm" />
+            <argument type="service" id="cmf_routing_auto.adapter" />
             <argument type="service" id="cmf_routing_auto.service_registry" />
         </service>
 
diff --git a/Resources/config/conflict_resolvers.xml b/Resources/config/conflict_resolvers.xml
@@ -13,7 +13,7 @@
     <services>
 
         <service id="cmf_routing_auto.conflict_resolver.auto_increment" class="%cmf_routing_auto.conflict_resolver.auto_increment.class%">
-            <argument type="service" id="cmf_routing_auto.adapter.phpcr_odm" />
+            <argument type="service" id="cmf_routing_auto.adapter" />
             <tag name="cmf_routing_auto.conflict_resolver" alias="auto_increment" />
         </service>
 
diff --git a/Resources/config/defunct_route_handlers.xml b/Resources/config/defunct_route_handlers.xml
@@ -14,18 +14,18 @@
     <services>
 
         <service id="cmf_routing_auto.defunct_route_handler.remove" class="%cmf_routing_auto.defunct_route_handler.remove.class%">
-            <argument type="service" id="cmf_routing_auto.adapter.phpcr_odm" />
+            <argument type="service" id="cmf_routing_auto.adapter" />
             <tag name="cmf_routing_auto.defunct_route_handler" alias="remove" />
         </service>
 
         <service id="cmf_routing_auto.defunct_route_handler.leave_redirect" class="%cmf_routing_auto.defunct_route_handler.leave_redirect.class%">
-            <argument type="service" id="cmf_routing_auto.adapter.phpcr_odm" />
+            <argument type="service" id="cmf_routing_auto.adapter" />
             <tag name="cmf_routing_auto.defunct_route_handler" alias="leave_redirect" />
         </service>
 
         <service id="cmf_routing_auto.defunct_route_handler.delegating" class="%cmf_routing_auto.defunct_route_handler.delegating.class%">
             <argument type="service" id="cmf_routing_auto.metadata.factory" />
-            <argument type="service" id="cmf_routing_auto.adapter.phpcr_odm" />
+            <argument type="service" id="cmf_routing_auto.adapter" />
             <argument type="service" id="cmf_routing_auto.service_registry" />
         </service>
 
diff --git a/Resources/config/phpcr-odm.xml b/Resources/config/phpcr-odm.xml
@@ -15,6 +15,7 @@
         <service id="cmf_routing_auto.adapter.phpcr_odm" class="%cmf_routing_auto.adapter.phpcr_odm.class%">
             <argument type="service" id="doctrine_phpcr.odm.default_document_manager"/>
             <argument>%cmf_routing_auto.persistence.phpcr.route_basepath%</argument>
+            <tag name="cmf_routing_auto.adapter" alias="doctrine_phpcr_odm" />
         </service>
 
         <service id="cmf_routing_auto.phpcrodm_auto_route_listener" class="%cmf_routing_auto.phpcrodm_auto_route_listener.class%">
diff --git a/Tests/Unit/Adapter/PhpcrOdmAdapterTest.php b/Tests/Unit/Adapter/PhpcrOdmAdapterTest.php
@@ -116,7 +116,6 @@ public function testCreateAutoRoute($path, $expectedParentPath, $expectedName, $
         }
 
         $this->uriContext->getUri()->willReturn($path);
-
         $res = $this->adapter->createAutoRoute($this->uriContext->reveal(), $this->contentDocument, 'fr');
         $this->assertNotNull($res);
         $this->assertInstanceOf('Symfony\Cmf\Bundle\RoutingAutoBundle\Model\AutoRoute', $res);
diff --git a/Tests/Unit/DependencyInjection/CmfRoutingAutoExtensionTest.php b/Tests/Unit/DependencyInjection/CmfRoutingAutoExtensionTest.php
@@ -17,41 +17,89 @@ public function setUp()
         ));
     }
 
-    protected function getContainerExtensions()
+    /**
+     * An exception should be thrown if an adapter has not been explicitly or
+     * implicitly configured.
+     *
+     * @expectedException Symfony\Component\Config\Definition\Exception\InvalidConfigurationException
+     * @expectedExceptionMessage No adapter has been configured, you either need to 
+     */
+    public function testLoad()
     {
-        return array(
-            new CmfRoutingAutoExtension()
-        );
+        $this->setParameter('kernel.bundles', array());
+        $this->load();
     }
 
-    protected function loadPhpcrOdm()
+    /**
+     * It should be possible to explicitly specify an adapter
+     */
+    public function testExplicitAdapter()
     {
         $this->load(array(
+            'adapter' => 'foobar'
+        ));
+
+        $adapter = $this->container->getParameter('cmf_routing_auto.adapter_name');
+        $this->assertEquals('foobar', $adapter);
+    }
+
+    /**
+     * The adapter should be implicitly configured if the PHPCR ODM integration has
+     * been enabled
+     */
+    public function testImplicitPhpcrOdmAdapter()
+    {
+        $this->loadPhpcrOdm();
+
+        $adapter = $this->container->getParameter('cmf_routing_auto.adapter_name');
+        $this->assertEquals('doctrine_phpcr_odm', $adapter);
+    }
+
+    /**
+     * It should be possible to override the implicitly configured adapter
+     */
+    public function testOverrideImplicitPhpcrOdmAdapter()
+    {
+        $this->load(array(
+            'adapter' => 'foobar',
             'persistence' => array(
                 'phpcr' => array(
                     'enabled' => true
                 )
             )
         ));
+        $adapter = $this->container->getParameter('cmf_routing_auto.adapter_name');
+        $this->assertEquals('foobar', $adapter);
     }
 
     /**
-     * @expectedException Symfony\Component\Config\Definition\Exception\InvalidConfigurationException
-     * @expectedExceptionMessage enable one of the persistence layers
+     * The bundle should automatically register routing auto mapping configuration in
+     * the Resources/config directory.
      */
-    public function testLoad()
-    {
-        $this->setParameter('kernel.bundles', array());
-        $this->load();
-    }
-
     public function testAutoMappingRegistration()
     {
         $this->loadPhpcrOdm();
 
         $resources = $this->container->getParameter('cmf_routing_auto.metadata.loader.resources');
 
-        // both the YAML and the XML files in the TestBundle have been registered
         $this->assertCount(2, $resources);
     }
+
+    protected function getContainerExtensions()
+    {
+        return array(
+            new CmfRoutingAutoExtension()
+        );
+    }
+
+    protected function loadPhpcrOdm()
+    {
+        $this->load(array(
+            'persistence' => array(
+                'phpcr' => array(
+                    'enabled' => true
+                )
+            )
+        ));
+    }
 }
diff --git a/Tests/Unit/DependencyInjection/Compiler/AdapterPassTest.php b/Tests/Unit/DependencyInjection/Compiler/AdapterPassTest.php
@@ -0,0 +1,48 @@
+<?php
+
+use Symfony\Cmf\Bundle\RoutingAutoBundle\Tests\Unit\DependencyInjection\Compiler;
+use Symfony\Component\DependencyInjection\Definition;
+use Matthias\SymfonyDependencyInjectionTest\PhpUnit\AbstractCompilerPassTestCase;
+use Symfony\Component\DependencyInjection\ContainerBuilder;
+use Symfony\Component\DependencyInjection\Reference;
+use Symfony\Component\DependencyInjection\Alias;
+use Symfony\Cmf\Bundle\RoutingAutoBundle\DependencyInjection\Compiler\AdapterPass;
+
+class AutoRoutePassTest extends AbstractCompilerPassTestCase
+{
+    protected function registerCompilerPass(ContainerBuilder $container)
+    {
+        $container->addCompilerPass(new AdapterPass());
+    }
+
+    /**
+     * @expectedException \RuntimeException
+     * @expectedExceptionMessage Could not find configured adapter "bar", available adapters: "foobar"
+     */
+    public function testAdapterRegistrationUnknownAdapter()
+    {
+        $managerDef = new Definition();
+        $this->setDefinition('cmf_routing_auto.auto_route_manager', $managerDef);
+        $this->container->setParameter('cmf_routing_auto.adapter_name', 'bar');
+
+        $adapterDef = new Definition();
+        $adapterDef->addTag('cmf_routing_auto.adapter', array('alias' => 'foobar'));
+        $this->setDefinition('some_adapter', $adapterDef);
+        $this->compile();
+    }
+
+    public function testAdapterRegistration()
+    {
+        $managerDef = new Definition();
+        $managerDef->setArguments(array(0, 1, 2));
+        $this->setDefinition('cmf_routing_auto.auto_route_manager', $managerDef);
+        $this->container->setParameter('cmf_routing_auto.adapter_name', 'foobar');
+
+        $adapterDef = new Definition();
+        $adapterDef->addTag('cmf_routing_auto.adapter', array('alias' => 'foobar'));
+        $this->setDefinition('some_adapter', $adapterDef);
+        $this->compile();
+
+        $this->assertEquals(new Alias('some_adapter'), $this->container->getAlias('cmf_routing_auto.adapter'));
+    }
+}
diff --git a/Tests/Unit/DependencyInjection/Compiler/ServicePassTest.php b/Tests/Unit/DependencyInjection/Compiler/ServicePassTest.php

Original file line number	Diff line number	Diff line change
`@@ -19,7 +19,7 @@`
`19`	`19`	`/**`
`20`	`20`	`* @author Daniel Leech <[email protected]>`
`21`	`21`	`*/`
`22`		`-class AutoRoutePass implements CompilerPassInterface`
	`22`	`+class ServicePass implements CompilerPassInterface`
`23`	`23`	`{`
`24`	`24`	`public function process(ContainerBuilder $container)`
`25`	`25`	`{`
Original file line number	Diff line number	Diff line change
`@@ -116,7 +116,6 @@ public function testCreateAutoRoute($path, $expectedParentPath, $expectedName, $`
`116`	`116`	`}`
`117`	`117`
`118`	`118`	`$this->uriContext->getUri()->willReturn($path);`
`119`		`-`
`120`	`119`	`$res = $this->adapter->createAutoRoute($this->uriContext->reveal(), $this->contentDocument, 'fr');`
`121`	`120`	`$this->assertNotNull($res);`
`122`	`121`	`$this->assertInstanceOf('Symfony\Cmf\Bundle\RoutingAutoBundle\Model\AutoRoute', $res);`