release(crypto): v0.1.1

README.org

@@ -131,7 +131,7 @@ duckbrain update --dry-run   # muestra el plan sin escribir
 
 - =list=: core y componentes instalados con versión y modo.
 - =doctor=: matriz de compatibilidad, sin efectos secundarios.
-- =catalog=: paquetes y componentes disponibles.
+- =catalog=: paquetes y componentes disponibles, cada uno con su descripción.
 - =adopt=: registra copias hechas a mano en proyectos antiguos.
 
 * Manifiesto =duckbrain.json=
@@ -278,15 +278,15 @@ Hay *dos* sistemas de versión y no hay que confundirlos:
 
 =make help= lista los objetivos:
 
-| Objetivo     | Qué hace                                                                                  |
+| Objetivo     | Qué hace                                                                                                               |
-|--------------+-------------------------------------------------------------------------------------------|
+|--------------+------------------------------------------------------------------------------------------------------------------------|
-| =make test=    | Corre la suite (=php tests/run.php=). En verde antes de commitear.                          |
+| =make test=    | Corre la suite (=php tests/run.php=). En verde antes de commitear.                                                       |
-| =make build=   | Genera =dist/duckbrain.phar= + =dist/duckbrain.phar.sha256=.                                  |
+| =make build=   | Genera =dist/duckbrain.phar= + =dist/duckbrain.phar.sha256=.                                                               |
 | =make compat=  | Barrido de compatibilidad contra el core real (=scripts/compat-sweep=); requiere red. =ARGS="--only pkg"= para un paquete. |
-| =make release= | Asistente interactivo de releases de paquetes (=ARGS="pkg minor --yes"= para modo directo). |
+| =make release= | Asistente interactivo de releases de paquetes (=ARGS="pkg minor --yes"= para modo directo).                              |
-| =make publish= | =build= + publica la release =v$(Config::VERSION)= con los assets. Requiere =FORGEJO_TOKEN=.    |
+| =make publish= | =build= + publica la release =v$(Config::VERSION)= con los assets. Requiere =FORGEJO_TOKEN=.                                 |
-| =make check=   | =self-update --check= contra el servidor: =actual/disponible=, exit 1 si hay nuevo.           |
+| =make check=   | =self-update --check= contra el servidor: =actual/disponible=, exit 1 si hay nuevo.                                        |
-| =make clean=   | Borra =dist/=.                                                                              |
+| =make clean=   | Borra =dist/=.                                                                                                           |
 
 El token para publicar es un token personal de la API de Forgejo
 (*Ajustes → Aplicaciones*, scope =write:repository=, con caducidad y revocable).

packages/commands/duckbrain.json

@@ -1,35 +1,35 @@
 {
-  "name": "commands",
+    "name": "commands",
-  "version": "0.2.0",
+    "version": "0.2.1",
-  "description": "CLI y migraciones para Duckbrain",
+    "description": "CLI y migraciones para Duckbrain",
-  "components": {
+    "components": {
-    "cli": {
+        "cli": {
-      "files": [
+            "files": [
-        "duckbrain",
+                "duckbrain",
-        "src/Interfaces/CommandInterface.php"
+                "src/Interfaces/CommandInterface.php"
-      ]
+            ]
+        },
+        "migration": {
+            "files": [
+                "src/Commands/Migration.php",
+                "src/Libs/Migration.php"
+            ],
+            "require": {
+                "commands:cli": "*"
+            },
+            "core": {
+                "requires": ">=0.1",
+                "tested": "0.1"
+            }
+        },
+        "toolbox": {
+            "files": [
+                "src/Toolbox"
+            ]
+        }
     },
-    "migration": {
+    "default": [
-      "files": [
+        "cli",
-        "src/Commands/Migration.php",
+        "migration"
-        "src/Libs/Migration.php"
+    ]
-      ],
-      "require": {
-        "commands:cli": "*"
-      },
-      "core": {
-        "requires": ">=0.1",
-        "tested": "0.1"
-      }
-    },
-    "toolbox": {
-      "files": [
-        "src/Toolbox"
-      ]
-    }
-  },
-  "default": [
-    "cli",
-    "migration"
-  ]
 }

packages/commands/src/Toolbox/Commands/CatalogCommand.php

@@ -31,7 +31,7 @@ final class CatalogCommand extends Command
                     $first ? $package->name . ' (' . $package->version . ')' : '',
                     $name,
                     $installed,
-                    $first ? $package->description : '',
+                    $package->descriptionOf($name) ?? '',
                 ];
                 $first = false;
             }

