Removing the prefix from import, and making the user actually put tha…

…t into the parent builder
symfony · weaverryan · Sep 9, 2015 · Sep 9, 2015 · Sep 12, 2015 · Sep 13, 2015
commit 012cb92ad792635fb35b160e0870a7df76428b12
diff --git a/src/Symfony/Component/Routing/RouteCollectionBuilder.php b/src/Symfony/Component/Routing/RouteCollectionBuilder.php
@@ -52,22 +52,31 @@ public function __construct(LoaderInterface $loader = null)
     }
 
     /**
-     * Import an external routing resource, like a file.
+     * Import an external routing resource and returns the RouteCollectionBuilder
      *
-     * Returns a RouteCollectionBuilder so you can continue to tweak options on the routes.
+     *  $routes->mount('/blog', $routes->import('blog.yml'));
      *
      * @param mixed  $resource
-     * @param string $prefix
      * @param string $type
      *
      * @return RouteCollectionBuilder
      */
-    public function import($resource, $prefix = null, $type = null)
+    public function import($resource, $type = null)
     {
-        /** @var RouteCollection $subCollection */
-        $subCollection = $this->resolve($resource, $type)->load($resource, $type);
+        /** @var RouteCollection $collection */
+        $collection = $this->resolve($resource, $type)->load($resource, $type);
 
-        return $this->addRouteCollection($subCollection, $prefix);
+        // create a builder from the RouteCollection
+    
8000
    $builder = $this->createBuilder();
+        foreach ($collection->all() as $name => $route) {
+            $builder->addRoute($route, $name);
+        }
+
+        foreach ($collection->getResources() as $resource) {
+            $builder->addResource($resource);
+        }
+
+        return $builder;
     }
 
     /**
@@ -111,31 +120,6 @@ public function mount($prefix, RouteCollectionBuilder $builder)
         $this->routes[] = $builder;
     }
 
-    /**
-     * Adds a RouteCollection directly and returns those routes in a RouteCollectionBuilder.
-     *
-     * @param RouteCollection $collection
-     * @param string|null     $prefix
-     *
-     * @return $this
-     */
-    public function addRouteCollection(RouteCollection $collection, $prefix = null)
-    {
-        // create a builder from the RouteCollection
-        $builder = $this->createBuilder();
-        foreach ($collection->all() as $name => $route) {
-            $builder->addRoute($route, $name);
-        }
-
-        foreach ($collection->getResources() as $resource) {
-            $builder->addResource($resource);
-        }
-
-        $this->mount($prefix, $builder);
-
-        return $builder;
-    }
-
     /**
      * Adds a Route object to the builder.
      *

diff --git a/src/Symfony/Component/Routing/Tests/RouteCollectionBuilderTest.php b/src/Symfony/Component/Routing/Tests/RouteCollectionBuilderTest.php
@@ -27,8 +27,9 @@ public function testImport()
             ->with('admin_routing.yml', 'yaml')
             ->will($this->returnValue($resolvedLoader));
 
+        $originalRoute = new Route('/foo/path');
         $expectedCollection = new RouteCollection();
-        $expectedCollection->add('one_test_route', new Route('/foo/path'));
+        $expectedCollection->add('one_test_route', $originalRoute);
 
         $resolvedLoader
             ->expects($this->once())
@@ -41,18 +42,17 @@ public function testImport()
             ->method('getResolver')
             ->will($this->returnValue($resolver));
 
-        // import the file! (with a prefix)
-        $collectionBuilder = new RouteCollectionBuilder($loader);
-        $addedBuilder = $collectionBuilder->import('admin_routing.yml', '/admin', 'yaml');
+        // import the file!
+        $routes = new RouteCollectionBuilder($loader);
+        $importedRoutes = $routes->import('admin_routing.yml', 'yaml');
 
         // we should get back a RouteCollectionBuilder
-        $this->assertInstanceOf('Symfony\Component\Routing\RouteCollectionBuilder', $addedBuilder);
+        $this->assertInstanceOf('Symfony\Component\Routing\RouteCollectionBuilder', $importedRoutes);
 
         // get the collection back so we can look at it
-        $addedCollection = $addedBuilder->build();
+        $addedCollection = $importedRoutes->build();
         $route = $addedCollection->get('one_test_route');
-        $this->assertNotNull($route);
-        $this->assertEquals('/admin/foo/path', $route->getPath(), 'The prefix should be applied');
+        $this->assertSame($originalRoute, $route);
     }
 
     /**
@@ -79,14 +79,6 @@ public function testAdd()
 
     public function testFlushOrdering()
     {
-        $loadedCollection1 = new RouteCollection();
-        $loadedCollection1->add('first_collection_route1', new Route('/collection/first/blog1'));
-        $loadedCollection1->add('first_collection_route2', new Route('/collection/first/blog2'));
-
-        $loadedCollection2 = new RouteCollection();
-        $loadedCollection2->add('second_collection_route1', new Route('/collection/second/product1'));
-        $loadedCollection2->add('second_collection_route2', new Route('/collection/second/product2'));
-
         $importedCollection = new RouteCollection();
         $importedCollection->add('imported_route1', new Route('/imported/foo1'));
         $importedCollection->add('imported_route2', new Route('/imported/foo2'));
@@ -101,39 +93,31 @@ public function testFlushOrdering()
             ->method('load')
             ->will($this->returnValue($importedCollection));
 
-        $collectionBuilder = new RouteCollectionBuilder($loader);
+        $routes = new RouteCollectionBuilder($loader);
 
         // 1) Add a route
-        $collectionBuilder->add('/checkout', 'AppBundle:Order:checkout', 'checkout_route');
-        // 2) Add a collection directly
-        $collectionBuilder->addRouteCollection($loadedCollection1);
-        // 3) Import from a file
-        $collectionBuilder->import('admin_routing.yml');
+        $routes->add('/checkout', 'AppBundle:Order:checkout', 'checkout_route');
+        // 2) Import from a file
+        $routes->mount('/', $routes->import('admin_routing.yml'));
+        // 3) Add another route
+        $routes->add('/', 'AppBundle:Default:homepage', 'homepage');
         // 4) Add another route
-        $collectionBuilder->add('/', 'AppBundle:Default:homepage', 'homepage');
-        // 5) Add another collection
-        $collectionBuilder->addRouteCollection($loadedCollection2);
-        // 6) Add another route
-        $collectionBuilder->add('/admin', 'AppBundle:Admin:dashboard', 'admin_dashboard');
+        $routes->add('/admin', 
A60B
9;AppBundle:Admin:dashboard', 'admin_dashboard');
 
         // set a default value
-        $collectionBuilder->setDefault('_locale', 'fr');
+        $routes->setDefault('_locale', 'fr');
         // set an extra resource
-        $collectionBuilder->addResource(new FileResource('foo_routing.xml'));
+        $routes->addResource(new FileResource('foo_routing.xml'));
 
-        $actualCollection = $collectionBuilder->build();
+        $actualCollection = $routes->build();
 
-        $this->assertCount(9, $actualCollection);
+        $this->assertCount(5, $actualCollection);
         $actualRouteNames = array_keys($actualCollection->all());
         $this->assertEquals(array(
             'checkout_route',
-            'first_collection_route1',
-            'first_collection_route2',
             'imported_route1',
             'imported_route2',
             'homepage',
-            'second_collection_route1',
-            'second_collection_route2',
             'admin_dashboard',
         ), $actualRouteNames);
 
@@ -304,7 +288,7 @@ public function testFlushSetsPrefixedWithMultipleLevels()
             ->method('load')
             ->will($this->returnValue($importedCollection));
         // import this from the /admin route builder
-        $adminRoutes->import('admin.yml', '/imported');
+        $adminRoutes->mount('/imported', $adminRoutes->import('admin.yml'));
 
         $collection = $routes->build();
         $this->assertEquals('/admin/dashboard', $collection->get('admin_dashboard')->getPath(), 'Routes before mounting have the prefix');