feat: improve namespaces command

Author: kenjis

system/Commands/Utilities/Namespaces.php

@@ -14,6 +14,7 @@
 use CodeIgniter\CLI\BaseCommand;
 use CodeIgniter\CLI\CLI;
 use Config\Autoload;
+use Config\Services;
 
 /**
  * Lists namespaces set in Config\Autoload with their
@@ -63,33 +64,94 @@ class Namespaces extends BaseCommand
      *
      * @var array
      */
-    protected $options = [];
+    protected $options = [
+        '-c' => 'Show only CodeIgniter config namespaces.',
+        '-r' => 'Show raw path strings.',
+        '-m' => 'Specify max length of the path strings to output. Default: 60.',
+    ];
 
     /**
      * Displays the help for the spark cli script itself.
      */
     public function run(array $params)
     {
+        $params['m'] = (int) ($params['m'] ?? 60);
+
+        if (array_key_exists('c', $params)) {
+            $tbody = $this->outputCINamespaces($params);
+        } else {
+            $tbody = $this->outputAllNamespaces($params);
+        }
+
+        $thead = [
+            'Namespace',
+            'Path',
+            'Found?',
+        ];
+
+        CLI::table($tbody, $thead);
+    }
+
+    private function outputAllNamespaces(array $params): array
+    {
+        $maxLength = $params['m'];
+
+        $autoloader = Services::autoloader();
+
+        $tbody = [];
+
+        foreach ($autoloader->getNamespace() as $ns => $paths) {
+            foreach ($paths as $path) {
+                if (array_key_exists('r', $params)) {
+                    $pathOutput = $this->truncate($path, $maxLength);
+                } else {
+                    $pathOutput = $this->truncate(clean_path($path), $maxLength);
+                }
+
+                $tbody[] = [
+                    $ns,
+                    $pathOutput,
+                    is_dir($path) ? 'Yes' : 'MISSING',
+                ];
+            }
+        }
+
+        return $tbody;
+    }
+
+    private function truncate(string $string, int $max): string
+    {
+        $length = strlen($string);
+
+        if ($length > $max) {
+            return substr($string, 0, $max - 3) . '...';
+        }
+
+        return $string;
+    }
+
+    private function outputCINamespaces(array $params): array
+    {
+        $maxLength = $params['m'];
+
         $config = new Autoload();
 
         $tbody = [];
 
         foreach ($config->psr4 as $ns => $path) {
-            $path = realpath($path) ?: $path;
+            if (array_key_exists('r', $params)) {
+                $pathOutput = $this->truncate($path, $maxLength);
+            } else {
+                $pathOutput = $this->truncate(clean_path($path), $maxLength);
+            }
 
             $tbody[] = [
                 $ns,
-                realpath($path) ?: $path,
+                $pathOutput,
                 is_dir($path) ? 'Yes' : 'MISSING',
             ];
         }
 
-        $thead = [
-            'Namespace',
-            'Path',
-            'Found?',
-        ];
-
-        CLI::table($tbody, $thead);
+        return $tbody;
     }
 }

tests/system/Commands/Utilities/NamespacesTest.php

@@ -0,0 +1,83 @@
+<?php
+
+/**
+ * This file is part of CodeIgniter 4 framework.
+ *
+ * (c) CodeIgniter Foundation <admin@codeigniter.com>
+ *
+ * For the full copyright and license information, please view
+ * the LICENSE file that was distributed with this source code.
+ */
+
+namespace CodeIgniter\Commands\Utilities;
+
+use CodeIgniter\Test\CIUnitTestCase;
+use CodeIgniter\Test\Filters\CITestStreamFilter;
+
+/**
+ * @internal
+ */
+final class NamespacesTest extends CIUnitTestCase
+{
+    private $streamFilter;
+
+    protected function setUp(): void
+    {
+        $this->resetServices();
+
+        parent::setUp();
+
+        CITestStreamFilter::$buffer = '';
+
+        $this->streamFilter = stream_filter_append(STDOUT, 'CITestStreamFilter');
+        $this->streamFilter = stream_filter_append(STDERR, 'CITestStreamFilter');
+    }
+
+    protected function tearDown(): void
+    {
+        stream_filter_remove($this->streamFilter);
+
+        $this->resetServices();
+    }
+
+    protected function getBuffer()
+    {
+        return CITestStreamFilter::$buffer;
+    }
+
+    public function testNamespacesCommandCodeIgniterOnly()
+    {
+        command('namespaces -c');
+
+        $expected = <<<'EOL'
+            +---------------+-------------------------+--------+
+            | Namespace     | Path                    | Found? |
+            +---------------+-------------------------+--------+
+            | CodeIgniter   | ROOTPATH/system         | Yes    |
+            | App           | ROOTPATH/app            | Yes    |
+            | Config        | APPPATH/Config          | Yes    |
+            | Tests\Support | ROOTPATH/tests/_support | Yes    |
+            +---------------+-------------------------+--------+
+            EOL;
+
+        $this->assertStringContainsString($expected, $this->getBuffer());
+    }
+
+    public function testNamespacesCommandAllNamespaces()
+    {
+        command('namespaces');
+
+        $this->assertStringContainsString(
+            '|CodeIgniter|ROOTPATH/system|Yes|',
+            str_replace(' ', '', $this->getBuffer())
+        );
+        $this->assertStringContainsString(
+            '|App|ROOTPATH/app|Yes|',
+            str_replace(' ', '', $this->getBuffer())
+        );
+        $this->assertStringContainsString(
+            '|Config|APPPATH/Config|Yes|',
+            str_replace(' ', '', $this->getBuffer())
+        );
+    }
+}