Issue#45: Replace Psalm with PHPStan

Signed-off-by: horea <horea@rospace.com>

Author: Howriq

.github/workflows/static-analysis.yml

@@ -0,0 +1,50 @@
+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.1"
+          - "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

@@ -14,7 +14,7 @@ It is more lightweight though, but supports controller plugins and event listene
 
 [![Build Static](https://github.com/dotkernel/dot-controller/actions/workflows/continuous-integration.yml/badge.svg?branch=4.0)](https://github.com/dotkernel/dot-controller/actions/workflows/continuous-integration.yml)
 [![codecov](https://codecov.io/gh/dotkernel/dot-controller/graph/badge.svg?token=VUBG5LM4CK)](https://codecov.io/gh/dotkernel/dot-controller)
-
+[![PHPStan](https://github.com/dotkernel/dot-controller/actions/workflows/static-analysis.yml/badge.svg?branch=4.0)](https://github.com/dotkernel/dot-controller/actions/workflows/static-analysis.yml)
 ## Installation
 
 Install `dot-controller` by executing the following Composer command:

composer.json

@@ -28,8 +28,9 @@
     "require-dev": {
         "laminas/laminas-coding-standard": "^3.0",
         "laminas/laminas-diactoros": "^3.0",
-        "phpunit/phpunit": "^10.2",
-        "vimeo/psalm": "^6.0"
+        "phpstan/phpstan": "^2.1",
+        "phpstan/phpstan-phpunit": "^2.0",
+        "phpunit/phpunit": "^10.2"
     },
     "autoload": {
         "psr-4": {
@@ -50,8 +51,7 @@
         "cs-check": "phpcs",
         "cs-fix": "phpcbf",
         "test": "phpunit --colors=always",
-        "test-coverage": "phpunit --colors=always --coverage-clover clover.xml",
-        "static-analysis": "psalm --shepherd --stats"
+        "static-analysis": "phpstan analyse --memory-limit 1G"
     },
     "config": {
         "sort-packages": true,

phpstan.neon

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

psalm.xml

@@ -28,7 +28,7 @@ public function testNonExistingActionWillReturnResponse(): void
         };
 
         $response = $subject->process($request, $handler);
-        $this->assertInstanceOf(ResponseInterface::class, $response);
+        $this->assertContainsOnlyInstancesOf(ResponseInterface::class, [$response]);
     }
 
     /**
@@ -49,6 +49,6 @@ public function indexAction(): ResponseInterface
         };
 
         $response = $subject->process($request, $handler);
-        $this->assertInstanceOf(ResponseInterface::class, $response);
+        $this->assertContainsOnlyInstancesOf(ResponseInterface::class, [$response]);
     }
 }

test/AbstractActionControllerTest.php

@@ -73,7 +73,5 @@ public function testAttachControllerListeners(): void
             ->with($this->isInstanceOf(ControllerEventListenerInterface::class), 1);
 
         $this->subject->attachControllerListeners($this->container, $this->controller);
-
-        $this->assertTrue(true);
     }
 }

test/Factory/ControllerEventListenersInitializerTest.php

@@ -60,7 +60,7 @@ public function testInvokeWithUrlHelper(): void
 
         $pluginManager = $this->subject->__invoke($this->container);
 
-        $this->assertInstanceOf(PluginManager::class, $pluginManager);
+        $this->assertContainsOnlyInstancesOf(PluginManager::class, [$pluginManager]);
         $this->assertTrue($pluginManager->has('url'));
         $this->assertFalse($pluginManager->has('template'));
         $this->assertInstanceOf(UrlHelperPlugin::class, $pluginManager->get('url'));
@@ -91,7 +91,7 @@ public function testInvokeWithTemplateRenderer(): void
 
         $pluginManager = $this->subject->__invoke($this->container);
 
-        $this->assertInstanceOf(PluginManager::class, $pluginManager);
+        $this->assertContainsOnlyInstancesOf(PluginManager::class, [$pluginManager]);
         $this->assertTrue($pluginManager->has('template'));
         $this->assertFalse($pluginManager->has('url'));
         $this->assertInstanceOf(TemplatePlugin::class, $pluginManager->get('template'));