Skip to content

Commit 9226d94

Browse files
calebdwcalebdw
committed
feat: improve Factory generics
1 parent b397704 commit 9226d94

File tree

6 files changed

+125
-145
lines changed

6 files changed

+125
-145
lines changed

‎src/Illuminate/Database/Eloquent/Factories/Factory.php

+32-26
Original file line numberDiff line numberDiff line change
@@ -32,7 +32,7 @@ abstract class Factory
3232
/**
3333
* The name of the factory's corresponding model.
3434
*
35-
* @var class-string<\Illuminate\Database\Eloquent\Model|TModel>
35+
* @var class-string<TModel>
3636
*/
3737
protected $model;
3838

@@ -109,7 +109,7 @@ abstract class Factory
109109
/**
110110
* The default model name resolver.
111111
*
112-
* @var callable
112+
* @var callable(self): class-string<TModel>
113113
*/
114114
protected static $modelNameResolver;
115115

@@ -214,7 +214,7 @@ public function raw($attributes = [], ?Model $parent = null)
214214
* Create a single model and persist it to the database.
215215
*
216216
* @param (callable(array<string, mixed>): array<string, mixed>)|array<string, mixed> $attributes
217-
* @return \Illuminate\Database\Eloquent\Model|TModel
217+
* @return TModel
218218
*/
219219
public function createOne($attributes = [])
220220
{
@@ -225,7 +225,7 @@ public function createOne($attributes = [])
225225
* Create a single model and persist it to the database without dispatching any model events.
226226
*
227227
* @param (callable(array<string, mixed>): array<string, mixed>)|array<string, mixed> $attributes
228-
* @return \Illuminate\Database\Eloquent\Model|TModel
228+
* @return TModel
229229
*/
230230
public function createOneQuietly($attributes = [])
231231
{
@@ -236,7 +236,7 @@ public function createOneQuietly($attributes = [])
236236
* Create a collection of models and persist them to the database.
237237
*
238238
* @param int|null|iterable<int, array<string, mixed>> $records
239-
* @return \Illuminate\Database\Eloquent\Collection<int, \Illuminate\Database\Eloquent\Model|TModel>
239+
* @return \Illuminate\Database\Eloquent\Collection<int, TModel>
240240
*/
241241
public function createMany(int|iterable|null $records = null)
242242
{
@@ -259,7 +259,7 @@ public function createMany(int|iterable|null $records = null)
259259
* Create a collection of models and persist them to the database without dispatching any model events.
260260
*
261261
* @param int|null|iterable<int, array<string, mixed>> $records
262-
* @return \Illuminate\Database\Eloquent\Collection<int, \Illuminate\Database\Eloquent\Model|TModel>
262+
* @return \Illuminate\Database\Eloquent\Collection<int, TModel>
263263
*/
264264
public function createManyQuietly(int|iterable|null $records = null)
265265
{
@@ -273,7 +273,7 @@ public function createManyQuietly(int|iterable|null $records = null)
273273
*
274274
* @param (callable(array<string, mixed>): array<string, mixed>)|array<string, mixed> $attributes
275275
* @param \Illuminate\Database\Eloquent\Model|null $parent
276-
* @return \Illuminate\Database\Eloquent\Collection<int, \Illuminate\Database\Eloquent\Model|TModel>|\Illuminate\Database\Eloquent\Model|TModel
276+
* @return \Illuminate\Database\Eloquent\Collection<int, TModel>|TModel
277277
*/
278278
public function create($attributes = [], ?Model $parent = null)
279279
{
@@ -301,7 +301,7 @@ public function create($attributes = [], ?Model $parent = null)
301301
*
302302
* @param (callable(array<string, mixed>): array<string, mixed>)|array<string, mixed> $attributes
303303
* @param \Illuminate\Database\Eloquent\Model|null $parent
304-
* @return \Illuminate\Database\Eloquent\Collection<int, \Illuminate\Database\Eloquent\Model|TModel>|\Illuminate\Database\Eloquent\Model|TModel
304+
* @return \Illuminate\Database\Eloquent\Collection<int, TModel>|TModel
305305
*/
306306
public function createQuietly($attributes = [], ?Model $parent = null)
307307
{
@@ -315,7 +315,7 @@ public function createQuietly($attributes = [], ?Model $parent = null)
315315
*
316316
* @param array<string, mixed> $attributes
317317
* @param \Illuminate\Database\Eloquent\Model|null $parent
318-
* @return \Closure(): (\Illuminate\Database\Eloquent\Collection<int, \Illuminate\Database\Eloquent\Model|TModel>|\Illuminate\Database\Eloquent\Model|TModel)
318+
* @return \Closure(): (\Illuminate\Database\Eloquent\Collection<int, TModel>|TModel)
319319
*/
320320
public function lazy(array $attributes = [], ?Model $parent = null)
321321
{
@@ -325,7 +325,7 @@ public function lazy(array $attributes = [], ?Model $parent = null)
325325
/**
326326
* Set the connection name on the results and store them.
327327
*
328-
* @param \Illuminate\Support\Collection $results
328+
* @param \Illuminate\Support\Collection<int, \Illuminate\Database\Eloquent\Model> $results
329329
* @return void
330330
*/
331331
protected function store(Collection $results)
@@ -366,7 +366,7 @@ protected function createChildren(Model $model)
366366
* Make a single instance of the model.
367367
*
368368
* @param (callable(array<string, mixed>): array<string, mixed>)|array<string, mixed> $attributes
369-
* @return \Illuminate\Database\Eloquent\Model|TModel
369+
* @return TModel
370370
*/
371371
public function makeOne($attributes = [])
372372
{
@@ -378,7 +378,7 @@ public function makeOne($attributes = [])
378378
*
379379
* @param (callable(array<string, mixed>): array<string, mixed>)|array<string, mixed> $attributes
380380
* @param \Illuminate\Database\Eloquent\Model|null $parent
381-
* @return \Illuminate\Database\Eloquent\Collection<int, \Illuminate\Database\Eloquent\Model|TModel>|\Illuminate\Database\Eloquent\Model|TModel
381+
* @return \Illuminate\Database\Eloquent\Collection<int, TModel>|TModel
382382
*/
383383
public function make($attributes = [], ?Model $parent = null)
384384
{
@@ -504,7 +504,7 @@ protected function expandAttributes(array $definition)
504504
/**
505505
* Add a new state transformation to the model definition.
506506
*
507-
* @param (callable(array<string, mixed>, \Illuminate\Database\Eloquent\Model|null): array<string, mixed>)|array<string, mixed> $state
507+
* @param (callable(array<string, mixed>, TModel|null): array<string, mixed>)|array<string, mixed> $state
508508
* @return static
509509
*/
510510
public function state($state)
@@ -654,8 +654,10 @@ public function recycle($model)
654654
/**
655655
* Retrieve a random model of a given type from previously provided models to recycle.
656656
*
657-
* @param string $modelClassName
658-
* @return \Illuminate\Database\Eloquent\Model|null
657+
* @template TClass of \Illuminate\Database\Eloquent\Model
658+
*
659+
* @param class-string<TClass> $modelClassName
660+
* @return TClass|null
659661
*/
660662
public function getRandomRecycledModel($modelClassName)
661663
{
@@ -665,7 +667,7 @@ public function getRandomRecycledModel($modelClassName)
665667
/**
666668
* Add a new "after making" callback to the model definition.
667669
*
668-
* @param \Closure(\Illuminate\Database\Eloquent\Model|TModel): mixed $callback
670+
* @param \Closure(TModel): mixed $callback
669671
* @return static
670672
*/
671673
public function afterMaking(Closure $callback)
@@ -676,7 +678,7 @@ public function afterMaking(Closure $callback)
676678
/**
677679
* Add a new "after creating" callback to the model definition.
678680
*
679-
* @param \Closure(\Illuminate\Database\Eloquent\Model|TModel): mixed $callback
681+
* @param \Closure(TModel): mixed $callback
680682
* @return static
681683
*/
682684
public function afterCreating(Closure $callback)
@@ -761,7 +763,7 @@ protected function newInstance(array $arguments = [])
761763
* Get a new model instance.
762764
*
763765
* @param array<string, mixed> $attributes
764-
* @return \Illuminate\Database\Eloquent\Model|TModel
766+
* @return TModel
765767
*/
766768
public function newModel(array $attributes = [])
767769
{
@@ -773,7 +775,7 @@ public function newModel(array $attributes = [])
773775
/**
774776
* Get the name of the model that is generated by the factory.
775777
*
776-
* @return class-string<\Illuminate\Database\Eloquent\Model|TModel>
778+
* @return class-string<TModel>
777779
*/
778780
public function modelName()
779781
{
@@ -797,7 +799,7 @@ public function modelName()
797799
/**
798800
* Specify the callback that should be invoked to guess model names based on factory names.
799801
*
800-
* @param callable(self): class-string<\Illuminate\Database\Eloquent\Model|TModel> $callback
802+
* @param callable(self): class-string<TModel> $callback
801803
* @return void
802804
*/
803805
public static function guessModelNamesUsing(callable $callback)
@@ -819,8 +821,10 @@ public static function useNamespace(string $namespace)
819821
/**
820822
* Get a new factory instance for the given model name.
821823
*
822-
* @param class-string<\Illuminate\Database\Eloquent\Model> $modelName
823-
* @return \Illuminate\Database\Eloquent\Factories\Factory
824+
* @template TClass of \Illuminate\Database\Eloquent\Model
825+
*
826+
* @param class-string<TClass> $modelName
827+
* @return \Illuminate\Database\Eloquent\Factories\Factory<TClass>
824828
*/
825829
public static function factoryForModel(string $modelName)
826830
{
@@ -853,8 +857,10 @@ protected function withFaker()
853857
/**
854858
* Get the factory name for the given model name.
855859
*
856-
* @param class-string<\Illuminate\Database\Eloquent\Model> $modelName
857-
* @return class-string<\Illuminate\Database\Eloquent\Factories\Factory>
860+
* @template TClass of \Illuminate\Database\Eloquent\Model
861+
*
862+
* @param class-string<TClass> $modelName
863+
* @return class-string<\Illuminate\Database\Eloquent\Factories\Factory<TClass>>
858864
*/
859865
public static function resolveFactoryName(string $modelName)
860866
{
@@ -880,8 +886,8 @@ protected static function appNamespace()
880886
{
881887
try {
882888
return Container::getInstance()
883-
->make(Application::class)
884-
->getNamespace();
889+
->make(Application::class)
890+
->getNamespace();
885891
} catch (Throwable) {
886892
return 'App\\';
887893
}

‎src/Illuminate/Database/Eloquent/Factories/HasFactory.php

+13-6
Original file line numberDiff line numberDiff line change
@@ -2,18 +2,21 @@
22

33
namespace Illuminate\Database\Eloquent\Factories;
44

5+
/**
6+
* @template TFactory of \Illuminate\Database\Eloquent\Factories\Factory
7+
*/
58
trait HasFactory
69
{
710
/**
811
* Get a new factory instance for the model.
912
*
10-
* @param callable|array|int|null $count
11-
* @param callable|array $state
12-
* @return \Illuminate\Database\Eloquent\Factories\Factory<static>
13+
* @param (callable(array<string, mixed>, static|null): array<string, mixed>)|array<string, mixed>|int|null $count
14+
* @param (callable(array<string, mixed>, static|null): array<string, mixed>)|array<string, mixed> $state
15+
* @return TFactory
1316
*/
1417
public static function factory($count = null, $state = [])
1518
{
16-
$factory = static::newFactory() ?: Factory::factoryForModel(get_called_class());
19+
$factory = static::newFactory() ?? Factory::factoryForModel(get_called_class());
1720

1821
return $factory
1922
->count(is_numeric($count) ? $count : null)
@@ -23,10 +26,14 @@ public static function factory($count = null, $state = [])
2326
/**
2427
* Create a new factory instance for the model.
2528
*
26-
* @return \Illuminate\Database\Eloquent\Factories\Factory<static>
29+
* @return TFactory|null
2730
*/
2831
protected static function newFactory()
2932
{
30-
//
33+
if (isset(static::$factory)) {
34+
return static::$factory::new();
35+
}
36+
37+
return null;
3138
}
3239
}

‎tests/Database/Fixtures/Models/Money/Price.php

+2-4
Original file line numberDiff line numberDiff line change
@@ -8,12 +8,10 @@
88

99
class Price extends Model
1010
{
11+
/** @use HasFactory<PriceFactory> */
1112
use HasFactory;
1213

1314
protected $table = 'prices';
1415

15-
public static function factory()
16-
{
17-
return PriceFactory::new();
18-
}
16+
protected static string $factory = PriceFactory::class;
1917
}

‎types/Autoload.php

+20
Original file line numberDiff line numberDiff line change
@@ -1,17 +1,37 @@
11
<?php
22

3+
use Illuminate\Database\Eloquent\Factories\Factory;
34
use Illuminate\Database\Eloquent\Factories\HasFactory;
45
use Illuminate\Database\Eloquent\MassPrunable;
6+
use Illuminate\Database\Eloquent\Model;
57
use Illuminate\Database\Eloquent\SoftDeletes;
68
use Illuminate\Foundation\Auth\User as Authenticatable;
79
use Illuminate\Notifications\HasDatabaseNotifications;
810

911
class User extends Authenticatable
1012
{
1113
use HasDatabaseNotifications;
14+
/** @use HasFactory<UserFactory> */
1215
use HasFactory;
1316
use MassPrunable;
1417
use SoftDeletes;
18+
19+
protected static string $factory = UserFactory::class;
20+
}
21+
22+
/** @extends Factory<User> */
23+
class UserFactory extends Factory
24+
{
25+
protected $model = User::class;
26+
27+
public function definition(): array
28+
{
29+
return [];
30+
}
31+
}
32+
33+
class Post extends Model
34+
{
1535
}
1636

1737
enum UserType

0 commit comments

Comments
 (0)