Merge pull request #57 from inpsyde/feature/phpstan

Introduction of phpstan

Author: tfrommen

.gitattributes

@@ -1,11 +1,13 @@
 * text eol=lf
 
-tests export-ignore
-.psalm export-ignore
-.github export-ignore
-.gitattributes export-ignore
-.gitignore export-ignore
-README.md export-ignore
-phpcs.xml.dist export-ignore
-phpunit.xml.dist export-ignore
-psalm.xml export-ignore
+*.php diff=php
+
+/.github/           export-ignore
+/docs/              export-ignore
+/tests/             export-ignore
+/.gitattributes     export-ignore
+/.gitignore         export-ignore
+/README.md          export-ignore
+/phpcs.xml.dist     export-ignore
+/phpstan.neon.dist  export-ignore
+/phpunit.xml.dist   export-ignore

.github/workflows/php-qa.yml

@@ -6,14 +6,14 @@ on:
             - '**workflows/php-qa.yml'
             - '**.php'
             - '**phpcs.xml.dist'
-            - '**psalm.xml'
+            - '**phpstan.neon.dist'
             - '**composer.json'
     pull_request:
         paths:
             - '**workflows/php-qa.yml'
             - '**.php'
             - '**phpcs.xml.dist'
-            - '**psalm.xml'
+            - '**phpstan.neon.dist'
             - '**composer.json'
     workflow_dispatch:
         inputs:
@@ -25,7 +25,7 @@ on:
                 options:
                     - 'Run all'
                     - 'Run PHPCS only'
-                    - 'Run Psalm only'
+                    - 'Run PHPStan only'
                     - 'Run lint only'
 
 concurrency:
@@ -38,7 +38,7 @@ jobs:
         uses: inpsyde/reusable-workflows/.github/workflows/lint-php.yml@main
         strategy:
             matrix:
-                php: [ '7.4', '8.0', '8.1', '8.2', '8.3' ]
+                php: [ '7.4', '8.0', '8.1', '8.2', '8.3', '8.4' ]
         with:
             PHP_VERSION: ${{ matrix.php }}
             LINT_ARGS: '-e php --colors --show-deprecated ./src'
@@ -50,11 +50,10 @@ jobs:
             PHP_VERSION: '8.3'
 
     static-code-analysis:
-        if: ${{ (github.event_name != 'workflow_dispatch') || ((github.event.inputs.jobs == 'Run all') || (github.event.inputs.jobs == 'Run Psalm only')) }}
+        if: ${{ (github.event_name != 'workflow_dispatch') || ((github.event.inputs.jobs == 'Run all') || (github.event.inputs.jobs == 'Run PHPStan only')) }}
         uses: inpsyde/reusable-workflows/.github/workflows/static-analysis-php.yml@main
         strategy:
             matrix:
                 php: [ '7.4', '8.0', '8.1', '8.2', '8.3' ]
         with:
             PHP_VERSION: ${{ matrix.php }}
-            PSALM_ARGS: --output-format=github --no-suggestions --no-cache --no-diff --find-unused-psalm-suppress

.github/workflows/php-unit-tests.yml

@@ -50,7 +50,7 @@ jobs:
 
             -   name: Setup dependencies for PSR-11 target version
                 run: |
-                    composer remove inpsyde/php-coding-standards inpsyde/wp-stubs-versions vimeo/psalm --dev --no-update
+                    composer remove inpsyde/php-coding-standards --dev --no-update
                     composer require "psr/container:${{ matrix.container-versions }}" --no-update
                     composer config --no-plugins allow-plugins.roots/wordpress-core-installer false
 

README.md

@@ -25,7 +25,7 @@ When installed for development via Composer, the package also requires:
 
 * inpsyde/php-coding-standards
 * roots/wordpress
-* vimeo/psalm
+* phpstan/phpstan
 * phpunit/phpunit
 * brain/monkey
 * mikey179/vfsstream

composer.json

