[type-declaration-docblocks] Add PrivateClassMethodArrayDocblockParamFromLocalCallsRector

Author: TomasVotruba

config/set/type-declaration-docblocks.php

@@ -6,6 +6,7 @@
 use Rector\TypeDeclaration\Rector\ClassMethod\AddReturnArrayDocblockBasedOnArrayMapRector;
 use Rector\TypeDeclaration\Rector\ClassMethod\AddReturnDocblockForScalarArrayFromAssignsRector;
 use Rector\TypeDeclarationDocblocks\Rector\Class_\DocblockVarFromParamDocblockInConstructorRector;
+use Rector\TypeDeclarationDocblocks\Rector\Class_\PrivateClassMethodArrayDocblockParamFromLocalCallsRector;
 use Rector\TypeDeclarationDocblocks\Rector\ClassMethod\AddParamArrayDocblockFromDataProviderRector;
 use Rector\TypeDeclarationDocblocks\Rector\ClassMethod\AddParamArrayDocblockFromDimFetchAccessRector;
 use Rector\TypeDeclarationDocblocks\Rector\ClassMethod\AddReturnDocblockForCommonObjectDenominatorRector;
@@ -24,5 +25,6 @@
         AddReturnDocblockForCommonObjectDenominatorRector::class,
         AddParamArrayDocblockFromDimFetchAccessRector::class,
         AddParamArrayDocblockFromDataProviderRector::class,
+        PrivateClassMethodArrayDocblockParamFromLocalCallsRector::class,
     ]);
 };

rules-tests/TypeDeclarationDocblocks/Rector/Class_/PrivateClassMethodArrayDocblockParamFromLocalCallsRector/Fixture/handle_non_final_protected.php.inc

@@ -0,0 +1,15 @@
+<?php
+
+namespace Rector\Tests\TypeDeclarationDocblocks\Rector\Class_\PrivateClassMethodArrayDocblockParamFromLocalCallsRector\Fixture;
+
+class HandleProtectedMethodInNonFinal
+{
+    public function go()
+    {
+        $this->run(['item1', 'item2']);
+    }
+
+    protected function run(array $items)
+    {
+    }
+}

rules-tests/TypeDeclarationDocblocks/Rector/Class_/PrivateClassMethodArrayDocblockParamFromLocalCallsRector/Fixture/handle_protected_method_in_final.php.inc

@@ -0,0 +1,42 @@
+<?php
+
+namespace Rector\Tests\TypeDeclarationDocblocks\Rector\Class_\PrivateClassMethodArrayDocblockParamFromLocalCallsRector\Fixture;
+
+final class HandleProtectedMethodInFinal
+{
+    public function go()
+    {
+        $this->run([2512, 3423]);
+
+        $this->run([324, 534]);
+    }
+
+    protected function run(array $items)
+    {
+    }
+}
+
+?>
+-----
+<?php
+
+namespace Rector\Tests\TypeDeclarationDocblocks\Rector\Class_\PrivateClassMethodArrayDocblockParamFromLocalCallsRector\Fixture;
+
+final class HandleProtectedMethodInFinal
+{
+    public function go()
+    {
+        $this->run([2512, 3423]);
+
+        $this->run([324, 534]);
+    }
+
+    /**
+     * @param int[] $items
+     */
+    protected function run(array $items)
+    {
+    }
+}
+
+?>

rules-tests/TypeDeclarationDocblocks/Rector/Class_/PrivateClassMethodArrayDocblockParamFromLocalCallsRector/Fixture/multiple_calls.php.inc

@@ -0,0 +1,42 @@
+<?php
+
+namespace Rector\Tests\TypeDeclarationDocblocks\Rector\Class_\PrivateClassMethodArrayDocblockParamFromLocalCallsRector\Fixture;
+
+final class MultipleCalls
+{
+    public function go()
+    {
+        $this->run(['item1', 'item2']);
+
+        $this->run(['item1', 'item2']);
+    }
+
+    private function run(array $items)
+    {
+    }
+}
+
+?>
+-----
+<?php
+
+namespace Rector\Tests\TypeDeclarationDocblocks\Rector\Class_\PrivateClassMethodArrayDocblockParamFromLocalCallsRector\Fixture;
+
+final class MultipleCalls
+{
+    public function go()
+    {
+        $this->run(['item1', 'item2']);
+
+        $this->run(['item1', 'item2']);
+    }
+
+    /**
+     * @param string[] $items
+     */
+    private function run(array $items)
+    {
+    }
+}
+
+?>

rules-tests/TypeDeclarationDocblocks/Rector/Class_/PrivateClassMethodArrayDocblockParamFromLocalCallsRector/Fixture/skip_public.php.inc

@@ -0,0 +1,17 @@
+<?php
+
+namespace Rector\Tests\TypeDeclarationDocblocks\Rector\Class_\PrivateClassMethodArrayDocblockParamFromLocalCallsRector\Fixture;
+
+final class SkipPublic
+{
+    public function go()
+    {
+        $this->run([2512, 3423]);
+
+        $this->run([324, 534]);
+    }
+
+    public function run(array $items)
+    {
+    }
+}

rules-tests/TypeDeclarationDocblocks/Rector/Class_/PrivateClassMethodArrayDocblockParamFromLocalCallsRector/Fixture/some_class.php.inc

