Refactored to use php attributes

Author: akadlec

.gitattributes

@@ -6,5 +6,3 @@
 .gitattributes export-ignore
 .gitignore export-ignore
 Makefile export-ignore
-phpcs.xml export-ignore
-phpstan.neon export-ignore

.github/workflows/ci.yaml

@@ -16,7 +16,7 @@ env:
   extensions: "json"
   cache-version: "1"
   composer-version: "v2"
-  composer-install: "composer update --no-interaction --no-progress --no-suggest --prefer-dist --prefer-stable"
+  composer-options: "--no-interaction --no-progress --no-suggest --prefer-dist --prefer-stable"
   coverage: "none"
 
 jobs:
@@ -27,12 +27,12 @@ jobs:
     strategy:
       fail-fast: false
       matrix:
-        php-version: ["8.1"]
+        php-version: ["8.1","8.2","8.3"]
         operating-system: ["ubuntu-latest"]
 
     steps:
       - name: "Checkout"
-        uses: "actions/checkout@v2"
+        uses: "actions/checkout@v4"
 
       - name: "Setup PHP cache environment"
         id: "extcache"
@@ -43,7 +43,7 @@ jobs:
           key: "${{ env.cache-version }}"
 
       - name: "Cache PHP extensions"
-        uses: "actions/cache@v2"
+        uses: "actions/cache@v4"
         with:
           path: "${{ steps.extcache.outputs.dir }}"
           key: "${{ steps.extcache.outputs.key }}"
@@ -55,27 +55,17 @@ jobs:
           php-version: "${{ matrix.php-version }}"
           extensions: "${{ env.extensions }}"
           tools: "composer:${{ env.composer-version }}, cs2pr"
-          coverage: "${{ env.coverage }}"
+          coverage: "none"
 
       - name: "Setup problem matchers for PHP"
         run: 'echo "::add-matcher::${{ runner.tool_cache }}/php.json"'
 
-      - name: "Get Composer cache directory"
-        id: "composercache"
-        run: 'echo "::set-output name=dir::$(composer config cache-files-dir)"'
-
-      - name: "Cache PHP dependencies"
-        uses: "actions/cache@v2"
+      - name: "Setup composer & install dependencies"
+        uses: "ramsey/composer-install@v2"
         with:
-          path: "${{ steps.composercache.outputs.dir }}"
-          key: "${{ runner.os }}-composer-${{ hashFiles('**/composer.json') }}"
-          restore-keys: "${{ runner.os }}-composer-"
-
-      - name: "Validate Composer"
-        run: "composer validate"
-
-      - name: "Install dependencies"
-        run: "${{ env.composer-install }}"
+          dependency-versions: "highest"
+          composer-options: "${{ env.composer-options }}"
+          custom-cache-key: "${{ runner.os }}-composer-${{ hashFiles('**/composer.json') }}"
 
       - name: "Coding Standard"
         run: "make cs"
@@ -87,12 +77,12 @@ jobs:
     strategy:
       fail-fast: false
       matrix:
-        php-version: ["8.1"]
+        php-version: ["8.1","8.2","8.3"]
         operating-system: ["ubuntu-latest"]
 
     steps:
       - name: "Checkout"
-        uses: "actions/checkout@v2"
+        uses: "actions/checkout@v4"
 
       - name: "Setup PHP cache environment"
         id: "extcache"
@@ -103,7 +93,7 @@ jobs:
           key: "${{ env.cache-version }}"
 
       - name: "Cache PHP extensions"
-        uses: "actions/cache@v2"
+        uses: "actions/cache@v4"
         with:
           path: "${{ steps.extcache.outputs.dir }}"
           key: "${{ steps.extcache.outputs.key }}"
@@ -120,19 +110,12 @@ jobs:
       - name: "Setup problem matchers for PHP"
         run: 'echo "::add-matcher::${{ runner.tool_cache }}/php.json"'
 