packages/commands/src/Toolbox/Component.php

@@ -15,6 +15,7 @@ final class Component
         public readonly array $requires = [],
         public readonly ?string $coreRequires = null,
         public readonly ?string $coreTested = null,
+        public readonly ?string $description = null,
         public readonly ?array $destinations = null,
         public readonly bool $override = false,
     ) {
@@ -51,12 +52,22 @@ final class Component
             }
         }
 
+        $description = null;
+        if (isset($data['description'])) {
+            if (!is_string($data['description'])) {
+                throw new ToolboxException("El componente '{$name}' tiene un 'description' inválido");
+            }
+
+            $description = $data['description'];
+        }
+
         return new self(
             name: $name,
             files: array_values($data['files']),
             requires: $requires,
             coreRequires: $data['core']['requires'] ?? null,
             coreTested: $data['core']['tested'] ?? null,
+            description: $description,
             destinations: $destinations,
             override: (bool) ($data['override'] ?? false),
         );

packages/commands/src/Toolbox/Config.php

@@ -8,7 +8,7 @@ namespace Toolbox;
  */
 final class Config
 {
-    public const VERSION = '0.2.0';
+    public const VERSION = '0.2.1';
 
     public static function toolboxUrl(): string
     {

packages/commands/src/Toolbox/Manifest.php

@@ -157,4 +157,17 @@ final class Manifest
 
         return $this->coreTested;
     }
+
+    /**
+     * Descripcion efectiva: la propia del componente o, en su ausencia, la del
+     * paquete (mismo patrón de herencia que los rangos de core).
+     */
+    public function descriptionOf(?string $component = null): ?string
+    {
+        if ($component !== null) {
+            return $this->component($component)->description ?? $this->description;
+        }
+
+        return $this->description;
+    }
 }

packages/crypto/duckbrain.json

@@ -1,13 +1,35 @@
 {
-  "name": "crypto",
+    "name": "crypto",
-  "version": "0.1.0",
+    "version": "0.1.1",
-  "description": "Criptografía y segundo factor (Crypto, Nonce, TwoFactorAuthenticator)",
+    "description": "Criptograf\u00eda y segundo factor (Crypto, Nonce, TwoFactorAuthenticator)",
-  "core": { "requires": ">=0.1", "tested": "0.1" },
+    "core": {
-  "php": ">=8.1",
+        "requires": ">=0.1",
-  "components": {
+        "tested": "0.1"
-    "crypto": { "files": ["src/Libs/Crypto.php"] },
+    },
-    "nonce": { "files": ["src/Libs/Nonce.php"] },
+    "php": ">=8.1",
-    "twoFactor": { "files": ["src/Libs/TwoFactorAuthenticator.php"] }
+    "components": {
-  },
+        "crypto": {
-  "default": ["crypto", "nonce", "twoFactor"]
+            "files": [
+                "src/Libs/Crypto.php"
+            ],
+            "description": "Cifrado sim\u00e9trico con salida hex/base64"
+        },
+        "nonce": {
+            "files": [
+                "src/Libs/Nonce.php"
+            ],
+            "description": "Generaci\u00f3n y verificaci\u00f3n de tokens de un solo uso"
+        },
+        "twoFactor": {
+            "files": [
+                "src/Libs/TwoFactorAuthenticator.php"
+            ],
+            "description": "TOTP compatible con Google Authenticator"
+        }
+    },
+    "default": [
+        "crypto",
+        "nonce",
+        "twoFactor"
+    ]
 }

packages/text/duckbrain.json

