Merge pull request dotkernel#46 from Howriq/Issue-#45

alexmerlin · web-flow · commit 5a40757f5050 · 2025-02-28T07:46:51.000+02:00
Issue#45: Replace Psalm with PHPStan
diff --git a/.github/workflows/static-analysis.yml b/.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
diff --git a/README.md b/README.md
@@ -4,8 +4,14 @@ This is Dotkernel's controller package that can be use like middleware inside Do
 It provides base classes for action based controllers similar to Laminas controller component.
 It is more lightweight though, but supports controller plugins and event listeners.
 
+## Documentation
+
+Documentation is available at: https://docs.dotkernel.org/dot-controller/.
+
+## Badges
+
 ![OSS Lifecycle](https://img.shields.io/osslifecycle/dotkernel/dot-controller)
-![PHP from Packagist (specify version)](https://img.shields.io/packagist/php-v/dotkernel/dot-controller/4.0.1)
+![PHP from Packagist (specify version)](https://img.shields.io/packagist/php-v/dotkernel/dot-controller/4.1.0)
 
 [![GitHub issues](https://img.shields.io/github/issues/dotkernel/dot-controller)](https://github.com/dotkernel/dot-controller/issues)
 [![GitHub forks](https://img.shields.io/github/forks/dotkernel/dot-controller)](https://github.com/dotkernel/dot-controller/network)
@@ -14,6 +20,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
 
diff --git a/composer.json b/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,
diff --git a/docs/book/v4/overview.md b/docs/book/v4/overview.md
@@ -3,3 +3,17 @@
 `dot-controller` is Dotkernel's controller package that can be use like middleware inside Dotkernel or Mezzio application.
 It provides base classes for action based controllers similar to Laminas controller component.
 It is more lightweight though, but supports controller plugins and event listeners.
+
+## Badges
+
+![OSS Lifecycle](https://img.shields.io/osslifecycle/dotkernel/dot-controller)
+![PHP from Packagist (specify version)](https://img.shields.io/packagist/php-v/dotkernel/dot-controller/4.1.0)
+
+[![GitHub issues](https://img.shields.io/github/issues/dotkernel/dot-controller)](https://github.com/dotkernel/dot-controller/issues)
+[![GitHub forks](https://img.shields.io/github/forks/dotkernel/dot-controller)](https://github.com/dotkernel/dot-controller/network)
+[![GitHub stars](https://img.shields.io/github/stars/dotkernel/dot-controller)](https://github.com/dotkernel/dot-controller/stargazers)
+[![GitHub license](https://img.shields.io/github/license/dotkernel/dot-controller)](https://github.com/dotkernel/dot-controller/blob/4.0/LICENSE.md)
+
+[![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)
diff --git a/phpstan.neon b/phpstan.neon
@@ -0,0 +1,13 @@
+includes:
+    - vendor/phpstan/phpstan-phpunit/extension.neon
+parameters:
+    level: 5
+    paths:
+        - src
+        - test
+    treatPhpDocTypesAsCertain: false
+    ignoreErrors:
+            - message: '#Call to an undefined method .*::somePlugin\(\)\.#'
+              path: test/AbstractControllerTest.php
+            - message: '#Call to an undefined method .*::callablePlugin\(\)\.#'
+              path: test/AbstractControllerTest.php
diff --git a/psalm.xml b/psalm.xml
diff --git a/test/AbstractActionControllerTest.php b/test/AbstractActionControllerTest.php
@@ -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]);
     }
 }
diff --git a/test/Factory/ControllerEventListenersInitializerTest.php b/test/Factory/ControllerEventListenersInitializerTest.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);
     }
 }
diff --git a/test/Factory/PluginManagerFactoryTest.php b/test/Factory/PluginManagerFactoryTest.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'));

Original file line number	Diff line number	Diff line change
`@@ -28,7 +28,7 @@ public function testNonExistingActionWillReturnResponse(): void`
`28`	`28`	`};`
`29`	`29`
`30`	`30`	`$response = $subject->process($request, $handler);`
`31`		`- $this->assertInstanceOf(ResponseInterface::class, $response);`
	`31`	`+ $this->assertContainsOnlyInstancesOf(ResponseInterface::class, [$response]);`
`32`	`32`	`}`
`33`	`33`
`34`	`34`	`/**`
`@@ -49,6 +49,6 @@ public function indexAction(): ResponseInterface`
`49`	`49`	`};`
`50`	`50`
`51`	`51`	`$response = $subject->process($request, $handler);`
`52`		`- $this->assertInstanceOf(ResponseInterface::class, $response);`
	`52`	`+ $this->assertContainsOnlyInstancesOf(ResponseInterface::class, [$response]);`
`53`	`53`	`}`
`54`	`54`	`}`
Original file line number	Diff line number	Diff line change
`@@ -73,7 +73,5 @@ public function testAttachControllerListeners(): void`
`73`	`73`	`->with($this->isInstanceOf(ControllerEventListenerInterface::class), 1);`
`74`	`74`
`75`	`75`	`$this->subject->attachControllerListeners($this->container, $this->controller);`
`76`		`-`
`77`		`- $this->assertTrue(true);`
`78`	`76`	`}`
`79`	`77`	`}`