[typed-collections] Add CurrentOnCollectionToArrayRector (#438)

Author: TomasVotruba

config/sets/typed-collections.php

@@ -25,6 +25,7 @@
 use Rector\Doctrine\TypedCollections\Rector\Expression\RemoveCoalesceAssignOnCollectionRector;
 use Rector\Doctrine\TypedCollections\Rector\FuncCall\ArrayMapOnCollectionToArrayRector;
 use Rector\Doctrine\TypedCollections\Rector\FuncCall\ArrayMergeOnCollectionToArrayRector;
+use Rector\Doctrine\TypedCollections\Rector\FuncCall\CurrentOnCollectionToArrayRector;
 use Rector\Doctrine\TypedCollections\Rector\FuncCall\InArrayOnCollectionToContainsCallRector;
 use Rector\Doctrine\TypedCollections\Rector\If_\RemoveIfCollectionIdenticalToNullRector;
 use Rector\Doctrine\TypedCollections\Rector\If_\RemoveIfInstanceofCollectionRector;
@@ -54,6 +55,7 @@
         ArrayOffsetSetToSetCollectionCallRector::class,
         ArrayMapOnCollectionToArrayRector::class,
         ArrayMergeOnCollectionToArrayRector::class,
+        CurrentOnCollectionToArrayRector::class,
         EmptyOnCollectionToIsEmptyCallRector::class,
         InArrayOnCollectionToContainsCallRector::class,
 

rules-tests/TypedCollections/Rector/FuncCall/CurrentOnCollectionToArrayRector/CurrentOnCollectionToArrayRectorTest.php

@@ -0,0 +1,28 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Rector\Doctrine\Tests\TypedCollections\Rector\FuncCall\CurrentOnCollectionToArrayRector;
+
+use Iterator;
+use PHPUnit\Framework\Attributes\DataProvider;
+use Rector\Testing\PHPUnit\AbstractRectorTestCase;
+
+final class CurrentOnCollectionToArrayRectorTest 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/TypedCollections/Rector/FuncCall/CurrentOnCollectionToArrayRector/Fixture/simple_class.php.inc

@@ -0,0 +1,45 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Rector\Doctrine\Tests\TypedCollections\Rector\FuncCall\CurrentOnCollectionToArrayRector\Fixture;
+
+use Doctrine\Common\Collections\Collection;
+
+final class SimpleClass
+{
+    /**
+     * @var Collection<int, string>
+     */
+    public $items;
+
+    public function merge()
+    {
+        return current($this->items);
+    }
+}
+
+?>
+-----
+<?php
+
+declare(strict_types=1);
+
+namespace Rector\Doctrine\Tests\TypedCollections\Rector\FuncCall\CurrentOnCollectionToArrayRector\Fixture;
+
+use Doctrine\Common\Collections\Collection;
+
+final class SimpleClass
+{
+    /**
+     * @var Collection<int, string>
+     */
+    public $items;
+
+    public function merge()
+    {
+        return current($this->items->toArray());
+    }
+}
+
+?>

rules-tests/TypedCollections/Rector/FuncCall/CurrentOnCollectionToArrayRector/Fixture/skip_non_collection.php.inc

@@ -0,0 +1,18 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Rector\Doctrine\Tests\TypedCollections\Rector\FuncCall\CurrentOnCollectionToArrayRector\Fixture;
+
+final class SkipNonCollection
+{
+    /**
+     * @var array<int, string>
+     */
+    public $items;
+
+    public function merge()
+    {
+        return current($this->items);
+    }
+}

rules-tests/TypedCollections/Rector/FuncCall/CurrentOnCollectionToArrayRector/config/configured_rule.php

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

rules/TypedCollections/Rector/FuncCall/CurrentOnCollectionToArrayRector.php

@@ -0,0 +1,96 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Rector\Doctrine\TypedCollections\Rector\FuncCall;
+
+use PhpParser\Node;
+use PhpParser\Node\Expr\FuncCall;
+use PhpParser\Node\Expr\MethodCall;
+use Rector\Doctrine\TypedCollections\TypeAnalyzer\CollectionTypeDetector;
+use Rector\Rector\AbstractRector;
+use Symplify\RuleDocGenerator\ValueObject\CodeSample\CodeSample;
+use Symplify\RuleDocGenerator\ValueObject\RuleDefinition;
+
+/**
+ * @see \Rector\Doctrine\Tests\TypedCollections\Rector\FuncCall\CurrentOnCollectionToArrayRector\CurrentOnCollectionToArrayRectorTest
+ */
+final class CurrentOnCollectionToArrayRector extends AbstractRector
+{
+    public function __construct(
+        private readonly CollectionTypeDetector $collectionTypeDetector
+    ) {
+    }
+
+    public function getRuleDefinition(): RuleDefinition
+    {
+        return new RuleDefinition(
+            'Change current() on Collection typed property to ->toArray() call, to always provide an array',
+            [
+                new CodeSample(
+                    <<<'CODE_SAMPLE'
+use Doctrine\Common\Collections\Collection;
+
+final class SimpleClass
+{
+    /**
+     * @var Collection<int, string>
+     */
+    public $items;
+
+    public function merge()
+    {
+        return current($this->items);
+    }
+}
+CODE_SAMPLE
+                    ,
+                    <<<'CODE_SAMPLE'
+use Doctrine\Common\Collections\Collection;
+
+final class SimpleClass
+{
+    /**
+     * @var Collection<int, string>
+     */
+    public $items;
+
+    public function merge()
+    {
+        return current($this->items->toArray());
+    }
+}
+CODE_SAMPLE
+                ),
+            ]
+        );
+    }
+
+    public function getNodeTypes(): array
+    {
+        return [FuncCall::class];
+    }
+
+    /**
+     * @param FuncCall $node
+     */
+    public function refactor(Node $node): ?FuncCall
+    {
+        if ($node->isFirstClassCallable()) {
+            return null;
+        }
+
+        if (! $this->isName($node->name, 'current')) {
+            return null;
+        }
+
+        $secondArg = $node->getArgs()[0];
+        if (! $this->collectionTypeDetector->isCollectionType($secondArg->value)) {
+            return null;
+        }
+
+        $secondArg->value = new MethodCall($secondArg->value, 'toArray');
+
+        return $node;
+    }
+}