Merge pull request #21 from Howriq/issue-#20

alexmerlin · web-flow · commit c9fe64248c27 · 2025-03-05T08:32:20.000+02:00
Issue #20: 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
@@ -1,9 +1,17 @@
 # dot-authorization
 
-Authorization base package defining interfaces for authorization services to be used with Dotkernel applications.
+Dotkernel authorization service abstractions.
+
+`dot-authorization` is Dotkernel's authorization base package which define interfaces for authorization services to be used with Dotkernel applications.
+
+## Documentation
+
+Documentation is available at: https://docs.dotkernel.org/dot-authorization/.
+
+## Badges
 
 ![OSS Lifecycle](https://img.shields.io/osslifecycle/dotkernel/dot-authorization)
-![PHP from Packagist (specify version)](https://img.shields.io/packagist/php-v/dotkernel/dot-authorization/3.6.1)
+![PHP from Packagist (specify version)](https://img.shields.io/packagist/php-v/dotkernel/dot-authorization/3.7.0)
 
 [![GitHub issues](https://img.shields.io/github/issues/dotkernel/dot-authorization)](https://github.com/dotkernel/dot-authorization/issues)
 [![GitHub forks](https://img.shields.io/github/forks/dotkernel/dot-authorization)](https://github.com/dotkernel/dot-authorization/network)
@@ -12,6 +20,7 @@ Authorization base package defining interfaces for authorization services to be
 
 [![Build Static](https://github.com/dotkernel/dot-authorization/actions/workflows/continuous-integration.yml/badge.svg?branch=3.0)](https://github.com/dotkernel/dot-authorization/actions/workflows/continuous-integration.yml)
 [![codecov](https://codecov.io/gh/dotkernel/dot-authorization/graph/badge.svg?token=ZBZDEA3LY8)](https://codecov.io/gh/dotkernel/dot-authorization)
+[![PHPStan](https://github.com/dotkernel/dot-authorization/actions/workflows/static-analysis.yml/badge.svg?branch=3.0)](https://github.com/dotkernel/dot-authorization/actions/workflows/static-analysis.yml)
 
 ## Installation
 
diff --git a/composer.json b/composer.json
@@ -20,8 +20,9 @@
     },
     "require-dev": {
         "laminas/laminas-coding-standard": "^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": {
@@ -48,7 +49,6 @@
         "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"
     }
 }
diff --git a/docs/book/v3/overview.md b/docs/book/v3/overview.md
@@ -1,3 +1,19 @@
 # Overview
 
+Dotkernel authorization service abstractions.
+
 `dot-authorization` is Dotkernel's authorization base package which define interfaces for authorization services to be used with Dotkernel applications.
+
+## Badges
+
+![OSS Lifecycle](https://img.shields.io/osslifecycle/dotkernel/dot-authorization)
+![PHP from Packagist (specify version)](https://img.shields.io/packagist/php-v/dotkernel/dot-authorization/3.7.0)
+
+[![GitHub issues](https://img.shields.io/github/issues/dotkernel/dot-authorization)](https://github.com/dotkernel/dot-authorization/issues)
+[![GitHub forks](https://img.shields.io/github/forks/dotkernel/dot-authorization)](https://github.com/dotkernel/dot-authorization/network)
+[![GitHub stars](https://img.shields.io/github/stars/dotkernel/dot-authorization)](https://github.com/dotkernel/dot-authorization/stargazers)
+[![GitHub license](https://img.shields.io/github/license/dotkernel/dot-authorization)](https://github.com/dotkernel/dot-authorization/blob/3.0/LICENSE.md)
+
+[![Build Static](https://github.com/dotkernel/dot-authorization/actions/workflows/continuous-integration.yml/badge.svg?branch=3.0)](https://github.com/dotkernel/dot-authorization/actions/workflows/continuous-integration.yml)
+[![codecov](https://codecov.io/gh/dotkernel/dot-authorization/graph/badge.svg?token=ZBZDEA3LY8)](https://codecov.io/gh/dotkernel/dot-authorization)
+[![PHPStan](https://github.com/dotkernel/dot-authorization/actions/workflows/static-analysis.yml/badge.svg?branch=3.0)](https://github.com/dotkernel/dot-authorization/actions/workflows/static-analysis.yml)
diff --git a/phpstan.neon b/phpstan.neon
@@ -0,0 +1,8 @@
+includes:
+    - vendor/phpstan/phpstan-phpunit/extension.neon
+parameters:
+    level: 5
+    paths:
+        - src
+        - test
+    treatPhpDocTypesAsCertain: false
diff --git a/psalm-baseline.xml b/psalm-baseline.xml
diff --git a/psalm.xml b/psalm.xml
diff --git a/test/Exception/ForbiddenExceptionTest.php b/test/Exception/ForbiddenExceptionTest.php
@@ -6,17 +6,13 @@
 
 use Dot\Authorization\Exception\ExceptionInterface;
 use Dot\Authorization\Exception\ForbiddenException;
-use PHPUnit\Framework\MockObject\Exception;
 use PHPUnit\Framework\MockObject\MockObject;
 use PHPUnit\Framework\TestCase;
 
 class ForbiddenExceptionTest extends TestCase
 {
     protected ForbiddenException|MockObject $forbiddenExceptionMock;
 
-    /**
-     * @throws Exception
-     */
     public function setUp(): void
     {
         $this->forbiddenExceptionMock = $this->createMock(ForbiddenException::class);
@@ -25,6 +21,6 @@ public function setUp(): void
     public function testCreate(): void
     {
         $this->assertInstanceOf(ForbiddenException::class, $this->forbiddenExceptionMock);
-        $this->assertInstanceOf(ExceptionInterface::class, $this->forbiddenExceptionMock);
+        $this->assertContainsOnlyInstancesOf(ExceptionInterface::class, [$this->forbiddenExceptionMock]);
     }
 }
diff --git a/test/Exception/RuntimeExceptionTest.php b/test/Exception/RuntimeExceptionTest.php
@@ -13,7 +13,7 @@ class RuntimeExceptionTest extends TestCase
     public function testInstances(): void
     {
         $exception = new RuntimeException('test');
-        $this->assertInstanceOf(RuntimeException::class, $exception);
-        $this->assertInstanceOf(ExceptionInterface::class, $exception);
+        $this->assertSame(RuntimeException::class, $exception::class);
+        $this->assertContainsOnlyInstancesOf(ExceptionInterface::class, [$exception]);
     }
 }

Original file line number	Diff line number	Diff line change
`@@ -6,17 +6,13 @@`
`6`	`6`
`7`	`7`	`use Dot\Authorization\Exception\ExceptionInterface;`
`8`	`8`	`use Dot\Authorization\Exception\ForbiddenException;`
`9`		`-use PHPUnit\Framework\MockObject\Exception;`
`10`	`9`	`use PHPUnit\Framework\MockObject\MockObject;`
`11`	`10`	`use PHPUnit\Framework\TestCase;`
`12`	`11`
`13`	`12`	`class ForbiddenExceptionTest extends TestCase`
`14`	`13`	`{`
`15`	`14`	`protected ForbiddenException\|MockObject $forbiddenExceptionMock;`
`16`	`15`
`17`		`- /**`
`18`		`- * @throws Exception`
`19`		`- */`
`20`	`16`	`public function setUp(): void`
`21`	`17`	`{`
`22`	`18`	`$this->forbiddenExceptionMock = $this->createMock(ForbiddenException::class);`
`@@ -25,6 +21,6 @@ public function setUp(): void`
`25`	`21`	`public function testCreate(): void`
`26`	`22`	`{`
`27`	`23`	`$this->assertInstanceOf(ForbiddenException::class, $this->forbiddenExceptionMock);`
`28`		`- $this->assertInstanceOf(ExceptionInterface::class, $this->forbiddenExceptionMock);`
	`24`	`+ $this->assertContainsOnlyInstancesOf(ExceptionInterface::class, [$this->forbiddenExceptionMock]);`
`29`	`25`	`}`
`30`	`26`	`}`
Original file line number	Diff line number	Diff line change
`@@ -13,7 +13,7 @@ class RuntimeExceptionTest extends TestCase`
`13`	`13`	`public function testInstances(): void`
`14`	`14`	`{`
`15`	`15`	`$exception = new RuntimeException('test');`
`16`		`- $this->assertInstanceOf(RuntimeException::class, $exception);`
`17`		`- $this->assertInstanceOf(ExceptionInterface::class, $exception);`
	`16`	`+ $this->assertSame(RuntimeException::class, $exception::class);`
	`17`	`+ $this->assertContainsOnlyInstancesOf(ExceptionInterface::class, [$exception]);`
`18`	`18`	`}`
`19`	`19`	`}`