Add static code analysis

Author: korridor

.github/workflows/static-analysis.yml

@@ -0,0 +1,50 @@
+name: Static Analysis
+
+on: [ push ]
+
+jobs:
+    PHPUnit:
+        strategy:
+            matrix:
+                include:
+                    # Laravel 10.*
+                    -   php: 8.3
+                        testbench: 8.*
+                        laravel: 10.*
+                        composer-flag: '--prefer-stable'
+                    # Laravel 11.*
+                    -   php: 8.3
+                        testbench: 9.*
+                        laravel: 11.*
+                        composer-flag: '--prefer-stable'
+                    # Laravel 12.*
+                    -   php: 8.4
+                        testbench: 10.*
+                        laravel: 12.*
+                        composer-flag: '--prefer-stable'
+                    # Laravel 13.*
+                    -   php: 8.4
+                        testbench: 11.*
+                        laravel: 13.*
+                        composer-flag: '--prefer-stable'
+
+        runs-on: ubuntu-latest
+
+        steps:
+            - uses: actions/checkout@v6
+
+            - name: Setup PHP
+              uses: shivammathur/setup-php@v2
+              with:
+                  php-version: ${{ matrix.php }}
+                  extensions: curl, mbstring, zip, pcntl, pdo, sqlite, pdo_sqlite, iconv
+                  coverage: none
+
+            - name: Install dependencies
+              run: composer require "laravel/framework:${{ matrix.laravel }}" "orchestra/testbench:${{ matrix.testbench }}" --no-interaction --no-update
+
+            - name: Update dependencies
+              run: composer update ${{ matrix.composer-flag }} --prefer-dist --no-interaction
+
+            - name: Run PhpStan
+              run: composer analyse

.github/workflows/unittests.yml

@@ -129,6 +129,9 @@ jobs:
             extensions: curl, mbstring, zip, pcntl, pdo, sqlite, pdo_sqlite, iconv
             coverage: xdebug
 
+      - name: Remove larastan
+        run: composer remove --dev larastan/larastan
+
       - name: Install dependencies
         run: composer require "laravel/framework:${{ matrix.laravel }}" "orchestra/testbench:${{ matrix.testbench }}" --no-interaction --no-update
 

composer.json

@@ -23,9 +23,10 @@
         "illuminate/database": "^10|^11|^12|^13"
     },
     "require-dev": {
+        "friendsofphp/php-cs-fixer": "^3.6",
+        "larastan/larastan": "^3.0",
         "orchestra/testbench": "^8.0|^9.0|^10.0",
         "phpunit/phpunit": "^10|^11.5.3",
-        "friendsofphp/php-cs-fixer": "^3.6",
         "squizlabs/php_codesniffer": "^3.5"
     },
     "autoload": {
@@ -42,7 +43,8 @@
         "test": "vendor/bin/phpunit",
         "test-coverage": "XDEBUG_MODE=coverage vendor/bin/phpunit --coverage-text --coverage-html coverage",
         "fix": "./vendor/bin/php-cs-fixer fix",
-        "lint": "./vendor/bin/phpcs --extensions=php"
+        "lint": "./vendor/bin/phpcs --extensions=php",
+        "analyse": "@php ./vendor/bin/phpstan analyse --memory-limit=2G"
     },
     "extra": {
         "laravel": {

phpstan.neon

@@ -0,0 +1,11 @@
+includes:
+    - ./vendor/larastan/larastan/extension.neon
+
+parameters:
+
+    paths:
+        - src
+        - tests
+
+    # Level 9 is the highest level
+    level: 9

src/Rules/ExistsEloquent.php

@@ -6,7 +6,6 @@
 
 use Closure;
 use Illuminate\Contracts\Validation\ValidationRule;
-use Illuminate\Database\Eloquent\Builder;
 use Illuminate\Database\Eloquent\Model;
 use Illuminate\Support\Str;
 
@@ -142,7 +141,7 @@ public function validate(string $attribute, mixed $value, Closure $fail): void
                 return;
             }
         }
-        /** @var Model|Builder $builder */
+        /** @var Model $builder */
         $builder = new $this->model();
         $modelKeyName = $builder->getKeyName();
         if (null === $this->key) {

src/Rules/UniqueEloquent.php

@@ -6,7 +6,6 @@
 
 use Closure;
 use Illuminate\Contracts\Validation\ValidationRule;
-use Illuminate\Database\Eloquent\Builder;
 use Illuminate\Database\Eloquent\Model;
 use Illuminate\Support\Str;
 
@@ -109,7 +108,7 @@ public function validate(string $attribute, mixed $value, Closure $fail): void
                 return;
             }
         }
-        /** @var Model|Builder $builder */
+        /** @var Model $builder */
         $builder = new $this->model();
         $modelKeyName = $builder->getKeyName();
         $builder = $builder->where(null === $this->key ? $modelKeyName : $this->key, $value);

tests/TestCase.php

@@ -26,7 +26,7 @@ public function setUp(): void
 
     /**
      * @param  Application  $app
-     * @return array
+     * @return array<int, class-string>
      */
     protected function getPackageProviders($app): array
     {

tests/TestEnvironment/Models/Fact.php

@@ -20,7 +20,7 @@ class Fact extends Model
     protected $guarded = [];
 
     /**
-     * @return BelongsTo<User>
+     * @return BelongsTo<User, $this>
      */
     public function user(): BelongsTo
     {

tests/TestEnvironment/Models/User.php

@@ -20,9 +20,9 @@ class User extends Model
     protected $guarded = [];
 
     /**
-     * @return HasMany<Fact>
+     * @return HasMany<Fact, $this>
      */
-    public function user(): HasMany
+    public function facts(): HasMany
     {
         return $this->hasMany(Fact::class);
     }