@@ -1,12 +1,28 @@
 {
-  "name": "text",
+    "name": "text",
-  "version": "0.1.0",
+    "version": "0.1.1",
-  "description": "Filtros y reemplazos de texto (Filter, Replacement)",
+    "description": "Filtros y reemplazos de texto (Filter, Replacement)",
-  "core": { "requires": ">=0.1", "tested": "0.1" },
+    "core": {
-  "php": ">=8.1",
+        "requires": ">=0.1",
-  "components": {
+        "tested": "0.1"
-    "filter": { "files": ["src/Libs/Filter.php"] },
+    },
-    "replacement": { "files": ["src/Libs/Replacement.php"] }
+    "php": ">=8.1",
-  },
+    "components": {
-  "default": ["filter", "replacement"]
+        "filter": {
+            "files": [
+                "src/Libs/Filter.php"
+            ],
+            "description": "Filtros de contenido extensibles por contexto y prioridad"
+        },
+        "replacement": {
+            "files": [
+                "src/Libs/Replacement.php"
+            ],
+            "description": "B\u00fasqueda y reemplazo de patrones sobre contenido"
+        }
+    },
+    "default": [
+        "filter",
+        "replacement"
+    ]
 }

tests/group2_manifest_test.php

@@ -121,3 +121,28 @@ Harness::it('ciclo de dependencias se detecta', function () {
 
     rrmdir($dir);
 });
+
+Harness::it('la descripcion del componente prevalece y hereda del paquete', function () {
+    $m = Manifest::fromArray([
+        'name'        => 'pkg',
+        'version'     => '1.0.0',
+        'description' => 'Resumen del paquete',
+        'components'  => [
+            'a' => ['files' => ['src/A.php'], 'description' => 'Componente A'],
+            'b' => ['files' => ['src/B.php']],
+        ],
+    ]);
+
+    eq('Componente A', $m->descriptionOf('a'), 'descripción propia gana');
+    eq('Resumen del paquete', $m->descriptionOf('b'), 'sin descripción propia hereda del paquete');
+    eq('Resumen del paquete', $m->descriptionOf(), 'sin componente: la del paquete');
+
+    $m2 = Manifest::fromArray(['name' => 'x', 'version' => '1.0.0', 'components' => ['c' => ['files' => ['c.php']]]]);
+    eq('', $m2->descriptionOf('c'), 'paquete sin texto produce cadena vacía (no null)');
+
+    throws(fn () => Manifest::fromArray([
+        'name'       => 'y',
+        'version'    => '1.0.0',
+        'components' => ['c' => ['files' => ['c.php'], 'description' => 7]],
+    ]), 'description no-string es inválida');
+});

tests/group7_commands_test.php

@@ -238,3 +238,27 @@ Harness::it('--force resuelve drift pero no salta avisos de compatibilidad', fun
     rrmdir($proj);
     rrmdir($tool);
 });
+
+Harness::it('el catálogo describe cada componente con su texto propio o heredado', function () {
+    $toolbox = g7_toolbox();
+    $manifest = json_decode((string) file_get_contents($toolbox . '/packages/http/duckbrain.json'), true);
+    $manifest['components']['curlRequest']['description'] = 'Cliente HTTP sobre cURL';
+    write_file($toolbox . '/packages/http/duckbrain.json', json_encode($manifest, JSON_PRETTY_PRINT));
+
+    $proj = tmpdir('proj');
+    $out  = fopen('php://memory', 'rw');
+    $code = (new Toolbox\Commands\CatalogCommand(new Console($out)))->run(
+        ['--root=' . $proj, '--toolbox=' . $toolbox]
+    );
+    rewind($out);
+    $text = (string) stream_get_contents($out);
+
+    eq(0, $code, 'catalog termina bien');
+    ok((bool) preg_match('/curlRequest.*Cliente HTTP sobre cURL/', $text), 'fila propia con su texto');
+    ok((bool) preg_match('/aria2.*Utilidades HTTP/', $text), 'fila sin texto hereda el del paquete');
+    ok((bool) preg_match('/compreFace.*Utilidades HTTP/', $text), 'vecino heredando igual');
+    ok(!preg_match('/aria2.*cURL/', $text), 'los textos no se mezclan entre filas');
+
+    rrmdir($toolbox);
+    rrmdir($proj);
+});