[11.x] Allow sorting routes by precedence in artisan routes:list. (laravel#53706)

mathieutu · taylorotwell · web-flow · commit 9a9cb2fb490c · 2024-11-29T08:57:13.000-06:00
* Allow sorting route by precedence.

* Fix style.

* rename option

* fix test

---------

Co-authored-by: Taylor Otwell &lt;taylor@laravel.com&gt;
diff --git a/src/Illuminate/Foundation/Console/RouteListCommand.php b/src/Illuminate/Foundation/Console/RouteListCommand.php
@@ -157,6 +157,10 @@ protected function getRouteInformation(Route $route)
      */
     protected function sortRoutes($sort, array $routes)
     {
+        if ($sort === 'definition') {
+            return $routes;
+        }
+
         if (Str::contains($sort, ',')) {
             $sort = explode(',', $sort);
         }
@@ -495,7 +499,7 @@ protected function getOptions()
             ['path', null, InputOption::VALUE_OPTIONAL, 'Only show routes matching the given path pattern'],
             ['except-path', null, InputOption::VALUE_OPTIONAL, 'Do not display the routes matching the given path pattern'],
             ['reverse', 'r', InputOption::VALUE_NONE, 'Reverse the ordering of the routes'],
-            ['sort', null, InputOption::VALUE_OPTIONAL, 'The column (domain, method, uri, name, action, middleware) to sort by', 'uri'],
+            ['sort', null, InputOption::VALUE_OPTIONAL, 'The column (domain, method, uri, name, action, middleware, definition) to sort by', 'uri'],
             ['except-vendor', null, InputOption::VALUE_NONE, 'Do not display routes defined by vendor packages'],
             ['only-vendor', null, InputOption::VALUE_NONE, 'Only display routes defined by vendor packages'],
         ];
diff --git a/tests/Foundation/Console/RouteListCommandTest.php b/tests/Foundation/Console/RouteListCommandTest.php
@@ -97,6 +97,26 @@ public function testSortRouteListDesc()
         $this->assertJsonStringEqualsJsonString($expectedOrder, $output);
     }
 
+    public function testSortRouteListDefault()
+    {
+        $this->app->call('route:list', ['--json' => true]);
+        $output = $this->app->output();
+
+        $expectedOrder = '[{"domain":null,"method":"GET|HEAD","uri":"example","name":null,"action":"Closure","middleware":["exampleMiddleware"]},{"domain":null,"method":"GET|HEAD","uri":"example-group","name":null,"action":"Closure","middleware":["web","auth"]}, {"domain":"sub","method":"GET|HEAD","uri":"sub-example","name":null,"action":"Closure","middleware":["exampleMiddleware"]}]';
+
+        $this->assertJsonStringEqualsJsonString($expectedOrder, $output);
+    }
+
+    public function testSortRouteListPrecedence()
+    {
+        $this->app->call('route:list', ['--json' => true, '--sort' => 'definition']);
+        $output = $this->app->output();
+
+        $expectedOrder = '[{"domain":null,"method":"GET|HEAD","uri":"example","name":null,"action":"Closure","middleware":["exampleMiddleware"]},{"domain":"sub","method":"GET|HEAD","uri":"sub-example","name":null,"action":"Closure","middleware":["exampleMiddleware"]}, {"domain":null,"method":"GET|HEAD","uri":"example-group","name":null,"action":"Closure","middleware":["web","auth"]}]';
+
+        $this->assertJsonStringEqualsJsonString($expectedOrder, $output);
+    }
+
     public function testMiddlewareGroupsAssignmentInCli()
     {
         $this->app->call('route:list', ['-v' => true]);
