[DowngradePhp84] Apply on return on DowngradeArrayFindKeyRector (#301)

Author: samsonasik

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

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

rules/DowngradePhp84/Rector/Expression/DowngradeArrayFindKeyRector.php

@@ -16,6 +16,7 @@
 use PhpParser\Node\Stmt\Expression;
 use PhpParser\Node\Stmt\Foreach_;
 use PhpParser\Node\Stmt\If_;
+use PhpParser\Node\Stmt\Return_;
 use Rector\Naming\Naming\VariableNaming;
 use Rector\PHPStan\ScopeFetcher;
 use Rector\Rector\AbstractRector;
@@ -36,7 +37,7 @@ public function __construct(
 
     public function getNodeTypes(): array
     {
-        return [Expression::class];
+        return [Expression::class, Return_::class];
     }
 
     public function getRuleDefinition(): RuleDefinition
@@ -64,28 +65,36 @@ public function getRuleDefinition(): RuleDefinition
     }
 
     /**
-     * @param Expression $node
+     * @param Expression|Return_ $node
      * @return Stmt[]|null
      */
     public function refactor(Node $node): ?array
     {
-        if (! $node->expr instanceof Assign) {
+        if ($node instanceof Return_ && ! $node->expr instanceof FuncCall) {
             return null;
         }
 
-        if (! $node->expr->expr instanceof FuncCall) {
+        if ($node instanceof Expression && ! $node->expr instanceof Assign) {
             return null;
         }
 
-        if (! $this->isName($node->expr->expr, 'array_find_key')) {
+        $expr = $node instanceof Expression && $node->expr instanceof Assign
+            ? $node->expr->expr
+            : $node->expr;
+
+        if (! $expr instanceof FuncCall) {
+            return null;
+        }
+
+        if (! $this->isName($expr, 'array_find_key')) {
             return null;
         }
 
-        if ($node->expr->expr->isFirstClassCallable()) {
+        if ($expr->isFirstClassCallable()) {
             return null;
         }
 
-        $args = $node->expr->expr->getArgs();
+        $args = $expr->getArgs();
         if (count($args) !== 2) {
             return null;
         }
@@ -94,19 +103,24 @@ public function refactor(Node $node): ?array
             return null;
         }
 
+        $scope = ScopeFetcher::fetch($node);
+        $variable = $node instanceof Expression && $node->expr instanceof Assign
+            ? $node->expr->var
+            : new Variable($this->variableNaming->createCountedValueName('found', $scope));
+
         $keyVar = $args[1]->value->params[1]->var ?? new Variable($this->variableNaming->createCountedValueName(
             'idx',
-            ScopeFetcher::fetch($node)
+            $scope
         ));
 
         $valueCond = $args[1]->value->expr;
         $if = new If_($valueCond, [
-            'stmts' => [new Expression(new Assign($node->expr->var, $keyVar)), new Break_()],
+            'stmts' => [new Expression(new Assign($variable, $keyVar)), new Break_()],
         ]);
 
-        return [
+        $result = [
             // init
-            new Expression(new Assign($node->expr->var, new ConstFetch(new Name('null')))),
+            new Expression(new Assign($variable, new ConstFetch(new Name('null')))),
 
             // foreach loop
             new Foreach_(
@@ -118,5 +132,11 @@ public function refactor(Node $node): ?array
                 ]
             ),
         ];
+
+        if ($node instanceof Return_) {
+            $result[] = new Return_($variable);
+        }
+
+        return $result;
     }
 }