Merge pull request #77 from worksome/bugfix/without-timestamps

fix: add support for builder types

Author: owenvoke

composer.json

@@ -19,6 +19,7 @@
     "require-dev": {
         "composer/composer": "^2.7",
         "friendsofphp/php-cs-fixer": "^3.53",
+        "orchestra/testbench": "^9.5",
         "pestphp/pest": "^2.34",
         "spatie/invade": "^1.1.1",
         "squizlabs/php_codesniffer": "^3.8"

src/PHPStan/Laravel/Migrations/WithoutTimestampsVisitor.php

@@ -4,6 +4,7 @@
 
 namespace Worksome\CodingStyle\PHPStan\Laravel\Migrations;
 
+use Illuminate\Database\Eloquent\Builder;
 use Illuminate\Database\Eloquent\Model;
 use PhpParser\Node;
 use PhpParser\Node\Expr\MethodCall;
@@ -107,27 +108,40 @@ private function isModelCall(Node $node): bool
             return false;
         }
 
-        if ($node instanceof MethodCall) {
-            $varType = $this->scope->getType($node->var);
+        if ($node instanceof StaticCall) {
+            if (! $node->class instanceof Node\Name) {
+                return false;
+            }
+
+            $className = $this->scope->resolveName($node->class);
+
+            if (! $className) {
+                return false;
+            }
 
             $modelType = new ObjectType(Model::class);
+            $classType = new ObjectType($className);
 
-            return $varType->isSuperTypeOf($modelType)->yes();
+            return $modelType->isSuperTypeOf($classType)->yes();
         }
 
-        if (! $node instanceof StaticCall || ! $node->class instanceof Node\Name) {
-            return false;
-        }
+        $classType = $this->scope->getType($node->var);
 
-        $className = $this->scope->resolveName($node->class);
+        $modelType = new ObjectType(Model::class);
+        $builderType = new ObjectType(Builder::class);
+
+        if ($modelType->isSuperTypeOf($classType)->yes()) {
+            return true;
+        }
 
-        if (! $className) {
+        if (! $builderType->isSuperTypeOf($classType)->yes()) {
             return false;
         }
 
-        $modelType = new ObjectType(Model::class);
-        $classType = new ObjectType($className);
+        if (! isset($classType->getTypes()[0])) {
+            return false;
+        }
 
-        return $classType->isSubclassOf($modelType)->yes();
+        return $modelType->isSuperTypeOf($classType->getTypes()[0])->yes();
     }
 }

tests/PHPStan/BaseRuleTestCase.php

@@ -2,22 +2,34 @@
 
 namespace Worksome\CodingStyle\Tests\PHPStan;
 
+use Larastan\Larastan\ApplicationResolver;
 use PHPStan\Rules\Rule;
 use PHPStan\Testing\RuleTestCase;
 
 class BaseRuleTestCase extends RuleTestCase
 {
     public Rule $rule;
 
+    protected function setUp(): void
+    {
+        parent::setUp();
+
+        if (! defined('LARAVEL_VERSION') && class_exists(ApplicationResolver::class)) {
+            define('LARAVEL_VERSION', ApplicationResolver::resolve()->version());
+        }
+    }
+
     protected function getRule(): Rule
     {
         return $this->rule;
     }
 
     public static function getAdditionalConfigFiles(): array
     {
-        return array_merge(parent::getAdditionalConfigFiles(), [
+        return [
+            ... parent::getAdditionalConfigFiles(),
             __DIR__ . '/../../phpstan-rich-parser.neon',
-        ]);
+            __DIR__ . '/../../vendor/larastan/larastan/extension.neon',
+        ];
     }
 }

tests/PHPStan/Laravel/Migrations/RequireWithoutTimestampRule/Fixture/Models/TestUser.php

@@ -3,7 +3,9 @@
 namespace Worksome\CodingStyle\Tests\PHPStan\Laravel\Migrations\RequireWithoutTimestampRule\Fixture\Models;
 
 use Illuminate\Database\Eloquent\Model;
+use Illuminate\Database\Eloquent\SoftDeletes;
 
 class TestUser extends Model
 {
+    use SoftDeletes;
 }

tests/PHPStan/Laravel/Migrations/RequireWithoutTimestampRule/Fixture/database/migrations/invalid_migration.php.inc

@@ -25,11 +25,9 @@ return new class extends Migration
             'test' => 'test',
         ]);
 
-        $testUser = TestUser::make(['test' => 'test']);
-        $testUser->save();
+        TestUser::make(['test' => 'test'])->save();
 
-        $testUser2 = TestUser::make(['test' => 'test']);
-        $testUser2->saveQuietly();
+        TestUser::make(['test' => 'test'])->saveQuietly();
 
         TestUser::where('test', 'test')
             ->delete();

tests/PHPStan/Laravel/Migrations/RequireWithoutTimestampRule/Fixture/database/migrations/invalid_migration_with_multiple_models.php.inc

@@ -18,7 +18,7 @@ return new class extends Migration
                 ->nullable();
         });
 
-        TestClient::withTrashed()->update([
+        TestClient::update([
             'test' => 'test',
         ]);
 

tests/PHPStan/Laravel/Migrations/RequireWithoutTimestampRule/RequireWithoutTimestampsRuleTest.php

@@ -33,20 +33,20 @@
             24,
         ],
         [
-            "Line 29: The 'save()' method call should be within 'withoutTimestamps()' context to prevent unintended timestamp updates.",
-            29,
+            "Line 28: The 'save()' method call should be within 'withoutTimestamps()' context to prevent unintended timestamp updates.",
+            28,
         ],
         [
-            "Line 32: The 'saveQuietly()' method call should be within 'withoutTimestamps()' context to prevent unintended timestamp updates.",
-            32,
+            "Line 30: The 'saveQuietly()' method call should be within 'withoutTimestamps()' context to prevent unintended timestamp updates.",
+            30,
         ],
         [
-            "Line 34: The 'delete()' method call should be within 'withoutTimestamps()' context to prevent unintended timestamp updates.",
-            34,
+            "Line 32: The 'delete()' method call should be within 'withoutTimestamps()' context to prevent unintended timestamp updates.",
+            32,
         ],
         [
-            "Line 37: The 'restore()' method call should be within 'withoutTimestamps()' context to prevent unintended timestamp updates.",
-            37,
+            "Line 35: The 'restore()' method call should be within 'withoutTimestamps()' context to prevent unintended timestamp updates.",
+            35,
         ],
     ],
     'invalid migration with multiple models' => [