Update docs (#143)

Update docs

Author: driftingly

docs/rector_rules_overview.md

@@ -1,4 +1,4 @@
-# 41 Rules Overview
+# 45 Rules Overview
 
 ## AddArgumentDefaultValueRector
 
@@ -478,10 +478,11 @@ The EloquentMagicMethodToQueryBuilderRule is designed to automatically transform
 - class: [`RectorLaravel\Rector\StaticCall\EloquentMagicMethodToQueryBuilderRector`](../src/Rector/StaticCall/EloquentMagicMethodToQueryBuilderRector.php)
 
 ```diff
--User::find(1);
--User::where('email', '[email protected]')->first();
-+User::query()->find(1);
-+User::query()->where('email', '[email protected]')->first();
+ use App\Models\User;
+
+-$user = User::find(1);
++$user = User::query()->find(1);
+```
 
 <br>
 
@@ -500,31 +501,10 @@ Changes `orderBy()` to `latest()` or `oldest()`
 +$builder->latest();
 +$builder->oldest();
 +$builder->latest('deleted_at');
-
- use App\Models\User;
-
--$user = User::find(1);
-+$user = User::query()->find(1);
 ```
 
 <br>
 
-## EloquentWhereTypeHintClosureParameterRector
-
-Change typehint of closure parameter in where method of Eloquent Builder
-
-- class: [`RectorLaravel\Rector\MethodCall\EloquentWhereTypeHintClosureParameterRector`](../src/Rector/MethodCall/EloquentWhereTypeHintClosureParameterRector.php)
-
-```diff
--$query->where(function ($query) {
-+$query->where(function (\Illuminate\Contracts\Database\Eloquent\Builder $query) {
-     $query->where('id', 1);
- });
-```
-
-<br>
-
-
 ## EloquentWhereRelationTypeHintingParameterRector
 
 Add type hinting to where relation has methods e.g. `whereHas`, `orWhereHas`, `whereDoesntHave`, `orWhereDoesntHave`, `whereHasMorph`, `orWhereHasMorph`, `whereDoesntHaveMorph`, `orWhereDoesntHaveMorph`
@@ -545,6 +525,21 @@ Add type hinting to where relation has methods e.g. `whereHas`, `orWhereHas`, `w
 
 <br>
 
+## EloquentWhereTypeHintClosureParameterRector
+
+Change typehint of closure parameter in where method of Eloquent Builder
+
+- class: [`RectorLaravel\Rector\MethodCall\EloquentWhereTypeHintClosureParameterRector`](../src/Rector/MethodCall/EloquentWhereTypeHintClosureParameterRector.php)
+
+```diff
+-$query->where(function ($query) {
++$query->where(function (\Illuminate\Contracts\Database\Eloquent\Builder $query) {
+     $query->where('id', 1);
+ });
+```
+
+<br>
+
 ## EmptyToBlankAndFilledFuncRector
 
 Replace use of the unsafe `empty()` function with Laravel's safer `blank()` & `filled()` functions.

src/Rector/Assign/CallOnAppArrayAccessToStandaloneAssignRector.php

@@ -11,6 +11,7 @@
 use PhpParser\Node\Expr\MethodCall;
 use PhpParser\Node\Expr\Variable;
 use PhpParser\Node\Stmt\Expression;
+use PhpParser\Node\Stmt\Nop;
 use PHPStan\Type\ObjectType;
 use Rector\Comments\NodeDocBlock\DocBlockUpdater;
 use Rector\Core\Rector\AbstractRector;
@@ -96,7 +97,7 @@ public function refactor(Node $node): Node|array|int|null
 
             // the nop is a workaround because the docs of the first node are somehow stripped away
             // this will add a newline but the docs will be preserved
-            return [new Node\Stmt\Nop(), $assignExpression, $node];
+            return [new Nop(), $assignExpression, $node];
         }
 
         return null;

src/Rector/ClassMethod/AddGenericReturnTypeToRelationsRector.php

@@ -315,12 +315,7 @@ private function shouldSkipNode(ClassMethod $classMethod, Scope $scope): bool
         if (! $classReflection instanceof ClassReflection || $classReflection->isAnonymous()) {
             return true;
         }
-
-        if (! $classReflection->isTrait() && ! $classReflection->isSubclassOf('Illuminate\Database\Eloquent\Model')) {
-            return true;
-        }
-
-        return false;
+        return ! $classReflection->isTrait() && ! $classReflection->isSubclassOf('Illuminate\Database\Eloquent\Model');
     }
 
     /**

src/Rector/ClassMethod/MigrateToSimplifiedAttributeRector.php

@@ -129,8 +129,8 @@ private function refactorClassMethod(ClassMethod $classMethod, array $allClassMe
         }
 
         // Skip if the new attribute name is already used
-        foreach ($allClassMethods as $method) {
-            if ($this->isName($method, $attributeName)) {
+        foreach ($allClassMethods as $allClassMethod) {
+            if ($this->isName($allClassMethod, $attributeName)) {
                 return null;
             }
         }
@@ -276,9 +276,9 @@ private function isMutator(string $nodeName): bool
      */
     private function findPossibleAccessor(array $allClassMethods, string $attributeName): ?ClassMethod
     {
-        foreach ($allClassMethods as $classMethod) {
-            if ($classMethod->name->toString() === 'get' . ucfirst($attributeName) . 'Attribute') {
-                return $classMethod;
+        foreach ($allClassMethods as $allClassMethod) {
+            if ($allClassMethod->name->toString() === 'get' . ucfirst($attributeName) . 'Attribute') {
+                return $allClassMethod;
             }
         }
 
@@ -290,9 +290,9 @@ private function findPossibleAccessor(array $allClassMethods, string $attributeN
      */
     private function findPossibleMutator(array $allClassMethods, string $attributeName): ?ClassMethod
     {
-        foreach ($allClassMethods as $classMethod) {
-            if ($classMethod->name->toString() === 'set' . ucfirst($attributeName) . 'Attribute') {
-                return $classMethod;
+        foreach ($allClassMethods as $allClassMethod) {
+            if ($allClassMethod->name->toString() === 'set' . ucfirst($attributeName) . 'Attribute') {
+                return $allClassMethod;
             }
         }
 

src/Rector/Class_/AddExtendsAnnotationToModelFactoriesRector.php

@@ -130,14 +130,14 @@ public function addExtendsPhpDocTag(Node $node, Property $property): void
         $phpDocInfo->addPhpDocTagNode($phpDocTagNode);
     }
 
-    private function getModelName(?Expr $defaultProp): ?string
+    private function getModelName(?Expr $expr): ?string
     {
-        if ($defaultProp instanceof ClassConstFetch) {
-            return $this->getName($defaultProp->class);
+        if ($expr instanceof ClassConstFetch) {
+            return $this->getName($expr->class);
         }
 
-        if ($defaultProp instanceof String_) {
-            return $defaultProp->value;
+        if ($expr instanceof String_) {
+            return $expr->value;
         }
 
         return null;

src/Rector/Class_/CashierStripeOptionsToStripeRector.php

@@ -77,13 +77,13 @@ public function refactorWithScope(Node $node, Scope $scope): ?Node
         }
 
         /** @var Class_ $node */
-        $stripeOptionsMethod = $node->getMethod('stripeOptions');
+        $classMethod = $node->getMethod('stripeOptions');
 
-        if (! $stripeOptionsMethod instanceof ClassMethod) {
+        if (! $classMethod instanceof ClassMethod) {
             return null;
         }
 
-        $stripeOptionsMethod->name = new Identifier('stripe');
+        $classMethod->name = new Identifier('stripe');
 
         return $node;
     }

src/Rector/Expr/AppEnvironmentComparisonToParameterRector.php

@@ -5,9 +5,13 @@
 namespace RectorLaravel\Rector\Expr;
 
 use PhpParser\Node;
+use PhpParser\Node\Arg;
 use PhpParser\Node\Expr;
 use PhpParser\Node\Expr\BinaryOp\Equal;
 use PhpParser\Node\Expr\BinaryOp\Identical;
+use PhpParser\Node\Expr\MethodCall;
+use PhpParser\Node\Expr\StaticCall;
+use PhpParser\Node\Scalar\String_;
 use PHPStan\Type\ObjectType;
 use Rector\Core\Rector\AbstractRector;
 use Symplify\RuleDocGenerator\ValueObject\CodeSample\CodeSample;
@@ -41,7 +45,7 @@ public function getNodeTypes(): array
         return [Expr::class];
     }
 
-    public function refactor(Node $node): Expr\MethodCall|Expr\StaticCall|null
+    public function refactor(Node $node): MethodCall|StaticCall|null
     {
         if (! $node instanceof Identical && ! $node instanceof Equal) {
             return null;
@@ -51,7 +55,7 @@ public function refactor(Node $node): Expr\MethodCall|Expr\StaticCall|null
         $methodCall = array_values(
             array_filter(
                 [$node->left, $node->right],
-                fn ($node) => ($node instanceof Node\Expr\MethodCall || $node instanceof Node\Expr\StaticCall) && $this->isName(
+                fn ($node) => ($node instanceof MethodCall || $node instanceof StaticCall) && $this->isName(
                     $node->name,
                     'environment'
                 )
@@ -67,7 +71,7 @@ public function refactor(Node $node): Expr\MethodCall|Expr\StaticCall|null
             array_filter([$node->left, $node->right], static fn ($node) => $node !== $methodCall)
         )[0] ?? null;
 
-        if (! $otherNode instanceof Node\Scalar\String_) {
+        if (! $otherNode instanceof String_) {
             return null;
         }
 
@@ -76,23 +80,23 @@ public function refactor(Node $node): Expr\MethodCall|Expr\StaticCall|null
             return null;
         }
 
-        $methodCall->args[] = new Node\Arg($otherNode);
+        $methodCall->args[] = new Arg($otherNode);
 
         return $methodCall;
     }
 
-    private function validMethodCall(Expr\MethodCall|Expr\StaticCall $methodCall): bool
+    private function validMethodCall(MethodCall|StaticCall $methodCall): bool
     {
         return match (true) {
-            $methodCall instanceof Node\Expr\MethodCall && $this->isObjectType(
+            $methodCall instanceof MethodCall && $this->isObjectType(
                 $methodCall->var,
                 new ObjectType('Illuminate\Contracts\Foundation\Application')
             ) => true,
-            $methodCall instanceof Node\Expr\StaticCall && $this->isObjectType(
+            $methodCall instanceof StaticCall && $this->isObjectType(
                 $methodCall->class,
                 new ObjectType('Illuminate\Support\Facades\App')
             ) => true,
-            $methodCall instanceof Node\Expr\StaticCall && $this->isObjectType(
+            $methodCall instanceof StaticCall && $this->isObjectType(
                 $methodCall->class,
                 new ObjectType('App')
             ) => true,

src/Rector/FuncCall/ArgumentFuncCallToMethodCallRector.php

@@ -170,21 +170,21 @@ public function configure(array $configuration): void
     }
 
     public function refactorFuncCallToMethodCall(
-        FuncCall $node,
+        FuncCall $funcCall,
         ArgumentFuncCallToMethodCall $argumentFuncCallToMethodCall,
         MethodCall|PropertyFetch|Variable $expr
     ): MethodCall|PropertyFetch|Variable {
-        if ($node->args === []) {
+        if ($funcCall->args === []) {
             return $this->refactorEmptyFuncCallArgs($argumentFuncCallToMethodCall, $expr);
         }
 
-        $methodName = $argumentFuncCallToMethodCall->getMethodIfArgs();
+        $methodIfArgs = $argumentFuncCallToMethodCall->getMethodIfArgs();
 
-        if (! is_string($methodName)) {
+        if (! is_string($methodIfArgs)) {
             throw new ShouldNotHappenException();
         }
 
-        return $this->nodeFactory->createMethodCall($expr, $methodName, $node->args);
+        return $this->nodeFactory->createMethodCall($expr, $methodIfArgs, $funcCall->args);
     }
 
     private function refactorArrayFunctionToMethodCall(

src/Rector/FuncCall/SleepFuncToSleepStaticCallRector.php

@@ -5,6 +5,8 @@
 namespace RectorLaravel\Rector\FuncCall;
 
 use PhpParser\Node;
+use PhpParser\Node\Expr\FuncCall;
+use PhpParser\Node\Stmt\Expression;
 use Rector\Core\Rector\AbstractRector;
 use Symplify\RuleDocGenerator\ValueObject\CodeSample\CodeSample;
 use Symplify\RuleDocGenerator\ValueObject\RuleDefinition;
@@ -35,15 +37,15 @@ public function getRuleDefinition(): RuleDefinition
 
     public function getNodeTypes(): array
     {
-        return [Node\Stmt\Expression::class];
+        return [Expression::class];
     }
 
     /**
      * @param Node\Stmt\Expression $node
      */
     public function refactor(Node $node): ?Node
     {
-        if (! $node->expr instanceof Node\Expr\FuncCall) {
+        if (! $node->expr instanceof FuncCall) {
             return null;
         }
 

src/Rector/MethodCall/EloquentOrderByToLatestOrOldestRector.php

@@ -5,7 +5,12 @@
 namespace RectorLaravel\Rector\MethodCall;
 
 use PhpParser\Node;
+use PhpParser\Node\Arg;
+use PhpParser\Node\Expr;
 use PhpParser\Node\Expr\MethodCall;
+use PhpParser\Node\Identifier;
+use PhpParser\Node\Scalar\String_;
+use PhpParser\Node\VariadicPlaceholder;
 use PHPStan\Type\ObjectType;
 use Rector\Core\Rector\AbstractRector;
 use Symplify\RuleDocGenerator\ValueObject\CodeSample\CodeSample;
@@ -66,19 +71,19 @@ private function isOrderByMethodCall(MethodCall $methodCall): bool
         // Check if it's a method call to `orderBy`
 
         return $this->isObjectType($methodCall->var, new ObjectType('Illuminate\Database\Query\Builder'))
-            && $methodCall->name instanceof Node\Identifier
+            && $methodCall->name instanceof Identifier
             && ($methodCall->name->name === 'orderBy' || $methodCall->name->name === 'orderByDesc')
-            && count($methodCall->args) > 0;
+            && $methodCall->args !== [];
     }
 
     private function convertOrderByToLatest(MethodCall $methodCall): MethodCall
     {
-        if (! isset($methodCall->args[0]) && ! $methodCall->args[0] instanceof Node\VariadicPlaceholder) {
+        if (! isset($methodCall->args[0]) && ! $methodCall->args[0] instanceof VariadicPlaceholder) {
             return $methodCall;
         }
 
         $columnVar = $methodCall->args[0]->value ?? null;
-        if ($columnVar === null) {
+        if (! $columnVar instanceof Expr) {
             return $methodCall;
         }
 
@@ -88,22 +93,22 @@ private function convertOrderByToLatest(MethodCall $methodCall): MethodCall
         } else {
             $newMethod = $direction === 'asc' ? 'latest' : 'oldest';
         }
-        if ($columnVar instanceof Node\Scalar\String_ && $columnVar->value === 'created_at') {
-            $methodCall->name = new Node\Identifier($newMethod);
+        if ($columnVar instanceof String_ && $columnVar->value === 'created_at') {
+            $methodCall->name = new Identifier($newMethod);
             $methodCall->args = [];
 
             return $methodCall;
         }
 
-        if ($columnVar instanceof Node\Scalar\String_) {
-            $methodCall->name = new Node\Identifier($newMethod);
-            $methodCall->args = [new Node\Arg(new Node\Scalar\String_($columnVar->value))];
+        if ($columnVar instanceof String_) {
+            $methodCall->name = new Identifier($newMethod);
+            $methodCall->args = [new Arg(new String_($columnVar->value))];
 
             return $methodCall;
         }
 
-        $methodCall->name = new Node\Identifier($newMethod);
-        $methodCall->args = [new Node\Arg($columnVar)];
+        $methodCall->name = new Identifier($newMethod);
+        $methodCall->args = [new Arg($columnVar)];
 
         return $methodCall;
     }