Refining the Box Config and App Versioning (#41)

* Refining the Box Config and App Versioning
* Updating CI Action
* Refining the version handling
* Revert "Refining the version handling"
* Refining the version handling
* Adding tag script
* Reverting a change to the Box Config
* Minor refactoring / clean code

Author: floriankraemer

.github/workflows/ci.yaml

@@ -1,6 +1,12 @@
 name: CI
 
-on: [push, pull_request]
+on:
+  push:
+    branches:
+      - main
+  pull_request:
+    branches:
+      - '*'
 
 jobs:
   testsuite:

.github/workflows/phar-build.yaml

@@ -17,13 +17,16 @@ jobs:
     - name: Setup PHP
       uses: shivammathur/setup-php@v2
       with:
-        php-version: '8.2'
+        php-version: '8.4'
         extensions: json, fileinfo
         tools: composer
 
     - name: Install dependencies
       run: composer install --no-dev --optimize-autoloader
 
+    - name: Inject version from tag
+      run: sed -i "s/public const VERSION = .*/public const VERSION = '\${{ github.ref_name }}';/" src/Application.php
+
     - name: Build PHAR
       run: composer build-phar
 

.gitignore

@@ -10,4 +10,4 @@
 .env
 infection.log
 phive.phar
-cognitive-analysis.phar
+phpcca.phar

box.json.dist

@@ -1,8 +1,13 @@
 {
-    "main": "./bin/phpcca",
+    "main": "bin/phpcca",
     "compression": "GZ",
     "output": "phpcca.phar",
     "force-autodiscovery": true,
+    "compactors": [
+        "KevinGH\\Box\\Compactor\\Json",
+        "KevinGH\\Box\\Compactor\\Php",
+        "KevinGH\\Box\\Compactor\\PhpScoper"
+    ],
     "files": [
         "config.yml",
         "composer.json",

scripts/tag.sh

@@ -0,0 +1,10 @@
+# Get the latest tag reachable from the previous commit
+TAG=$(git describe --tags --abbrev=0 HEAD^ 2>/dev/null)
+
+if [ -n "$TAG" ]; then
+  sed -i "s/public const VERSION = .*/public const VERSION = '$TAG';/" src/Application.php
+  git add src/Application.php
+  echo "Version set to $TAG"
+else
+  echo "No previous tag found."
+fi

src/Application.php

@@ -49,6 +49,8 @@
  */
 class Application
 {
+    public const VERSION = '1.3.0';
+
     private ContainerBuilder $containerBuilder;
 
     public function __construct()
@@ -231,6 +233,10 @@ private function registerCommands(): void
     private function configureApplication(): void
     {
         $this->containerBuilder->register(SymfonyApplication::class, SymfonyApplication::class)
+            ->setArguments([
+                'Cognitive Code Analysis',
+                self::VERSION
+            ])
             ->setPublic(true)
             ->addMethodCall('add', [new Reference(CognitiveMetricsCommand::class)])
             ->addMethodCall('add', [new Reference(ChurnCommand::class)]);

src/Command/EventHandler/VerboseHandler.php

@@ -25,10 +25,7 @@ public function __construct(
 
     public function __invoke(SourceFilesFound|FileProcessed $event): void
     {
-        if (
-            $this->input->hasOption(CognitiveMetricsCommand::OPTION_DEBUG)
-                && $this->input->getOption(CognitiveMetricsCommand::OPTION_DEBUG) === false
-        ) {
+        if (!$this->isDebugEnabled()) {
             return;
         }
 
@@ -62,4 +59,13 @@ private function formatBytes(int $size): string
 
         return round($size, 2) . ' ' . $units[$index];
     }
+
+    /**
+     * @return bool
+     */
+    public function isDebugEnabled(): bool
+    {
+        return $this->input->hasOption(CognitiveMetricsCommand::OPTION_DEBUG)
+            && $this->input->getOption(CognitiveMetricsCommand::OPTION_DEBUG) === false;
+    }
 }