Component Template: PHP 8.5 support

.github/workflows/ci.yml

@@ -7,51 +7,59 @@ on:
     branches: [ main ]
 
 jobs:
-  build:
+  ci:
 
     runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        php-versions: [ '8.3', '8.4', '8.5' ]
 
     steps:
-      - uses: actions/checkout@v3
+      - uses: actions/checkout@v4
         with:
-          fetch-depth: 0 # To avoid "Shallow clone detected" error in SonarCloud report
+          fetch-depth: 0
 
-      - name: Validate composer.json and composer.lock
-        run: composer validate
+      #~ PHP Setup
+      - name: Setup PHP ${{ matrix.php-versions }}
+        uses: shivammathur/setup-php@v2
+        with:
+          php-version: ${{ matrix.php-versions }}
 
-      - name: Cache Composer dependencies
+      #~ Composer Cache
+      - name: Get Composer Cache Directory
         id: composer-cache
-        uses: actions/cache@v3
+        run: |
+          echo "dir=$(composer config cache-files-dir)" >> $GITHUB_OUTPUT
+
+      - uses: actions/cache@v3
         with:
-          path: /tmp/composer-cache
+          path: ${{ steps.composer-cache.outputs.dir }}
           key: ${{ runner.os }}-composer-${{ hashFiles('**/composer.lock') }}
+          restore-keys: |
+            ${{ runner.os }}-composer-
+
+      #~ Composer install
+      - name: Validate composer.json
+        run: composer validate
 
       - name: Install dependencies
         if: steps.composer-cache.outputs.cache-hit != 'true'
         run: make install
 
+      #~ CI part
+      - name: Dependencies
+        run: make php/deps
+
       - name: Check Code Style
-        run: make phpcs
+        run: make php/check
 
       - name: Units Tests
-        run: make tests
+        run: make php/tests
 
       - name: Fix unit tests report path
         run: |
           sed -i 's+'$GITHUB_WORKSPACE'+/github/workspace+g' build/reports/phpunit/clover.xml
           sed -i 's+'$GITHUB_WORKSPACE'+/github/workspace+g' build/reports/phpunit/unit.xml
 
-      - name: PHP 7.4 Compatibility
-        run: make php74compatibility
-
-      - name: PHP 8.2 Compatibility
-        run: make php82compatibility
-
       - name: PHP Static Analyze
-        run: make analyze
-
-      - name: SonarCloud Scan
-        uses: SonarSource/sonarcloud-github-action@v1.7
-        env:
-          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
-          SONAR_TOKEN: ${{ secrets.SONAR_TOKEN }}
+        run: make php/analyze

.github/workflows/sonarcloud.yml

@@ -0,0 +1,46 @@
+name: SonarQube
+
+on:
+  push:
+    branches: [ main ]
+  pull_request:
+    branches: [ main ]
+
+jobs:
+  sonarcloud:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+        with:
+          fetch-depth: 0 # To avoid "Shallow clone detected" error in SonarCloud report
+
+      #~ PHP Setup
+      - name: Setup PHP 8.3 # Minimum version
+        uses: shivammathur/setup-php@v2
+        with:
+          php-version: '8.3'
+
+      #~ Composer Cache
+      - name: Get Composer Cache Directory
+        id: composer-cache
+        run: |
+          echo "dir=$(composer config cache-files-dir)" >> $GITHUB_OUTPUT
+
+      - uses: actions/cache@v3
+        with:
+          path: ${{ steps.composer-cache.outputs.dir }}
+          key: ${{ runner.os }}-composer-${{ hashFiles('**/composer.lock') }}
+          restore-keys: |
+            ${{ runner.os }}-composer-
+
+      - name: Install dependencies
+        if: steps.composer-cache.outputs.cache-hit != 'true'
+        run: make install
+
+      - name: Units Tests
+        run: make php/tests # To generate the coverage report
+
+      - name: SonarQube Scan
+        uses: SonarSource/sonarqube-scan-action@v7
+        env:
+          SONAR_TOKEN: ${{ secrets.SONAR_TOKEN }}

.php-cs-fixer.dist.php

@@ -0,0 +1,24 @@
+<?php
+
+return (new PhpCsFixer\Config())
+    //~ Rules
+    ->setRules(
+        [
+            '@PER-CS3x0' => true,
+        ]
+    )
+
+    //~ Format
+    ->setFormat('txt')
+
+    //~ Cache
+    ->setUsingCache(true)
+    ->setCacheFile(__DIR__ . '/build/.php-cs-fixer.cache')
+
+    //~ Finder
+    ->setFinder((new PhpCsFixer\Finder())->in(
+        [
+            __DIR__ . '/src',
+            __DIR__ . '/tests',
+        ]))
+;

CHANGELOG.md

