fix: spark routes shows invalid routes with Auto Routing Improved

Shows invalid routes with `x` to let devs know there are methods.
codeigniter4 · Apr 10, 2023 · 1df8a1b · 1df8a1b
1 parent 7e0631c
commit 1df8a1b
Show file tree

Hide file tree

Showing 3 changed files with 73 additions and 3 deletions.
diff --git a/system/Commands/Utilities/Routes/AutoRouterImproved/ControllerMethodReader.php b/system/Commands/Utilities/Routes/AutoRouterImproved/ControllerMethodReader.php
@@ -117,6 +117,12 @@ public function read(string $class, string $defaultController = 'Home', string $
                         $params[$param->getName()] = $required;
                     }
 
+                    // If it is the default controller, the method will not be
+                    // routed.
+                    if ($classShortname === $defaultController) {
+                        $route = 'x ' . $route;
+                    }
+
                     $output[] = [
                         'method'       => $httpVerb,
                         'route'        => $route,

diff --git a/tests/system/Commands/Utilities/Routes/AutoRouterImproved/ControllerMethodReaderTest.php b/tests/system/Commands/Utilities/Routes/AutoRouterImproved/ControllerMethodReaderTest.php
@@ -11,6 +11,7 @@
 
 namespace CodeIgniter\Commands\Utilities\Routes\AutoRouterImproved;
 
+use CodeIgniter\Commands\Utilities\Routes\AutoRouterImproved\Controllers\Home;
 use CodeIgniter\Test\CIUnitTestCase;
 use Tests\Support\Controllers\Newautorouting;
 use Tests\Support\Controllers\Remap;
@@ -22,13 +23,13 @@
  */
 final class ControllerMethodReaderTest extends CIUnitTestCase
 {
-    private function createControllerMethodReader(): ControllerMethodReader
-    {
+    private function createControllerMethodReader(
+        string $namespace = 'Tests\Support\Controllers'
+    ): ControllerMethodReader {
         $methods = [
             'get',
             'post',
         ];
-        $namespace = 'Tests\Support\Controllers';
 
         return new ControllerMethodReader($namespace, $methods);
     }
@@ -63,6 +64,34 @@ public function testRead()
         $this->assertSame($expected, $routes);
     }
 
+    public function testReadDefaultController()
+    {
+        $reader = $this->createControllerMethodReader(
+            'CodeIgniter\Commands\Utilities\Routes\AutoRouterImproved\Controllers'
+        );
+
+        $routes = $reader->read(Home::class);
+
+        $expected = [
+            0 => [
+                'method'       => 'get',
+                'route'        => '/',
+                'route_params' => '',
+                'handler'      => '\CodeIgniter\Commands\Utilities\Routes\AutoRouterImproved\Controllers\Home::getIndex',
+                'params'       => [],
+            ],
+            [
+                'method'       => 'post',
+                'route'        => '/',
+                'route_params' => '',
+                'handler'      => '\CodeIgniter\Commands\Utilities\Routes\AutoRouterImproved\Controllers\Home::postIndex',
+                'params'       => [],
+            ],
+        ];
+
+        $this->assertSame($expected, $routes);
+    }
+
     public function testReadControllerWithRemap()
     {
         $reader = $this->createControllerMethodReader();

diff --git a/tests/system/Commands/Utilities/Routes/AutoRouterImproved/Controllers/Home.php b/tests/system/Commands/Utilities/Routes/AutoRouterImproved/Controllers/Home.php
@@ -0,0 +1,35 @@
+<?php
+
+/**
+ * This file is part of CodeIgniter 4 framework.
+ *
+ * (c) CodeIgniter Foundation <[email protected]>
+ *
+ * For the full copyright and license information, please view
+ * the LICENSE file that was distributed with this source code.
+ */
+
+namespace CodeIgniter\Commands\Utilities\Routes\AutoRouterImproved\Controllers;
+
+use CodeIgniter\Controller;
+
+/**
+ * The default controller for Auto Routing (Improved)
+ */
+class Home extends Controller
+{
+    public function getIndex()
+    {
+    }
+
+    public function postIndex()
+    {
+    }
+
+    /**
+     * This method cannot be accessible.
+     */
+    public function getFoo()
+    {
+    }
+}