feat: auto routes listing

[kenjis]

Description

• add listing of auto routes in spark routes
  • auto routes are not listed and users may expose unexpected methods

Note:
If you have Controllers\Home::index, on macOS you can access it by:

• http://localhost:8080/home/index
• http://localhost:8080/Home/Index
• http://localhost:8080/hOme/iNdex
• ...
• http://localhost:8080/HOME/INDEX

But this command shows only home/index[/...].

Checklist:

• This PR needs Fix Autoloader::initialize() #5592
• Securely signed commits
• Component(s) with PHPDoc blocks, only if necessary or adds value
• Unit testing, with >80% coverage
• User guide updated
• Conforms to style guide

[MGatner]

This is some great work @kenjis! I do wonder if the functional change could be confusing or break someone's CLI output. What about making this a separate command, and appending a warning note at the end of routes like: "Auto-routing is enabled; run _____ to see additional active routes."

I would like to hear others' opinions too, I don't feel strongly either way.

[kenjis]

@MGatner I think one command is better.
Because if you have auto routes, the routes are already there.
It is better you can see all routes at a sight.

+--------+-------------------------------------+-------------------------------------------------+
| Method | Route                               | Handler                                         |
+--------+-------------------------------------+-------------------------------------------------+
| GET    | /                                   | \App\Controllers\Home::index                    |
| GET    | news/create                         | \App\Controllers\News::create                   |
| GET    | news/([^/]+)                        | \App\Controllers\News::view/$1                  |
| GET    | news                                | \App\Controllers\News::index                    |
| GET    | (.*)                                | \App\Controllers\Pages::view/$1                 |
| POST   | news/create                         | \App\Controllers\News::create                   |
| CLI    | migrations/([^/]+)/([^/]+)          | \CodeIgniter\Commands\MigrationsCommand::$1/$2  |
| CLI    | migrations/([^/]+)                  | \CodeIgniter\Commands\MigrationsCommand::$1     |
| CLI    | migrations                          | \CodeIgniter\Commands\MigrationsCommand::index  |
| CLI    | ci(.*)                              | \CodeIgniter\CLI\CommandRunner::index/$1        |
| auto   | /                                   | \App\Controllers\Home::index                    |
| auto   | home                                | \App\Controllers\Home::index                    |
| auto   | home/index[/...]                    | \App\Controllers\Home::index                    |
| auto   | news                                | \App\Controllers\News::index                    |
| auto   | news/index[/...]                    | \App\Controllers\News::index                    |
| auto   | news/view[/...]                     | \App\Controllers\News::view                     |
| auto   | news/create[/...]                   | \App\Controllers\News::create                   |
| auto   | pages                               | \App\Controllers\Pages::index                   |
| auto   | pages/index[/...]                   | \App\Controllers\Pages::index                   |
| auto   | pages/view[/...]                    | \App\Controllers\Pages::view                    |
+--------+-------------------------------------+-------------------------------------------------+

You can use grep for one controller.

$ php spark routes | grep '\\App\\Controllers\\News::'
| GET    | news/create                         | \App\Controllers\News::create                   |
| GET    | news/([^/]+)                        | \App\Controllers\News::view/$1                  |
| GET    | news                                | \App\Controllers\News::index                    |
| POST   | news/create                         | \App\Controllers\News::create                   |
| auto   | news                                | \App\Controllers\News::index                    |
| auto   | news/index[/...]                    | \App\Controllers\News::index                    |
| auto   | news/view[/...]                     | \App\Controllers\News::view                     |
| auto   | news/create[/...]                   | \App\Controllers\News::create                   |

[kenjis]

Added note in #5590 (comment)

[kenjis]

Rector reports an error. But on my local, [OK] Rector is done!.
I rebased and ran composer update, but the same. Why?

1) system/Commands/Utilities/Routes.php:107

    ---------- begin diff ----------
@@ @@
                 $collection->getDefaultController(),
                 $collection->getDefaultMethod()
             );
-            $tbody = array_merge($tbody, $autoRouteCollector->get());
+            $tbody = [...$tbody, ...$autoRouteCollector->get()];
         }

         $thead = [
    ----------- end diff -----------

Applied rules:
 * ArraySpreadInsteadOfArrayMergeRector (https://wiki.php.net/rfc/spread_operator_for_array)

https://github.com/codeigniter4/CodeIgniter4/runs/4932368477?check_suite_focus=true

[kenjis]

Fixed the file.

$ vendor/bin/rector --clear-cache
 648/708 [▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓░░░]  91%
1 file with changes
===================

1) system/Commands/Utilities/Routes.php:107

    ---------- begin diff ----------
@@ @@
                 $collection->getDefaultController(),
                 $collection->getDefaultMethod()
             );
-            $tbody = array_merge($tbody, $autoRouteCollector->get());
+            $tbody = [...$tbody, ...$autoRouteCollector->get()];
         }

         $thead = [
    ----------- end diff -----------

Applied rules:
 * ArraySpreadInsteadOfArrayMergeRector (https://wiki.php.net/rfc/spread_operator_for_array)


                                                                                                    
 [ERROR] Could not process                                                                          
         "/Users/kenji/work/codeigniter/CodeIgniter4/vendor/rector/rector/vendor/symplify/easy-paral
         lel/src/ValueObject/ParallelProcess.php" file, due to:                                     
         "Child process timed out after 120 seconds". On line: 100                                  
                                                                                                    

                                                                                                    
 [ERROR] Could not process some files, due to:                                                      
         "Reached system errors count limit of 20, exiting...".                                     
                                                                                                    

[kenjis]

CI4 still has _remap() method.
https://codeigniter4.github.io/CodeIgniter4/incoming/controllers.html#remapping-method-calls

[kenjis]

<?php

namespace App\Controllers;

class Home extends BaseController
{
    public function index()
    {
        return view('welcome_message');
    }

    public function _remap($method)
    {
        if ($method === 'abc') {
            return $this->index();
        }

        return $this->default();
    }

    public function default()
    {
        return 'default';
    }
}

$ php spark routes

CodeIgniter v4.1.8 Command Line Tool - Server Time: 2022-01-25 23:24:33 UTC-06:00

+--------+----------------------------+------------------------------------------------+
| Method | Route                      | Handler                                        |
+--------+----------------------------+------------------------------------------------+
| GET    | /                          | \App\Controllers\Home::index                   |
| CLI    | migrations/([^/]+)/([^/]+) | \CodeIgniter\Commands\MigrationsCommand::$1/$2 |
| CLI    | migrations/([^/]+)         | \CodeIgniter\Commands\MigrationsCommand::$1    |
| CLI    | migrations                 | \CodeIgniter\Commands\MigrationsCommand::index |
| CLI    | ci(.*)                     | \CodeIgniter\CLI\CommandRunner::index/$1       |
| auto   | /                          | \App\Controllers\Home::_remap                  |
| auto   | home[/...]                 | \App\Controllers\Home::_remap                  |
+--------+----------------------------+------------------------------------------------+