[PHPUnit] Change @return array<> to @return Iterator<> on YieldDataProviderRector (#415)

* YieldDataProviderRector: added failling test

* Update use_data_provider_with_phpdoc.php.inc

* Update rules-tests/CodeQuality/Rector/Class_/YieldDataProviderRector/Fixture/use_data_provider_with_phpdoc.php.inc

Co-authored-by: Abdul Malik Ikhsan <[email protected]>

* Closes #414

---------

Co-authored-by: Markus Staab <[email protected]>
Co-authored-by: Markus Staab <[email protected]>

Author: samsonasik

rules-tests/CodeQuality/Rector/Class_/YieldDataProviderRector/Fixture/use_data_provider_with_phpdoc.php.inc

@@ -0,0 +1,61 @@
+<?php
+
+namespace Rector\PHPUnit\Tests\CodeQuality\Rector\Class_\YieldDataProviderRector\Fixture;
+
+use PHPUnit\Framework\TestCase;
+
+final class UseDataProviderTestPhpdoc extends TestCase
+{
+    #[\PHPUnit\Framework\Attributes\DataProvider('dataProvider')]
+    #[\PHPUnit\Framework\Attributes\DataProvider('provideDataForProvider')]
+    public function test(string $filePath): void
+    {
+    }
+
+    /** @return array<int, array<string>> */
+    public static function provideDataForProvider()
+    {
+        return [
+            ['<?php implode("", $foo, );', '<?php implode($foo, "", );']
+        ];
+    }
+
+    public static function dataProvider()
+    {
+        return [
+            ['<?php implode(\'\', $foo, );', '<?php implode($foo, );'],
+            ['<?php implode(\'\', $foo, );', '<?php implode($foo, );']
+        ];
+    }
+}
+
+?>
+-----
+<?php
+
+namespace Rector\PHPUnit\Tests\CodeQuality\Rector\Class_\YieldDataProviderRector\Fixture;
+
+use PHPUnit\Framework\TestCase;
+
+final class UseDataProviderTestPhpdoc extends TestCase
+{
+    #[\PHPUnit\Framework\Attributes\DataProvider('dataProvider')]
+    #[\PHPUnit\Framework\Attributes\DataProvider('provideDataForProvider')]
+    public function test(string $filePath): void
+    {
+    }
+
+    /** @return \Iterator<int, array<string>> */
+    public static function provideDataForProvider(): \Iterator
+    {
+        yield ['<?php implode("", $foo, );', '<?php implode($foo, "", );'];
+    }
+
+    public static function dataProvider(): \Iterator
+    {
+        yield ['<?php implode(\'\', $foo, );', '<?php implode($foo, );'];
+        yield ['<?php implode(\'\', $foo, );', '<?php implode($foo, );'];
+    }
+}
+
+?>

rules/CodeQuality/Rector/Class_/YieldDataProviderRector.php

@@ -11,7 +11,10 @@
 use PhpParser\Node\Stmt\ClassMethod;
 use PhpParser\Node\Stmt\Return_;
 use PHPStan\PhpDocParser\Ast\PhpDoc\ReturnTagValueNode;
+use PHPStan\Type\ArrayType;
+use PHPStan\Type\Generic\GenericObjectType;
 use Rector\BetterPhpDocParser\PhpDocInfo\PhpDocInfoFactory;
+use Rector\BetterPhpDocParser\PhpDocManipulator\PhpDocTypeChanger;
 use Rector\DeadCode\NodeAnalyzer\IsClassMethodUsedAnalyzer;
 use Rector\NodeTypeResolver\Node\AttributeKey;
 use Rector\PhpParser\NodeTransformer;
@@ -35,7 +38,8 @@ public function __construct(
         private readonly TestsNodeAnalyzer $testsNodeAnalyzer,
         private readonly DataProviderClassMethodFinder $dataProviderClassMethodFinder,
         private readonly PhpDocInfoFactory $phpDocInfoFactory,
-        private readonly IsClassMethodUsedAnalyzer $isClassMethodUsedAnalyzer
+        private readonly IsClassMethodUsedAnalyzer $isClassMethodUsedAnalyzer,
+        private readonly PhpDocTypeChanger $phpDocTypeChanger,
     ) {
     }
 
@@ -166,6 +170,20 @@ private function transformArrayToYieldsOnMethodNode(ClassMethod $classMethod, Ar
     private function removeReturnTag(ClassMethod $classMethod): void
     {
         $phpDocInfo = $this->phpDocInfoFactory->createFromNodeOrEmpty($classMethod);
-        $phpDocInfo->removeByType(ReturnTagValueNode::class);
+
+        if ($phpDocInfo->getReturnType() instanceof ArrayType) {
+            $keyType = $phpDocInfo->getReturnType()
+                ->getIterableKeyType();
+            $itemType = $phpDocInfo->getReturnType()
+                ->getIterableValueType();
+
+            $this->phpDocTypeChanger->changeReturnType(
+                $classMethod,
+                $phpDocInfo,
+                new GenericObjectType('Iterator', [$keyType, $itemType])
+            );
+        } else {
+            $phpDocInfo->removeByType(ReturnTagValueNode::class);
+        }
     }
 }