[Php84] Allow on return on ForeachToArrayAnyRector (#7119)

* Add ForeachWithReturnToArrayAnyRector

There is already a rule to convert foreach that contains a break statement with array_any.
This new rule adds support for foreach that return early with true

* fix

* Fix

* Fix

* fix

* Combine array any patterns

* Delete separate array any rules

* Rename ArrayAny rule

* delete test

* rename tests

Author: Orest-Divintari

rules-tests/Php84/Rector/Foreach_/ForeachToArrayAnyRector/Fixture/basic_usage.php.inc

@@ -68,4 +68,4 @@ class BasicUsage
     }
 }
 
-?>
+?>

rules-tests/Php84/Rector/Foreach_/ForeachToArrayAnyRector/Fixture/early_return_basic_usage.php.inc

@@ -0,0 +1,60 @@
+<?php
+
+namespace Rector\Tests\Php84\Rector\Foreach_\ForeachToArrayAnyRector\Fixture;
+
+class EarlyReturnBasicUsage
+{
+    public function checkAnimal(array $animals)
+    {
+        foreach ($animals as $animal) {
+            if (str_starts_with($animal, 'c')) {
+                return true;
+            }
+        }
+        return false;
+    }
+
+    public function checkNumber(array $numbers)
+    {
+        foreach ($numbers as $number) {
+            if ($number > 10) {
+                return true;
+            }
+        }
+        return false;
+    }
+
+    public function checkWithKey(array $items)
+    {
+        foreach ($items as $key => $value) {
+            if ($value === 'target') {
+                return true;
+            }
+        }
+        return false;
+    }
+}
+?>
+-----
+<?php
+
+namespace Rector\Tests\Php84\Rector\Foreach_\ForeachToArrayAnyRector\Fixture;
+
+class EarlyReturnBasicUsage
+{
+    public function checkAnimal(array $animals)
+    {
+        return array_any($animals, fn($animal) => str_starts_with($animal, 'c'));
+    }
+
+    public function checkNumber(array $numbers)
+    {
+        return array_any($numbers, fn($number) => $number > 10);
+    }
+
+    public function checkWithKey(array $items)
+    {
+        return array_any($items, fn($value) => $value === 'target');
+    }
+}
+?>

rules-tests/Php84/Rector/Foreach_/ForeachToArrayAnyRector/Fixture/early_return_skip_missing_return_false.php.inc

@@ -0,0 +1,15 @@
+<?php
+
+namespace Rector\Tests\Php84\Rector\Foreach_\ForeachToArrayAnyRector\Fixture;
+
+class EarlyReturnSkipMultipleStatements
+{
+    public function run(array $animals)
+    {
+        foreach ($animals as $animal) {
+            if (str_starts_with($animal, 'c')) {
+                return true;
+            }
+        }
+    }
+}

rules-tests/Php84/Rector/Foreach_/ForeachToArrayAnyRector/Fixture/early_return_skip_multiple_statements_after_foreach.php.inc

@@ -0,0 +1,17 @@
+<?php
+
+namespace Rector\Tests\Php84\Rector\Foreach_\ForeachToArrayAnyRector\Fixture;
+
+class EarlyReturnSkipMultipleStatements
+{
+    public function run(array $animals)
+    {
+        foreach ($animals as $animal) {
+            if (str_starts_with($animal, 'c')) {
+                return true;
+            }
+        }
+        echo 'ok';
+        return false;
+    }
+}

rules-tests/Php84/Rector/Foreach_/ForeachToArrayAnyRector/Fixture/early_return_skip_multiple_statements_within_if_statement.php.inc

@@ -0,0 +1,17 @@
+<?php
+
+namespace Rector\Tests\Php84\Rector\Foreach_\ForeachToArrayAnyRector\Fixture;
+
+class EarlyReturnSkipMultipleStatements
+{
+    public function run(array $animals)
+    {
+        foreach ($animals as $animal) {
+            if (str_starts_with($animal, 'c')) {
+                echo 'Found: ' . $animal;
+                return true;
+            }
+        }
+        return false;
+    }
+}

rules-tests/Php84/Rector/Foreach_/ForeachToArrayAnyRector/Fixture/early_return_skip_nested_if_statements.php.inc

@@ -0,0 +1,18 @@
+<?php
+
+namespace Rector\Tests\Php84\Rector\Foreach_\ForeachToArrayAnyRector\Fixture;
+
+class EarlyReturnSkipMultipleStatements
+{
+    public function run(array $animals)
+    {
+        foreach ($animals as $animal) {
+            if(str_starts_with($animal, 'foo')) {
+                if (str_starts_with($animal, 'c')) {
+                    return true;
+                }
+            }
+        }
+        return false;
+    }
+}

rules-tests/Php84/Rector/Foreach_/ForeachToArrayAnyRector/Fixture/early_return_skip_non_array.php.inc

@@ -0,0 +1,16 @@
+<?php
+
+namespace Rector\Tests\Php84\Rector\Foreach_\ForeachToArrayAnyRector\Fixture;
+
+class EarlyReturnSkipNonArray
+{
+    public function checkAnimal(\ArrayIterator $animals)
+    {
+        foreach ($animals as $animal) {
+            if (str_starts_with($animal, 'c')) {
+                return true;
+            }
+        }
+        return false;
+    }
+}

rules-tests/Php84/Rector/Foreach_/ForeachToArrayAnyRector/Fixture/early_return_skip_unexpected_early_return_other_than_true.php.inc

@@ -0,0 +1,16 @@
+<?php
+
+namespace Rector\Tests\Php84\Rector\Foreach_\ForeachToArrayAnyRector\Fixture;
+
+class EarlyReturnSkipMultipleStatements
+{
+    public function run(array $animals)
+    {
+        foreach ($animals as $animal) {
+            if (str_starts_with($animal, 'c')) {
+                return 'ok';
+            }
+        }
+        return false;
+    }
+}

rules-tests/Php84/Rector/Foreach_/ForeachToArrayAnyRector/Fixture/early_return_with_key.php.inc

@@ -0,0 +1,32 @@
+<?php
+
+namespace Rector\Tests\Php84\Rector\Foreach_\ForeachToArrayAnyRector\Fixture;
+
+class EarlyReturnWithKey
+{
+    public function checkAnimal(array $animals)
+    {
+        foreach ($animals as $key => $animal) {
+            if (str_starts_with($animal, 'c') && $key === 1) {
+                return true;
+            }
+        }
+        return false;
+    }
+}
+
+?>
+-----
+<?php
+
+namespace Rector\Tests\Php84\Rector\Foreach_\ForeachToArrayAnyRector\Fixture;
+
+class EarlyReturnWithKey
+{
+    public function checkAnimal(array $animals)
+    {
+        return array_any($animals, fn($animal, $key) => str_starts_with($animal, 'c') && $key === 1);
+    }
+}
+
+?>

rules-tests/Php84/Rector/Foreach_/ForeachToArrayAnyRector/Fixture/skip_multiple_statements.php.inc

@@ -16,4 +16,4 @@ class SkipMultipleStatements
         }
         return $found;
     }
-}
+}