Remove the model property from Factories and add extends annotation

config/sets/laravel90.php

@@ -10,6 +10,7 @@
 use Rector\Renaming\ValueObject\MethodCallRename;
 use Rector\Visibility\Rector\ClassMethod\ChangeMethodVisibilityRector;
 use Rector\Visibility\ValueObject\ChangeMethodVisibility;
+use RectorLaravel\Rector\Class_\AddExtendsAnnotationToModelFactoriesRector;
 use RectorLaravel\Rector\PropertyFetch\ReplaceFakerInstanceWithHelperRector;
 
 # see https://laravel.com/docs/9.x/upgrade
@@ -70,6 +71,9 @@
     // https://github.com/laravel/framework/commit/7746337149a7ffd6b4a862d9bd54593cf3520708
     $rectorConfig->rule(ReplaceFakerInstanceWithHelperRector::class);
 
+    // https://github.com/laravel/framework/pull/39169
+    $rectorConfig->rule(AddExtendsAnnotationToModelFactoriesRector::class);
+
     $rectorConfig
         ->ruleWithConfiguration(RenameMethodRector::class, [
             // https://github.com/laravel/framework/commit/9b4f011fb95c70444812f61d46c8e21fb5b66dd9

docs/rector_rules_overview.md

@@ -1,4 +1,4 @@
-# 37 Rules Overview
+# 39 Rules Overview
 
 ## AddArgumentDefaultValueRector
 
@@ -40,6 +40,26 @@ return static function (RectorConfig $rectorConfig): void {
 
 <br>
 
+## AddExtendsAnnotationToModelFactoriesRector
+
+Adds the `@extends` annotation to Factories.
+
+- class: [`RectorLaravel\Rector\Class_\AddExtendsAnnotationToModelFactoriesRector`](../src/Rector/Class_/AddExtendsAnnotationToModelFactoriesRector.php)
+
+```diff
+ use Illuminate\Database\Eloquent\Factories\Factory;
+
++/**
++ * @extends \Illuminate\Database\Eloquent\Factories\Factory<\App\Models\User>
++ */
+ class UserFactory extends Factory
+ {
+     protected $model = \App\Models\User::class;
+ }
+```
+
+<br>
+
 ## AddGenericReturnTypeToRelationsRector
 
 Add generic return type to relations in child of `Illuminate\Database\Eloquent\Model`
@@ -795,6 +815,23 @@ It will removes the dump data just like dd or dump functions from the code.`
 
 <br>
 
+## RemoveModelPropertyFromFactoriesRector
+
+Removes the `$model` property from Factories.
+
+- class: [`RectorLaravel\Rector\Class_\RemoveModelPropertyFromFactoriesRector`](../src/Rector/Class_/RemoveModelPropertyFromFactoriesRector.php)
+
+```diff
+ use Illuminate\Database\Eloquent\Factories\Factory;
+
+ class UserFactory extends Factory
+ {
+-    protected $model = \App\Models\User::class;
+ }
+```
+
+<br>
+
 ## ReplaceFakerInstanceWithHelperRector
 
 Replace `$this->faker` with the `fake()` helper function in Factories

src/Rector/Class_/AddExtendsAnnotationToModelFactoriesRector.php

@@ -0,0 +1,137 @@
+<?php
+
+declare(strict_types=1);
+
+namespace RectorLaravel\Rector\Class_;
+
+use PhpParser\Node;
+use PhpParser\Node\Expr;
+use PhpParser\Node\Expr\ClassConstFetch;
+use PhpParser\Node\Scalar\String_;
+use PhpParser\Node\Stmt\Class_;
+use PhpParser\Node\Stmt\Property;
+use PHPStan\PhpDocParser\Ast\PhpDoc\ExtendsTagValueNode;
+use PHPStan\PhpDocParser\Ast\PhpDoc\PhpDocTagNode;
+use PHPStan\PhpDocParser\Ast\Type\GenericTypeNode;
+use PHPStan\Type\ObjectType;
+use Rector\BetterPhpDocParser\ValueObject\Type\FullyQualifiedIdentifierTypeNode;
+use Rector\Core\Rector\AbstractRector;
+use Symplify\RuleDocGenerator\ValueObject\CodeSample\CodeSample;
+use Symplify\RuleDocGenerator\ValueObject\RuleDefinition;
+
+/**
+ * @changelog https://github.com/laravel/framework/pull/39169
+ *
+ * @see \RectorLaravel\Tests\Rector\Class_\AddExtendsAnnotationToModelFactoriesRector\AddExtendsAnnotationToModelFactoriesRectorTest
+ */
+final class AddExtendsAnnotationToModelFactoriesRector extends AbstractRector
+{
+    private const EXTENDS_TAG_NAME = '@extends';
+
+    private const FACTORY_CLASS_NAME = 'Illuminate\Database\Eloquent\Factories\Factory';
+
+    public function getRuleDefinition(): RuleDefinition
+    {
+        return new RuleDefinition('Adds the @extends annotation to Factories.', [
+            new CodeSample(
+                <<<'CODE_SAMPLE'
+use Illuminate\Database\Eloquent\Factories\Factory;
+
+class UserFactory extends Factory
+{
+    protected $model = \App\Models\User::class;
+}
+CODE_SAMPLE
+
+                ,
+                <<<'CODE_SAMPLE'
+use Illuminate\Database\Eloquent\Factories\Factory;
+
+/**
+ * @extends \Illuminate\Database\Eloquent\Factories\Factory<\App\Models\User>
+ */
+class UserFactory extends Factory
+{
+    protected $model = \App\Models\User::class;
+}
+CODE_SAMPLE
+            ),
+        ]);
+    }
+
+    /**
+     * @return array<class-string<Node>>
+     */
+    public function getNodeTypes(): array
+    {
+        return [Class_::class];
+    }
+
+    /**
+     * @param Class_ $node
+     */
+    public function refactor(Node $node): ?Node
+    {
+        if (! $this->isObjectType($node, new ObjectType(self::FACTORY_CLASS_NAME))) {
+            return null;
+        }
+
+        foreach ($node->stmts as $stmt) {
+            if (! $stmt instanceof Property) {
+                continue;
+            }
+
+            if (! $this->isName($stmt, 'model')) {
+                continue;
+            }
+
+            $this->addExtendsPhpDocTag($node, $stmt);
+
+            break;
+        }
+
+        return $node;
+    }
+
+    public function addExtendsPhpDocTag(Node $node, Property $property): void
+    {
+        if ($property->props === []) {
+            return;
+        }
+
+        $modelName = $this->getModelName($property->props[0]->default);
+
+        if ($modelName === null) {
+            return;
+        }
+
+        $phpDocInfo = $this->phpDocInfoFactory->createFromNodeOrEmpty($node);
+
+        if ($phpDocInfo->hasByName(self::EXTENDS_TAG_NAME)) {
+            return;
+        }
+
+        $phpDocTagNode = new PhpDocTagNode(self::EXTENDS_TAG_NAME, new ExtendsTagValueNode(
+            new GenericTypeNode(
+                new FullyQualifiedIdentifierTypeNode(self::FACTORY_CLASS_NAME),
+                [new FullyQualifiedIdentifierTypeNode($modelName)]
+            ),
+            ''
+        ));
+
+        $phpDocInfo->addPhpDocTagNode($phpDocTagNode);
+    }
+
+    private function getModelName(?Expr $defaultProp): ?string
+    {
+        if ($defaultProp instanceof ClassConstFetch) {
+            return $this->getName($defaultProp->class);
+        }
+
+        if ($defaultProp instanceof String_) {
+            return $defaultProp->value;
+        }
+
+        return null;
+    }
+}

src/Rector/Class_/RemoveModelPropertyFromFactoriesRector.php

@@ -0,0 +1,80 @@
+<?php
+
+declare(strict_types=1);
+
+namespace RectorLaravel\Rector\Class_;
+
+use PhpParser\Node;
+use PhpParser\Node\Stmt\Class_;
+use PhpParser\Node\Stmt\Property;
+use PHPStan\Type\ObjectType;
+use Rector\Core\Rector\AbstractRector;
+use Symplify\RuleDocGenerator\ValueObject\CodeSample\CodeSample;
+use Symplify\RuleDocGenerator\ValueObject\RuleDefinition;
+
+/**
+ * @changelog https://github.com/laravel/framework/pull/39310
+ *
+ * @see \RectorLaravel\Tests\Rector\Class_\RemoveModelPropertyFromFactoriesRector\RemoveModelPropertyFromFactoriesRectorTest
+ */
+final class RemoveModelPropertyFromFactoriesRector extends AbstractRector
+{
+    public function getRuleDefinition(): RuleDefinition
+    {
+        return new RuleDefinition('Removes the $model property from Factories.', [
+            new CodeSample(
+                <<<'CODE_SAMPLE'
+use Illuminate\Database\Eloquent\Factories\Factory;
+
+class UserFactory extends Factory
+{
+    protected $model = \App\Models\User::class;
+}
+CODE_SAMPLE
+
+                ,
+                <<<'CODE_SAMPLE'
+use Illuminate\Database\Eloquent\Factories\Factory;
+
+class UserFactory extends Factory
+{
+}
+CODE_SAMPLE
+            ),
+        ]);
+    }
+
+    /**
+     * @return array<class-string<Node>>
+     */
+    public function getNodeTypes(): array
+    {
+        return [Class_::class];
+    }
+
+    /**
+     * @param Class_ $node
+     */
+    public function refactor(Node $node): ?Node
+    {
+        if (! $this->isObjectType($node, new ObjectType('Illuminate\Database\Eloquent\Factories\Factory'))) {
+            return null;
+        }
+
+        foreach ($node->stmts as $index => $stmt) {
+            if (! $stmt instanceof Property) {
+                continue;
+            }
+
+            if (! $this->isName($stmt, 'model')) {
+                continue;
+            }
+
+            unset($node->stmts[$index]);
+
+            break;
+        }
+
+        return $node;
+    }
+}

tests/Rector/Class_/AddExtendsAnnotationToModelFactoriesRector/AddExtendsAnnotationToModelFactoriesRectorTest.php

@@ -0,0 +1,28 @@
+<?php
+
+declare(strict_types=1);
+
+namespace RectorLaravel\Tests\Rector\Class_\AddExtendsAnnotationToModelFactoriesRector;
+
+use Iterator;
+use PHPUnit\Framework\Attributes\DataProvider;
+use Rector\Testing\PHPUnit\AbstractRectorTestCase;
+
+final class AddExtendsAnnotationToModelFactoriesRectorTest extends AbstractRectorTestCase
+{
+    #[DataProvider('provideData')]
+    public function test(string $filePath): void
+    {
+        $this->doTestFile($filePath);
+    }
+
+    public static function provideData(): Iterator
+    {
+        return self::yieldFilesFromDirectory(__DIR__ . '/Fixture');
+    }
+
+    public function provideConfigFilePath(): string
+    {
+        return __DIR__ . '/config/configured_rule.php';
+    }
+}

tests/Rector/Class_/AddExtendsAnnotationToModelFactoriesRector/Fixture/fixture.php.inc

@@ -0,0 +1,28 @@
+<?php
+
+namespace RectorLaravel\Tests\Rector\Class_\AddExtendsAnnotationToModelFactoriesRector\Fixture;
+
+use Illuminate\Database\Eloquent\Factories\Factory;
+
+class UserFactory extends Factory
+{
+    protected $model = \App\Models\User::class;
+}
+
+?>
+-----
+<?php
+
+namespace RectorLaravel\Tests\Rector\Class_\AddExtendsAnnotationToModelFactoriesRector\Fixture;
+
+use Illuminate\Database\Eloquent\Factories\Factory;
+
+/**
+ * @extends \Illuminate\Database\Eloquent\Factories\Factory<\App\Models\User>
+ */
+class UserFactory extends Factory
+{
+    protected $model = \App\Models\User::class;
+}
+
+?>

tests/Rector/Class_/AddExtendsAnnotationToModelFactoriesRector/Fixture/skip_existing_extends_tag.php.inc

@@ -0,0 +1,15 @@
+<?php
+
+namespace RectorLaravel\Tests\Rector\Class_\AddExtendsAnnotationToModelFactoriesRector\Fixture;
+
+use Illuminate\Database\Eloquent\Factories\Factory;
+
+/**
+ * @extends \Illuminate\Database\Eloquent\Factories\Factory<\App\Models\User>
+ */
+class UserFactory extends Factory
+{
+    protected $model = \App\Models\User::class;
+}
+
+?>

tests/Rector/Class_/AddExtendsAnnotationToModelFactoriesRector/Fixture/using_class_string_as_model_type.php.inc

@@ -0,0 +1,28 @@
+<?php
+
+namespace RectorLaravel\Tests\Rector\Class_\AddExtendsAnnotationToModelFactoriesRector\Fixture;
+
+use Illuminate\Database\Eloquent\Factories\Factory;
+
+class UserFactory extends Factory
+{
+    protected $model = 'App\Models\User';
+}
+
+?>
+-----
+<?php
+
+namespace RectorLaravel\Tests\Rector\Class_\AddExtendsAnnotationToModelFactoriesRector\Fixture;
+
+use Illuminate\Database\Eloquent\Factories\Factory;
+
+/**
+ * @extends \Illuminate\Database\Eloquent\Factories\Factory<\App\Models\User>
+ */
+class UserFactory extends Factory
+{
+    protected $model = 'App\Models\User';
+}
+
+?>