@@ -27,12 +27,16 @@
     },
     "require-dev": {
         "brain/monkey": "^2.6.1",
-        "inpsyde/php-coding-standards": "^2@dev",
-        "inpsyde/wp-stubs-versions": "dev-latest",
+        "inpsyde/php-coding-standards": "^2.0.0",
         "roots/wordpress-no-content": "@dev",
         "mikey179/vfsstream": "^v1.6.11",
         "phpunit/phpunit": "^9.6.19",
-        "vimeo/psalm": "^5.24.0"
+        "phpstan/phpstan": "^2.1.1",
+        "phpstan/phpstan-mockery": "^2.0.0",
+        "phpstan/phpstan-phpunit": "^2.0.4",
+        "swissspidy/phpstan-no-private": "^v1.0.0",
+        "phpstan/phpstan-deprecation-rules": "^2.0.1",
+        "inpsyde/wp-stubs-versions": "dev-latest"
     },
     "extra": {
         "branch-alias": {
@@ -53,13 +57,13 @@
     "minimum-stability": "dev",
     "prefer-stable": true,
     "scripts": {
-        "cs": "@php ./vendor/squizlabs/php_codesniffer/bin/phpcs",
-        "psalm": "@php ./vendor/vimeo/psalm/psalm --no-suggestions --report-show-info=false --find-unused-psalm-suppress --no-diff --no-cache --no-file-cache --output-format=compact",
+        "phpcs": "@php ./vendor/squizlabs/php_codesniffer/bin/phpcs",
+        "phpstan": "@php ./vendor/bin/phpstan analyse --memory-limit=1G",
         "tests": "@php ./vendor/phpunit/phpunit/phpunit --no-coverage",
         "tests:coverage": "@php ./vendor/phpunit/phpunit/phpunit",
         "qa": [
-            "@cs",
-            "@psalm",
+            "@phpcs",
+            "@phpstan",
             "@tests"
         ]
     },

docs/README.md

@@ -30,7 +30,7 @@ When installed for development, via Composer, the package also requires:
 
 * inpsyde/php-coding-standards
 * roots/wordpress
-* vimeo/psalm
+* phpstan/phpstan
 * phpunit/phpunit
 * brain/monkey
 * mikey179/vfsstream

phpcs.xml.dist

@@ -2,6 +2,7 @@
 <ruleset>
     <file>./src</file>
     <file>./tests</file>
+    <exclude-pattern>./tests/unit/stubs.php</exclude-pattern>
 
     <arg value="sp"/>
     <arg name="colors"/>

phpstan.neon.dist

@@ -0,0 +1,19 @@
+includes:
+    - vendor/phpstan/phpstan-deprecation-rules/rules.neon
+    - vendor/phpstan/phpstan-mockery/extension.neon
+    - vendor/phpstan/phpstan-phpunit/extension.neon
+    - vendor/swissspidy/phpstan-no-private/rules.neon
+parameters:
+    level: 8
+    dynamicConstantNames:
+        - WP_DEBUG
+    scanFiles:
+        - vendor/inpsyde/wp-stubs-versions/latest.php
+    paths:
+        - src/
+        - tests/
+    treatPhpDocTypesAsCertain: false
+    ignoreErrors:
+        -
+            message: '#Call to static method PHPUnit\\Framework\\Assert::assertInstanceOf\(\) .* will always evaluate to true.#'
+            path: tests/*

psalm.xml

@@ -7,8 +7,8 @@
 use Psr\Container\ContainerInterface;
 
 /**
- * @psalm-import-type Service from \Inpsyde\Modularity\Module\ServiceModule
- * @psalm-import-type ExtendingService from \Inpsyde\Modularity\Module\ExtendingModule
+ * @phpstan-import-type Service from \Inpsyde\Modularity\Module\ServiceModule
+ * @phpstan-import-type ExtendingService from \Inpsyde\Modularity\Module\ExtendingModule
  */
 class ContainerConfigurator
 {
@@ -113,7 +113,7 @@ public function hasExtension(string $id): bool
     /**
      * @return ContainerInterface
      *
-     * @psalm-assert ContainerInterface $this->compiledContainer
+     * @phpstan-assert ContainerInterface $this->compiledContainer
      */
     public function createReadOnlyContainer(): ContainerInterface
     {

src/Container/ContainerConfigurator.php

@@ -44,8 +44,8 @@ public function has(string $id): bool
     /**
      * @return bool
      *
-     * @psalm-assert-if-true ContainerInterface $this->container
-     * @psalm-assert-if-false null $this->container
+     * @phpstan-assert-if-true ContainerInterface $this->container
+     * @phpstan-assert-if-false null $this->container
      */
     private function tryContainer(): bool
     {
@@ -67,7 +67,7 @@ private function tryContainer(): bool
      * @param string $id
      * @return void
      *
-     * @psalm-assert ContainerInterface $this->container
+     * @phpstan-assert ContainerInterface $this->container
      */
     private function assertPackageBooted(string $id): void
     {

src/Container/PackageProxyContainer.php

@@ -8,8 +8,8 @@
 use Psr\Container\NotFoundExceptionInterface;
 
 /**
- * @psalm-import-type Service from \Inpsyde\Modularity\Module\ServiceModule
- * @psalm-import-type ExtendingService from \Inpsyde\Modularity\Module\ExtendingModule
+ * @phpstan-import-type Service from \Inpsyde\Modularity\Module\ServiceModule
+ * @phpstan-import-type ExtendingService from \Inpsyde\Modularity\Module\ExtendingModule
  */
 class ReadOnlyContainer implements ContainerInterface
 {
@@ -26,7 +26,7 @@ class ReadOnlyContainer implements ContainerInterface
     /**
      * @param array<string, Service> $services
      * @param array<string, bool> $factoryIds
-     * @param ServiceExtensions|array $extensions
+     * @param ServiceExtensions|array<string, ExtendingService> $extensions
      * @param ContainerInterface[] $containers
      */
     public function __construct(

src/Container/ReadOnlyContainer.php

@@ -7,7 +7,7 @@
 use Psr\Container\ContainerInterface as Container;
 
 /**
- * @psalm-import-type ExtendingService from \Inpsyde\Modularity\Module\ExtendingModule
+ * @phpstan-import-type ExtendingService from \Inpsyde\Modularity\Module\ExtendingModule
  */
 class ServiceExtensions
 {
@@ -20,6 +20,7 @@ class ServiceExtensions
 
     /**
      * @param string $type
+     *
      * @return string
      */
     final public static function typeId(string $type): string
@@ -30,18 +31,22 @@ final public static function typeId(string $type): string
     /**
      * @param string $extensionId
      * @param ExtendingService $extender
+     *
      * @return static
      */
     public function add(string $extensionId, callable $extender): ServiceExtensions
     {
-        isset($this->extensions[$extensionId]) or $this->extensions[$extensionId] = [];
+        if (!isset($this->extensions[$extensionId])) {
+            $this->extensions[$extensionId] = [];
+        }
         $this->extensions[$extensionId][] = $extender;
 
         return $this;
     }
 
     /**
      * @param string $extensionId
+     *
      * @return bool
      */
     public function has(string $extensionId): bool
@@ -53,6 +58,7 @@ public function has(string $extensionId): bool
      * @param mixed $service
      * @param string $id
      * @param Container $container
+     *
      * @return mixed
      */
     final public function resolve($service, string $id, Container $container)
@@ -68,6 +74,7 @@ final public function resolve($service, string $id, Container $container)
      * @param string $id
      * @param mixed $service
      * @param Container $container
+     *
      * @return mixed
      */
     protected function resolveById(string $id, $service, Container $container)
@@ -83,7 +90,8 @@ protected function resolveById(string $id, $service, Container $container)
      * @param string $className
      * @param object $service
      * @param Container $container
-     * @param array $extendedClasses
+     * @param string[] $extendedClasses
+     *
      * @return mixed
      *
      * phpcs:disable Generic.Metrics.CyclomaticComplexity
@@ -110,8 +118,7 @@ protected function resolveByType(
         }
 
         // 2nd group of extensions: targeting parent classes
-        $parents = class_parents($service, false);
-        ($parents === false) and $parents = [];
+        $parents = class_parents($service, false) ?: [];
         foreach ($parents as $parentName) {
             $byParent = $this->extensions[self::typeId($parentName)] ?? null;
             if (($byParent !== null) && ($byParent !== [])) {
@@ -120,8 +127,7 @@ protected function resolveByType(
         }
 
         // 3rd group of extensions: targeting implemented interfaces
-        $interfaces = class_implements($service, false);
-        ($interfaces === false) and $interfaces = [];
+        $interfaces = class_implements($service, false) ?: [];
         foreach ($interfaces as $interfaceName) {
             $byInterface = $this->extensions[self::typeId($interfaceName)] ?? null;
             if (($byInterface !== null) && ($byInterface !== [])) {
@@ -163,6 +169,7 @@ protected function resolveByType(
      * @param object $service
      * @param Container $container
      * @param list<ExtendingService> $extenders
+     *
      * @return list{mixed, int}
      */
     private function extendByType(

src/Container/ServiceExtensions.php

@@ -7,7 +7,7 @@
 use Psr\Container\ContainerInterface;
 
 /**
- * @psalm-type ExtendingService = callable(mixed $service, ContainerInterface $container):mixed
+ * @phpstan-type ExtendingService callable(mixed $service, ContainerInterface $container): mixed
  */
 interface ExtendingModule extends Module
 {

src/Module/ExtendingModule.php

@@ -5,7 +5,7 @@
 namespace Inpsyde\Modularity\Module;
 
 /**
- * @psalm-import-type Service from ServiceModule
+ * @phpstan-import-type Service from ServiceModule
  */
 interface FactoryModule extends Module
 {

src/Module/FactoryModule.php

@@ -7,7 +7,7 @@
 use Psr\Container\ContainerInterface;
 
 /**
- * @psalm-type Service = callable(ContainerInterface $container):mixed
+ * @phpstan-type Service callable(ContainerInterface $container): mixed
  */
 interface ServiceModule extends Module
 {