-      - name: "Get Composer cache directory"
-        id: "composercache"
-        run: 'echo "::set-output name=dir::$(composer config cache-files-dir)"'
-
-      - name: "Cache PHP dependencies"
-        uses: "actions/cache@v2"
+      - name: "Setup composer & install dependencies"
+        uses: "ramsey/composer-install@v2"
         with:
-          path: "${{ steps.composercache.outputs.dir }}"
-          key: "${{ runner.os }}-composer-${{ hashFiles('**/composer.json') }}"
-          restore-keys: "${{ runner.os }}-composer-"
-
-      - name: "Install dependencies"
-        run: "${{ env.composer-install }}"
+          dependency-versions: "highest"
+          composer-options: "${{ env.composer-options }}"
+          custom-cache-key: "${{ runner.os }}-composer-${{ hashFiles('**/composer.json') }}"
 
       - name: "PHPStan"
         run: "make phpstan"
@@ -145,19 +128,12 @@ jobs:
     strategy:
       fail-fast: false
       matrix:
-        php-version: ["8.1"]
+        php-version: ["8.1","8.2","8.3"]
         operating-system: ["ubuntu-latest"]
 
     steps:
       - name: "Checkout"
-        uses: "actions/checkout@v2"
-
-      - name : "Setup MySQL"
-        uses : "mirromutth/mysql-action@v1.1"
-        with :
-          mysql version : "5.7"
-          mysql database : "testdb"
-          mysql root password : "root"
+        uses: "actions/checkout@v4"
 
       - name: "Setup PHP cache environment"
         id: "extcache"
@@ -168,7 +144,7 @@ jobs:
           key: "${{ env.cache-version }}"
 
       - name: "Cache PHP extensions"
-        uses: "actions/cache@v2"
+        uses: "actions/cache@v4"
         with:
           path: "${{ steps.extcache.outputs.dir }}"
           key: "${{ steps.extcache.outputs.key }}"
@@ -185,29 +161,22 @@ jobs:
       - name: "Setup problem matchers for PHP"
         run: 'echo "::add-matcher::${{ runner.tool_cache }}/php.json"'
 
-      - name: "Get Composer cache directory"
-        id: "composercache"
-        run: 'echo "::set-output name=dir::$(composer config cache-files-dir)"'
-
-      - name: "Cache PHP dependencies"
-        uses: "actions/cache@v2"
+      - name: "Setup composer & install dependencies"
+        uses: "ramsey/composer-install@v2"
         with:
-          path: "${{ steps.composercache.outputs.dir }}"
-          key: "${{ runner.os }}-composer-${{ hashFiles('**/composer.json') }}"
-          restore-keys: "${{ runner.os }}-composer-"
-
-      - name: "Install dependencies"
-        run: "${{ env.composer-install }} ${{ matrix.composer-args }}"
+          dependency-versions: "highest"
+          composer-options: "${{ env.composer-options }}"
+          custom-cache-key: "${{ runner.os }}-composer-${{ hashFiles('**/composer.json') }}"
 
       - name: "Tests"
         run: "make tests"
 
-      - name: "Upload test output"
-        if: ${{ failure() }}
-        uses: "actions/upload-artifact@v2"
+      - name: "Upload logs"
+        uses: "actions/upload-artifact@v4"
         with:
-          name: output
-          path: tests/**/output
+          name: "Logs - Tests (${{ matrix.operating-system }}, ${{ matrix.php-version }})"
+          path: "var/log"
+          if-no-files-found: "ignore"
 
   tests-code-coverage:
     name: "Code tests with code coverage"
@@ -216,22 +185,15 @@ jobs:
 
     strategy:
       matrix:
-        php-version: ["8.1"]
+        php-version: ["8.1","8.2","8.3"]
         operating-system: ["ubuntu-latest"]
       fail-fast: false
 
     if: "github.event_name == 'push'"
 
     steps:
       - name: "Checkout"
