[TypeDeclaration] Add AddParamArrayDocblockBasedOnCallableNativeFuncC…

…allRector (#6233)

* [TypeDeclaration] Add AddParamArrayDocblockBasedOnCallableNativeFuncCallRector

* example

* collect variables from param array type

* remove comment

* move to private

* getting type param

* [ci-review] Rector Rectify

* [ci-review] Rector Rectify

* check variable first

* ensure same variable and not changed type

* ensure same variable and not changed type

* adding test

* adding param docs

* update fixture

* Fix

* Fix

* skip reassign

* skip mixed

* skip first class callable

* add array_walk()

* add usort

* fix edge case: handle different usage

* fix variable key usage

* register array_filter as well

* handle usort

* handle usort

* isset

---------

Co-authored-by: GitHub Action <actions@github.com>

rules-tests/TypeDeclaration/Rector/ClassMethod/AddParamArrayDocblockBasedOnCallableNativeFuncCallRector/AddParamArrayDocblockBasedOnCallableNativeFuncCallRectorTest.php

@@ -0,0 +1,28 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Rector\Tests\TypeDeclaration\Rector\ClassMethod\AddParamArrayDocblockBasedOnCallableNativeFuncCallRector;
+
+use Iterator;
+use PHPUnit\Framework\Attributes\DataProvider;
+use Rector\Testing\PHPUnit\AbstractRectorTestCase;
+
+final class AddParamArrayDocblockBasedOnCallableNativeFuncCallRectorTest 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/TypeDeclaration/Rector/ClassMethod/AddParamArrayDocblockBasedOnCallableNativeFuncCallRector/Fixture/different_usage.php.inc

@@ -0,0 +1,54 @@
+<?php
+
+namespace Rector\Tests\TypeDeclaration\Rector\ClassMethod\AddParamArrayDocblockBasedOnCallableNativeFuncCallRector\Fixture;
+
+use DateTime;
+use stdClass;
+
+final class DifferentUsage {
+    public function process(array $items): void
+    {
+        if (rand(0, 1)) {
+            array_walk($items, function (stdClass $item) {
+                echo $item->value;
+            });
+
+            return;
+        }
+
+        array_walk($items, function (DateTime $item) {
+            echo $item->format('Y-m-d');
+        });
+    }
+}
+
+?>
+-----
+<?php
+
+namespace Rector\Tests\TypeDeclaration\Rector\ClassMethod\AddParamArrayDocblockBasedOnCallableNativeFuncCallRector\Fixture;
+
+use DateTime;
+use stdClass;
+
+final class DifferentUsage {
+    /**
+     * @param \stdClass[]|\DateTime[] $items
+     */
+    public function process(array $items): void
+    {
+        if (rand(0, 1)) {
+            array_walk($items, function (stdClass $item) {
+                echo $item->value;
+            });
+
+            return;
+        }
+
+        array_walk($items, function (DateTime $item) {
+            echo $item->format('Y-m-d');
+        });
+    }
+}
+
+?>

rules-tests/TypeDeclaration/Rector/ClassMethod/AddParamArrayDocblockBasedOnCallableNativeFuncCallRector/Fixture/fixture.php.inc

@@ -0,0 +1,38 @@
+<?php
+
+namespace Rector\Tests\TypeDeclaration\Rector\ClassMethod\AddParamArrayDocblockBasedOnCallableNativeFuncCallRector\Fixture;
+
+use stdClass;
+
+final class Fixture
+{
+    public function process(array $items): void
+    {
+        array_walk($items, function (stdClass $item) {
+            echo $item->value;
+        });
+    }
+}
+
+?>
+-----
+<?php
+
+namespace Rector\Tests\TypeDeclaration\Rector\ClassMethod\AddParamArrayDocblockBasedOnCallableNativeFuncCallRector\Fixture;
+
+use stdClass;
+
+final class Fixture
+{
+    /**
+     * @param \stdClass[] $items
+     */
+    public function process(array $items): void
+    {
+        array_walk($items, function (stdClass $item) {
+            echo $item->value;
+        });
+    }
+}
+
+?>

rules-tests/TypeDeclaration/Rector/ClassMethod/AddParamArrayDocblockBasedOnCallableNativeFuncCallRector/Fixture/skip_first_class_callable.php.inc

@@ -0,0 +1,12 @@
+<?php
+
+namespace Rector\Tests\TypeDeclaration\Rector\ClassMethod\AddParamArrayDocblockBasedOnCallableNativeFuncCallRector\Fixture;
+
+use stdClass;
+
+final class SkipFirstClassCallable {
+    function process(array $items): void
+    {
+        array_walk(...);
+    }
+}

rules-tests/TypeDeclaration/Rector/ClassMethod/AddParamArrayDocblockBasedOnCallableNativeFuncCallRector/Fixture/skip_mixed.php.inc

@@ -0,0 +1,10 @@
+<?php
+
+namespace Rector\Tests\TypeDeclaration\Rector\ClassMethod\AddParamArrayDocblockBasedOnCallableNativeFuncCallRector\Fixture;
+
+final class SkipMixed {
+    function process(array $items, $callable): void
+    {
+        array_walk($items, $callable);
+    }
+}

rules-tests/TypeDeclaration/Rector/ClassMethod/AddParamArrayDocblockBasedOnCallableNativeFuncCallRector/Fixture/skip_reassign_with_generator.php.inc

@@ -0,0 +1,18 @@
+<?php
+
+namespace Rector\Tests\TypeDeclaration\Rector\ClassMethod\AddParamArrayDocblockBasedOnCallableNativeFuncCallRector\Fixture;
+
+use stdClass;
+
+final class SkipReAssign {
+    function process(array $items): void
+    {
+        $items = new stdClass;
+        $items->one = new stdClass;
+        $items->two = new stdClass;
+
+        array_walk($items, function (stdClass $item) {
+            echo $item->value;
+        });
+    }
+}

rules-tests/TypeDeclaration/Rector/ClassMethod/AddParamArrayDocblockBasedOnCallableNativeFuncCallRector/Fixture/skip_typed_doc.php.inc

@@ -0,0 +1,17 @@
+<?php
+
+namespace Rector\Tests\TypeDeclaration\Rector\ClassMethod\AddParamArrayDocblockBasedOnCallableNativeFuncCallRector\Fixture;
+
+use stdClass;
+
+final class SkipTypedDoc {
+    /**
+     * @param stdClass[] $items
+     */
+    public function process(array $items): void
+    {
+        array_walk($items, function (stdClass $item) {
+            echo $item->value;
+        });
+    }
+}

rules-tests/TypeDeclaration/Rector/ClassMethod/AddParamArrayDocblockBasedOnCallableNativeFuncCallRector/Fixture/with_array_filter_and_array_walk.php.inc

@@ -0,0 +1,54 @@
+<?php
+
+namespace Rector\Tests\TypeDeclaration\Rector\ClassMethod\AddParamArrayDocblockBasedOnCallableNativeFuncCallRector\Fixture;
+
+use stdClass;
+
+final class WithArrayFilterAndArrayWalk
+{
+    public function process(array $items): void
+    {
+        if (rand(0, 1)) {
+            array_filter(
+                $items,
+                fn (string $str): bool => $str === 'a'
+            );
+            return;
+        }
+
+        array_walk($items, function (stdClass $item) {
+            echo $item->value;
+        });
+    }
+}
+
+?>
+-----
+<?php
+
+namespace Rector\Tests\TypeDeclaration\Rector\ClassMethod\AddParamArrayDocblockBasedOnCallableNativeFuncCallRector\Fixture;
+
+use stdClass;
+
+final class WithArrayFilterAndArrayWalk
+{
+    /**
+     * @param string[]|\stdClass[] $items
+     */
+    public function process(array $items): void
+    {
+        if (rand(0, 1)) {
+            array_filter(
+                $items,
+                fn (string $str): bool => $str === 'a'
+            );
+            return;
+        }
+
+        array_walk($items, function (stdClass $item) {
+            echo $item->value;
+        });
+    }
+}
+
+?>

rules-tests/TypeDeclaration/Rector/ClassMethod/AddParamArrayDocblockBasedOnCallableNativeFuncCallRector/Fixture/with_array_map.php.inc

@@ -0,0 +1,38 @@
+<?php
+
+namespace Rector\Tests\TypeDeclaration\Rector\ClassMethod\AddParamArrayDocblockBasedOnCallableNativeFuncCallRector\Fixture;
+
+use stdClass;
+
+final class WithArrayMap
+{
+    public function process(array $items)
+    {
+        array_map(function (stdClass $item): string {
+            return $item->value;
+        }, $items);
+    }
+}
+
+?>
+-----
+<?php
+
+namespace Rector\Tests\TypeDeclaration\Rector\ClassMethod\AddParamArrayDocblockBasedOnCallableNativeFuncCallRector\Fixture;
+
+use stdClass;
+
+final class WithArrayMap
+{
+    /**
+     * @param \stdClass[] $items
+     */
+    public function process(array $items)
+    {
+        array_map(function (stdClass $item): string {
+            return $item->value;
+        }, $items);
+    }
+}
+
+?>

rules-tests/TypeDeclaration/Rector/ClassMethod/AddParamArrayDocblockBasedOnCallableNativeFuncCallRector/Fixture/with_usort.php.inc

@@ -0,0 +1,38 @@
+<?php
+
+namespace Rector\Tests\TypeDeclaration\Rector\ClassMethod\AddParamArrayDocblockBasedOnCallableNativeFuncCallRector\Fixture;
+
+use stdClass;
+
+final class WithUsort
+{
+    public function process(array $classes)
+    {
+        usort($classes, function (stdClass $stdClass, stdClass $stdClass2): int {
+            return 1;
+        });
+    }
+}
+
+?>
+-----
+<?php
+
+namespace Rector\Tests\TypeDeclaration\Rector\ClassMethod\AddParamArrayDocblockBasedOnCallableNativeFuncCallRector\Fixture;
+
+use stdClass;
+
+final class WithUsort
+{
+    /**
+     * @param \stdClass[] $classes
+     */
+    public function process(array $classes)
+    {
+        usort($classes, function (stdClass $stdClass, stdClass $stdClass2): int {
+            return 1;
+        });
+    }
+}
+
+?>

rules-tests/TypeDeclaration/Rector/ClassMethod/AddParamArrayDocblockBasedOnCallableNativeFuncCallRector/config/configured_rule.php

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