refactor configuration to prepare for orm. fix #105

dbu · dbu · commit 7896ad8213fa · 2013-06-20T11:13:15.000+02:00
diff --git a/Admin/RouteAdmin.php b/Admin/RouteAdmin.php
@@ -9,6 +9,7 @@
 use Sonata\DoctrinePHPCRAdminBundle\Admin\Admin;
 use Symfony\Component\HttpFoundation\Request;
 use Symfony\Component\HttpKernel\Controller\ControllerResolverInterface;
+use PHPCR\Util\PathHelper;
 
 class RouteAdmin extends Admin
 {
@@ -74,7 +75,8 @@ protected function configureDatagridFilters(DatagridMapper $datagridMapper)
 
     public function setRouteRoot($routeRoot)
     {
-        $this->routeRoot = $routeRoot;
+        // TODO: fix widget to show root node when root is selectable
+        $this->routeRoot = PathHelper::getParentPath($routeRoot);
     }
 
     public function setContentRoot($contentRoot)
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -6,6 +6,12 @@ Changelog
   RoutingBundle\Document\Route and RedirectRoute in favor of
   RoutingBundle\Doctrine\Phpcr\Route resp. RedirectRoute and also moved the
   PHPCR-ODM specific listeners and repository implementations to Doctrine\Phpcr
+  Configuration was cleaned up as well. PHPCR specific configurations moved
+  into dynamic.phpcr_provider: use_sonata_admin, 'manager_registry,
+  manager_name, route_basepath, content_basepath.
+  In preparation of other route provider support, you need to at least set
+  `phpcr_provider: ~` to have the PHPCR provider loaded.
+  Dropped redundant routing_repositoryroot.
 
 1.1.0-beta1
 -----------
diff --git a/DependencyInjection/CmfRoutingExtension.php b/DependencyInjection/CmfRoutingExtension.php
@@ -49,10 +49,6 @@ public function load(array $configs, ContainerBuilder $container)
             $resources = $container->getParameter('twig.form.resources');
             $container->setParameter('twig.form.resources', array_merge($resources, array('CmfRoutingBundle:Form:terms_form_type.html.twig')));
         }
-
-        if ($config['use_sonata_admin']) {
-            $this->loadSonataAdmin($config, $loader, $container);
-        }
     }
 
     public function setupFormTypes(array $config, ContainerBuilder $container, LoaderInterface $loader)
@@ -93,22 +89,18 @@ private function setupDynamicRouter(array $config, ContainerBuilder $container,
         $container->setParameter($this->getAlias() . '.defined_templates_class', $controllerForTemplates);
         $container->setParameter($this->getAlias() . '.uri_filter_regexp', $config['uri_filter_regexp']);
 
-        $loader->load('cmf_routing.xml');
-        $container->setParameter($this->getAlias() . '.routing_repositoryroot', $config['routing_repositoryroot']);
-        if (isset($config['locales']) && $config['locales']) {
-            $container->setParameter($this->getAlias() . '.locales', $config['locales']);
-        } else {
-            $container->removeDefinition('cmf_routing.phpcrodm_route_locale_listener');
-        }
+        $loader->load('dynamic_routing.xml');
 
-        $container->setAlias('cmf_routing.route_provider', $config['route_provider_service_id']);
-        $container->setAlias('cmf_routing.content_repository', $config['content_repository_service_id']);
+        if (isset($config['phpcr_provider'])) {
+            $this->loadPhpcrProvider($config['phpcr_provider'], $loader, $container);
+        }
 
-        $routeProvider = $container->getDefinition($this->getAlias() . '.default_route_provider');
-        $routeProvider->replaceArgument(0, new Reference($config['manager_registry']));
-        $contentRepository = $container->getDefinition($this->getAlias() . '.default_content_repository');
-        $contentRepository->replaceArgument(0, new Reference($config['manager_registry']));
-        $container->setParameter($this->getAlias() . '.manager_name', $config['manager_name']);
+        if (isset($config['route_provider_service_id'])) {
+            $container->setAlias('cmf_routing.route_provider', $config['route_provider_service_id']);
+        }
+        if (isset($config['content_repository_service_id'])) {
+            $container->setAlias('cmf_routing.content_repository', $config['content_repository_service_id']);
+        }
 
         $dynamic = $container->getDefinition($this->getAlias().'.dynamic_router');
 
@@ -134,16 +126,41 @@ private function setupDynamicRouter(array $config, ContainerBuilder $container,
         }
     }
 