-        uses: "actions/checkout@v2"
-
-      - name : "Setup MySQL"
-        uses : "mirromutth/mysql-action@v1.1"
-        with :
-          mysql version : "5.7"
-          mysql database : "testdb"
-          mysql root password : "root"
+        uses: "actions/checkout@v4"
 
       - name: "Setup PHP cache environment"
         id: "extcache"
@@ -242,7 +204,7 @@ jobs:
           key: "${{ env.cache-version }}"
 
       - name: "Cache PHP extensions"
-        uses: "actions/cache@v2"
+        uses: "actions/cache@v4"
         with:
           path: "${{ steps.extcache.outputs.dir }}"
           key: "${{ steps.extcache.outputs.key }}"
@@ -259,28 +221,21 @@ jobs:
       - name: "Setup problem matchers for PHP"
         run: 'echo "::add-matcher::${{ runner.tool_cache }}/php.json"'
 
-      - name: "Get Composer cache directory"
-        id: "composercache"
-        run: 'echo "::set-output name=dir::$(composer config cache-files-dir)"'
-
-      - name: "Cache PHP dependencies"
-        uses: "actions/cache@v2"
+      - name: "Setup composer & install dependencies"
+        uses: "ramsey/composer-install@v2"
         with:
-          path: "${{ steps.composercache.outputs.dir }}"
-          key: "${{ runner.os }}-composer-${{ hashFiles('**/composer.json') }}"
-          restore-keys: "${{ runner.os }}-composer-"
-
-      - name: "Install dependencies"
-        run: "${{ env.composer-install }} ${{ matrix.composer-args }}"
+          dependency-versions: "highest"
+          composer-options: "${{ env.composer-options }}"
+          custom-cache-key: "${{ runner.os }}-composer-${{ hashFiles('**/composer.json') }}"
 
       - name: "Tests"
-        run: "make coverage"
+        run: "make coverage-clover"
 
       - name: "Coveralls.io"
         env:
           CI_NAME: github
           CI: true
-          COVERALLS_REPO_TOKEN: "${{ secrets.GITHUB_TOKEN }}"
+          COVERALLS_REPO_TOKEN: ${{ secrets.GITHUB_TOKEN }}
         run: |
-          wget https://github.com/php-coveralls/php-coveralls/releases/download/v2.1.0/php-coveralls.phar
-          php php-coveralls.phar --verbose --config tests/.coveralls.yml
+          wget https://github.com/php-coveralls/php-coveralls/releases/download/v2.5.3/php-coveralls.phar
+          php php-coveralls.phar --verbose --config tools/.coveralls.yml

.gitignore

@@ -1,6 +1,5 @@
 .idea
+/var
 /vendor
 /composer.lock
