Build phar binary

Build phar binary file and update build settings for Csv-Blueprint. Create symlink for testing. Update box.json.dist and composer.json.
JBZoo · Mar 10, 2024 · a613bf4 · a613bf4
1 parent 2b96410
commit a613bf4
Show file tree

Hide file tree

Showing 6 changed files with 140 additions and 39 deletions.
diff --git a/.github/workflows/main.yml b/.github/workflows/main.yml
@@ -138,3 +138,39 @@ jobs:
         with:
           name: Reports - ${{ matrix.php-version }}
           path: build/
+
+  phar:
+    name: Phar
+    runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        php-version: [ 8.1, 8.2, 8.3 ]
+    steps:
+      - name: Checkout code
+        uses: actions/checkout@v3
+        with:
+          fetch-depth: 0
+
+      - name: Setup PHP
+        uses: shivammathur/setup-php@v2
+        with:
+          php-version: ${{ matrix.php-version }}
+          coverage: xdebug
+          tools: composer
+          extensions: ast
+
+      - name: Build the project
+        run: make build --no-print-directory
+
+      - name: Building Phar binary file
+        run: make build-phar --no-print-directory
+
+      - name: Trying to use the phar file
+        run: ./build/csv-blueprint.phar --help
+
+      - name: Upload Artifacts
+        uses: actions/upload-artifact@v3
+        continue-on-error: true
+        with:
+          name: Reports - ${{ matrix.php-version }}
+          path: build/
diff --git a/Makefile b/Makefile
@@ -10,17 +10,29 @@
 # @see        https://github.com/JBZoo/Csv-Blueprint
 #
 
+.PHONY: build
 
 ifneq (, $(wildcard ./vendor/jbzoo/codestyle/src/init.Makefile))
     include ./vendor/jbzoo/codestyle/src/init.Makefile
 endif
 
 OUTPUT ?= table
 
-update: ##@Project Install/Update all 3rd party dependencies
+build: ##@Project Install all 3rd party dependencies
 	$(call title,"Install/Update all 3rd party dependencies")
+	@composer install
+	@make build-phar
+	@make create-symlink
+
+
+update: ##@Project Install/Update all 3rd party dependencies
 	@echo "Composer flags: $(JBZOO_COMPOSER_UPDATE_FLAGS)"
 	@composer update $(JBZOO_COMPOSER_UPDATE_FLAGS)
+	@make build-phar
+
+
+create-symlink: ##@Project Create Symlink (alias for testing)
+	@ln -sfv `pwd`/ci-report-converter `pwd`/vendor/bin/ci-report-converter
 
 
 test-all: ##@Project Run all project tests at once

diff --git a/box.json.dist b/box.json.dist
@@ -0,0 +1,22 @@
+{
+    "banner"      : [
+        "JBZoo Toolbox - Csv-Blueprint",
+        "",
+        "This file is part of the JBZoo Toolbox project.",
+        "For the full copyright and license information, please view the LICENSE",
+        "file that was distributed with this source code.",
+        "",
+        "@package    Csv-Blueprint",
+        "@license    MIT",
+        "@copyright  Copyright (C) JBZoo.com, All rights reserved.",
+        "@link       https://github.com/JBZoo/Csv-Blueprint"
+    ],
+
+    "output"      : "build/csv-blueprint.phar",
+
+    "directories" : ["src"],
+    "files"       : ["csv-blueprint.php"],
+    "git-version" : "git-version",
+
+    "finder"      : [{"in" : "vendor"}]
+}
diff --git a/composer.json b/composer.json
@@ -42,6 +42,8 @@
         "jbzoo/toolbox-dev"         : "^7.1"
     },
 
+    "bin"               : ["csv-blueprint"],
+
     "autoload"          : {
         "psr-4" : {"JBZoo\\CsvBlueprint\\" : "src"}
     },

diff --git a/csv-blueprint b/csv-blueprint
@@ -1,43 +1,18 @@
 #!/usr/bin/env php
 <?php
 
