[Routing] allow no-slash root on imported routes

nicolas-grekas · nicolas-grekas · commit 509d01e5895b · 2018-02-23T12:05:28.000+01:00
diff --git a/src/Symfony/Component/Routing/Route.php b/src/Symfony/Component/Routing/Route.php
@@ -109,7 +109,7 @@ public function unserialize($serialized)
      */
     public function getPath()
     {
-        return $this->path;
+        return '' === $this->path ? '/' : $this->path;
     }
 
     /**
@@ -123,14 +123,20 @@ public function getPath()
      */
     public function setPath($pattern)
     {
+        $pattern = trim($pattern);
         // A pattern must start with a slash and must not have multiple slashes at the beginning because the
         // generated path for this route would be confused with a network path, e.g. '//domain.com/path'.
-        $this->path = '/'.ltrim(trim($pattern), '/');
+        $this->path = '' !== $pattern && '/' !== $pattern ? '/'.ltrim($pattern, '/') : $pattern;
         $this->compiled = null;
 
         return $this;
     }
 
+    public function hasTrailingSlash(): bool
+    {
+        return '' !== $this->path && '/' === $this->path[-1];
+    }
+
     /**
      * Returns the pattern for the host.
      *
diff --git a/src/Symfony/Component/Routing/RouteCollection.php b/src/Symfony/Component/Routing/RouteCollection.php
@@ -147,7 +147,7 @@ public function addPrefix($prefix, array $defaults = array(), array $requirement
         }
 
         foreach ($this->routes as $route) {
-            $route->setPath('/'.$prefix.$route->getPath());
+            $route->setPath('/'.$prefix.(!$route->hasTrailingSlash() && '/' === $route->getPath() ? '' : $route->getPath()));
             $route->addDefaults($defaults);
             $route->addRequirements($requirements);
         }
diff --git a/src/Symfony/Component/Routing/Tests/Fixtures/controller/routing.xml b/src/Symfony/Component/Routing/Tests/Fixtures/controller/routing.xml
@@ -6,6 +6,8 @@
 
     <route id="app_homepage" path="/" controller="AppBundle:Homepage:show" />
 
+    <route id="app_homepage_no_slash" path="" controller="AppBundle:Homepage:show" />
+
     <route id="app_blog" path="/blog">
         <default key="_controller">AppBundle:Blog:list</default>
     </route>
diff --git a/src/Symfony/Component/Routing/Tests/Fixtures/controller/routing.yml b/src/Symfony/Component/Routing/Tests/Fixtures/controller/routing.yml
@@ -2,6 +2,10 @@ app_homepage:
     path: /
     controller: AppBundle:Homepage:show
 
+app_homepage_no_slash:
+    path: ''
+    controller: AppBundle:Homepage:show
+
 app_blog:
     path: /blog
     defaults:
diff --git a/src/Symfony/Component/Routing/Tests/Loader/XmlFileLoaderTest.php b/src/Symfony/Component/Routing/Tests/Loader/XmlFileLoaderTest.php
@@ -296,6 +296,10 @@ public function testLoadRouteWithControllerAttribute()
         $route = $routeCollection->get('app_homepage');
 
         $this->assertSame('AppBundle:Homepage:show', $route->getDefault('_controller'));
+
+        $route = $routeCollection->get('app_homepage_no_slash');
+
+        $this->assertSame('/', $route->getPath());
     }
 
     public function testLoadRouteWithoutControllerAttribute()
@@ -371,5 +375,11 @@ public function testImportRouteWithNamePrefix()
         $this->assertEquals('/blog', $routeCollection->get('app_blog')->getPath());
         $this->assertNotNull($routeCollection->get('api_app_blog'));
         $this->assertEquals('/api/blog', $routeCollection->get('api_app_blog')->getPath());
+
+        $route = $routeCollection->get('api_app_homepage');
+        $this->assertSame('/api/', $route->getPath());
+
+        $route = $routeCollection->get('api_app_homepage_no_slash');
+        $this->assertSame('/api', $route->getPath());
     }
 }
diff --git a/src/Symfony/Component/Routing/Tests/Loader/YamlFileLoaderTest.php b/src/Symfony/Component/Routing/Tests/Loader/YamlFileLoaderTest.php
@@ -117,6 +117,10 @@ public function testLoadRouteWithControllerAttribute()
         $route = $routeCollection->get('app_homepage');
 
         $this->assertSame('AppBundle:Homepage:show', $route->getDefault('_controller'));
+
+        $route = $routeCollection->get('app_homepage_no_slash');
+
+        $this->assertSame('/', $route->getPath());
     }
 
     public function testLoadRouteWithoutControllerAttribute()
@@ -192,5 +196,11 @@ public function testImportRouteWithNamePrefix()
         $this->assertEquals('/blog', $routeCollection->get('app_blog')->getPath());
         $this->assertNotNull($routeCollection->get('api_app_blog'));
         $this->assertEquals('/api/blog', $routeCollection->get('api_app_blog')->getPath());
+
+        $route = $routeCollection->get('api_app_homepage');
+        $this->assertSame('/api/', $route->getPath());
+
+        $route = $routeCollection->get('api_app_homepage_no_slash');
+        $this->assertSame('/api', $route->getPath());
     }
 }

Original file line number	Diff line number	Diff line change
`@@ -109,7 +109,7 @@ public function unserialize($serialized)`
`109`	`109`	`*/`
`110`	`110`	`public function getPath()`
`111`	`111`	`{`
`112`		`- return $this->path;`
	`112`	`+ return '' === $this->path ? '/' : $this->path;`
`113`	`113`	`}`
`114`	`114`
`115`	`115`	`/**`
`@@ -123,14 +123,20 @@ public function getPath()`
`123`	`123`	`*/`
`124`	`124`	`public function setPath($pattern)`
`125`	`125`	`{`
	`126`	`+ $pattern = trim($pattern);`
`126`	`127`	`// A pattern must start with a slash and must not have multiple slashes at the beginning because the`
`127`	`128`	`// generated path for this route would be confused with a network path, e.g. '//domain.com/path'.`
`128`		`- $this->path = '/'.ltrim(trim($pattern), '/');`
	`129`	`+ $this->path = '' !== $pattern && '/' !== $pattern ? '/'.ltrim($pattern, '/') : $pattern;`
`129`	`130`	`$this->compiled = null;`
`130`	`131`
`131`	`132`	`return $this;`
`132`	`133`	`}`
`133`	`134`
	`135`	`+ public function hasTrailingSlash(): bool`
	`136`	`+ {`
	`137`	`+ return '' !== $this->path && '/' === $this->path[-1];`
	`138`	`+ }`
	`139`	`+`
`134`	`140`	`/**`
`135`	`141`	`* Returns the pattern for the host.`
`136`	`142`	`*`
Original file line number	Diff line number	Diff line change
`@@ -147,7 +147,7 @@ public function addPrefix($prefix, array $defaults = array(), array $requirement`
`147`	`147`	`}`
`148`	`148`
`149`	`149`	`foreach ($this->routes as $route) {`
`150`		`- $route->setPath('/'.$prefix.$route->getPath());`
	`150`	`+ $route->setPath('/'.$prefix.(!$route->hasTrailingSlash() && '/' === $route->getPath() ? '' : $route->getPath()));`
`151`	`151`	`$route->addDefaults($defaults);`
`152`	`152`	`$route->addRequirements($requirements);`
`153`	`153`	`}`