feat(cli): pure alias-based dispatcher in project bin; Commands\Toolbox entry point; describe() required on CommandInterface

BREAKING: project commands implementing CommandInterface must define static describe(): string (intentional, forces documentation).
2026-10-06 15:14:33 -03:00
parent 5eb019726a
commit c2931245bb
7 changed files with 257 additions and 62 deletions
@@ -2,41 +2,111 @@
 <?php

 // CLI del proyecto Duckbrain. Requiere el autoloader del core (proyecto ya
-// armado). Delega en el motor `Toolbox\` si el componente opcional
-// `commands:toolbox` está instalado; en caso contrario, sólo ofrece los
-// comandos propios del proyecto (p. ej. migraciones).
-require_once('./autoload.php');
+// armado). Despachador genérico: el primer argumento resuelve primero como
+// nombre de clase del namespace Commands del proyecto y, si no, como alias
+// declarado por una de esas clases (`public static function aliases():
+// array`). Un alias duplicado —o que robe el nombre de otra clase— aborta
+// con error explícito listando ambos dueños. Los comandos implementan
+// Interfaces\CommandInterface (run + describe obligatorios).

-$command = $argv[1] ?? null;
+require_once './autoload.php';

-$toolboxCommands = [
-    'add', 'remove', 'update', 'list', 'doctor', 'catalog', 'adopt',
-    'help', '--help', '-h', '--version', '-V',
-];
-
-if ($command === null || in_array($command, $toolboxCommands, true)) {
-    if (!class_exists('Toolbox\\Cli')) {
-        fwrite(STDERR, "El componente 'commands:toolbox' no está instalado.\n");
-        fwrite(STDERR, "Añádelo con el instalador global: duckbrain add commands:toolbox\n");
-        exit(1);
+/**
+ * @return array<string, string> clase por nombre de archivo (basename => FQCN)
+ */
+function project_commands(): array
+{
+    $classes = [];
+    foreach (glob(rtrim(ROOT_CORE, '/') . '/Commands/*.php') as $file) {
+        $base  = basename($file, '.php');
+        $class = 'Commands\\' . $base;
+        if (class_exists($class) && is_a($class, 'Interfaces\\CommandInterface', true)) {
+            $classes[$base] = $class;
+        }
    }

-    exit((new Toolbox\Cli())->run($argv));
+    return $classes;
 }

-// Comandos propios del proyecto, despachados desde ROOT_CORE/Commands.
-$coreCommand = 'Commands\\' . ucfirst($command);
+/**
+ * @param array<string, string> $classes
+ * @return array<string, string> alias => FQCN
+ */
+function alias_map(array $classes): array
+{
+    $map     = [];
+    $byLower  = [];
+    foreach ($classes as $base => $class) {
+        $byLower[strtolower($base)] = $class;
+    }

-if (!class_exists($coreCommand) && !file_exists(ROOT_CORE . '/Commands/' . ucfirst($command) . '.php')) {
-    fwrite(STDERR, "Invalid command.\n");
-    exit(1);
+    foreach ($classes as $base => $class) {
+        if (!method_exists($class, 'aliases')) {
+            continue;
+        }
+
+        foreach ($class::aliases() as $alias) {
+            $owner = strtolower($base);
+            $key   = strtolower((string) $alias);
+
+            if ($key === $owner) {
+                continue;
+            }
+
+            if (isset($map[$key]) && $map[$key] !== $class) {
+                fwrite(STDERR, "Conflicto de alias '{$alias}': lo declaran {$map[$key]} y {$class}.\n");
+                exit(1);
+            }
+
+            if (isset($byLower[$key])) {
+                fwrite(STDERR, "El alias '{$alias}' de {$class} colisiona con el comando {$byLower[$key]}.\n");
+                exit(1);
+            }
+
+            $map[$key] = $class;
+        }
+    }
+
+    return $map;
 }

-$cli = new $coreCommand();
+$classes = project_commands();
+$map     = alias_map($classes);
+$command = $argv[1] ?? null;

-if ($cli instanceof Interfaces\CommandInterface) {
-    call_user_func_array([$cli, 'run'], array_slice($argv, 2));
+if ($command === null) {
+    $rev = [];
+    foreach ($map as $alias => $class) {
+        $rev[$class][] = $alias;
+    }
+
+    foreach ($classes as $base => $class) {
+        $line = '  ' . strtolower($base);
+        if (($rev[$class] ?? []) !== []) {
+            $line .= ', ' . implode(', ', $rev[$class]);
+        }
+        fwrite(STDOUT, $line . ' — ' . $class::describe() . "\n");
+    }
+
+    exit(0);
+}
+
+$direct = 'Commands\\' . ucfirst($command);
+$class  = null;
+$slice  = 2;
+
+if (class_exists($direct) && is_a($direct, 'Interfaces\\CommandInterface', true)) {
+    $class = $direct;
 } else {
-    fwrite(STDERR, "La clase $coreCommand no implementa CommandInterface.\n");
+    $class = $map[strtolower($command)] ?? null;
+    $slice = $class === null ? $slice : 1;
+}
+
+if ($class === null) {
+    fwrite(STDERR, "Comando desconocido: {$command}\n");
    exit(1);
 }
+
+$cli = new $class();
+
+call_user_func_array([$cli, 'run'], array_slice($argv, $slice));
@@ -1,40 +1,41 @@
 {
-    "name": "commands",
-    "version": "0.2.4",
-    "description": "CLI y migraciones para Duckbrain",
-    "components": {
-        "cli": {
-            "files": [
-                "duckbrain",
-                "src/Interfaces/CommandInterface.php"
-            ],
-            "description": "CLI del proyecto (binario duckbrain)",
-            "core": "none"
-        },
-        "migration": {
-            "files": [
-                "src/Commands/Migration.php",
-                "src/Libs/Migration.php"
-            ],
-            "require": {
-                "commands:cli": "*"
-            },
-            "core": {
-                "requires": ">=0.1",
-                "tested": "0.1"
-            },
-            "description": "Migraciones de base de datos (mysql/pgsql/sqlite)"
-        },
-        "toolbox": {
-            "files": [
-                "src/Toolbox"
-            ],
-            "description": "Gestor de addons dentro del propio proyecto",
-            "core": "none"
-        }
+  "name": "commands",
+  "version": "0.2.4",
+  "description": "CLI y migraciones para Duckbrain",
+  "components": {
+    "cli": {
+      "files": [
+        "duckbrain",
+        "src/Interfaces/CommandInterface.php"
+      ],
+      "description": "CLI del proyecto (binario duckbrain)",
+      "core": "none"
    },
-    "default": [
-        "cli",
-        "migration"
-    ]
+    "migration": {
+      "files": [
+        "src/Commands/Migration.php",
+        "src/Libs/Migration.php"
+      ],
+      "require": {
+        "commands:cli": "*"
+      },
+      "core": {
+        "requires": ">=0.1",
+        "tested": "0.1"
+      },
+      "description": "Migraciones de base de datos (mysql/pgsql/sqlite)"
+    },
+    "toolbox": {
+      "files": [
+        "src/Toolbox",
+        "src/Commands/Toolbox.php"
+      ],
+      "description": "Gestor de addons dentro del propio proyecto",
+      "core": "none"
+    }
+  },
+  "default": [
+    "cli",
+    "migration"
+  ]
 }
@@ -10,6 +10,11 @@ use PDO;

 class Migration implements CommandInterface
 {
+    public static function describe(): string
+    {
+        return 'Migraciones de base de datos (create, migrate, rollback, fresh, clear)';
+    }
+
    private const MIGRATIONS_PATH = ROOT_DIR . '/migrations/';
    private string $migratonsDatabaseFile;
    private PDO $db;
@@ -0,0 +1,39 @@
+<?php
+
+namespace Commands;
+
+use Interfaces\CommandInterface;
+use Toolbox\Cli;
+
+/**
+ * Entry point del gestor de addons dentro del proyecto: el bin `duckbrain`
+ * despacha aquí todo alias del motor (add, remove, update, list, doctor,
+ * catalog, adopt, help y variantes de versión/usage). Vive en el namespace
+ * Commands del proyecto para que el binario siga siendo un despachador
+ * genérico: no conoce la lista de comandos de nadie más que de los propios.
+ */
+class Toolbox implements CommandInterface
+{
+    public static function describe(): string
+    {
+        return 'Gestor de addons del proyecto (motor duckbrain-toolbox)';
+    }
+
+    /**
+     * @return list<string>
+     */
+    public static function aliases(): array
+    {
+        return [
+            'add', 'remove', 'update', 'list', 'doctor', 'catalog', 'adopt',
+            'help', '--help', '-h', '--version', '-V',
+        ];
+    }
+
+    public function run(): void
+    {
+        $args = func_get_args();
+
+        exit((new Cli())->run(array_merge(['duckbrain'], array_map('strval', $args))));
+    }
+}
@@ -10,4 +10,10 @@ interface CommandInterface
     * @return void
     */
    public function run(): void;
+
+    /**
+     * Descripción de una línea del comando, obligatoria: fuerza a documentar
+     * cada comando del proyecto para que sea visible en la superficie.
+     */
+    public static function describe(): string;
 }