do not repeat --resource values on pipeline stub and configure stages…

… (use meta-data file contents instead)
llaville · Aug 27, 2024 · c22e99d · c22e99d
1 parent 988f46c
commit c22e99d
Show file tree

Hide file tree

Showing 11 changed files with 40 additions and 20 deletions.
diff --git a/.github/workflows/release.yml b/.github/workflows/release.yml
@@ -45,7 +45,7 @@ jobs:
                 name: Build Release Artifact
                 run: |
                     bin/box-manifest make -r console-table.txt -r plain.txt -r sbom.json build
-                    bin/box-manifest make -r console-table.txt -r plain.txt -r sbom.json --output-stub stub.php stub
+                    bin/box-manifest make --output-stub stub.php stub
                     bin/box-manifest make compile -c box.json.dist -vvv --ansi
 
             -   # https://github.com/softprops/action-gh-release

diff --git a/docs/Tutorial/generate-box-json-dist.md b/docs/Tutorial/generate-box-json-dist.md
@@ -13,18 +13,18 @@ you need to have a BOX configuration file that :
 >
 > Don't forget to specify option `--config /path/to/any-box.json` on following command invocations.
 
-## :material-numeric-1-box: Identify all manifest files
-
-To do so, you have to specify `--resource` (`-r` shortcut) option with filename that should be previously built (or not).
+## :material-numeric-1-box: Store manifests in default directory
 
 === "Command"
 
     ```shell
-    box-manifest make -r console-table.txt -r manifest.txt configure
+    box-manifest make configure
     ```
 
 === "Output"
 
+    Here, we supposed to have previously generated `console-table.txt` and `manifest.txt` resources.
+
     ```json
     {
         "files-bin": [
@@ -49,11 +49,13 @@ To do so, you have to specify `--resource` (`-r` shortcut) option with filename
 === "Command"
 
     ```shell
