Upgrade to PHPStan 2 (#47)

Author: Slamdunk

.gitattributes

@@ -4,6 +4,8 @@
 /.gitignore                     export-ignore
 /.php-cs-fixer.php              export-ignore
 /Makefile                       export-ignore
+/Dockerfile                     export-ignore
+/docker-compose.yml             export-ignore
 /composer-require-checker.json  export-ignore
 /phpstan-baseline.neon          export-ignore
 /phpstan.neon                   export-ignore

.gitignore

@@ -2,6 +2,7 @@
 /.phpunit.cache/
 /vendor/
 /coverage/
+/.env
 /.php-cs-fixer.cache
 /.phpunit.result.cache
 /composer.lock

Dockerfile

@@ -0,0 +1,13 @@
+FROM php:8.3
+
+ADD --chmod=0755 https://github.com/mlocati/docker-php-extension-installer/releases/latest/download/install-php-extensions /usr/local/bin/
+
+RUN install-php-extensions @composer pcov
+
+ARG USER_ID
+ARG GROUP_ID
+
+RUN groupadd --gid ${GROUP_ID} code \
+    && useradd --create-home --shell /bin/bash --uid ${USER_ID} --gid code code
+
+USER code

Makefile

@@ -1,23 +1,29 @@
-CSFIX_PHP_BIN=PHP_CS_FIXER_IGNORE_ENV=1 php8.2
-PHP_BIN=php8.2 -d zend.assertions=1
-COMPOSER_BIN=$(shell command -v composer)
+ifdef CI
+	DOCKER_PHP_EXEC :=
+else
+	DOCKER_PHP_EXEC := docker compose run --rm php
+endif
 
 all: csfix static-analysis test
 	@echo "Done."
 
-vendor: composer.json
-	$(PHP_BIN) $(COMPOSER_BIN) update
-	$(PHP_BIN) $(COMPOSER_BIN) bump
-	touch vendor
+.env: /etc/passwd /etc/group Makefile
+	printf "USER_ID=%s\nGROUP_ID=%s\n" `id --user "${USER}"` `id --group "${USER}"` > .env
+
+vendor: .env docker-compose.yml Dockerfile composer.json
+	docker compose build --pull
+	$(DOCKER_PHP_EXEC) composer update
+	$(DOCKER_PHP_EXEC) composer bump
+	touch --no-create $@
 
 .PHONY: csfix
 csfix: vendor
-	$(CSFIX_PHP_BIN) vendor/bin/php-cs-fixer fix -v $(arg)
+	$(DOCKER_PHP_EXEC) vendor/bin/php-cs-fixer fix -v $(arg)
 
 .PHONY: static-analysis
 static-analysis: vendor
-	$(PHP_BIN) vendor/bin/phpstan analyse $(PHPSTAN_ARGS)
+	$(DOCKER_PHP_EXEC) php -d zend.assertions=1 vendor/bin/phpstan analyse $(PHPSTAN_ARGS)
 
 .PHONY: test
 test: vendor
-	$(PHP_BIN) vendor/bin/phpunit $(PHPUNIT_ARGS)
+	$(DOCKER_PHP_EXEC) php -d zend.assertions=1 vendor/bin/phpunit $(PHPUNIT_ARGS)

composer.json

@@ -14,11 +14,11 @@
         "php": "~8.3.0 || ~8.4.0"
     },
     "require-dev": {
-        "phpstan/phpstan": "^1.12.9",
-        "phpstan/phpstan-phpunit": "^1.4.0",
-        "phpstan/phpstan-strict-rules": "^1.6.1",
+        "phpstan/phpstan": "^2",
+        "phpstan/phpstan-phpunit": "^2",
+        "phpstan/phpstan-strict-rules": "^2",
         "phpunit/phpunit": "^11.4.3",
-        "slam/php-cs-fixer-extensions": "^3.12.0",
+        "slam/php-cs-fixer-extensions": "^3.12",
         "symfony/console": "^7.1.7"
     },
     "autoload": {

docker-compose.yml

@@ -0,0 +1,10 @@
+services:
+  php:
+    build:
+      context: .
+      args:
+        USER_ID: ${USER_ID}
+        GROUP_ID: ${GROUP_ID}
+    volumes:
+      - .:${PWD}
+    working_dir: ${PWD}

lib/ErrorHandler.php

@@ -246,8 +246,8 @@ public function exceptionHandler(Throwable $exception): void
 
                 $this->outputError(\PHP_EOL);
                 $this->outputError(\sprintf('<error> %s </error>', \str_repeat(' ', $width)));
-                foreach ($lines as $line) {
-                    $this->outputError(\sprintf('<error> %s%s </error>', $line, \str_repeat(' ', \max(0, $width - \strlen($line)))));
+                foreach ($lines as $line2) {
+                    $this->outputError(\sprintf('<error> %s%s </error>', $line2, \str_repeat(' ', \max(0, $width - \strlen($line2)))));
                 }
                 $this->outputError(\sprintf('<error> %s </error>', \str_repeat(' ', $width)));
                 $this->outputError(\PHP_EOL);

phpstan-baseline.neon

@@ -1,22 +1,62 @@
 parameters:
 	ignoreErrors:
 		-
-			message: "#^Expression \"\\$arrayPerVerificaErrori\\['undefined_index'\\]\" on a separate line does not do anything\\.$#"
+			message: '#^Parameter \#1 \$search of function str_replace expects array\<string\>\|string, mixed given\.$#'
+			identifier: argument.type
+			count: 1
+			path: lib/ErrorHandler.php
+
+		-
+			message: '#^Parameter \#2 \$array of function implode expects array\<string\>, mixed given\.$#'
+			identifier: argument.type
+			count: 1
+			path: lib/ErrorHandler.php
+
+		-
+			message: '#^Parameter \#2 \$array of function implode expects array\|null, mixed given\.$#'
+			identifier: argument.type
+			count: 1
+			path: lib/ErrorHandler.php
+
+		-
+			message: '#^Parameter \#3 \.\.\.\$values of function sprintf expects bool\|float\|int\|string\|null, mixed given\.$#'
+			identifier: argument.type
+			count: 1
+			path: lib/ErrorHandler.php
+
+		-
+			message: '#^Expression "\$arrayPerVerificaErrori\[''undefined_index''\]" on a separate line does not do anything\.$#'
+			identifier: expr.resultUnused
 			count: 1
 			path: tests/ErrorHandlerTest.php
 
 		-
-			message: "#^Expression \"@\\$arrayPerVerificaErrori\\['no_exception_thrown_on_undefined_index_now'\\]\" on a separate line does not do anything\\.$#"
+			message: '#^Expression "@\$arrayPerVerificaErrori\[''no_exception_thrown_on_undefined_index_now''\]" on a separate line does not do anything\.$#'
+			identifier: expr.resultUnused
 			count: 1
 			path: tests/ErrorHandlerTest.php
 
 		-
-			message: "#^Offset 'no_exception_thrown…' does not exist on array\\{\\}\\.$#"
+			message: '#^Offset ''no_exception_thrown_on_undefined_index_now'' does not exist on array\{\}\.$#'
+			identifier: offsetAccess.notFound
 			count: 1
 			path: tests/ErrorHandlerTest.php
 
 		-
-			message: "#^Offset 'undefined_index' does not exist on array\\{\\}\\.$#"
+			message: '#^Offset ''undefined_index'' does not exist on array\{\}\.$#'
+			identifier: offsetAccess.notFound
 			count: 1
 			path: tests/ErrorHandlerTest.php
 
+		-
+			message: '#^Parameter \#1 \$needle of static method PHPUnit\\Framework\\Assert\:\:assertStringContainsString\(\) expects string, mixed given\.$#'
+			identifier: argument.type
+			count: 2
+			path: tests/ErrorHandlerTest.php
+
+		-
+			message: '#^Parameter \#1 \$needle of static method PHPUnit\\Framework\\Assert\:\:assertStringNotContainsString\(\) expects string, mixed given\.$#'
+			identifier: argument.type
+			count: 2
+			path: tests/ErrorHandlerTest.php
+

tests/ErrorHandlerTest.php

@@ -19,6 +19,7 @@ final class ErrorHandlerTest extends TestCase
     /** @var list<array{subject: string, body: string}> */
     private array $emailsSent = [];
     private ErrorHandler $errorHandler;
+    private bool $unregister = false;
 
     protected function setUp(): void
     {
@@ -44,6 +45,10 @@ protected function tearDown(): void
         \putenv('COLUMNS');
         \ini_set('error_log', $this->backupErrorLog);
         @\unlink($this->errorLog);
+        if ($this->unregister) {
+            \restore_exception_handler();
+            \restore_error_handler();
+        }
     }
 
     public function testDefaultConfiguration(): void
@@ -76,6 +81,7 @@ public function testRegisterBuiltinHandlers(): void
     {
         \error_reporting(\E_ALL);
         $this->errorHandler->register();
+        $this->unregister       = true;
         $arrayPerVerificaErrori = [];
 
         @ $arrayPerVerificaErrori['no_exception_thrown_on_undefined_index_now'];
@@ -96,6 +102,7 @@ public function testScream(): void
 
         \error_reporting(\E_ALL);
         $this->errorHandler->register();
+        $this->unregister = true;
 
         @ \trigger_error(\uniqid('deprecated_'), \E_USER_DEPRECATED);