feat: add option to spark routes to sort by handler

Author: kenjis

system/Commands/Utilities/Routes.php

@@ -68,13 +68,17 @@ class Routes extends BaseCommand
      *
      * @var array
      */
-    protected $options = [];
+    protected $options = [
+        '-h' => 'Sort by Handler.',
+    ];
 
     /**
      * Displays the help for the spark cli script itself.
      */
     public function run(array $params)
     {
+        $sortByHandler = array_key_exists('h', $params) ? true : false;
+
         $collection = Services::routes()->loadRoutes();
         $methods    = [
             'get',
@@ -157,11 +161,16 @@ public function run(array $params)
             'Method',
             'Route',
             'Name',
-            'Handler',
+            $sortByHandler ? 'Handler ↓' : 'Handler',
             'Before Filters',
             'After Filters',
         ];
 
+        // Sort by Handler.
+        if ($sortByHandler) {
+            usort($tbody, static fn ($handler1, $handler2) => strcmp($handler1[3], $handler2[3]));
+        }
+
         CLI::table($tbody, $thead);
     }
 }

tests/system/Commands/RoutesTest.php

@@ -77,6 +77,32 @@ public function testRoutesCommand()
         $this->assertStringContainsString($expected, $this->getBuffer());
     }
 
+    public function testRoutesCommandSortByHandler()
+    {
+        $this->getCleanRoutes();
+
+        command('routes -h');
+
+        $expected = <<<'EOL'
+            +---------+---------+---------------+----------------------------------------+----------------+---------------+
+            | Method  | Route   | Name          | Handler ↓                              | Before Filters | After Filters |
+            +---------+---------+---------------+----------------------------------------+----------------+---------------+
+            | GET     | closure | »             | (Closure)                              |                | toolbar       |
+            | GET     | /       | »             | \App\Controllers\Home::index           |                | toolbar       |
+            | GET     | testing | testing-index | \App\Controllers\TestController::index |                | toolbar       |
+            | HEAD    | testing | testing-index | \App\Controllers\TestController::index |                | toolbar       |
+            | POST    | testing | testing-index | \App\Controllers\TestController::index |                | toolbar       |
+            | PUT     | testing | testing-index | \App\Controllers\TestController::index |                | toolbar       |
+            | DELETE  | testing | testing-index | \App\Controllers\TestController::index |                | toolbar       |
+            | OPTIONS | testing | testing-index | \App\Controllers\TestController::index |                | toolbar       |
+            | TRACE   | testing | testing-index | \App\Controllers\TestController::index |                | toolbar       |
+            | CONNECT | testing | testing-index | \App\Controllers\TestController::index |                | toolbar       |
+            | CLI     | testing | testing-index | \App\Controllers\TestController::index |                |               |
+            +---------+---------+---------------+----------------------------------------+----------------+---------------+
+            EOL;
+        $this->assertStringContainsString($expected, $this->getBuffer());
+    }
+
     public function testRoutesCommandAutoRouteImproved()
     {
         $routes = $this->getCleanRoutes();