feat: implement route group names + resource autonaming

Author: mychidarko

src/Router.php

@@ -92,6 +92,11 @@ class Router
      */
     protected static $groupRoute = '';
 
+    /**
+     * Current group name prefix for named routes (e.g. "admin.")
+     */
+    protected static $groupName = '';
+
     /**
      * Default controller namespace
      */
@@ -158,6 +163,7 @@ public static function mount(string $path, $handler)
 
         $initialNamespace = static::$namespace;
         $initialGroupRoute = static::$groupRoute;
+        $initialGroupName = static::$groupName;
         $initialLingoOptions = static::$lingoOptions;
         $initialSitemapOptions = static::$sitemapOptions;
         $initialGroupMiddleware = static::$routeGroupMiddleware;
@@ -172,6 +178,12 @@ public static function mount(string $path, $handler)
             static::$routeGroupMiddleware = $groupOptions['middleware'];
         }
 
+        if (!empty($groupOptions['name'])) {
+            // group names cascade: group "admin" + route "users.index"
+            // registers as "admin.users.index" — nested groups compose
+            static::$groupName .= trim($groupOptions['name'], '.') . '.';
+        }
+
         if (isset($groupOptions['lingo.routes'])) {
             static::$lingoOptions['lingo.routes'] = $groupOptions['lingo.routes'];
         }
@@ -184,6 +196,7 @@ public static function mount(string $path, $handler)
 
         static::$namespace = $initialNamespace;
         static::$groupRoute = $initialGroupRoute;
+        static::$groupName = $initialGroupName;
         static::$lingoOptions = $initialLingoOptions;
         static::$sitemapOptions = $initialSitemapOptions;
         static::$routeGroupMiddleware = $initialGroupMiddleware;
@@ -219,6 +232,10 @@ public static function match(string $allowedMethods, string $pattern, $handler)
 
         list($handler, $routeOptions) = static::mapHandler($handler);
 
+        if (!empty($routeOptions['name']) && static::$groupName !== '') {
+            $routeOptions['name'] = static::$groupName . $routeOptions['name'];
+        }
+
         if (is_string($handler)) {
             $namespace = static::$namespace;
 
@@ -443,6 +460,21 @@ public static function inertia(string $pattern, string $view, $data = [])
      * @param string $pattern The base route to use eg: /post
      * @param array|string $controller to handle route eg: PostController
      */
+    /**
+     * Derive the dot-name base for a resource: '/admin/users' -> 'admin.users',
+     * '/' inside a group -> the group's last segment
+     */
+    protected static function resourceName(string $pattern): string
+    {
+        $base = trim($pattern, '/');
+
+        if ($base === '') {
+            $base = trim(basename(static::$groupRoute), '/');
+        }
+
+        return str_replace('/', '.', $base);
+    }
+
     public static function resource(string $pattern, $controller)
     {
         if (is_array($controller)) {
@@ -455,13 +487,15 @@ public static function resource(string $pattern, $controller)
             return static::group($pattern, $controller);
         }
 
-        static::match('GET|HEAD', $pattern, "$controller@index");
-        static::post($pattern, "$controller@store");
-        static::match('GET|HEAD', "$pattern/create", "$controller@create");
-        static::match('DELETE', "$pattern/{id}", "$controller@destroy");
-        static::match('PUT|PATCH', "$pattern/{id}", "$controller@update");
-        static::match('GET|HEAD', "$pattern/{id}/edit", "$controller@edit");
-        static::match('GET|HEAD', "$pattern/{id}", "$controller@show");
+        $name = static::resourceName($pattern);
+
+        static::match('GET|HEAD', $pattern, ['name' => "$name.index", "$controller@index"]);
+        static::post($pattern, ['name' => "$name.store", "$controller@store"]);
+        static::match('GET|HEAD', "$pattern/create", ['name' => "$name.create", "$controller@create"]);
+        static::match('DELETE', "$pattern/{id}", ['name' => "$name.destroy", "$controller@destroy"]);
+        static::match('PUT|PATCH', "$pattern/{id}", ['name' => "$name.update", "$controller@update"]);
+        static::match('GET|HEAD', "$pattern/{id}/edit", ['name' => "$name.edit", "$controller@edit"]);
+        static::match('GET|HEAD', "$pattern/{id}", ['name' => "$name.show", "$controller@show"]);
 
         // still keeping DELETE and PUT|PATCH so earlier versions of leaf apps don't break
         static::match('POST|DELETE', "$pattern/{id}/delete", "$controller@destroy");
@@ -494,11 +528,13 @@ public static function apiResource(string $pattern, $controller)
             return static::group($pattern, $controller);
         }
 
-        static::match('GET|HEAD', $pattern, "$controller@index");
-        static::post($pattern, "$controller@store");
-        static::match('GET|HEAD', "$pattern/{id}", "$controller@show");
-        static::match('DELETE', "$pattern/{id}", "$controller@destroy");
-        static::match('PUT|PATCH', "$pattern/{id}", "$controller@update");
+        $name = static::resourceName($pattern);
+
+        static::match('GET|HEAD', $pattern, ['name' => "$name.index", "$controller@index"]);
+        static::post($pattern, ['name' => "$name.store", "$controller@store"]);
+        static::match('GET|HEAD', "$pattern/{id}", ['name' => "$name.show", "$controller@show"]);
+        static::match('DELETE', "$pattern/{id}", ['name' => "$name.destroy", "$controller@destroy"]);
+        static::match('PUT|PATCH', "$pattern/{id}", ['name' => "$name.update", "$controller@update"]);
 
         // still keeping DELETE and PUT|PATCH so earlier versions of leaf apps don't break
         static::match('POST|DELETE', "$pattern/{id}/delete", "$controller@destroy");
@@ -1110,6 +1146,7 @@ public static function reset(): void
         ];
         static::$sitemapOptions = [];
         static::$groupRoute = '';