-declare(strict_types=1);
-
-namespace JBZoo\CsvBlueprint;
-
-use JBZoo\Cli\CliApplication;
-
-\define('PATH_ROOT', __DIR__);
+/**
+ * JBZoo Toolbox - Csv-Blueprint.
+ *
+ * This file is part of the JBZoo Toolbox project.
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ *
+ * @license    MIT
+ * @copyright  Copyright (C) JBZoo.com, All rights reserved.
+ * @see        https://github.com/JBZoo/Csv-Blueprint
+ */
 
-$vendorPaths = [
-    __DIR__ . '/../../autoload.php',
-    __DIR__ . '/../vendor/autoload.php',
-    __DIR__ . '/vendor/autoload.php',
-];
-
-foreach ($vendorPaths as $file) {
-    if (\file_exists($file)) {
-        \define('JBZOO_AUTOLOAD_FILE', $file);
-        break;
-    }
-}
-
-require_once JBZOO_AUTOLOAD_FILE;
-
-\date_default_timezone_set('UTC');
+declare(strict_types=1);
 
-(new CliApplication('CSV Blueprint', '@git-version@'))
-    ->registerCommandsByPath(PATH_ROOT . '/src/Commands', __NAMESPACE__)
-    ->setLogo(
-        <<<'EOF'
-         _____            ______ _                       _       _   
-        /  __ \           | ___ \ |                     (_)     | |  
-        | /  \/_____   __ | |_/ / |_   _  ___ _ __  _ __ _ _ __ | |_ 
-        | |   / __\ \ / / | ___ \ | | | |/ _ \ '_ \| '__| | '_ \| __|
-        | \__/\__ \\ V /  | |_/ / | |_| |  __/ |_) | |  | | | | | |_ 
-         \____/___/ \_/   \____/|_|\__,_|\___| .__/|_|  |_|_| |_|\__|
-                                             | |                     
-                                             |_|                     
-        EOF,
-    )
-    ->run();
+require_once __DIR__ . '/csv-blueprint.php';
diff --git a/csv-blueprint.php b/csv-blueprint.php
@@ -0,0 +1,54 @@
+<?php
+
+/**
+ * JBZoo Toolbox - Csv-Blueprint.
+ *
+ * This file is part of the JBZoo Toolbox project.
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ *
+ * @license    MIT
+ * @copyright  Copyright (C) JBZoo.com, All rights reserved.
+ * @see        https://github.com/JBZoo/Csv-Blueprint
+ */
+
+declare(strict_types=1);
+
+namespace JBZoo\CsvBlueprint;
+
+use JBZoo\Cli\CliApplication;
+
+\define('PATH_ROOT', __DIR__);
+
+$vendorPaths = [
+    __DIR__ . '/../../autoload.php',
+    __DIR__ . '/../vendor/autoload.php',
+    __DIR__ . '/vendor/autoload.php',
+];
+
+foreach ($vendorPaths as $file) {
+    if (\file_exists($file)) {
+        \define('JBZOO_AUTOLOAD_FILE', $file);
+        break;
+    }
+}
+
+require_once JBZOO_AUTOLOAD_FILE;
+
+\date_default_timezone_set('UTC');
+
+(new CliApplication('CSV Blueprint', '@git-version@'))
+    ->registerCommandsByPath(PATH_ROOT . '/src/Commands', __NAMESPACE__)
+    ->setLogo(
+        <<<'EOF'
+             _____            ______ _                       _       _   
+            /  __ \           | ___ \ |                     (_)     | |  
+            | /  \/_____   __ | |_/ / |_   _  ___ _ __  _ __ _ _ __ | |_ 
+            | |   / __\ \ / / | ___ \ | | | |/ _ \ '_ \| '__| | '_ \| __|
+            | \__/\__ \\ V /  | |_/ / | |_| |  __/ |_) | |  | | | | | |_ 
+             \____/___/ \_/   \____/|_|\__,_|\___| .__/|_|  |_|_| |_|\__|
+                                                 | |                     
+                                                 |_|                     
+            EOF,
+    )
+    ->run();