Add ReplaceFakerInstanceWithHelperRector (#77)

Add ReplaceFakerInstanceWithHelperRector

Author: GeniJaho

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\PropertyFetch\ReplaceFakerInstanceWithHelperRector;
 
 # see https://laravel.com/docs/9.x/upgrade
 return static function (RectorConfig $rectorConfig): void {
@@ -77,6 +78,9 @@
         ),
         ]);
 
+    // https://github.com/laravel/framework/commit/7746337149a7ffd6b4a862d9bd54593cf3520708
+    $rectorConfig->rule(ReplaceFakerInstanceWithHelperRector::class);
+
     $rectorConfig
         ->ruleWithConfiguration(RenameMethodRector::class, [
             // https://github.com/laravel/framework/commit/9b4f011fb95c70444812f61d46c8e21fb5b66dd9

docs/rector_rules_overview.md

@@ -1,4 +1,4 @@
-# 26 Rules Overview
+# 27 Rules Overview
 
 ## AddArgumentDefaultValueRector
 
@@ -525,6 +525,29 @@ It will removes the dump data just like dd or dump functions from the code.`
 
 <br>
 
+## ReplaceFakerInstanceWithHelperRector
+
+Replace `$this->faker` with the `fake()` helper function in Factories
+
+- class: [`RectorLaravel\Rector\PropertyFetch\ReplaceFakerInstanceWithHelperRector`](../src/Rector/PropertyFetch/ReplaceFakerInstanceWithHelperRector.php)
+
+```diff
+ class UserFactory extends Factory
+ {
+     public function definition()
+     {
+         return [
+-            'name' => $this->faker->name,
+-            'email' => $this->faker->unique()->safeEmail,
++            'name' => fake()->name,
++            'email' => fake()->unique()->safeEmail,
+         ];
+     }
+ }
+```
+
+<br>
+
 ## RequestStaticValidateToInjectRector
 
 Change static `validate()` method to `$request->validate()`

src/Rector/PropertyFetch/ReplaceFakerInstanceWithHelperRector.php

@@ -0,0 +1,108 @@
+<?php
+
+declare(strict_types=1);
+
+namespace RectorLaravel\Rector\PropertyFetch;
+
+use PhpParser\Node;
+use PhpParser\Node\Expr\MethodCall;
+use PhpParser\Node\Expr\PropertyFetch;
+use PhpParser\Node\Stmt\Class_;
+use PhpParser\Node\Stmt\ClassLike;
+use PHPStan\Type\ObjectType;
+use Rector\Core\Rector\AbstractRector;
+use Symplify\RuleDocGenerator\ValueObject\CodeSample\CodeSample;
+use Symplify\RuleDocGenerator\ValueObject\RuleDefinition;
+
+/**
+ * @see \RectorLaravel\Tests\Rector\PropertyFetch\ReplaceFakerInstanceWithHelperRector\ReplaceFakerInstanceWithHelperRectorTest
+ */
+final class ReplaceFakerInstanceWithHelperRector extends AbstractRector
+{
+    public function getRuleDefinition(): RuleDefinition
+    {
+        return new RuleDefinition(
+            'Replace $this->faker with the fake() helper function in Factories',
+            [
+                new CodeSample(
+                    <<<'CODE_SAMPLE'
+class UserFactory extends Factory
+{
+    public function definition()
+    {
+        return [
+            'name' => $this->faker->name,
+            'email' => $this->faker->unique()->safeEmail,
+        ];
+    }
+}
+CODE_SAMPLE
+                    ,
+                    <<<'CODE_SAMPLE'
+class UserFactory extends Factory
+{
+    public function definition()
+    {
+        return [
+            'name' => fake()->name,
+            'email' => fake()->unique()->safeEmail,
+        ];
+    }
+}
+CODE_SAMPLE
+                ),
+            ]
+        );
+    }
+
+    /**
+     * @return array<class-string<Node>>
+     */
+    public function getNodeTypes(): array
+    {
+        return [PropertyFetch::class];
+    }
+
+    /**
+     * @param PropertyFetch $node
+     */
+    public function refactor(Node $node): ?Node
+    {
+        if ($this->shouldSkipNode($node)) {
+            return null;
+        }
+
+        return $this->nodeFactory->createFuncCall('fake');
+    }
+
+    private function shouldSkipNode(PropertyFetch $propertyFetch): bool
+    {
+        if (! $this->isName($propertyFetch->var, 'this')) {
+            return true;
+        }
+
+        if (! $this->isName($propertyFetch->name, 'faker')) {
+            return true;
+        }
+
+        // The randomEnum() method is a special case where the faker instance is used
+        // see https://github.com/spatie/laravel-enum#faker-provider
+        $parent = $propertyFetch->getAttribute('parent');
+
+        if ($parent instanceof MethodCall && $this->isName($parent->name, 'randomEnum')) {
+            return true;
+        }
+
+        $classLike = $this->betterNodeFinder->findParentType($propertyFetch, ClassLike::class);
+
+        if (! $classLike instanceof ClassLike) {
+            return true;
+        }
+
+        if ($classLike instanceof Class_) {
+            return ! $this->isObjectType($classLike, new ObjectType('Illuminate\Database\Eloquent\Factories\Factory'));
+        }
+
+        return false;
+    }
+}

tests/Rector/PropertyFetch/ReplaceFakerInstanceWithHelperRector/Fixture/fixture.php.inc

@@ -0,0 +1,29 @@
+<?php
+use Illuminate\Database\Eloquent\Factories\Factory;
+
+class UserFactory extends Factory
+{
+    public function definition()
+    {
+        return [
+            'name' => $this->faker->name,
+            'email' => $this->faker->unique()->safeEmail,
+        ];
+    }
+}
+?>
+-----
+<?php
+use Illuminate\Database\Eloquent\Factories\Factory;
+
+class UserFactory extends Factory
+{
+    public function definition()
+    {
+        return [
+            'name' => fake()->name,
+            'email' => fake()->unique()->safeEmail,
+        ];
+    }
+}
+?>

tests/Rector/PropertyFetch/ReplaceFakerInstanceWithHelperRector/Fixture/skip_already.php.inc

@@ -0,0 +1,15 @@
+<?php
+
+use Illuminate\Database\Eloquent\Factories\Factory;
+
+class UserFactory extends Factory
+{
+    public function definition()
+    {
+        return [
+            'name' => fake()->name,
+            'email' => fake()->unique()->safeEmail,
+            'test' => $this->test,
+        ];
+    }
+}

tests/Rector/PropertyFetch/ReplaceFakerInstanceWithHelperRector/Fixture/skip_other_than_model_factories.php.inc

@@ -0,0 +1,12 @@
+<?php
+
+class SomeFactory
+{
+    public function definition()
+    {
+        return [
+            'name' => $this->faker->name,
+            'email' => $this->faker->unique()->safeEmail,
+        ];
+    }
+}

tests/Rector/PropertyFetch/ReplaceFakerInstanceWithHelperRector/Fixture/skip_spatie_enum_helper.php.inc

@@ -0,0 +1,13 @@
+<?php
+
+use Illuminate\Database\Eloquent\Factories\Factory;
+
+class TestFactory extends Factory
+{
+    public function definition()
+    {
+        return [
+            'name' => $this->faker->randomEnum(SomeEnum::class),
+        ];
+    }
+}

tests/Rector/PropertyFetch/ReplaceFakerInstanceWithHelperRector/ReplaceFakerInstanceWithHelperRectorTest.php

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

tests/Rector/PropertyFetch/ReplaceFakerInstanceWithHelperRector/config/configured_rule.php

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