+        static::$groupName = '';
         static::$namespace = '';
         static::$serverBasePath = null;
         static::$currentUri = null;

tests/router.test.php

@@ -268,3 +268,54 @@
     expect($fired)->toBeFalse()
         ->and($uri)->toBe('/outside'); // path untouched when base doesn't prefix it
 });
+
+test('group names cascade into route names', function () {
+    // https://github.com/leafsphp/leaf/issues/279
+    \Leaf\Router::reset();
+
+    app()->group('/admin', ['name' => 'admin', function () {
+        app()->get('/dashboard', ['name' => 'dashboard', function () {}]);
+
+        app()->group('/reports', ['name' => 'reports', function () {
+            app()->get('/{id}', ['name' => 'show', function () {}]);
+        }]);
+    }]);
+
+    expect(\Leaf\Router::route('admin.dashboard'))->toBe('/admin/dashboard')
+        ->and(\Leaf\Router::route('admin.reports.show', ['id' => 9]))->toBe('/admin/reports/9');
+});
+
+test('resource routes name themselves', function () {
+    \Leaf\Router::reset();
+
+    app()->resource('/users', 'UsersController');
+
+    expect(\Leaf\Router::route('users.index'))->toBe('/users')
+        ->and(\Leaf\Router::route('users.show', ['id' => 3]))->toBe('/users/3')
+        ->and(\Leaf\Router::route('users.edit', ['id' => 3]))->toBe('/users/3/edit');
+});
+
+test('resource names compose with group names', function () {
+    \Leaf\Router::reset();
+
+    app()->group('/admin', ['name' => 'admin', function () {
+        app()->apiResource('/users', 'UsersController');
+    }]);
+
+    expect(\Leaf\Router::route('admin.users.index'))->toBe('/admin/users')
+        ->and(\Leaf\Router::route('admin.users.update', ['id' => 5]))->toBe('/admin/users/5');
+});
+
+test('unnamed routes in named groups stay unnamed', function () {
+    \Leaf\Router::reset();
+
+    app()->group('/named', ['name' => 'named', function () {
+        app()->get('/plain', function () {});
+    }]);
+
+    $ref = new ReflectionClass(\Leaf\Router::class);
+    $prop = $ref->getProperty('namedRoutes');
+    $prop->setAccessible(true);
+
+    expect($prop->getValue())->toBe([]);
+});