@@ -17,6 +17,18 @@ and this project adheres to [Semantic Versioning](http://semver.org/spec/v2.0.0.
 
 ----
 
+## [2.0.0] - 2026-01-05
+### Added
+- PHP 8.5 support
+### Removed
+- PHP support of versions < 8.3
+### Changed
+- Update Makefile
+- Update CI configs
+- Update dependencies
+
+----
+
 ## [1.1.0] - 2023-03-15
 ### Changed
 - Update Makefile

Makefile

@@ -1,75 +1,80 @@
-.PHONY: validate install update phpcs phpcbf php74compatibility php82compatibility phpstan analyze tests testdox ci clean
+.PHONY: validate install update php/deps php/check php/fix php/min-compatibility php/max-compatibility php/phpstan php/analyze php/tests php/test php/testdox ci clean
 
+PHP_MIN_VERSION := "8.3"
+PHP_MAX_VERSION := "8.5"
+COMPOSER_BIN := composer
 define header =
     @if [ -t 1 ]; then printf "\n\e[37m\e[100m  \e[104m $(1) \e[0m\n"; else printf "\n### $(1)\n"; fi
 endef
 
 #~ Composer dependency
 validate:
 	$(call header,Composer Validation)
-	@composer validate
+	@${COMPOSER_BIN} validate
 
 install:
 	$(call header,Composer Install)
-	@composer install
+	@${COMPOSER_BIN} install
 
 update:
 	$(call header,Composer Update)
-	@composer update
+	@${COMPOSER_BIN} update
+	@${COMPOSER_BIN} bump --dev-only
 
 composer.lock: install
 
 #~ Vendor binaries dependencies
-vendor/bin/phpcbf:
-vendor/bin/phpcs:
-vendor/bin/phpstan:
-vendor/bin/phpunit:
+vendor/bin/php-cs-fixer: composer.lock
+vendor/bin/phpstan: composer.lock
+vendor/bin/phpunit: composer.lock
 
 #~ Report directories dependencies
 build/reports/phpunit:
 	@mkdir -p build/reports/phpunit
 
-build/reports/phpcs:
-	@mkdir -p build/reports/cs
-
 build/reports/phpstan:
 	@mkdir -p build/reports/phpstan
 
 #~ main commands
-phpcs: vendor/bin/phpcs build/reports/phpcs
-	$(call header,Checking Code Style)
-	@./vendor/bin/phpcs --standard=./ci/phpcs/eureka.xml --cache=./build/cs_eureka.cache -p --report-full --report-checkstyle=./build/reports/cs/eureka.xml src/ tests/
+php/deps: composer.json
+	$(call header,Checking Dependencies)
+	@XDEBUG_MODE=off ./vendor/bin/composer-dependency-analyser --config ./ci/composer-dependency-analyser.php # for shadow, unused required dependencies and ext-* missing dependencies
 
-phpcbf: vendor/bin/phpcbf
+php/check: vendor/bin/php-cs-fixer
+	$(call header,Checking Code Style)
+	@XDEBUG_MODE=off ./vendor/bin/php-cs-fixer check
+php/fix: vendor/bin/php-cs-fixer
 	$(call header,Fixing Code Style)
-	@./vendor/bin/phpcbf --standard=./ci/phpcs/eureka.xml src/ tests/
+	@XDEBUG_MODE=off ./vendor/bin/php-cs-fixer fix -v
 
-php74compatibility: vendor/bin/phpstan build/reports/phpstan
-	$(call header,Checking PHP 7.4 compatibility)
-	@XDEBUG_MODE=off ./vendor/bin/phpstan analyse --configuration=./ci/php74-compatibility.neon --error-format=table
+php/min-compatibility: vendor/bin/phpstan build/reports/phpstan
+	$(call header,Checking PHP ${PHP_MIN_VERSION} compatibility)
+	@XDEBUG_MODE=off ./vendor/bin/phpstan analyse --configuration=./ci/phpmin-compatibility.neon --error-format=table
 
-php82compatibility: vendor/bin/phpstan build/reports/phpstan
-	$(call header,Checking PHP 8.2 compatibility)
-	@XDEBUG_MODE=off ./vendor/bin/phpstan analyse --configuration=./ci/php82-compatibility.neon --error-format=table
+php/max-compatibility: vendor/bin/phpstan build/reports/phpstan #ci
+	$(call header,Checking PHP ${PHP_MAX_VERSION} compatibility)
+	@XDEBUG_MODE=off ./vendor/bin/phpstan analyse --configuration=./ci/phpmax-compatibility.neon --error-format=table
 
-analyze: vendor/bin/phpstan build/reports/phpstan
+php/analyze: vendor/bin/phpstan build/reports/phpstan #manual & ci
 	$(call header,Running Static Analyze - Pretty tty format)
 	@XDEBUG_MODE=off ./vendor/bin/phpstan analyse --error-format=table
 
-phpstan: vendor/bin/phpstan build/reports/phpstan
-	$(call header,Running Static Analyze)
-	@XDEBUG_MODE=off ./vendor/bin/phpstan analyse --error-format=checkstyle > ./build/reports/phpstan/phpstan.xml
-
-tests: vendor/bin/phpunit build/reports/phpunit
+php/tests: vendor/bin/phpunit build/reports/phpunit #ci
 	$(call header,Running Unit Tests)
-	@XDEBUG_MODE=coverage php -dzend_extension=xdebug.so ./vendor/bin/phpunit --coverage-clover=./build/reports/phpunit/clover.xml --log-junit=./build/reports/phpunit/unit.xml --coverage-php=./build/reports/phpunit/unit.cov --coverage-html=./build/reports/coverage/ --fail-on-warning
+	@XDEBUG_MODE=coverage php ./vendor/bin/phpunit --testsuite=unit --coverage-clover=./build/reports/phpunit/clover.xml --log-junit=./build/reports/phpunit/unit.xml --coverage-php=./build/reports/phpunit/unit.cov --coverage-html=./build/reports/coverage/ --fail-on-warning
+
+php/test: php/tests
+
+php/integration: vendor/bin/phpunit build/reports/phpunit #manual
+	$(call header,Running Integration Tests)
+	@XDEBUG_MODE=coverage php -dzend_extension=xdebug.so ./vendor/bin/phpunit --testsuite=integration --fail-on-warning
 
-testdox: vendor/bin/phpunit $(PHP_FILES)
+php/testdox: vendor/bin/phpunit #manual
 	$(call header,Running Unit Tests (Pretty format))
-	@XDEBUG_MODE=coverage php -dzend_extension=xdebug.so ./vendor/bin/phpunit --fail-on-warning --testdox
+	@XDEBUG_MODE=coverage php -dzend_extension=xdebug.so ./vendor/bin/phpunit --testsuite=unit --fail-on-warning --testdox
 
 clean:
-	$(call header,Cleaning previous build)
+	$(call header,Cleaning previous build) #manual
 	@if [ "$(shell ls -A ./build)" ]; then rm -rf ./build/*; fi; echo " done"
 
-ci: clean validate install phpcs tests php74compatibility php82compatibility analyze
+ci: clean validate install php/deps php/check php/tests php/integration php/min-compatibility php/max-compatibility php/analyze

README.md

@@ -1,6 +1,6 @@
 # component-template
 [![Current version](https://img.shields.io/packagist/v/eureka/component-template.svg?logo=composer)](https://packagist.org/packages/eureka/component-template)
-[![Supported PHP version](https://img.shields.io/static/v1?logo=php&label=PHP&message=7.4%20-%208.2&color=777bb4)](https://packagist.org/packages/eureka/component-template)
+[![Supported PHP version](https://img.shields.io/static/v1?logo=php&label=PHP&message=>%3D8.3&color=777bb4)](https://packagist.org/packages/eureka/component-template)
 ![CI](https://github.com/eureka-framework/component-template/workflows/CI/badge.svg)
 [![Quality Gate Status](https://sonarcloud.io/api/project_badges/measure?project=eureka-framework_component-template&metric=alert_status)](https://sonarcloud.io/dashboard?id=eureka-framework_component-template)
 [![Coverage](https://sonarcloud.io/api/project_badges/measure?project=eureka-framework_component-template&metric=coverage)](https://sonarcloud.io/dashboard?id=eureka-framework_component-template)
@@ -53,41 +53,55 @@ NB: For the components, the `composer.lock` file is not committed.
 ### Testing & CI (Continuous Integration)
 
 #### Tests
-You can run tests (with coverage) on your side with following command:
+You can run unit tests (with coverage) on your side with following command:
 ```bash
-make tests
+make php/tests
+```
+
+You can run integration tests (without coverage) on your side with following command:
+```bash
+make php/integration
 ```
 
 For prettier output (but without coverage), you can use the following command:
 ```bash
-make testdox # run tests without coverage reports but with prettified output
+make php/testdox # run tests without coverage reports but with prettified output
 ```
 
 #### Code Style
 You also can run code style check with following commands:
 ```bash
-make phpcs
+make php/check
 ```
 
 You also can run code style fixes with following commands:
 ```bash
-make phpcbf
+make php/fix
+```
+
+#### Check for missing explicit dependencies
+You can check if any explicit dependency is missing with the following command:
+```bash
+make php/deps
 ```
 
 #### Static Analysis
 To perform a static analyze of your code (with phpstan, lvl 9 at default), you can use the following command:
 ```bash
-make analyze
+make php/analyse
 ```
 
+To ensure you code still compatible with current supported version at Deezer and futures versions of php, you need to
+run the following commands (both are required for full support):
+
 Minimal supported version:
 ```bash
-make php74compatibility
+make php/min-compatibility
 ```
 
 Maximal supported version:
 ```bash
-make php82compatibility
+make php/max-compatibility
 ```
 
 #### CI Simulation
@@ -96,7 +110,6 @@ And the last "helper" commands, you can run before commit and push, is:
 make ci  
 ```
 
-
 ## License
 
-This project is licensed under the MIT License - see the `LICENSE` file for details
+This project is currently under The MIT License (MIT). See [LICENSE](LICENSE) file for more information.

ci/composer-dependency-analyser.php

@@ -0,0 +1,10 @@
+<?php
+
+use ShipMonk\ComposerDependencyAnalyser\Config\Configuration;
+
+$config = new Configuration();
+
+return $config
+    ->addPathToScan(__DIR__ . '/../src', isDev: false)
+    ->addPathToScan(__DIR__ . '/../tests', isDev: true)
+;