Issue #50: Replace Psalm with PHPStan

.github/workflows/static-analysis.yml

@@ -0,0 +1,49 @@
+on:
+  - push
+
+name: Run PHPStan checks
+
+jobs:
+  mutation:
+    name: PHPStan ${{ matrix.php }}-${{ matrix.os }}
+
+    runs-on: ${{ matrix.os }}
+
+    strategy:
+      matrix:
+        os:
+          - ubuntu-latest
+
+        php:
+          - "8.2"
+          - "8.3"
+          - "8.4"
+
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v4
+
+      - name: Install PHP
+        uses: shivammathur/setup-php@v2
+        with:
+          php-version: "${{ matrix.php }}"
+          coverage: pcov
+          ini-values: assert.exception=1, zend.assertions=1, error_reporting=-1, log_errors_max_len=0, display_errors=On
+          tools: composer:v2, cs2pr
+
+      - name: Determine composer cache directory
+        run: echo "COMPOSER_CACHE_DIR=$(composer config cache-dir)" >> $GITHUB_ENV
+
+      - name: Cache dependencies installed with composer
+        uses: actions/cache@v4
+        with:
+          path: ${{ env.COMPOSER_CACHE_DIR }}
+          key: php${{ matrix.php }}-composer-${{ hashFiles('**/composer.json') }}
+          restore-keys: |
+            php${{ matrix.php }}-composer-
+
+      - name: Install dependencies with composer
+        run: composer install --prefer-dist --no-interaction --no-progress --optimize-autoloader --ansi
+
+      - name: Run static analysis with PHPStan
+        run:  vendor/bin/phpstan analyse

README.md

