Issue dotkernel#58: Replace Psalm with PHPStan

Howriq · Howriq · commit dd2974951fdd · 2025-03-03T17:42:23.000+02:00
Signed-off-by: horea &lt;horea@rospace.com&gt;
diff --git a/.github/workflows/static-analysis.yml b/.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
diff --git a/README.md b/README.md
@@ -4,8 +4,14 @@ Dotkernel component used to create services through [Laminas Service Manager](ht
 
 This package can clean up your code, by getting rid of all the factories you write, sometimes just to inject a dependency or two.
 
+## Documentation
+
+Documentation is available at: https://docs.dotkernel.org/dot-controller/.
+
+## Badges
+
 ![OSS Lifecycle](https://img.shields.io/osslifecycle?file_url=https%3A%2F%2Fgithub.com%2Fdotkernel%2Fdot-annotated-services%2Fblob%2F4.0%2FOSSMETADATA)
-![PHP from Packagist (specify version)](https://img.shields.io/packagist/php-v/dotkernel/dot-annotated-services/4.2.1)
+![PHP from Packagist (specify version)](https://img.shields.io/packagist/php-v/dotkernel/dot-annotated-services/4.3.0)
 
 [![GitHub issues](https://img.shields.io/github/issues/dotkernel/dot-annotated-services)](https://github.com/dotkernel/dot-annotated-services/issues)
 [![GitHub forks](https://img.shields.io/github/forks/dotkernel/dot-annotated-services)](https://github.com/dotkernel/dot-annotated-services/network)
@@ -14,6 +20,7 @@ This package can clean up your code, by getting rid of all the factories you wri
 
 [![Build Static](https://github.com/dotkernel/dot-annotated-services/actions/workflows/continuous-integration.yml/badge.svg?branch=4.0)](https://github.com/dotkernel/dot-annotated-services/actions/workflows/continuous-integration.yml)
 [![codecov](https://codecov.io/gh/dotkernel/dot-annotated-services/graph/badge.svg?token=ZBZDEA3LY8)](https://codecov.io/gh/dotkernel/dot-annotated-services)
+[![PHPStan](https://github.com/dotkernel/dot-annotated-services/actions/workflows/static-analysis.yml/badge.svg?branch=4.0)](https://github.com/dotkernel/dot-annotated-services/actions/workflows/static-analysis.yml)
 
 ## Installation
 
diff --git a/composer.json b/composer.json
@@ -1,12 +1,12 @@
 {
     "name": "dotkernel/dot-annotated-services",
     "type": "library",
-    "description": "DotKernel service creation component through laminas-servicemanager and annotations",
+    "description": "Dotkernel service creation component through laminas-servicemanager and annotations",
     "license": "MIT",
     "homepage": "https://github.com/dotkernel/dot-annotated-services",
     "authors": [
         {
-            "name": "DotKernel Team",
+            "name": "Dotkernel Team",
             "email": "team@dotkernel.com"
         }
     ],
@@ -28,8 +28,9 @@
     },
     "require-dev": {
         "laminas/laminas-coding-standard": "^3.0",
-        "phpunit/phpunit": "^10.5.9",
-        "vimeo/psalm": "^6.0"
+        "phpstan/phpstan": "^2.1",
+        "phpstan/phpstan-phpunit": "^2.0",
+        "phpunit/phpunit": "^10.5.9"
     },
     "autoload": {
         "psr-4": {
@@ -49,8 +50,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-annotated-services` is Dotkernel's dependency injection service.
 
 By providing reusable factories for service and repository injection, it reduces code complexity in projects.
+
+## Badges
+
+![OSS Lifecycle](https://img.shields.io/osslifecycle?file_url=https%3A%2F%2Fgithub.com%2Fdotkernel%2Fdot-annotated-services%2Fblob%2F4.0%2FOSSMETADATA)
+![PHP from Packagist (specify version)](https://img.shields.io/packagist/php-v/dotkernel/dot-annotated-services/4.3.0)
+
+[![GitHub issues](https://img.shields.io/github/issues/dotkernel/dot-annotated-services)](https://github.com/dotkernel/dot-annotated-services/issues)
+[![GitHub forks](https://img.shields.io/github/forks/dotkernel/dot-annotated-services)](https://github.com/dotkernel/dot-annotated-services/network)
+[![GitHub stars](https://img.shields.io/github/stars/dotkernel/dot-annotated-services)](https://github.com/dotkernel/dot-annotated-services/stargazers)
+[![GitHub license](https://img.shields.io/github/license/dotkernel/dot-annotated-services)](https://github.com/dotkernel/dot-annotated-services/blob/4.0/LICENSE.md)
+
+[![Build Static](https://github.com/dotkernel/dot-annotated-services/actions/workflows/continuous-integration.yml/badge.svg?branch=4.0)](https://github.com/dotkernel/dot-annotated-services/actions/workflows/continuous-integration.yml)
+[![codecov](https://codecov.io/gh/dotkernel/dot-annotated-services/graph/badge.svg?token=ZBZDEA3LY8)](https://codecov.io/gh/dotkernel/dot-annotated-services)
+[![PHPStan](https://github.com/dotkernel/dot-annotated-services/actions/workflows/static-analysis.yml/badge.svg?branch=4.0)](https://github.com/dotkernel/dot-annotated-services/actions/workflows/static-analysis.yml)
diff --git a/phpstan.neon b/phpstan.neon
@@ -0,0 +1,17 @@
+includes:
+    - vendor/phpstan/phpstan-phpunit/extension.neon
+parameters:
+    level: 5
+    paths:
+        - src
+        - test
+    treatPhpDocTypesAsCertain: false
+    ignoreErrors:
+        - message: '#Call to an undefined method .*::method\(\)\.#'
+          path: test/AnnotatedRepositoryFactoryTest.php
+        - message: '~Parameter #1 \$className of method PHPUnit\\Framework\\TestCase::getMockBuilder\(\) expects class-string<TestRepository>, string given.~'
+          path: test/AnnotatedRepositoryFactoryTest.php
+        - message: '#Call to an undefined method .*::method\(\)\.#'
+          path: test/AnnotatedServiceFactoryTest.php
+        - message: '~Parameter #1 \$className of method PHPUnit\\Framework\\TestCase::getMockBuilder\(\) expects class-string<TestService>, string given.~'
+          path: test/AnnotatedServiceFactoryTest.php
diff --git a/psalm.xml b/psalm.xml
diff --git a/test/AnnotatedRepositoryFactoryTest.php b/test/AnnotatedRepositoryFactoryTest.php
@@ -87,6 +87,6 @@ public function testCreateObjectReturnsEntityRepository()
 
         $object = $this->subject->__invoke($this->container, $repository::class);
 
-        $this->assertInstanceOf(EntityRepository::class, $object);
+        $this->assertContainsOnlyInstancesOf(EntityRepository::class, [$object]);
     }
 }
diff --git a/test/AnnotatedServiceFactoryTest.php b/test/AnnotatedServiceFactoryTest.php
@@ -60,7 +60,7 @@ public function testReturnServiceWithNoDependencies()
 
         $object = $this->subject->__invoke($this->container, $requestedName);
 
-        $this->assertInstanceOf($requestedName, $object);
+        $this->assertSame($requestedName, $object::class);
     }
 
     public function testThrowsExceptionAnnotationNotFound()
@@ -108,6 +108,6 @@ public function testReturnService()
 
         $service = $this->subject->__invoke($this->container, $requestedName);
 
-        $this->assertInstanceOf($requestedName, $service);
+        $this->assertSame($requestedName, $service::class);
     }
 }

Original file line number	Diff line number	Diff line change
`@@ -87,6 +87,6 @@ public function testCreateObjectReturnsEntityRepository()`
`87`	`87`
`88`	`88`	`$object = $this->subject->__invoke($this->container, $repository::class);`
`89`	`89`
`90`		`- $this->assertInstanceOf(EntityRepository::class, $object);`
	`90`	`+ $this->assertContainsOnlyInstancesOf(EntityRepository::class, [$object]);`
`91`	`91`	`}`
`92`	`92`	`}`
Original file line number	Diff line number	Diff line change
`@@ -60,7 +60,7 @@ public function testReturnServiceWithNoDependencies()`
`60`	`60`
`61`	`61`	`$object = $this->subject->__invoke($this->container, $requestedName);`
`62`	`62`
`63`		`- $this->assertInstanceOf($requestedName, $object);`
	`63`	`+ $this->assertSame($requestedName, $object::class);`
`64`	`64`	`}`
`65`	`65`
`66`	`66`	`public function testThrowsExceptionAnnotationNotFound()`
`@@ -108,6 +108,6 @@ public function testReturnService()`
`108`	`108`
`109`	`109`	`$service = $this->subject->__invoke($this->container, $requestedName);`
`110`	`110`
`111`		`- $this->assertInstanceOf($requestedName, $service);`
	`111`	`+ $this->assertSame($requestedName, $service::class);`
`112`	`112`	`}`
`113`	`113`	`}`