[9.x] Reinvents route:list command (#40269)

nunomaduro · taylorotwell · web-flow · commit 4c513ef17491 · 2022-01-06T10:24:10.000-06:00
* Improves CLI output of `route:list` command

* Uses same vertical padding

* Refactors mutation of routes

* Fixes right padding on non-verbose mode

* Fixes extra spacing

* Displays name on non-verbose mode

* minor formatting

Co-authored-by: Taylor Otwell &lt;taylor@laravel.com&gt;
diff --git a/src/Illuminate/Contracts/Routing/UrlGenerator.php b/src/Illuminate/Contracts/Routing/UrlGenerator.php
@@ -69,6 +69,13 @@ public function route($name, $parameters = [], $absolute = true);
      */
     public function action($action, $parameters = [], $absolute = true);
 
+    /**
+     * Get the root controller namespace.
+     *
+     * @return string
+     */
+    public function getRootControllerNamespace();
+
     /**
      * Set the root controller namespace.
      *
diff --git a/src/Illuminate/Foundation/Console/RouteListCommand.php b/src/Illuminate/Foundation/Console/RouteListCommand.php
@@ -4,11 +4,15 @@
 
 use Closure;
 use Illuminate\Console\Command;
+use Illuminate\Contracts\Routing\UrlGenerator;
 use Illuminate\Routing\Route;
 use Illuminate\Routing\Router;
+use Illuminate\Routing\ViewController;
 use Illuminate\Support\Arr;
 use Illuminate\Support\Str;
+use ReflectionClass;
 use Symfony\Component\Console\Input\InputOption;
+use Symfony\Component\Console\Terminal;
 
 class RouteListCommand extends Command
 {
@@ -50,11 +54,27 @@ class RouteListCommand extends Command
     protected $headers = ['Domain', 'Method', 'URI', 'Name', 'Action', 'Middleware'];
 
     /**
-     * The columns to display when using the "compact" flag.
+     * The terminal width resolver callback.
      *
-     * @var string[]
+     * @var \Closure|null
      */
-    protected $compactColumns = ['method', 'uri', 'action'];
+    protected static $terminalWidthResolver;
+
+    /**
+     * The verb colors for the command.
+     *
+     * @var array
+     */
+    protected $verbColors = [
+        'ANY' => 'red',
+        'GET' => 'blue',
+        'HEAD' => '#6C7280',
+        'OPTIONS' => '#6C7280',
+        'POST' => 'yellow',
+        'PUT' => 'yellow',
+        'PATCH' => 'yellow',
+        'DELETE' => 'red',
+    ];
 
     /**
      * Create a new route command instance.
@@ -164,13 +184,11 @@ protected function pluckColumns(array $routes)
      */
     protected function displayRoutes(array $routes)
     {
-        if ($this->option('json')) {
-            $this->line($this->asJson($routes));
-
-            return;
-        }
+        $routes = collect($routes);
 
-        $this->table($this->getHeaders(), $routes);
+        $this->output->writeln(
+            $this->option('json') ? $this->asJson($routes) : $this->forCli($routes)
+        );
     }
 
     /**
@@ -195,8 +213,8 @@ protected function getMiddleware($route)
     protected function filterRoute(array $route)
     {
         if (($this->option('name') && ! Str::contains($route['name'], $this->option('name'))) ||
-             $this->option('path') && ! Str::contains($route['uri'], $this->option('path')) ||
-             $this->option('method') && ! Str::contains($route['method'], strtoupper($this->option('method')))) {
+            $this->option('path') && ! Str::contains($route['uri'], $this->option('path')) ||
+            $this->option('method') && ! Str::contains($route['method'], strtoupper($this->option('method')))) {
             return;
         }
 
@@ -228,17 +246,7 @@ protected function getHeaders()
      */
     protected function getColumns()
     {
-        $availableColumns = array_map('strtolower', $this->headers);
-
-        if ($this->option('compact')) {
-            return array_intersect($availableColumns, $this->compactColumns);
-        }
-
-        if ($columns = $this->option('columns')) {
-            return array_intersect($availableColumns, $this->parseColumns($columns));
-        }
-
-        return $availableColumns;
+        return array_map('strtolower', $this->headers);
     }
 
     /**
@@ -265,12 +273,12 @@ protected function parseColumns(array $columns)
     /**
      * Convert the given routes to JSON.
      *
-     * @param  array  $routes
+     * @param  \Illuminate\Support\Collection  $routes
      * @return string
      */
-    protected function asJson(array $routes)
+    protected function asJson($routes)
     {
-        return collect($routes)
+        return $routes
             ->map(function ($route) {
                 $route['middleware'] = empty($route['middleware']) ? [] : explode("\n", $route['middleware']);
 
@@ -280,6 +288,125 @@ protected function asJson(array $routes)
             ->toJson();
     }
 
+    /**
+     * Convert the given routes to regular CLI output.
+     *
+     * @param  \Illuminate\Support\Collection  $routes
+     * @return array
+     */
+    protected function forCli($routes)
+    {
+        $routes = $routes->map(
+            fn ($route) => array_merge($route, [
+                'action' => $this->formatActionForCli($route),
+                'method' => $route['method'] == 'GET|HEAD|POST|PUT|PATCH|DELETE|OPTIONS' ? 'ANY' : $route['method'],
+                'uri' => $route['domain'] ? ($route['domain'].'/'.$route['uri']) : $route['uri'],
+            ]),
+        );
+
+        $maxMethod = mb_strlen($routes->max('method'));
+
+        $terminalWidth = $this->getTerminalWidth();
+
+        return $routes->map(function ($route) use ($maxMethod, $terminalWidth) {
+            [
+                'action' => $action,
+                'domain' => $domain,
+                'method' => $method,
+                'middleware' => $middleware,
+                'uri' => $uri,
+            ] = $route;
+
+            $middleware = Str::of($middleware)->explode("\n")->filter()->whenNotEmpty(
+                fn ($collection) => $collection->map(
+                    fn ($middleware) => sprintf('         %s⇂ %s', str_repeat(' ', $maxMethod), $middleware)
+                )
+            )->implode("\n");
+
+            $spaces = str_repeat(' ', max($maxMethod + 6 - mb_strlen($method), 0));
+
+            $dots = str_repeat('.', max(
+                $terminalWidth - mb_strlen($method.$spaces.$uri.$action) - 6 - ($action ? 1 : 0), 0
+            ));
+
+            $dots = empty($dots) ? $dots : " $dots";
+
+            if ($action && ! $this->output->isVerbose() && mb_strlen($method.$spaces.$uri.$action.$dots) > ($terminalWidth - 6)) {
+                $action = substr($action, 0, $terminalWidth - 7 - mb_strlen($method.$spaces.$uri.$dots)).'…';
+            }
+
+            $method = Str::of($method)->explode('|')->map(
+                fn ($method) => sprintf('<fg=%s>%s</>', $this->verbColors[$method] ?? 'default', $method),
+            )->implode('<fg=#6C7280>|</>');
+
+            return [sprintf(
+                '  <fg=white;options=bold>%s</> %s<fg=white>%s</><fg=#6C7280>%s %s</>',
+                $method,
+                $spaces,
+                preg_replace('#({[^}]+})#', '<fg=yellow>$1</>', $uri),
+                $dots,
+                str_replace('   ', ' › ', $action),
+            ), $this->output->isVerbose() && ! empty($middleware) ? "<fg=#6C7280>$middleware</>" : null];
+        })->flatten()->filter()->prepend('')->push('')->toArray();
+    }
+
+    /**
+     * Get the formatted action for display on the CLI.
+     *
+     * @param  array  $route
+     * @return string
+     */
+    protected function formatActionForCli($route)
+    {
+        ['action' => $action, 'name' => $name] = $route;
+
+        if ($action === 'Closure' || $action === ViewController::class) {
+            return $name;
+        }
+
+        $name = $name ? "$name   " : null;
+
+        $rootControllerNamespace = $this->laravel[UrlGenerator::class]->getRootControllerNamespace()
+            ?? ($this->laravel->getNamespace().'Http\\Controllers');
+
+        if (str_starts_with($action, $rootControllerNamespace)) {
+            return $name.substr($action, mb_strlen($rootControllerNamespace) + 1);
+        }
+
+        $actionClass = explode('@', $action)[0];
+
+        if (class_exists($actionClass) && str_starts_with((new ReflectionClass($actionClass))->getFilename(), base_path('vendor'))) {
+            $actionCollection = collect(explode('\\', $action));
+
+            return $name.$actionCollection->take(2)->implode('\\').'   '.$actionCollection->last();
+        }
+
+        return $name.$action;
+    }
+
+    /**
+     * Get the terminal width.
+     *
+     * @return int
+     */
+    public static function getTerminalWidth()
+    {
+        return is_null(static::$terminalWidthResolver)
+            ? (new Terminal)->getWidth()
+            : call_user_func(static::$terminalWidthResolver);
+    }
+
+    /**
+     * Set a callback that should be used when resolving the terminal width.
+     *
+     * @param  \Closure|null  $callback
+     * @return void
+     */
+    public static function resolveTerminalWidthUsing($resolver)
+    {
+        static::$terminalWidthResolver = $resolver;
+    }
+
     /**
      * Get the console command options.
      *
@@ -288,8 +415,6 @@ protected function asJson(array $routes)
     protected function getOptions()
     {
         return [
-            ['columns', null, InputOption::VALUE_OPTIONAL | InputOption::VALUE_IS_ARRAY, 'Columns to include in the route table'],
-            ['compact', 'c', InputOption::VALUE_NONE, 'Only show method, URI and action columns'],
             ['json', null, InputOption::VALUE_NONE, 'Output the route list as JSON'],
             ['method', null, InputOption::VALUE_OPTIONAL, 'Filter the routes by method'],
             ['name', null, InputOption::VALUE_OPTIONAL, 'Filter the routes by name'],
diff --git a/src/Illuminate/Routing/UrlGenerator.php b/src/Illuminate/Routing/UrlGenerator.php
@@ -793,6 +793,16 @@ public function setKeyResolver(callable $keyResolver)
         return $this;
     }
 
+    /**
+     * Get the root controller namespace.
+     *
+     * @return string
+     */
+    public function getRootControllerNamespace()
+    {
+        return $this->rootNamespace;
+    }
+
     /**
      * Set the root controller namespace.
      *
diff --git a/tests/Testing/Console/RouteListCommandTest.php b/tests/Testing/Console/RouteListCommandTest.php
@@ -0,0 +1,106 @@
+<?php
+
+namespace Illuminate\Tests\Testing;
+
+use Illuminate\Contracts\Routing\Registrar;
+use Illuminate\Foundation\Auth\User;
+use Illuminate\Foundation\Console\RouteListCommand;
+use Illuminate\Http\RedirectResponse;
+use Illuminate\Routing\Controller;
+use Illuminate\Support\Facades\Facade;
+use Orchestra\Testbench\TestCase;
+
+class RouteListCommandTest extends TestCase
+{
+    /**
+     * @var \Illuminate\Contracts\Routing\Registrar
+     */
+    private $router;
+
+    /**
+     * @var \Illuminate\Routing\UrlGenerator
+     */
+    private $urlGenerator;
+
+    protected function setUp(): void
+    {
+        parent::setUp();
+
+        $this->router = $this->app->make(Registrar::class);
+
+        RouteListCommand::resolveTerminalWidthUsing(function () {
+            return 70;
+        });
+    }
+
+    public function testDisplayRoutesForCli()
+    {
+        $this->router->get('closure', function () {
+            return new RedirectResponse($this->urlGenerator->signedRoute('signed-route'));
+        });
+
+        $this->router->get('controller-method/{user}', [FooController::class, 'show']);
+        $this->router->post('controller-invokable', FooController::class);
+        $this->router->domain('{account}.example.com')->group(function () {
+            $this->router->get('user/{id}', function ($account, $id) {
+                //
+            })->name('user.show')->middleware('web');
+        });
+
+        $this->artisan(RouteListCommand::class)
+            ->assertSuccessful()
+            ->expectsOutput('')
+            ->expectsOutput('  GET|HEAD   closure ............................................... ')
+            ->expectsOutput('  POST       controller-invokable Illuminate\Tests\Testing\FooContr…')
+            ->expectsOutput('  GET|HEAD   controller-method/{user} Illuminate\Tests\Testing\FooC…')
+            ->expectsOutput('  GET|HEAD   {account}.example.com/user/{id} ............. user.show')
+            ->expectsOutput('');
+    }
+
+    public function testDisplayRoutesForCliInVerboseMode()
+    {
+        $this->router->get('closure', function () {
+            return new RedirectResponse($this->urlGenerator->signedRoute('signed-route'));
+        });
+
+        $this->router->get('controller-method/{user}', [FooController::class, 'show']);
+        $this->router->post('controller-invokable', FooController::class);
+        $this->router->domain('{account}.example.com')->group(function () {
+            $this->router->get('user/{id}', function ($account, $id) {
+                //
+            })->name('user.show')->middleware('web');
+        });
+
+        $this->artisan(RouteListCommand::class, ['-v' => true])
+            ->assertSuccessful()
+            ->expectsOutput('')
+            ->expectsOutput('  GET|HEAD   closure ............................................... ')
+            ->expectsOutput('  POST       controller-invokable Illuminate\\Tests\\Testing\\FooController')
+            ->expectsOutput('  GET|HEAD   controller-method/{user} Illuminate\\Tests\\Testing\\FooController@show')
+            ->expectsOutput('  GET|HEAD   {account}.example.com/user/{id} ............. user.show')
+            ->expectsOutput('             ⇂ web')
+            ->expectsOutput('');
+    }
+
+    public function tearDown(): void
+    {
+        parent::tearDown();
+
+        Facade::setFacadeApplication(null);
+
+        RouteListCommand::resolveTerminalWidthUsing(null);
+    }
+}
+
+class FooController extends Controller
+{
+    public function show(User $user)
+    {
+        // ..
+    }
+
+    public function __invoke()
+    {
+        // ..
+    }
+}