@@ -9,15 +9,16 @@ Documentation is available at: https://docs.dotkernel.org/dot-errorhandler/
 ## Badges
 
 ![OSS Lifecycle](https://img.shields.io/osslifecycle/dotkernel/dot-errorhandler)
-![PHP from Packagist (specify version)](https://img.shields.io/packagist/php-v/dotkernel/dot-errorhandler/4.2.0)
+![PHP from Packagist (specify version)](https://img.shields.io/packagist/php-v/dotkernel/dot-errorhandler/4.3.0)
 
 [![GitHub issues](https://img.shields.io/github/issues/dotkernel/dot-errorhandler)](https://github.com/dotkernel/dot-errorhandler/issues)
 [![GitHub forks](https://img.shields.io/github/forks/dotkernel/dot-errorhandler)](https://github.com/dotkernel/dot-errorhandler/network)
 [![GitHub stars](https://img.shields.io/github/stars/dotkernel/dot-errorhandler)](https://github.com/dotkernel/dot-errorhandler/stargazers)
 [![GitHub license](https://img.shields.io/github/license/dotkernel/dot-errorhandler)](https://github.com/dotkernel/dot-errorhandler/blob/4.1/LICENSE)
 
 [![Build Static](https://github.com/dotkernel/dot-errorhandler/actions/workflows/continuous-integration.yml/badge.svg?branch=4.1)](https://github.com/dotkernel/dot-errorhandler/actions/workflows/continuous-integration.yml)
-[![codecov](https://codecov.io/gh/dotkernel/dot-errorhandler/branch/4.0/graph/badge.svg?token=0KIJARS5RS)](https://codecov.io/gh/dotkernel/dot-errorhandler)
+[![codecov](https://codecov.io/gh/dotkernel/dot-errorhandler/branch/4.1/graph/badge.svg?token=0KIJARS5RS)](https://codecov.io/gh/dotkernel/dot-errorhandler)
+[![PHPStan](https://github.com/dotkernel/dot-errorhandler/actions/workflows/static-analysis.yml/badge.svg?branch=4.1)](https://github.com/dotkernel/dot-errorhandler/actions/workflows/static-analysis.yml)
 
 ## Adding the error handler
 

composer.json

@@ -34,8 +34,9 @@
     "require-dev": {
         "laminas/laminas-coding-standard": "^3.0.1",
         "mikey179/vfsstream": "^1.6.12",
-        "phpunit/phpunit": "^10.5.45",
-        "vimeo/psalm": "6.6.2"
+        "phpstan/phpstan": "^2.1",
+        "phpstan/phpstan-phpunit": "^2.0",
+        "phpunit/phpunit": "^10.5.45"
     },
     "autoload": {
         "psr-4": {
@@ -57,6 +58,6 @@
         "cs-check": "phpcs",
         "cs-fix": "phpcbf",
         "test": "phpunit --colors=always",
-        "static-analysis": "psalm --shepherd --stats"
+        "static-analysis": "phpstan analyse --memory-limit 1G"
     }
 }

docs/book/v3/overview.md

@@ -4,3 +4,17 @@
 
 - `Dot\ErrorHandler\ErrorHandler`, same as the Zend Expressive error handling class with the only difference being the removal of the `final` statement for making extension possible
 - `Dot\ErrorHandler\LogErrorHandler` adds logging support to the default `ErrorHandler` class
+
+## Badges
+
+![OSS Lifecycle](https://img.shields.io/osslifecycle/dotkernel/dot-errorhandler)
+![PHP from Packagist (specify version)](https://img.shields.io/packagist/php-v/dotkernel/dot-errorhandler/4.3.0)
+
+[![GitHub issues](https://img.shields.io/github/issues/dotkernel/dot-errorhandler)](https://github.com/dotkernel/dot-errorhandler/issues)
+[![GitHub forks](https://img.shields.io/github/forks/dotkernel/dot-errorhandler)](https://github.com/dotkernel/dot-errorhandler/network)
+[![GitHub stars](https://img.shields.io/github/stars/dotkernel/dot-errorhandler)](https://github.com/dotkernel/dot-errorhandler/stargazers)
+[![GitHub license](https://img.shields.io/github/license/dotkernel/dot-errorhandler)](https://github.com/dotkernel/dot-errorhandler/blob/4.1/LICENSE)
+
+[![Build Static](https://github.com/dotkernel/dot-errorhandler/actions/workflows/continuous-integration.yml/badge.svg?branch=4.1)](https://github.com/dotkernel/dot-errorhandler/actions/workflows/continuous-integration.yml)
+[![codecov](https://codecov.io/gh/dotkernel/dot-errorhandler/branch/4.1/graph/badge.svg?token=0KIJARS5RS)](https://codecov.io/gh/dotkernel/dot-errorhandler)
+[![PHPStan](https://github.com/dotkernel/dot-errorhandler/actions/workflows/static-analysis.yml/badge.svg?branch=4.1)](https://github.com/dotkernel/dot-errorhandler/actions/workflows/static-analysis.yml)

phpstan.neon

@@ -0,0 +1,8 @@
+includes:
+    - vendor/phpstan/phpstan-phpunit/extension.neon
+parameters:
+    level: 5
+    paths:
+        - src
+        - test
+    treatPhpDocTypesAsCertain: false

src/Extra/Processor/AbstractProcessor.php

@@ -61,8 +61,8 @@ public function replaceInlineCookieValues(ReplacementStrategy $replacementStrate
             '/([^=\s;]+)=([^;]*)/',
             fn (array $matches): string => sprintf(
                 '%s=%s',
-                $matches[1] ?? '',
-                $this->replace($replacementStrategy, $matches[2] ?? '')
+                $matches[1],
+                $this->replace($replacementStrategy, $matches[2])
             ),
             $header
         );

src/LogErrorHandler.php

@@ -140,27 +140,27 @@ public function provideExtra(Throwable $throwable, ServerRequestInterface $reque
         ];
 
         if ($this->extraProvider?->getCookie()->isEnabled()) {
-            $extra['cookie'] = $this->extraProvider?->getCookie()->provide($request->getCookieParams());
+            $extra['cookie'] = $this->extraProvider->getCookie()->provide($request->getCookieParams());
         }
 
         if ($this->extraProvider?->getHeader()->isEnabled()) {
-            $extra['header'] = $this->extraProvider?->getHeader()->provide($request->getHeaders());
+            $extra['header'] = $this->extraProvider->getHeader()->provide($request->getHeaders());
         }
 
         if ($this->extraProvider?->getRequest()->isEnabled()) {
-            $extra['request'] = $this->extraProvider?->getRequest()->provide((array) $request->getParsedBody());
+            $extra['request'] = $this->extraProvider->getRequest()->provide((array) $request->getParsedBody());
         }
 
         if ($this->extraProvider?->getServer()->isEnabled()) {
-            $extra['server'] = $this->extraProvider?->getServer()->provide($request->getServerParams());
+            $extra['server'] = $this->extraProvider->getServer()->provide($request->getServerParams());
         }
 
         if ($this->extraProvider?->getSession()->isEnabled()) {
-            $extra['session'] = $this->extraProvider?->getSession()->provide($_SESSION ?? []);
+            $extra['session'] = $this->extraProvider->getSession()->provide($_SESSION ?? []);
         }
 
         if ($this->extraProvider?->getTrace()->isEnabled()) {
-            $extra['trace'] = $this->extraProvider?->getTrace()->provide($throwable->getTrace());
+            $extra['trace'] = $this->extraProvider->getTrace()->provide($throwable->getTrace());
         }
 
         return $extra;

test/ErrorHandlerFactoryTest.php

@@ -45,7 +45,7 @@ public function testWillCreateWithDefaultOption(): void
             ->willReturn($this->responseFactory);
 
         $result = (new ErrorHandlerFactory())($this->container);
-        $this->assertInstanceOf(ErrorHandler::class, $result);
+        $this->assertSame(ErrorHandler::class, $result::class);
     }
 
     /**
@@ -66,6 +66,6 @@ public function testWillCreateWithErrorResponseGenerator(): void
             ]);
 
         $result = (new ErrorHandlerFactory())($this->container);
-        $this->assertInstanceOf(ErrorHandler::class, $result);
+        $this->assertSame(ErrorHandler::class, $result::class);
     }
 }

test/ErrorHandlerTest.php

@@ -51,7 +51,7 @@ public function setUp(): void
 
     public function testWillCreateWithDefaultParameters(): void
     {
-        $this->assertInstanceOf(Subject::class, $this->subject);
+        $this->assertContainsOnlyInstancesOf(Subject::class, [$this->subject]);
     }
 
     public function testCreateErrorHandlerReturnsCallable(): void
@@ -112,7 +112,7 @@ public function testHandleThrowable(): void
 
         $response = ($this->errorResponseGenerator)($this->exception, $this->serverRequest, ($this->responseFactory)());
 
-        $this->assertInstanceOf(ResponseInterface::class, $response);
+        $this->assertContainsOnlyInstancesOf(ResponseInterface::class, [$response]);
     }
 
     public function testErrorHandlingTriggersListeners(): void

test/LogErrorHandlerTest.php

@@ -71,7 +71,7 @@ public function setUp(): void
 
     public function testWillCreateWithDefaultParameters(): void
     {
-        $this->assertInstanceOf(Subject::class, $this->subject);
+        $this->assertContainsOnlyInstancesOf(Subject::class, [$this->subject]);
     }
 
     public function testCreateErrorHandlerReturnsCallable(): void
@@ -104,7 +104,7 @@ public function testLogErrorHandlerWillInitiateWhenExtraProviderIsMissing(): voi
             new Logger($this->getConfig()),
         );
 
-        $this->assertInstanceOf(LogErrorHandler::class, $logErrorHandler);
+        $this->assertSame(LogErrorHandler::class, $logErrorHandler::class);
         $this->assertNull($logErrorHandler->getExtraProvider());
     }
 
@@ -120,7 +120,7 @@ public function testLogErrorHandlerWillInitiateWhenExtraProviderIsNull(): void
             null
         );
 
-        $this->assertInstanceOf(LogErrorHandler::class, $logErrorHandler);
+        $this->assertSame(LogErrorHandler::class, $logErrorHandler::class);
         $this->assertNull($logErrorHandler->getExtraProvider());
     }
 
@@ -136,7 +136,7 @@ public function testLogErrorHandlerWillInitiateWhenExtraProviderIsProvided(): vo
             new ExtraProvider()
         );
 
-        $this->assertInstanceOf(LogErrorHandler::class, $logErrorHandler);
+        $this->assertSame(LogErrorHandler::class, $logErrorHandler::class);
         $this->assertInstanceOf(ExtraProvider::class, $logErrorHandler->getExtraProvider());
     }
 
@@ -255,7 +255,7 @@ public function testHandleThrowable(): void
 
         $response = $responseGenerator($this->exception, $this->serverRequest, ($this->responseFactory)());
 
-        $this->assertInstanceOf(ResponseInterface::class, $response);
+        $this->assertContainsOnlyInstancesOf(ResponseInterface::class, [$response]);
     }
 
     public function testErrorHandlingTriggersListeners(): void