-    box-manifest make -r console-table.txt -r manifest.txt --resource-dir '.my_manifests/' configure
+    box-manifest make --resource-dir '.my_manifests/' configure
     ```
 
 === "Output"
 
+    Here, we supposed to have previously generated `console-table.txt` and `manifest.txt` resources.
+
     ```json
     {
         "files-bin": [
@@ -84,16 +86,19 @@ To do so, you have to specify `--output-stub` option with filename that should b
 === "Command"
 
     ```shell
-    box-manifest make -r console-table.txt -r manifest.txt --resource-dir '.my_manifests/' --output-stub app-fixtures-stub.php configure
+    box-manifest make --resource-dir '.my_manifests/' --output-stub app-fixtures-stub.php configure
     ```
 
 === "Output"
 
+    Here, we supposed to have previously generated `console-table.txt` and `manifest.txt` resources.
+
     ```json
     {
         "files-bin": [
             "console-table.txt",
             "manifest.txt",
+            ".box.manifests.bin",
         ],
         "map": [
             {

diff --git a/docs/Tutorial/generate-custom-stub.md b/docs/Tutorial/generate-custom-stub.md
@@ -19,11 +19,13 @@ Make for example this stub (see **Output** tab), either manually or with the fol
 === "Command"
 
     ```shell
-    box-manifest make -r console-table.txt -r manifest.txt stub
+    box-manifest make stub
     ```
 
 === "Output"
 
+    Here, we supposed to have previously generated `console-table.txt` and `manifest.txt` resources.
+
     ```php
     <?php
 
@@ -71,7 +73,7 @@ Make for example this stub (see **Output** tab), either manually or with the fol
 > === "Command"
 >
 >     ```shell
->     box-manifest make -r console-table.txt -r manifest.txt --template resources/empty_stub.template --output-stub my-stub.php stub
+>     box-manifest make --template resources/empty_stub.template --output-stub my-stub.php stub
 >     ```
 >
 > === "Output"

diff --git a/docs/UseCases/ConsoleTextFormat.md b/docs/UseCases/ConsoleTextFormat.md
@@ -22,7 +22,7 @@
 
     ![console format](../assets/images/app-fixtures-console.png)
 
-## :material-numeric-2-box: With new pipeline command
+## :material-numeric-2-box: With pipeline command
 
 === "Command"
 

diff --git a/docs/UseCases/CustomFormat.md b/docs/UseCases/CustomFormat.md
@@ -128,7 +128,7 @@ either by your autoloader or with bootstrap helper feature (see `--bootstrap|-b`
     )
     ```
 
-## :material-numeric-2-box: With new pipeline command
+## :material-numeric-2-box: With pipeline command
 
 === "Command"
 

diff --git a/docs/UseCases/DecoratedTextFormat.md b/docs/UseCases/DecoratedTextFormat.md
@@ -22,7 +22,7 @@
 
     ![ansi format](../assets/images/app-fixtures-ansi.png)
 
-## :material-numeric-2-box: With new pipeline command
+## :material-numeric-2-box: With pipeline command
 
 === "Command"
 

diff --git a/docs/UseCases/PlainTextFormat.md b/docs/UseCases/PlainTextFormat.md
@@ -25,7 +25,7 @@
     psr/log: 3.0.0
     ```
 
-## :material-numeric-2-box: With new pipeline command
+## :material-numeric-2-box: With pipeline command
 
 === "Command"
 

diff --git a/docs/UseCases/SBomJsonFormat.md b/docs/UseCases/SBomJsonFormat.md
@@ -70,7 +70,7 @@
     }
     ```
 
-## :material-numeric-2-box: With new pipeline command
+## :material-numeric-2-box: With pipeline command
 
 === "Command"
 

diff --git a/docs/UseCases/SBomXmlFormat.md b/docs/UseCases/SBomXmlFormat.md
@@ -56,7 +56,7 @@
     </bom>
     ```
 
-## :material-numeric-2-box: With new pipeline command
+## :material-numeric-2-box: With pipeline command
 
 === "Command"
 

diff --git a/docs/build-your-stub.md b/docs/build-your-stub.md
@@ -8,9 +8,20 @@
 === "Pipeline Command"
 
     ```shell
-    box-manifest make -r console-table.txt -r manifest.txt -r sbom.json --output-stub stub.php stub
+    box-manifest make --output-stub stub.php stub
     ```
 
+    > [!CAUTION]
+    >
+    > When none resources are provided (`--resource|-r`) recommended way,
+    > we used list defined into `.box.manifests.bin` meta-data file.
+    >
+    > === "Meta-data file"
+    >
+    >    ```
+    >    a:3:{s:17:"console-table.txt";s:24:"application/octet-stream";s:12:"manifest.txt";s:10:"text/plain";s:9:"sbom.json";s:38:"application/vnd.sbom+json; version=1.6";}
+    >    ```
+
 === "Legacy Command"
 
     ```shell

diff --git a/src/Pipeline/ConfigureStage.php b/src/Pipeline/ConfigureStage.php
@@ -8,6 +8,7 @@
 namespace Bartlett\BoxManifest\Pipeline;
 
 use Throwable;
+use function array_keys;
 use function array_push;
 use function file_exists;
 use function file_get_contents;
@@ -44,12 +45,13 @@ public function __invoke(array $payload): array
             $configs['files-bin'] = [];
         }
 
-        array_push($configs['files-bin'], ...$payload['resources']);
-        $configs['files-bin'][] = '.box.manifests.bin';
+        $resources = empty($payload['resources']) ? array_keys($this->getMetaData()) : $payload['resources'];
+        $resourceDir = $payload['resourceDir'];
 
-        $mapFiles = $payload['map'];
+        array_push($configs['files-bin'], ...$resources);
+        $configs['files-bin'][] = $resourceDir;
 
-        $resourceDir = $payload['resourceDir'];
+        $mapFiles = $payload['map'];
 
         if (!empty($resourceDir) && '/' !== $resourceDir) {
             foreach ($payload['resources'] as $resource) {