@@ -0,0 +1,38 @@
+<?php
+
+namespace Rector\Tests\TypeDeclarationDocblocks\Rector\Class_\PrivateClassMethodArrayDocblockParamFromLocalCallsRector\Fixture;
+
+class SomeClass
+{
+    public function go()
+    {
+        $this->run(['item1', 'item2']);
+    }
+
+    private function run(array $items)
+    {
+    }
+}
+
+?>
+-----
+<?php
+
+namespace Rector\Tests\TypeDeclarationDocblocks\Rector\Class_\PrivateClassMethodArrayDocblockParamFromLocalCallsRector\Fixture;
+
+class SomeClass
+{
+    public function go()
+    {
+        $this->run(['item1', 'item2']);
+    }
+
+    /**
+     * @param string[] $items
+     */
+    private function run(array $items)
+    {
+    }
+}
+
+?>

rules-tests/TypeDeclarationDocblocks/Rector/Class_/PrivateClassMethodArrayDocblockParamFromLocalCallsRector/PrivateClassMethodArrayDocblockParamFromLocalCallsRectorTest.php

@@ -0,0 +1,28 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Rector\Tests\TypeDeclarationDocblocks\Rector\Class_\PrivateClassMethodArrayDocblockParamFromLocalCallsRector;
+
+use Iterator;
+use PHPUnit\Framework\Attributes\DataProvider;
+use Rector\Testing\PHPUnit\AbstractRectorTestCase;
+
+final class PrivateClassMethodArrayDocblockParamFromLocalCallsRectorTest 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';
+    }
+}

rules-tests/TypeDeclarationDocblocks/Rector/Class_/PrivateClassMethodArrayDocblockParamFromLocalCallsRector/config/configured_rule.php

@@ -0,0 +1,10 @@
+<?php
+
+declare(strict_types=1);
+
+use Rector\Config\RectorConfig;
+use Rector\TypeDeclarationDocblocks\Rector\Class_\PrivateClassMethodArrayDocblockParamFromLocalCallsRector;
+
+return static function (RectorConfig $rectorConfig): void {
+    $rectorConfig->rule(PrivateClassMethodArrayDocblockParamFromLocalCallsRector::class);
+};

rules/TypeDeclaration/Rector/ClassMethod/AddMethodCallBasedStrictParamTypeRector.php

@@ -5,14 +5,13 @@
 namespace Rector\TypeDeclaration\Rector\ClassMethod;
 
 use PhpParser\Node;
-use PhpParser\Node\Name;
 use PhpParser\Node\Stmt\Class_;
 use PhpParser\Node\Stmt\ClassMethod;
-use Rector\Configuration\Parameter\FeatureFlags;
 use Rector\PhpParser\NodeFinder\LocalMethodCallFinder;
 use Rector\Rector\AbstractRector;
 use Rector\TypeDeclaration\NodeAnalyzer\CallTypesResolver;
 use Rector\TypeDeclaration\NodeAnalyzer\ClassMethodParamTypeCompleter;
+use Rector\TypeDeclarationDocblocks\PrivateMethodFlagger;
 use Symplify\RuleDocGenerator\ValueObject\CodeSample\CodeSample;
 use Symplify\RuleDocGenerator\ValueObject\RuleDefinition;
 
@@ -30,6 +29,7 @@ public function __construct(
         private readonly CallTypesResolver $callTypesResolver,
         private readonly ClassMethodParamTypeCompleter $classMethodParamTypeCompleter,
         private readonly LocalMethodCallFinder $localMethodCallFinder,
+        private readonly PrivateMethodFlagger $privateMethodFlagger
     ) {
     }
 
@@ -92,7 +92,7 @@ public function refactor(Node $node): ?Node
                 continue;
             }
 
-            if (! $this->isClassMethodPrivate($node, $classMethod)) {
+            if (! $this->privateMethodFlagger->isClassMethodPrivate($node, $classMethod)) {
                 continue;
             }
 
@@ -120,19 +120,4 @@ public function refactor(Node $node): ?Node
 
         return null;
     }
-
-    private function isClassMethodPrivate(Class_ $class, ClassMethod $classMethod): bool
-    {
-        if ($classMethod->isPrivate()) {
-            return true;
-        }
-
-        if ($classMethod->isFinal() && ! $class->extends instanceof Name && $class->implements === []) {
-            return true;
-        }
-
-        $isClassFinal = $class->isFinal() || FeatureFlags::treatClassesAsFinal($class);
-
-        return $isClassFinal && ! $class->extends instanceof Name && $class->implements === [] && $classMethod->isProtected();
-    }
 }

rules/TypeDeclarationDocblocks/PrivateMethodFlagger.php

@@ -0,0 +1,28 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Rector\TypeDeclarationDocblocks;
+
+use PhpParser\Node\Name;
+use PhpParser\Node\Stmt\Class_;
+use PhpParser\Node\Stmt\ClassMethod;
+use Rector\Configuration\Parameter\FeatureFlags;
+
+final class PrivateMethodFlagger
+{
+    public function isClassMethodPrivate(Class_ $class, ClassMethod $classMethod): bool
+    {
+        if ($classMethod->isPrivate()) {
+            return true;
+        }
+
+        if ($classMethod->isFinal() && ! $class->extends instanceof Name && $class->implements === []) {
+            return true;
+        }
+
+        $isClassFinal = $class->isFinal() || FeatureFlags::treatClassesAsFinal($class);
+
+        return $isClassFinal && ! $class->extends instanceof Name && $class->implements === [] && $classMethod->isProtected();
+    }
+}