Merge branch 'hotfix/596'

Close #596

CHANGELOG.md

@@ -10,7 +10,11 @@ All notable changes to this project will be documented in this file, in reverse
 
 ### Changed
 
-- Nothing.
+- [#596](https://github.com/zendframework/zend-expressive/pull/596) updates the
+  `ApplicationConfigInjectionDelegator::injectRoutesFromConfig()` method to use
+  the key name associated with a route specification if no `name` member is
+  provided when creating a `Route` instance. This can help enforce name
+  uniqueness when defining routes via configuration.
 
 ### Deprecated
 

docs/book/v3/cookbook/autowiring-routes-and-pipelines.md

@@ -40,6 +40,15 @@ return [
                 'the'   => 'underlying router',
             ],
         ],
+        'another.route.name' => [
+            'path' => '/another/path/to/match',
+            'middleware' => 'Middleware service or pipeline',
+            'allowed_methods' => ['GET', 'POST'],
+            'options' => [
+                'more'    => 'router',
+                'options' => 'here',
+            ],
+        ],
     ],
 ];
 ```
@@ -97,7 +106,9 @@ following keys:
   the HTTP methods allowed for the route. If this is omitted, the assumption is
   any method is allowed.
 - `name` (optional, string): the name of the route, if any; this can be used
-  later to generate a URI based on the route, and must be unique.
+  later to generate a URI based on the route, and must be unique. The name may
+  also be set using a string key in the routes configuration array. If both are
+  set the name assigned in the spec will be used.
 - `options` (optional, array): any options to provide to the generated route.
   These might be default values or constraints, depending on the router
   implementation.

src/Container/ApplicationConfigInjectionDelegator.php

@@ -176,7 +176,7 @@ public static function injectRoutesFromConfig(Application $application, array $c
             return;
         }
 
-        foreach ($config['routes'] as $spec) {
+        foreach ($config['routes'] as $key => $spec) {
             if (! isset($spec['path']) || ! isset($spec['middleware'])) {
                 continue;
             }
@@ -192,7 +192,7 @@ public static function injectRoutesFromConfig(Application $application, array $c
                 }
             }
 
-            $name  = $spec['name'] ?? null;
+            $name  = $spec['name'] ?? (is_string($key) ? $key : null);
             $route = $application->route(
                 $spec['path'],
                 $spec['middleware'],

test/Container/ApplicationConfigInjectionDelegatorTest.php

@@ -391,6 +391,49 @@ public function testInjectRoutesFromConfigWillSkipSpecsThatOmitMiddleware()
         $this->assertEquals([], $app->getRoutes());
     }
 
+    public function testInjectRoutesFromConfigSetRouteNameViaArrayKey()
+    {
+        $config = [
+            'routes' => [
+                'home' => [
+                    'path' => '/',
+                    'middleware' => new TestAsset\InteropMiddleware(),
+                ],
+            ],
+        ];
+        $this->container->has('config')->willReturn(false);
+        $app = $this->createApplication();
+
+        ApplicationConfigInjectionDelegator::injectRoutesFromConfig($app, $config);
+
+        $routes = $app->getRoutes();
+
+        $route = array_shift($routes);
+        $this->assertEquals('home', $route->getName());
+    }
+
+    public function testInjectRoutesFromConfigRouteSpecNameOverrideArrayKeyName()
+    {
+        $config = [
+            'routes' => [
+                'home' => [
+                    'name' => 'homepage',
+                    'path' => '/',
+                    'middleware' => new TestAsset\InteropMiddleware(),
+                ],
+            ],
+        ];
+        $this->container->has('config')->willReturn(false);
+        $app = $this->createApplication();
+
+        ApplicationConfigInjectionDelegator::injectRoutesFromConfig($app, $config);
+
+        $routes = $app->getRoutes();
+
+        $route = array_shift($routes);
+        $this->assertEquals('homepage', $route->getName());
+    }
+
     public function testInjectPipelineFromConfigRaisesExceptionForSpecsOmittingMiddlewareKey()
     {
         $config = [