-    public function loadSonataAdmin($config, XmlFileLoader $loader, ContainerBuilder $container)
+    public function loadPhpcrProvider($config, XmlFileLoader $loader, ContainerBuilder $container)
+    {
+        $loader->load('provider_phpcr.xml');
+
+        $container->setParameter($this->getAlias() . '.phpcr_provider.route_basepath', $config['route_basepath']);
+        $container->setParameter($this->getAlias() . '.phpcr_provider.content_basepath', $config['content_basepath']);
+
+        $routeProvider = $container->getDefinition($this->getAlias() . '.phpcr_route_provider');
+        $routeProvider->replaceArgument(0, new Reference($config['manager_registry']));
+        $contentRepository = $container->getDefinition($this->getAlias() . '.phpcr_content_repository');
+        $contentRepository->replaceArgument(0, new Reference($config['manager_registry']));
+        $container->setParameter($this->getAlias() . '.manager_name', $config['manager_name']);
+
+        $container->setAlias($this->getAlias() . '.route_provider', $this->getAlias() . '.phpcr_route_provider');
+        $container->setAlias($this->getAlias() . '.content_repository', $this->getAlias() . '.phpcr_content_repository');
+
+        if (isset($config['locales']) && $config['locales']) {
+            $container->setParameter($this->getAlias() . '.locales', $config['locales']);
+        } else {
+            $container->removeDefinition('cmf_routing.phpcrodm_route_locale_listener');
+        }
+
+        if ($config['use_sonata_admin']) {
+            $this->loadSonataPhpcrAdmin($config, $loader, $container);
+        }
+    }
+
+    public function loadSonataPhpcrAdmin($config, XmlFileLoader $loader, ContainerBuilder $container)
     {
         $bundles = $container->getParameter('kernel.bundles');
         if ('auto' === $config['use_sonata_admin'] && !isset($bundles['SonataDoctrinePHPCRAdminBundle'])) {
             return;
         }
 
-        $loader->load('routing-admin.xml');
-        $container->setParameter($this->getAlias() . '.content_basepath', $config['content_basepath']);
-        $container->setParameter($this->getAlias() . '.route_basepath', $config['route_basepath']);
+        $loader->load('admin_phpcr.xml');
     }
 
     /**
diff --git a/DependencyInjection/Configuration.php b/DependencyInjection/Configuration.php
@@ -58,29 +58,31 @@ public function getConfigTreeBuilder()
                             ->useAttributeAsKey('alias')
                             ->prototype('scalar')->end()
                         ->end()
-                        ->scalarNode('manager_registry')->defaultValue('doctrine_phpcr')->end()
-                        ->scalarNode('manager_name')->defaultValue('default')->end()
+                        ->arrayNode('phpcr_provider')
+                            ->children()
+                                ->scalarNode('manager_registry')->defaultValue('doctrine_phpcr')->end()
+                                ->scalarNode('manager_name')->defaultValue('default')->end()
+                                ->scalarNode('route_basepath')->defaultValue('/cms/routes')->end()
+                                ->scalarNode('content_basepath')->defaultValue('/cms/content')->end()
+                                ->enumNode('use_sonata_admin')
+                                    ->values(array(true, false, 'auto'))
+                                    ->defaultValue('auto')
+                                ->end()
+                            ->end()
+                        ->end()
                         ->scalarNode('uri_filter_regexp')->defaultValue('')->end()
-                        ->scalarNode('route_provider_service_id')->defaultValue('cmf_routing.default_route_provider')->end()
+                        ->scalarNode('route_provider_service_id')->end()
                         ->arrayNode('route_filters_by_id')
                             ->canBeUnset()
                             ->useAttributeAsKey('id')
                             ->prototype('scalar')->end()
                         ->end()
-                        ->scalarNode('content_repository_service_id')->defaultValue('cmf_routing.default_content_repository')->end()
-                        ->scalarNode('routing_repositoryroot')->defaultValue('/cms/routes')->end()
+                        ->scalarNode('content_repository_service_id')->end()
                         ->arrayNode('locales')
                             ->prototype('scalar')->end()
                         ->end()
                     ->end()
                 ->end()
-                ->enumNode('use_sonata_admin')
-                    ->values(array(true, false, 'auto'))
-                    ->defaultValue('auto')
-                ->end()
-                ->scalarNode('content_basepath')->defaultValue('/cms/content')->end()
-                // TODO: fix widget to show root node when root is selectable, then use routing_repositoryroot for both
-                ->scalarNode('route_basepath')->defaultValue('/cms')->end()
             ->end()
         ;
 
diff --git a/Resources/config/admin_phpcr.xml b/Resources/config/admin_phpcr.xml
@@ -24,11 +24,11 @@
             </call>
 
             <call method="setContentRoot">
-                <argument>%cmf_routing.content_basepath%</argument>
+                <argument>%cmf_routing.phpcr_provider.content_basepath%</argument>
             </call>
 
             <call method="setRouteRoot">
-                <argument>%cmf_routing.route_basepath%</argument>
+                <argument>%cmf_routing.phpcr_provider.route_basepath%</argument>
             </call>
             <call method="setControllerResolver">
                 <argument type="service" id="controller_resolver" />
@@ -46,7 +46,7 @@
             </call>
 
             <call method="setRouteRoot">
-                <argument>%cmf_routing.route_basepath%</argument>
+                <argument>%cmf_routing.phpcr_provider.route_basepath%</argument>
             </call>
         </service>
 
diff --git a/Resources/config/dynamic_routing.xml b/Resources/config/dynamic_routing.xml
@@ -5,16 +5,12 @@
 
     <parameters>
         <parameter key="cmf_routing.dynamic_router_class">Symfony\Cmf\Bundle\RoutingBundle\Routing\DynamicRouter</parameter>
-        <parameter key="cmf_routing.route_entity_class">null</parameter>
+        <parameter key="cmf_routing.route_model_class">null</parameter>
         <parameter key="cmf_routing.uri_filter_regexp">null</parameter>
         <parameter key="cmf_routing.nested_matcher_class">Symfony\Cmf\Component\Routing\NestedMatcher\NestedMatcher</parameter>
         <parameter key="cmf_routing.final_matcher_class">Symfony\Cmf\Component\Routing\NestedMatcher\UrlMatcher</parameter>
         <parameter key="cmf_routing.url_matcher_class">Symfony\Bundle\FrameworkBundle\Routing\RedirectableUrlMatcher</parameter>
         <parameter key="cmf_routing.generator_class">Symfony\Cmf\Bundle\RoutingBundle\Routing\ContentAwareGenerator</parameter>
-        <parameter key="cmf_routing.route_provider_class">Symfony\Cmf\Bundle\RoutingBundle\Doctrine\Phpcr\RouteProvider</parameter>
-        <parameter key="cmf_routing.content_repository_class">Symfony\Cmf\Bundle\RoutingBundle\Doctrine\Phpcr\ContentRepository</parameter>
-        <parameter key="cmf_routing.phpcrodm_route_idprefix_listener_class">Symfony\Cmf\Bundle\RoutingBundle\Doctrine\Phpcr\IdPrefixListener</parameter>
-        <parameter key="cmf_routing.phpcrodm_route_locale_listener_class">Symfony\Cmf\Bundle\RoutingBundle\Doctrine\Phpcr\LocaleListener</parameter>
         <parameter key="cmf_routing.enhancer_route_content_class">Symfony\Cmf\Component\Routing\Enhancer\RouteContentEnhancer</parameter>
         <parameter key="cmf_routing.enhancer_explicit_template_class">Symfony\Cmf\Component\Routing\Enhancer\FieldPresenceEnhancer</parameter>
         <parameter key="cmf_routing.enhancer_controllers_by_type_class">Symfony\Cmf\Component\Routing\Enhancer\FieldMapEnhancer</parameter>
@@ -68,56 +64,24 @@
             <call method="setFinalMatcher"><argument type="service" id="cmf_routing.final_matcher"/></call>
         </service>
 
+        <service id="cmf_routing.matcher.dummy_collection" class="Symfony\Component\Routing\RouteCollection" public="false"/>
+        <service id="cmf_routing.matcher.dummy_context" class="Symfony\Component\Routing\RequestContext" public="false"/>
+
         <service id="cmf_routing.final_matcher" class="%cmf_routing.final_matcher_class%">
             <argument type="service" id="cmf_routing.matcher.dummy_collection"/>
             <argument type="service" id="cmf_routing.matcher.dummy_context"/>
         </service>
 
-        <service id="cmf_routing.matcher.dummy_collection" class="Symfony\Component\Routing\RouteCollection" public="false"/>
-        <service id="cmf_routing.matcher.dummy_context" class="Symfony\Component\Routing\RequestContext" public="false"/>
-
         <service id="cmf_routing.generator" class="%cmf_routing.generator_class%">
             <argument type="service" id="cmf_routing.route_provider" />
             <argument type="service" id="logger" on-invalid="ignore" />
             <call method="setContainer"><argument type="service" id="service_container"/></call>
             <call method="setContentRepository"><argument type="service" id="cmf_routing.content_repository"/></call>
         </service>
 
-        <service id="cmf_routing.default_route_provider" class="%cmf_routing.route_provider_class%">
-            <argument/>
-            <argument>%cmf_routing.route_entity_class%</argument>
-            <call method="setManagerName"><argument>%cmf_routing.manager_name%</argument></call>
-            <call method="setPrefix"><argument>%cmf_routing.routing_repositoryroot%</argument></call>
-        </service>
-
-        <service id="cmf_routing.default_content_repository" class="%cmf_routing.content_repository_class%">
-            <argument/>
-            <call method="setManagerName"><argument>%cmf_routing.manager_name%</argument></call>
-        </service>
-
-        <service id="cmf_routing.phpcrodm_route_idprefix_listener" class="%cmf_routing.phpcrodm_route_idprefix_listener_class%">
-            <argument>%cmf_routing.routing_repositoryroot%</argument>
-            <tag name="doctrine_phpcr.event_listener" event="postLoad" />
-            <tag name="doctrine_phpcr.event_listener" event="postPersist" />
-        </service>
-
-        <service id="cmf_routing.phpcrodm_route_locale_listener" class="%cmf_routing.phpcrodm_route_locale_listener_class%">
-            <argument>%cmf_routing.routing_repositoryroot%</argument>
-            <argument>%cmf_routing.locales%</argument>
-            <tag name="doctrine_phpcr.event_listener" event="postLoad" />
-            <tag name="doctrine_phpcr.event_listener" event="postPersist" />
-            <tag name="doctrine_phpcr.event_listener" event="postMove" />
-        </service>
-
         <service id="cmf_routing.redirect_controller" class="%cmf_routing.redirect_controller_class%">
             <argument type="service" id="router" />
         </service>
 
-        <service id="cmf_routing.initializer" class="Doctrine\Bundle\PHPCRBundle\Initializer\GenericInitializer">
-            <argument type="collection">
-                <argument>%cmf_routing.routing_repositoryroot%</argument>
-            </argument>
-            <tag name="doctrine_phpcr.initializer"/>
-        </service>
     </services>
 </container>
diff --git a/Resources/config/provider_phpcr.xml b/Resources/config/provider_phpcr.xml
@@ -0,0 +1,49 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<container xmlns="http://symfony.com/schema/dic/services"
+    xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
+    xsi:schemaLocation="http://symfony.com/schema/dic/services http://symfony.com/schema/dic/services/services-1.0.xsd">
+
+    <parameters>
+        <parameter key="cmf_routing.route_provider_class">Symfony\Cmf\Bundle\RoutingBundle\Doctrine\Phpcr\RouteProvider</parameter>
+        <parameter key="cmf_routing.content_repository_class">Symfony\Cmf\Bundle\RoutingBundle\Doctrine\Phpcr\ContentRepository</parameter>
+        <parameter key="cmf_routing.phpcrodm_route_idprefix_listener_class">Symfony\Cmf\Bundle\RoutingBundle\Doctrine\Phpcr\IdPrefixListener</parameter>
+        <parameter key="cmf_routing.phpcrodm_route_locale_listener_class">Symfony\Cmf\Bundle\RoutingBundle\Doctrine\Phpcr\LocaleListener</parameter>
+    </parameters>
+
+    <services>
+
+        <service id="cmf_routing.phpcr_route_provider" class="%cmf_routing.route_provider_class%">
+            <argument/>
+            <argument>%cmf_routing.route_model_class%</argument>
+            <call method="setManagerName"><argument>%cmf_routing.manager_name%</argument></call>
+            <call method="setPrefix"><argument>%cmf_routing.phpcr_provider.route_basepath%</argument></call>
+        </service>
+
+        <service id="cmf_routing.phpcr_content_repository" class="%cmf_routing.content_repository_class%">
+            <argument/>
+            <call method="setManagerName"><argument>%cmf_routing.manager_name%</argument></call>
+        </service>
+
+        <service id="cmf_routing.phpcrodm_route_idprefix_listener" class="%cmf_routing.phpcrodm_route_idprefix_listener_class%">
+            <argument>%cmf_routing.phpcr_provider.route_basepath%</argument>
+            <tag name="doctrine_phpcr.event_listener" event="postLoad" />
+            <tag name="doctrine_phpcr.event_listener" event="postPersist" />
+        </service>
+
+        <service id="cmf_routing.phpcrodm_route_locale_listener" class="%cmf_routing.phpcrodm_route_locale_listener_class%">
+            <argument>%cmf_routing.phpcr_provider.route_basepath%</argument>
+            <argument>%cmf_routing.locales%</argument>
+            <tag name="doctrine_phpcr.event_listener" event="postLoad" />
+            <tag name="doctrine_phpcr.event_listener" event="postPersist" />
+            <tag name="doctrine_phpcr.event_listener" event="postMove" />
+        </service>
+
+        <service id="cmf_routing.initializer" class="Doctrine\Bundle\PHPCRBundle\Initializer\GenericInitializer">
+            <argument type="collection">
+                <argument>%cmf_routing.phpcr_provider.route_basepath%</argument>
+            </argument>
+            <tag name="doctrine_phpcr.initializer"/>
+        </service>
+
+    </services>
+</container>
diff --git a/Tests/DependencyInjection/CmfRoutingExtensionTest.php b/Tests/DependencyInjection/CmfRoutingExtensionTest.php
@@ -27,19 +27,22 @@ public function testLoadDefault()
         $builder = $this->getBuilder(
             array(
                 array(
-                    'dynamic' => array(),
-                    'use_sonata_admin' => false,
+                    'dynamic' => array(
+                        'phpcr_provider' => array(
+                            'use_sonata_admin' => false,
+                        ),
+                    ),
                 )
             )
         );
 
         $this->assertTrue($builder->hasAlias('cmf_routing.route_provider'));
         $alias = $builder->getAlias('cmf_routing.route_provider');
-        $this->assertEquals('cmf_routing.default_route_provider', $alias->__toString());
+        $this->assertEquals('cmf_routing.phpcr_route_provider', $alias->__toString());
 
         $this->assertTrue($builder->hasAlias('cmf_routing.content_repository'));
         $alias = $builder->getAlias('cmf_routing.content_repository');
-        $this->assertEquals('cmf_routing.default_content_repository', $alias->__toString());
+        $this->assertEquals('cmf_routing.phpcr_content_repository', $alias->__toString());
 
         $this->assertTrue($builder->getParameter('cmf_routing.replace_symfony_router'));
 
@@ -75,8 +78,10 @@ public function testLoadConfigured()
                 'dynamic' => array(
                     'route_provider_service_id' => 'test_route_provider_service',
                     'content_repository_service_id' => 'test_content_repository_service',
+                    'phpcr_provider' => array(
+                        'use_sonata_admin' => false,
+                    ),
                 ),
-                'use_sonata_admin' => false,
                 'chain' => array(
                     'routers_by_id' => $providedRouters = array(
                         'router.custom' => 200,
diff --git a/Tests/Functional/config/cmf-routing.yml b/Tests/Functional/config/cmf-routing.yml
@@ -11,4 +11,5 @@ cmf_routing:
             Symfony\Cmf\Bundle\RoutingBundle\Doctrine\Phpcr\RedirectRoute:  cmf_routing.redirect_controller:redirectAction
         templates_by_class:
             Symfony\Cmf\Bundle\RoutingBundle\Tests\Functional\Testdoc\Content: TestBundle:Content:index.html.twig
-        routing_repositoryroot: /test/routing
+        phpcr_provider:
+            route_basepath: /test/routing

Original file line number	Diff line number	Diff line change
`@@ -9,6 +9,7 @@`
`9`	`9`	`use Sonata\DoctrinePHPCRAdminBundle\Admin\Admin;`
`10`	`10`	`use Symfony\Component\HttpFoundation\Request;`
`11`	`11`	`use Symfony\Component\HttpKernel\Controller\ControllerResolverInterface;`
	`12`	`+use PHPCR\Util\PathHelper;`
`12`	`13`
`13`	`14`	`class RouteAdmin extends Admin`
`14`	`15`	`{`
`@@ -74,7 +75,8 @@ protected function configureDatagridFilters(DatagridMapper $datagridMapper)`
`74`	`75`
`75`	`76`	`public function setRouteRoot($routeRoot)`
`76`	`77`	`{`
`77`		`- $this->routeRoot = $routeRoot;`
	`78`	`+ // TODO: fix widget to show root node when root is selectable`
	`79`	`+ $this->routeRoot = PathHelper::getParentPath($routeRoot);`
`78`	`80`	`}`
`79`	`81`
`80`	`82`	`public function setContentRoot($contentRoot)`