fix: no model forwarding to builder

This fixes two issues:

- the rule now correctly handles nullable union types
- the rule now correctly handles the `with()` method

Author: calebdw

src/Rules/NoModelForwardingToBuilder.php

@@ -13,6 +13,7 @@
 use PHPStan\Analyser\Scope;
 use PHPStan\Rules\Rule;
 use PHPStan\Rules\RuleErrorBuilder;
+use PHPStan\Type\TypeCombinator;
 
 use function array_map;
 use function sprintf;
@@ -37,7 +38,7 @@ public function processNode(Node $node, Scope $scope): array
                 $scope->getType($node->name)->getConstantStrings(),
             );
 
-        $calledOnType = $scope->getType($node->var);
+        $calledOnType = TypeCombinator::removeNull($scope->getType($node->var));
 
         foreach ($calledOnType->getObjectClassReflections() as $classReflection) {
             if (! $classReflection->is(Model::class)) {
@@ -52,7 +53,14 @@ public function processNode(Node $node, Scope $scope): array
                 $methodReflection = $classReflection->getMethod($method, $scope);
                 $declaringClass   = $methodReflection->getDeclaringClass();
 
-                if (! $declaringClass->is(QueryBuilder::class) && ! $declaringClass->is(EloquentBuilder::class)) {
+                if (
+                    ! $declaringClass->is(QueryBuilder::class)
+                    && ! $declaringClass->is(EloquentBuilder::class)
+                    // Override for the with() method, which is also a static method
+                    // on the Model class, so is not caught by the above check.
+                    // Should not be called on a model instance when this rule is enabled.
+                    && $method !== 'with'
+                ) {
                     continue;
                 }
 

tests/Rules/NoModelForwardingToBuilderTest.php

@@ -8,6 +8,8 @@
 use PHPStan\Rules\Rule;
 use PHPStan\Testing\RuleTestCase;
 
+use function strtr;
+
 /** @extends RuleTestCase<NoModelForwardingToBuilder> */
 class NoModelForwardingToBuilderTest extends RuleTestCase
 {
@@ -18,14 +20,22 @@ protected function getRule(): Rule
 
     public function testRule(): void
     {
+        $message = static fn (string $name) => strtr(
+            "Method [:name] is forwarded to a Builder instance, which is not allowed.\n    💡 Use [:::name()], [::query()->:name()] or [->newQuery()->:name()] instead.",
+            [':name' => $name],
+        );
+
         $this->analyse([__DIR__ . '/data/NoModelForwardingToBuilderInstance.php'], [
-            ["Method [first] is forwarded to a Builder instance, which is not allowed.\n    💡 Use [::first()], [::query()->first()] or [->newQuery()->first()] instead.", 5],
-            ["Method [get] is forwarded to a Builder instance, which is not allowed.\n    💡 Use [::get()], [::query()->get()] or [->newQuery()->get()] instead.", 6],
-            ["Method [find] is forwarded to a Builder instance, which is not allowed.\n    💡 Use [::find()], [::query()->find()] or [->newQuery()->find()] instead.", 7],
-            ["Method [paginate] is forwarded to a Builder instance, which is not allowed.\n    💡 Use [::paginate()], [::query()->paginate()] or [->newQuery()->paginate()] instead.", 8],
-            ["Method [where] is forwarded to a Builder instance, which is not allowed.\n    💡 Use [::where()], [::query()->where()] or [->newQuery()->where()] instead.", 9],
-            ["Method [take] is forwarded to a Builder instance, which is not allowed.\n    💡 Use [::take()], [::query()->take()] or [->newQuery()->take()] instead.", 10],
-            ["Method [max] is forwarded to a Builder instance, which is not allowed.\n    💡 Use [::max()], [::query()->max()] or [->newQuery()->max()] instead.", 11],
+            [$message('first'), 5],
+            [$message('get'), 6],
+            [$message('find'), 7],
+            [$message('paginate'), 8],
+            [$message('where'), 9],
+            [$message('take'), 10],
+            [$message('max'), 11],
+            [$message('with'), 12],
+            [$message('first'), 14],
+            [$message('with'), 15],
         ]);
     }
 

tests/Rules/data/NoModelForwardingToBuilderInstance.php

@@ -9,4 +9,7 @@
 $user->where('id', 1);
 $user->take(1);
 $user->max('foo');
+$user->with('foo');
 
+$user->accounts()->first()->first();
+$user->accounts()->first()->with('foo');