[DowngradePhp84] Add DowngradeArrayFindKeyRector (#293)

Author: samsonasik

config/set/downgrade-php84.php

@@ -5,6 +5,7 @@
 use Rector\Config\RectorConfig;
 use Rector\DowngradePhp84\Rector\Expression\DowngradeArrayAllRector;
 use Rector\DowngradePhp84\Rector\Expression\DowngradeArrayAnyRector;
+use Rector\DowngradePhp84\Rector\Expression\DowngradeArrayFindKeyRector;
 use Rector\DowngradePhp84\Rector\Expression\DowngradeArrayFindRector;
 use Rector\DowngradePhp84\Rector\FuncCall\DowngradeRoundingModeEnumRector;
 use Rector\DowngradePhp84\Rector\MethodCall\DowngradeNewMethodCallWithoutParenthesesRector;
@@ -18,5 +19,6 @@
         DowngradeArrayAllRector::class,
         DowngradeArrayAnyRector::class,
         DowngradeArrayFindRector::class,
+        DowngradeArrayFindKeyRector::class,
     ]);
 };

rules-tests/DowngradePhp84/Rector/Expression/DowngradeArrayFindKeyRector/DowngradeArrayFindKeyRectorTest.php

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

@@ -0,0 +1,33 @@
+<?php
+
+namespace Rector\Tests\DowngradePhp84\Rector\Expression\DowngradeArrayFindKeyRector\Fixture;
+
+class Fixture
+{
+    public function run(array $animals)
+    {
+        $found = array_find_key($animals, fn($animal) => str_starts_with($animal, 'c'));
+    }
+}
+
+?>
+-----
+<?php
+
+namespace Rector\Tests\DowngradePhp84\Rector\Expression\DowngradeArrayFindKeyRector\Fixture;
+
+class Fixture
+{
+    public function run(array $animals)
+    {
+        $found = null;
+        foreach ($animals as $idx => $animal) {
+            if (str_starts_with($animal, 'c')) {
+                $found = $idx;
+                break;
+            }
+        }
+    }
+}
+
+?>

rules-tests/DowngradePhp84/Rector/Expression/DowngradeArrayFindKeyRector/Fixture/with_key.php.inc

@@ -0,0 +1,33 @@
+<?php
+
+namespace Rector\Tests\DowngradePhp84\Rector\Expression\DowngradeArrayAnyRector\Fixture;
+
+class WithKey
+{
+    public function run(array $animals)
+    {
+        $found = array_find_key($animals, fn($animal, $key) => str_starts_with($animal, 'c') && $key > 0);
+    }
+}
+
+?>
+-----
+<?php
+
+namespace Rector\Tests\DowngradePhp84\Rector\Expression\DowngradeArrayAnyRector\Fixture;
+
+class WithKey
+{
+    public function run(array $animals)
+    {
+        $found = null;
+        foreach ($animals as $key => $animal) {
+            if (str_starts_with($animal, 'c') && $key > 0) {
+                $found = $key;
+                break;
+            }
+        }
+    }
+}
+
+?>

rules-tests/DowngradePhp84/Rector/Expression/DowngradeArrayFindKeyRector/config/configured_rule.php

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

rules/DowngradePhp84/Rector/Expression/DowngradeArrayFindKeyRector.php

@@ -0,0 +1,122 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Rector\DowngradePhp84\Rector\Expression;
+
+use PhpParser\Node;
+use PhpParser\Node\Expr\ArrowFunction;
+use PhpParser\Node\Expr\Assign;
+use PhpParser\Node\Expr\ConstFetch;
+use PhpParser\Node\Expr\FuncCall;
+use PhpParser\Node\Expr\Variable;
+use PhpParser\Node\Name;
+use PhpParser\Node\Stmt;
+use PhpParser\Node\Stmt\Break_;
+use PhpParser\Node\Stmt\Expression;
+use PhpParser\Node\Stmt\Foreach_;
+use PhpParser\Node\Stmt\If_;
+use Rector\Naming\Naming\VariableNaming;
+use Rector\PHPStan\ScopeFetcher;
+use Rector\Rector\AbstractRector;
+use Symplify\RuleDocGenerator\ValueObject\CodeSample\CodeSample;
+use Symplify\RuleDocGenerator\ValueObject\RuleDefinition;
+
+/**
+ * @changelog https://php.watch/versions/8.4/array_find-array_find_key-array_any-array_all
+ *
+ * @see \Rector\Tests\DowngradePhp84\Rector\Expression\DowngradeArrayFindKeyRector\DowngradeArrayFindKeyRectorTest
+ */
+final class DowngradeArrayFindKeyRector extends AbstractRector
+{
+    public function __construct(
+        private readonly VariableNaming $variableNaming
+    ) {
+    }
+
+    public function getNodeTypes(): array
+    {
+        return [Expression::class];
+    }
+
+    public function getRuleDefinition(): RuleDefinition
+    {
+        return new RuleDefinition(
+            'Downgrade array_find_key() to foreach loop',
+            [
+                new CodeSample(
+                    <<<'CODE_SAMPLE'
+$found = array_find_key($animals, fn($animal) => str_starts_with($animal, 'c'));
+CODE_SAMPLE
+                    ,
+                    <<<'CODE_SAMPLE'
+$found = null;
+foreach ($animals as $idx => $animal) {
+    if (str_starts_with($animal, 'c')) {
+        $found = $idx;
+        break;
+    }
+}
+CODE_SAMPLE
+                ),
+            ]
+        );
+    }
+
+    /**
+     * @param Expression $node
+     * @return Stmt[]|null
+     */
+    public function refactor(Node $node): ?array
+    {
+        if (! $node->expr instanceof Assign) {
+            return null;
+        }
+
+        if (! $node->expr->expr instanceof FuncCall) {
+            return null;
+        }
+
+        if (! $this->isName($node->expr->expr, 'array_find_key')) {
+            return null;
+        }
+
+        if ($node->expr->expr->isFirstClassCallable()) {
+            return null;
+        }
+
+        $args = $node->expr->expr->getArgs();
+        if (count($args) !== 2) {
+            return null;
+        }
+
+        if (! $args[1]->value instanceof ArrowFunction) {
+            return null;
+        }
+
+        $keyVar = $args[1]->value->params[1]->var ?? new Variable($this->variableNaming->createCountedValueName(
+            'idx',
+            ScopeFetcher::fetch($node)
+        ));
+
+        $valueCond = $args[1]->value->expr;
+        $if = new If_($valueCond, [
+            'stmts' => [new Expression(new Assign($node->expr->var, $keyVar)), new Break_()],
+        ]);
+
+        return [
+            // init
+            new Expression(new Assign($node->expr->var, new ConstFetch(new Name('null')))),
+
+            // foreach loop
+            new Foreach_(
+                $args[0]->value,
+                $args[1]->value->params[0]->var,
+                [
+                    'keyVar' => $keyVar,
+                    'stmts' => [$if],
+                ]
+            ),
+        ];
+    }
+}