-/tests/*/output
-/tests/tmp
 .DS_Store

Makefile

@@ -1,27 +1,74 @@
-.PHONY: qa lint cs csf phpstan tests coverage
+_: list
 
-all:
-	@$(MAKE) -pRrq -f $(lastword $(MAKEFILE_LIST)) : 2>/dev/null | awk -v RS= -F: '/^# File/,/^# Finished Make data base/ {if ($$1 !~ "^[#.]") {print $$1}}' | sort | egrep -v -e '^[^[:alnum:]]' -e '^$@$$' | xargs
+# Config
 
-vendor: composer.json composer.lock
-	composer install
+PHPCS_CONFIG=tools/phpcs.xml
+PHPSTAN_SRC_CONFIG=tools/phpstan.src.neon
+PHPSTAN_TESTS_CONFIG=tools/phpstan.tests.neon
+PHPUNIT_CONFIG=tools/phpunit.xml
+INFECTION_CONFIG=tools/infection.json
 
-qa: lint phpstan cs
+# QA
 
-lint: vendor
-	vendor/bin/parallel-lint --exclude .git --exclude vendor src tests
+qa: ## Check code quality - coding style and static analysis
+	make cs & make phpstan
 
-cs: vendor
-	vendor/bin/phpcs --standard=phpcs.xml src tests
+cs: ## Check PHP files coding style
+	mkdir -p var/tools/PHP_CodeSniffer
+	$(PRE_PHP) "vendor/bin/phpcs" src tests --standard=$(PHPCS_CONFIG) --parallel=$(LOGICAL_CORES) $(ARGS)
 
-csf: vendor
-	vendor/bin/phpcbf --standard=phpcs.xml src tests
+csf: ## Fix PHP files coding style
+	mkdir -p var/tools/PHP_CodeSniffer
+	$(PRE_PHP) "vendor/bin/phpcbf" src tests --standard=$(PHPCS_CONFIG) --parallel=$(LOGICAL_CORES) $(ARGS)
 
-phpstan: vendor
-	vendor/bin/phpstan analyse -c phpstan.neon src
+lint:
+	$(PRE_PHP) "vendor/bin/parallel-lint" src tests --exclude .git --exclude vendor
 
-tests: vendor
-	vendor/bin/tester -s -p php --colors 1 -C tests/cases
+phpstan: ## Analyse code with PHPStan
+	mkdir -p var/tools
+	$(PRE_PHP) "vendor/bin/phpstan" analyse -c $(PHPSTAN_SRC_CONFIG) $(ARGS)
+	$(PRE_PHP) "vendor/bin/phpstan" analyse -c $(PHPSTAN_TESTS_CONFIG) $(ARGS)
 
-coverage: vendor
-	vendor/bin/tester -s -p php --colors 1 -C --coverage ./coverage.xml --coverage-src ./src tests/cases
+# Tests
+
+.PHONY: tests
+tests: ## Run all tests
+	$(PRE_PHP) $(PHPUNIT_COMMAND) $(ARGS)
+
+coverage-clover: ## Generate code coverage in XML format
+	$(PRE_PHP) $(PHPUNIT_COVERAGE) --coverage-clover=var/coverage/clover.xml $(ARGS)
+
+coverage-html: ## Generate code coverage in HTML format
+	$(PRE_PHP) $(PHPUNIT_COVERAGE) --coverage-html=var/coverage/html $(ARGS)
+
+mutations: ## Check code for mutants
+	make mutations-tests
+	make mutations-infection
+
+mutations-tests:
+	mkdir -p var/coverage
+	$(PRE_PHP) $(PHPUNIT_COVERAGE) --coverage-xml=var/coverage/xml --log-junit=var/coverage/junit.xml
+
+mutations-infection:
+	$(PRE_PHP) vendor/bin/infection \
+		--configuration=$(INFECTION_CONFIG) \
+		--threads=$(LOGICAL_CORES) \
+		--coverage=../var/coverage \
+		--skip-initial-tests \
+		$(ARGS)
+
+# Utilities
+
+.SILENT: $(shell grep -h -E '^[a-zA-Z_-]+:.*?$$' $(MAKEFILE_LIST) | sort -u | awk 'BEGIN {FS = ":.*?"}; {printf "%s ", $$1}')
+
+LIST_PAD=20
+list:
+	awk 'BEGIN {FS = ":.*##"; printf "Usage:\n  make \033[36m<target>\033[0m\n\nTargets:\n"}'
+	grep -h -E '^[a-zA-Z_-]+:.*?## .*$$' $(MAKEFILE_LIST) | sort -u | awk 'BEGIN {FS = ":.*?## "}; {printf "  \033[36m%-$(LIST_PAD)s\033[0m %s\n", $$1, $$2}'
+
+PRE_PHP=XDEBUG_MODE=off
+
+PHPUNIT_COMMAND="vendor/bin/paratest" -c $(PHPUNIT_CONFIG) --runner=WrapperRunner -p$(LOGICAL_CORES)
+PHPUNIT_COVERAGE=php -d pcov.enabled=1 -d pcov.directory=./src $(PHPUNIT_COMMAND)
+
+LOGICAL_CORES=$(shell nproc || sysctl -n hw.logicalcpu || echo 4)