Add rule to add HasFactory to Models

Author: jradtilbrook

src/Rector/Class_/AddHasFactoryToModelsRector.php

@@ -0,0 +1,93 @@
+<?php
+
+declare(strict_types=1);
+
+namespace RectorLaravel\Rector\Class_;
+
+use PhpParser\Node;
+use PhpParser\Node\Name\FullyQualified;
+use PhpParser\Node\Stmt\Class_;
+use PhpParser\Node\Stmt\TraitUse;
+use PHPStan\Reflection\ClassReflection;
+use PHPStan\Type\ObjectType;
+use Rector\Rector\AbstractRector;
+use Rector\Reflection\ReflectionResolver;
+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 AddHasFactoryToModelsRector extends AbstractRector
+{
+    private const string TRAIT_NAME = 'Illuminate\Database\Eloquent\Factories\HasFactory';
+
+    public function __construct(
+        private readonly ReflectionResolver $reflectionResolver,
+    ) {}
+
+    public function getRuleDefinition(): RuleDefinition
+    {
+        return new RuleDefinition('Adds the HasFactory trait to Models.', [
+            new CodeSample(
+                <<<'CODE_SAMPLE'
+use Illuminate\Database\Eloquent\Model;
+
+class User extends Model
+{
+}
+CODE_SAMPLE
+
+                ,
+                <<<'CODE_SAMPLE'
+use Illuminate\Database\Eloquent\Model;
+
+class User extends Model
+{
+    use \Illuminate\Database\Eloquent\Factories\HasFactory;
+}
+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->shouldSkipClass($node)) {
+            return null;
+        }
+
+        $traitUse = new TraitUse([new FullyQualified(self::TRAIT_NAME)]);
+
+        $node->stmts = array_merge([$traitUse], $node->stmts);
+
+        return $node;
+    }
+
+    private function shouldSkipClass(Class_ $class): bool
+    {
+        if (! $this->isObjectType($class, new ObjectType('Illuminate\Database\Eloquent\Model'))) {
+            return null;
+        }
+
+        $classReflection = $this->reflectionResolver->resolveClassReflection($class);
+        if (! $classReflection instanceof ClassReflection) {
+            return false;
+        }
+
+        return $classReflection->hasTraitUse(self::TRAIT_NAME);
+    }
+}

stubs/Illuminate/Database/Eloquent/Factories/HasFactory.php

@@ -0,0 +1,9 @@
+<?php
+
+namespace Illuminate\Database\Eloquent\Factories;
+
+if (trait_exists('Illuminate\Database\Eloquent\Factories\HasFactory')) {
+    return;
+}
+
+trait HasFactory {}

tests/Rector/Class_/AddHasFactoryToModelsRector/AddHasFactoryToModelsRectorTest.php

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

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

@@ -0,0 +1,24 @@
+<?php
+
+namespace RectorLaravel\Tests\Rector\Class_\RemoveModelPropertyFromFactoriesRector\Fixture;
+
+use Illuminate\Database\Eloquent\Model;
+
+class User extends Model
+{
+}
+
+?>
+-----
+<?php
+
+namespace RectorLaravel\Tests\Rector\Class_\RemoveModelPropertyFromFactoriesRector\Fixture;
+
+use Illuminate\Database\Eloquent\Model;
+
+class User extends Model
+{
+    use \Illuminate\Database\Eloquent\Factories\HasFactory;
+}
+
+?>

tests/Rector/Class_/AddHasFactoryToModelsRector/Fixture/skip_if_already_present.php.inc

@@ -0,0 +1,12 @@
+<?php
+
+namespace RectorLaravel\Tests\Rector\Class_\RemoveModelPropertyFromFactoriesRector\Fixture;
+
+use Illuminate\Database\Eloquent\Model;
+
+class SkipIfAlreadyPresent extends Model
+{
+    use \Illuminate\Database\Eloquent\Factories\HasFactory;
+}
+
+?>

tests/Rector/Class_/AddHasFactoryToModelsRector/config/configured_rule.php

@@ -0,0 +1,12 @@
+<?php
+
+declare(strict_types=1);
+
+use Rector\Config\RectorConfig;
+use RectorLaravel\Rector\Class_\AddHasFactoryToModelsRector;
+
+return static function (RectorConfig $rectorConfig): void {
+    $rectorConfig->import(__DIR__ . '/../../../../../config/config.php');
+
+    $rectorConfig->rule(AddHasFactoryToModelsRector::class);
+};