qa/workflow-improvements (#40)

* Mark package as abandoned and update README with new package info.

The `composer.json` now indicates that `dropelikeit/laravel-responsefactory` is abandoned. The README advises users to transition to a new package that offers additional functions, and support will extend only until Laravel 11's end.

* Add .php-cs-fixer.cache to .gitignore

Ignore the cache file generated by PHP-CS-Fixer to prevent unintentional version control. This helps maintain a clean repository, avoiding unnecessary files from being tracked.

* Enable cache directory assertion

Re-enable the assertion to ensure the cache directory is a non-empty string. This change helps prevent potential errors related to invalid cache directory configurations. Adjustments improve code reliability and enforce stricter input validation.

* Remove unnecessary assertion from cache directory setup

The assertion ensuring the cache directory is not empty has been removed to simplify the code, as its necessity was reevaluated. A comment has been added to suppress PHPStan warnings on this line, ensuring the codebase remains free of analysis errors.

* Update dependencies and add PHP 8.4 workflow

Upgraded versions of Psalm, its Laravel plugin, and Infection in `composer.json`. Simplified PHP CS Fixer command in the CI workflow. Added a new workflow to support testing and analysis for PHP 8.4.

* Update infection/infection version constraint in composer.json

Allow compatibility with both 0.27.10 and ^0.29.10 versions. This change ensures greater flexibility in dependency resolution while maintaining support for specific versions.

* Update Psalm dependency to support version 5.x

This change ensures compatibility with both Psalm 5.x and 6.x. It provides greater flexibility for projects that rely on older versions of Psalm while maintaining support for the latest version.

.github/workflows/ci.yml

@@ -77,7 +77,7 @@ jobs:
         run: "composer test-coverage"
 
       - name: "Run PHP CS Check"
-        run: "PHP_CS_FIXER_IGNORE_ENV=1 composer cs-check"
+        run: "composer cs-check"
 
       - name: "Run PHPStan"
         run: "composer analyze"
@@ -119,7 +119,7 @@ jobs:
         run: "composer test-coverage"
 
       - name: "Run PHP CS Check"
-        run: "PHP_CS_FIXER_IGNORE_ENV=1 composer cs-check"
+        run: "composer cs-check"
 
       - name: "Run PHPStan"
         run: "composer analyze"
@@ -133,4 +133,46 @@ jobs:
       - name: "Run infection"
         env:
           INFECTION_BADGE_API_KEY: ${{ secrets.STRYKER_DASHBOARD_API_KEY }}
+        run: "composer infection-ci"
+
+  php84:
+    name: PHP 8.4
+    runs-on: ubuntu-latest
+    steps:
+      - name: "Checkout"
+        uses: "actions/checkout@v4"
+        with:
+          fetch-depth: 2
+
+      - name: "Install PHP 8.4"
+        uses: "shivammathur/setup-php@v2"
+        with:
+          php-version: "8.4"
+
+      - name: "Cache composer packages"
+        uses: "actions/cache@v4"
+        with:
+          path: "vendor"
+          key: "php-composer-locked-php-8.4-${{ hashFiles('**/composer.lock') }}"
+          restore-keys: "php-composer-locked-php-8.3-"
+
+      - name: "Install dependencies with composer"
+        run: "composer install --no-interaction --prefer-dist"
+
+      - name: "Run PHPUnit Tests"
+        run: "composer test-coverage"
+
+      - name: "Run PHP CS Check"
+        run: "PHP_CS_FIXER_IGNORE_ENV=1 composer cs-check"
+
+      - name: "Run PHPStan"
+        run: "composer analyze"
+
+      - name: "Run Psalm"
+        run: "composer psalm"
+
+      - name: "PHP Lint"
+        run: "composer lint"
+
+      - name: "Run infection"
         run: "composer infection-ci"

.gitignore

@@ -1,5 +1,6 @@
 # PHPUnit specific
 .phpunit.result.cache
+.php-cs-fixer.cache
 
 # Composer
 /vendor/

README.md

@@ -17,6 +17,9 @@ JMS-Serializer: https://github.com/schmittjoh/serializer
 
 You are also welcome to use the Issue Tracker to set bugs, improvements or upgrade requests.
 
+> Please use the new package https://github.com/Dropelikeit/laravel-responsefactory in the future. The new package contains some new and useful functions!
+This package will only be supported until the end of Laravel 11. Until then, you should use the new package.
+
 ### Installation
 
 ``` composer require dropelikeit/laravel-jms-serializer ```

composer.json

@@ -4,6 +4,7 @@
   "keywords": ["Lumen", "Laravel", "JMS Serializer", "JMS"],
   "minimum-stability": "stable",
   "license": "MIT",
+  "abandoned": "dropelikeit/laravel-responsefactory",
   "authors": [
     {
       "name": "Marcel Strahl",
@@ -44,10 +45,10 @@
     "phpstan/phpstan-phpunit": "^1.3",
     "php-parallel-lint/php-parallel-lint": "^1.3",
     "symfony/cache": "^6.3|^7.0",
-    "vimeo/psalm": "^5.23",
-    "psalm/plugin-laravel": "^2.10",
+    "vimeo/psalm": "^5.0|^6.0",
+    "psalm/plugin-laravel": "^2.11",
     "psalm/plugin-phpunit": "^0.19",
-    "infection/infection": "^0.27.10",
+    "infection/infection": "0.27.10|^0.29.10",
     "laravel/framework": "^10.0|^v11.0"
   },
   "scripts": {

src/Config/Config.php

@@ -45,8 +45,8 @@ private function __construct(
         array $customHandlers,
     ) {
         $cacheDir = sprintf('%s%s', $cacheDir, self::CACHE_DIR);
-        #Assert::stringNotEmpty($cacheDir);
 
+        // @phpstan-ignore-next-line
         $this->cacheDir = $cacheDir;
         $this->customHandlers = $customHandlers;
     }