Merge pull request #528 from dotkernel/issue-526

Composer post install script

Author: arhimede

.github/workflows/codecov.yml

@@ -44,12 +44,6 @@ jobs:
       - name: Install dependencies with composer
         run: composer install --prefer-dist --no-interaction --no-progress --optimize-autoloader --ansi
 
-      - name: Setup project
-        run: |
-          mv config/autoload/local.php.dist config/autoload/local.php
-          mv config/autoload/mail.local.php.dist config/autoload/mail.local.php
-          mv config/autoload/local.test.php.dist config/autoload/local.test.php
-
       - name: Collect code coverage with PHPUnit
         run: vendor/bin/phpunit --colors=always --coverage-clover clover.xml
 

.github/workflows/static-analysis.yml

@@ -44,11 +44,5 @@ jobs:
       - name: Install dependencies with composer
         run: composer install --prefer-dist --no-interaction --no-progress --optimize-autoloader --ansi
 
-      - name: Setup project
-        run: |
-          mv config/autoload/local.php.dist config/autoload/local.php
-          mv config/autoload/mail.local.php.dist config/autoload/mail.local.php
-          mv config/autoload/local.test.php.dist config/autoload/local.test.php
-
       - name: Run static analysis with PHPStan
         run:  vendor/bin/phpstan analyse

.laminas-ci/pre-run.sh

@@ -9,7 +9,6 @@ if [[ ${COMMAND} =~ phpunit ]];then
   apt-get install php"${PHP_VERSION}"-sqlite3
 
   cp config/autoload/local.php.dist config/autoload/local.php
-  cp config/autoload/mail.local.php.dist config/autoload/mail.local.php
   cp config/autoload/local.test.php.dist config/autoload/local.test.php
 
 fi

bin/composer-post-install-script.php

@@ -0,0 +1,52 @@
+<?php
+
+declare(strict_types=1);
+
+const ENVIRONMENT_DEVELOPMENT = 'development';
+const ENVIRONMENT_PRODUCTION  = 'production';
+
+// phpcs:disable PSR1.Files.SideEffects.FoundWithSymbols
+
+function copyFile(array $file): void
+{
+    if (is_readable($file['destination'])) {
+        echo "File {$file['destination']} already exists." . PHP_EOL;
+    } else {
+        if (! in_array(getEnvironment(), $file['environment'])) {
+            echo "Skipping the copy of {$file['source']} due to environment settings." . PHP_EOL;
+        } else {
+            if (! copy($file['source'], $file['destination'])) {
+                echo "Cannot copy {$file['source']} file to {$file['destination']}" . PHP_EOL;
+            } else {
+                echo "File {$file['source']} copied successfully to {$file['destination']}." . PHP_EOL;
+            }
+        }
+    }
+}
+
+function getEnvironment(): string
+{
+    return file_exists('config/autoload/development.local.php') ? ENVIRONMENT_DEVELOPMENT : ENVIRONMENT_PRODUCTION;
+}
+
+// when adding files to the below array the `source` and `destination` paths must be relative to the project root folder
+// the `environment` key will indicate on what environments the file will be copied,
+$files = [
+    [
+        'source'      => 'config/autoload/local.php.dist',
+        'destination' => 'config/autoload/local.php',
+        'environment' => [ENVIRONMENT_DEVELOPMENT, ENVIRONMENT_PRODUCTION],
+    ],
+    [
+        'source'      => 'config/autoload/local.test.php.dist',
+        'destination' => 'config/autoload/local.test.php',
+        'environment' => [ENVIRONMENT_DEVELOPMENT],
+    ],
+    [
+        'source'      => 'vendor/dotkernel/dot-mail/config/mail.global.php.dist',
+        'destination' => 'config/autoload/mail.global.php',
+        'environment' => [ENVIRONMENT_DEVELOPMENT, ENVIRONMENT_PRODUCTION],
+    ],
+];
+
+array_walk($files, 'copyFile');

composer.json

@@ -104,6 +104,9 @@
         "post-create-project-cmd": [
             "@development-enable"
         ],
+        "post-update-cmd": [
+            "php bin/composer-post-install-script.php"
+        ],
         "development-disable": "laminas-development-mode disable",
         "development-enable": "laminas-development-mode enable",
         "development-status": "laminas-development-mode status",