bug #16477 [Routing] Changing RouteCollectionBuilder::import() behavior to add to the builder (weaverryan)

fabpot · fabpot · commit 57e0468cc33e · 2015-11-23T10:29:40.000+01:00
This PR was squashed before being merged into the 2.8 branch (closes #16477). Discussion ---------- [Routing] Changing RouteCollectionBuilder::import() behavior to add to the builder | Q | A | ------------- | --- | Bug fix? | behavior change | New feature? | behavior change | BC breaks? | no | Deprecations? | no | Tests pass? | yes | Fixed tickets | n/a | License | MIT | Doc PR | n/a Based on conversation starting here: #15990 (comment). ```php // Before: $routes->mount('/admin', $routes->import(__DIR__.'/config/admin.yml'); // After: $routes->import(__DIR__.'/config/admin.yml', '/admin'); ``` This makes `import()` actually add the `RouteCollectionBuilder` into itself. We didn't do this before at Fabien's request, and actually the current implementation (before this PR) is quite "clean". However, I agree with @wouterj that `import()` really sounds/looks like it will actually *import* those routes *into* this `RouteCollectionBuilder`. This change is subjective - we just need to pick which way we like better and run full steam with it. Commits ------- 8feb9ef [Routing] Changing RouteCollectionBuilder::import() behavior to add to the builder
diff --git a/src/Symfony/Component/Routing/RouteCollectionBuilder.php b/src/Symfony/Component/Routing/RouteCollectionBuilder.php
@@ -49,16 +49,17 @@ public function __construct(LoaderInterface $loader = null)
     /**
      * Import an external routing resource and returns the RouteCollectionBuilder.
      *
-     *  $routes->mount('/blog', $routes->import('blog.yml'));
+     *  $routes->import('blog.yml', '/blog');
      *
-     * @param mixed  $resource
-     * @param string $type
+     * @param mixed       $resource
+     * @param string|null $prefix
+     * @param string      $type
      *
      * @return RouteCollectionBuilder
      *
      * @throws FileLoaderLoadException
      */
-    public function import($resource, $type = null)
+    public function import($resource, $prefix = '/', $type = null)
     {
         /** @var RouteCollection $collection */
         $collection = $this->load($resource, $type);
@@ -73,6 +74,9 @@ public function import($resource, $type = null)
             $builder->addResource($resource);
         }
 
+        // mount into this builder
+        $this->mount($prefix, $builder);
+
         return $builder;
     }
 
diff --git a/src/Symfony/Component/Routing/Tests/RouteCollectionBuilderTest.php b/src/Symfony/Component/Routing/Tests/RouteCollectionBuilderTest.php
@@ -45,7 +45,7 @@ public function testImport()
 
         // import the file!
         $routes = new RouteCollectionBuilder($loader);
-        $importedRoutes = $routes->import('admin_routing.yml', 'yaml');
+        $importedRoutes = $routes->import('admin_routing.yml', '/', 'yaml');
 
         // we should get back a RouteCollectionBuilder
         $this->assertInstanceOf('Symfony\Component\Routing\RouteCollectionBuilder', $importedRoutes);
@@ -56,6 +56,9 @@ public function testImport()
         $this->assertSame($originalRoute, $route);
         // should return file_resource.yml, which is in the original collection
         $this->assertCount(1, $addedCollection->getResources());
+
+        // make sure the routes were imported into the top-level builder
+        $this->assertCount(1, $routes->build());
     }
 
     /**
@@ -285,7 +288,7 @@ public function testFlushSetsPrefixedWithMultipleLevels()
             ->method('load')
             ->will($this->returnValue($importedCollection));
         // import this from the /admin route builder
-        $adminRoutes->mount('/imported', $adminRoutes->import('admin.yml'));
+        $adminRoutes->import('admin.yml', '/imported');
 
         $collection = $routes->build();
         $this->assertEquals('/admin/dashboard', $collection->get('admin_dashboard')->getPath(), 'Routes before mounting have the prefix');

Original file line number	Diff line number	Diff line change
`@@ -49,16 +49,17 @@ public function __construct(LoaderInterface $loader = null)`
`49`	`49`	`/**`
`50`	`50`	`* Import an external routing resource and returns the RouteCollectionBuilder.`
`51`	`51`	`*`
`52`		`- * $routes->mount('/blog', $routes->import('blog.yml'));`
	`52`	`+ * $routes->import('blog.yml', '/blog');`
`53`	`53`	`*`
`54`		`- * @param mixed $resource`
`55`		`- * @param string $type`
	`54`	`+ * @param mixed $resource`
	`55`	`+ * @param string\|null $prefix`
	`56`	`+ * @param string $type`
`56`	`57`	`*`
`57`	`58`	`* @return RouteCollectionBuilder`
`58`	`59`	`*`
`59`	`60`	`* @throws FileLoaderLoadException`
`60`	`61`	`*/`
`61`		`- public function import($resource, $type = null)`
	`62`	`+ public function import($resource, $prefix = '/', $type = null)`
`62`	`63`	`{`
`63`	`64`	`/** @var RouteCollection $collection */`
`64`	`65`	`$collection = $this->load($resource, $type);`
`@@ -73,6 +74,9 @@ public function import($resource, $type = null)`
`73`	`74`	`$builder->addResource($resource);`
`74`	`75`	`}`
`75`	`76`
	`77`	`+ // mount into this builder`
	`78`	`+ $this->mount($prefix, $builder);`
	`79`	`+`
`76`	`80`	`return $builder;`
`77`	`81`	`}`
`78`	`82`