Prefix routing bug (#349)

* Resolves #330

src/Lib/Route/RouteDecorator.php

@@ -56,6 +56,11 @@ class RouteDecorator
      */
     private $controllerFqn;
 
+    /**
+     * @var string|null
+     */
+    private $prefix;
+
     /**
      * @param \Cake\Routing\Route\Route $route Route
      */
@@ -73,6 +78,7 @@ public function __construct(Route $route)
             ->setName($route->getName())
             ->setPlugin($defaults['plugin'])
             ->setController($defaults['controller'])
+            ->setPrefix($defaults['prefix'] ?? null)
             ->setAction($defaults['action'])
             ->setMethods($methods);
     }
@@ -229,6 +235,25 @@ public function setControllerFqn(string $controllerFqn)
         return $this;
     }
 
+    /**
+     * @return string|null
+     */
+    public function getPrefix(): ?string
+    {
+        return $this->prefix;
+    }
+
+    /**
+     * @param string|null $prefix The routing prefix, for example "Admin" when controller is in App\Controller\Admin
+     * @return $this
+     */
+    public function setPrefix(?string $prefix)
+    {
+        $this->prefix = $prefix;
+
+        return $this;
+    }
+
     /**
      * Converts a CakePHP route template to an OpenAPI path
      *

src/Lib/Route/RouteScanner.php

@@ -90,13 +90,12 @@ private function loadRoutes(): void
             }
 
             $routeDecorator = new RouteDecorator($route);
+            $path = 'Controller\\';
+            $path .= $routeDecorator->getPrefix() ? $routeDecorator->getPrefix() . '\\' : '';
+            $path .= $routeDecorator->getController() . 'Controller';
 
-            $controller = $routeDecorator->getController();
-
-            $results = array_filter($classes, function ($fqn) use ($controller, $route) {
-                $prefix = !empty($route->defaults['prefix']) ? $route->defaults['prefix'] . '\\' : '';
-
-                return strstr($fqn, '\\' . $prefix . $controller . 'Controller');
+            $results = array_filter($classes, function ($fqn) use ($path) {
+                return strstr($fqn, $path);
             });
 
             if (count($results) === 1) {

tests/TestCase/Lib/Route/PrefixRouteTest.php

@@ -0,0 +1,81 @@
+<?php
+
+namespace SwaggerBake\Test\TestCase\Lib\Route;
+
+use Cake\Collection\Collection;
+use Cake\Routing\RouteBuilder;
+use Cake\Routing\Router;
+use Cake\TestSuite\TestCase;
+use SwaggerBake\Lib\Configuration;
+use SwaggerBake\Lib\Model\ModelScanner;
+use SwaggerBake\Lib\Route\RouteScanner;
+use SwaggerBake\Lib\Swagger;
+
+class PrefixRouteTest extends TestCase
+{
+    /**
+     * @var string[]
+     */
+    public $fixtures = [
+        'plugin.SwaggerBake.DepartmentEmployees',
+        'plugin.SwaggerBake.Departments',
+        'plugin.SwaggerBake.Employees',
+    ];
+
+    /**
+     * @var Router
+     */
+    private $router;
+
+    /**
+     * @var array
+     */
+    private $config;
+
+    public function setUp(): void
+    {
+        parent::setUp(); // TODO: Change the autogenerated stub
+        $router = new Router();
+        $router::scope('/', function (RouteBuilder $builder) {
+            $builder->setExtensions(['json']);
+            $builder->resources('Departments');
+            $builder->resources('Departments', [
+                'prefix' => 'Admin',
+                'path' => 'admin/departments',
+                'only' => ['index']
+            ]);
+        });
+        $this->router = $router;
+
+        $this->config = [
+            'prefix' => '/',
+            'yml' => '/config/swagger-bare-bones.yml',
+            'json' => '/webroot/swagger.json',
+            'webPath' => '/swagger.json',
+            'hotReload' => false,
+            'exceptionSchema' => 'Exception',
+            'requestAccepts' => ['application/x-www-form-urlencoded'],
+            'responseContentTypes' => ['application/json'],
+            'namespaces' => [
+                'controllers' => ['\SwaggerBakeTest\App\\'],
+                'entities' => ['\SwaggerBakeTest\App\\'],
+                'tables' => ['\SwaggerBakeTest\App\\'],
+            ]
+        ];
+    }
+
+    /**
+     * Tests prefix routing by verifying that paths are added for:
+     * - App\Controller\DepartmentsController
+     * - App\Controller\Admin\DepartmentsController
+     */
+    public function test_prefix_routing_with_same_controller_shortname(): void
+    {
+        $config = new Configuration($this->config, SWAGGER_BAKE_TEST_APP);
+        $cakeRoute = new RouteScanner($this->router, $config);
+        $openApi = (new Swagger(new ModelScanner($cakeRoute, $config)))->getArray();
+        $paths = new Collection(array_keys($openApi['paths']));
+        $this->assertTrue($paths->contains('/admin/departments'));
+        $this->assertTrue($paths->contains('/departments'));
+    }
+}

tests/test_app/src/Controller/Admin/DepartmentsController.php

@@ -0,0 +1,27 @@
+<?php
+declare(strict_types=1);
+
+namespace SwaggerBakeTest\App\Controller\Admin;
+
+use SwaggerBakeTest\App\Controller\AppController;
+
+/**
+ * Departments Controller
+ *
+ * @property \App\Model\Table\DepartmentsTable $Departments
+ *
+ * @method \App\Model\Entity\Department[]|\Cake\Datasource\ResultSetInterface paginate($object = null, array $settings = [])
+ */
+class DepartmentsController extends AppController
+{
+    /**
+     * Just a test for prefix routing when two controllers share the same short name
+     */
+    public function index()
+    {
+        $departments = $this->paginate($this->Departments);
+
+        $this->set(compact('departments'));
+        $this->viewBuilder()->setOption('serialize', 'departments');
+    }
+}