Make eloquent builder generic

Neol3108 · Neol3108 · commit 6b4f6714f6c9 · 2024-04-28T19:55:48.000+02:00
diff --git a/src/Extensions/StubExtension.php b/src/Extensions/StubExtension.php
@@ -17,6 +17,7 @@ public function getFiles(): array
     {
         return [
             __DIR__ . '/../../stubs/database/eloquent/builder.stub',
+            __DIR__ . '/../../stubs/database/eloquent/model.stub',
         ];
     }
 }
diff --git a/stubs/database/eloquent/builder.stub b/stubs/database/eloquent/builder.stub
@@ -2,11 +2,14 @@
 
 namespace Illuminate\Database\Eloquent;
 
+/**
+ * @template TModel of \Illuminate\Database\Eloquent\Model
+ */
 class Builder
 {
     /**
      * @param string[]|string $columns
-     * @return \Illuminate\Database\Eloquent\Model|null
+     * @return TModel|null
      */
     public function first($columns = ['*']);
 }
diff --git a/stubs/database/eloquent/model.stub b/stubs/database/eloquent/model.stub
@@ -0,0 +1,17 @@
+<?php
+
+namespace Illuminate\Database\Eloquent;
+
+class Model
+{
+    /**
+     * @param \Illuminate\Database\Query\Builder $query
+     * @return \Illuminate\Database\Eloquent\Builder<static>
+     */
+    public function newEloquentBuilder($query);
+
+    /**
+     * @return \Illuminate\Database\Eloquent\Builder<static>
+     */
+    public static function query();
+}
diff --git a/tests/Types/Database/Eloquent/ModelTest.php b/tests/Types/Database/Eloquent/ModelTest.php
@@ -0,0 +1,31 @@
+<?php declare(strict_types = 1);
+
+namespace Tests\Types\Database\Eloquent;
+
+use PHPStan\Testing\TypeInferenceTestCase;
+use PHPUnit\Framework\Attributes\DataProvider;
+
+final class ModelTest extends TypeInferenceTestCase
+{
+    /**
+     * @return iterable<string, mixed[]>
+     */
+    public static function fileAsserts(): iterable
+    {
+        yield from self::gatherAssertTypes(__DIR__ . '/../../data/database/eloquent/model.php');
+    }
+
+    #[DataProvider('fileAsserts')]
+    public function testFileAsserts(
+        string $assertType,
+        string $file,
+        mixed ...$args
+    ): void {
+        $this->assertFileAsserts($assertType, $file, ...$args);
+    }
+
+    public static function getAdditionalConfigFiles(): array
+    {
+        return [__DIR__ . '/../../../../extension.neon'];
+    }
+}
diff --git a/tests/Types/Fakes/User.php b/tests/Types/Fakes/User.php
@@ -0,0 +1,10 @@
+<?php
+
+namespace Tests\Types\Fakes;
+
+use Illuminate\Database\Eloquent\Model;
+
+final class User extends Model
+{
+    //
+}
diff --git a/tests/Types/data/database/eloquent/builder.php b/tests/Types/data/database/eloquent/builder.php
@@ -2,6 +2,6 @@
 
 use function PHPStan\Testing\assertType;
 
-/** @var \Illuminate\Database\Eloquent\Builder $builder */
+/** @var \Illuminate\Database\Eloquent\Builder<\Tests\Types\Fakes\User> $builder */
 
-assertType('Illuminate\Database\Eloquent\Model|null', $builder->first());
+assertType('Tests\Types\Fakes\User|null', $builder->first());
diff --git a/tests/Types/data/database/eloquent/model.php b/tests/Types/data/database/eloquent/model.php
@@ -0,0 +1,19 @@
+<?php
+
+use Illuminate\Database\Eloquent\Model;
+
+use function PHPStan\Testing\assertType;
+
+class User extends Model
+{
+    public function test(): void
+    {
+        /** @var \Illuminate\Database\Query\Builder $baseBuilder */
+
+        assertType('Illuminate\Database\Eloquent\Builder<static(User)>', $this->newEloquentBuilder($baseBuilder));
+        assertType('static(User)|null', $this->newEloquentBuilder($baseBuilder)->first());
+
+        assertType('Illuminate\Database\Eloquent\Builder<static(User)>', self::query());
+        assertType('static(User)|null', self::query()->first());
+    }
+}

Original file line number	Diff line number	Diff line change
`@@ -17,6 +17,7 @@ public function getFiles(): array`
`17`	`17`	`{`
`18`	`18`	`return [`
`19`	`19`	`__DIR__ . '/../../stubs/database/eloquent/builder.stub',`
	`20`	`+ __DIR__ . '/../../stubs/database/eloquent/model.stub',`
`20`	`21`	`];`
`21`	`22`	`}`
`22`	`23`	`}`
Original file line number	Diff line number	Diff line change
`@@ -2,11 +2,14 @@`
`2`	`2`
`3`	`3`	`namespace Illuminate\Database\Eloquent;`
`4`	`4`
	`5`	`+/**`
	`6`	`+ * @template TModel of \Illuminate\Database\Eloquent\Model`
	`7`	`+ */`
`5`	`8`	`class Builder`
`6`	`9`	`{`
`7`	`10`	`/**`
`8`	`11`	`* @param string[]\|string $columns`
`9`		`- * @return \Illuminate\Database\Eloquent\Model\|null`
	`12`	`+ * @return TModel\|null`
`10`	`13`	`*/`
`11`	`14`	`public function first($columns = ['*']);`
`12`	`15`	`}`