[type-declaration] Add ReturnIteratorInDataProviderRector (#7593)

Author: TomasVotruba

rules-tests/TypeDeclaration/Rector/Class_/ReturnIteratorInDataProviderRector/Fixture/skip_already_known.php.inc

@@ -0,0 +1,21 @@
+<?php
+
+namespace Rector\Tests\TypeDeclaration\Rector\Class_\ReturnIteratorInDataProviderRector\Fixture;
+
+use PHPUnit\Framework\TestCase;
+
+final class SkipAlreadyKnown extends TestCase
+{
+    /**
+     * @dataProvider someDataProvider
+     */
+    public function testSomething()
+    {
+    }
+
+    public function someDataProvider(): \Generator
+    {
+        yield ['data1'];
+        yield ['data2'];
+    }
+}

rules-tests/TypeDeclaration/Rector/Class_/ReturnIteratorInDataProviderRector/Fixture/skip_non_data_provider.php.inc

@@ -0,0 +1,18 @@
+<?php
+
+namespace Rector\Tests\TypeDeclaration\Rector\Class_\ReturnIteratorInDataProviderRector\Fixture;
+
+use PHPUnit\Framework\TestCase;
+
+final class SkipNonDataProvider extends TestCase
+{
+    public function testSomething()
+    {
+    }
+
+    public function someDataProvider()
+    {
+        yield ['data1'];
+        yield ['data2'];
+    }
+}

rules-tests/TypeDeclaration/Rector/Class_/ReturnIteratorInDataProviderRector/Fixture/some_class.php.inc

@@ -0,0 +1,47 @@
+<?php
+
+namespace Rector\Tests\TypeDeclaration\Rector\Class_\ReturnIteratorInDataProviderRector\Fixture;
+
+use PHPUnit\Framework\TestCase;
+
+final class SomeClass extends TestCase
+{
+    /**
+     * @dataProvider someDataProvider
+     */
+    public function testSomething()
+    {
+    }
+
+    public function someDataProvider()
+    {
+        yield ['data1'];
+        yield ['data2'];
+    }
+}
+
+?>
+-----
+<?php
+
+namespace Rector\Tests\TypeDeclaration\Rector\Class_\ReturnIteratorInDataProviderRector\Fixture;
+
+use PHPUnit\Framework\TestCase;
+
+final class SomeClass extends TestCase
+{
+    /**
+     * @dataProvider someDataProvider
+     */
+    public function testSomething()
+    {
+    }
+
+    public function someDataProvider(): \Iterator
+    {
+        yield ['data1'];
+        yield ['data2'];
+    }
+}
+
+?>

rules-tests/TypeDeclaration/Rector/Class_/ReturnIteratorInDataProviderRector/ReturnIteratorInDataProviderRectorTest.php

@@ -0,0 +1,28 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Rector\Tests\TypeDeclaration\Rector\Class_\ReturnIteratorInDataProviderRector;
+
+use Iterator;
+use PHPUnit\Framework\Attributes\DataProvider;
+use Rector\Testing\PHPUnit\AbstractRectorTestCase;
+
+final class ReturnIteratorInDataProviderRectorTest 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/TypeDeclaration/Rector/Class_/ReturnIteratorInDataProviderRector/config/configured_rule.php

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

rules/CodeQuality/Rector/Class_/ReturnIteratorInDataProviderRector.php

@@ -0,0 +1,123 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Rector\CodeQuality\Rector\Class_;
+
+use PhpParser\Node;
+use PhpParser\Node\Expr\Yield_;
+use PhpParser\Node\Name\FullyQualified;
+use PhpParser\Node\Stmt\Class_;
+use PhpParser\Node\Stmt\ClassMethod;
+use Rector\PhpParser\Node\BetterNodeFinder;
+use Rector\PHPUnit\NodeAnalyzer\TestsNodeAnalyzer;
+use Rector\Rector\AbstractRector;
+use Rector\TypeDeclarationDocblocks\NodeFinder\DataProviderMethodsFinder;
+use Symplify\RuleDocGenerator\ValueObject\CodeSample\CodeSample;
+use Symplify\RuleDocGenerator\ValueObject\RuleDefinition;
+
+/**
+ * @see \Rector\Tests\TypeDeclaration\Rector\Class_\ReturnIteratorInDataProviderRector\ReturnIteratorInDataProviderRectorTest
+ */
+final class ReturnIteratorInDataProviderRector extends AbstractRector
+{
+    public function __construct(
+        private readonly TestsNodeAnalyzer $testsNodeAnalyzer,
+        private readonly DataProviderMethodsFinder $dataProviderMethodsFinder,
+        private readonly BetterNodeFinder $betterNodeFinder
+    ) {
+    }
+
+    public function getRuleDefinition(): RuleDefinition
+    {
+        return new RuleDefinition('Add Iterator type on known PHPUnit data providers', [
+            new CodeSample(
+                <<<'CODE_SAMPLE'
+use PHPUnit\Framework\TestCase;
+
+final class SomeTest extends TestCase
+{
+    /**
+     * @dataProvider provideData()
+     */
+    public function testSomething($value)
+    {
+    }
+
+    public function provideData()
+    {
+        yield [5];
+    }
+}
+CODE_SAMPLE
+                ,
+                <<<'CODE_SAMPLE'
+use PHPUnit\Framework\TestCase;
+
+final class SomeTest extends TestCase
+{
+    /**
+     * @dataProvider provideData()
+     */
+    public function testSomething($value)
+    {
+    }
+
+    public function provideData(): \Iterator
+    {
+        yield [5];
+    }
+}
+CODE_SAMPLE
+            ),
+        ]);
+    }
+
+    /**
+     * @return array<class-string<Node>>
+     */
+    public function getNodeTypes(): array
+    {
+        return [Class_::class];
+    }
+
+    /**
+     * @param Class_ $node
+     */
+    public function refactor(Node $node): ?Node
+    {
+        if (! $this->testsNodeAnalyzer->isInTestClass($node)) {
+            return null;
+        }
+
+        $dataProviderClassMethods = $this->dataProviderMethodsFinder->findDataProviderNodesInClass($node);
+
+        $hasChanged = false;
+
+        foreach ($dataProviderClassMethods as $dataProviderClassMethod) {
+            if ($dataProviderClassMethod->returnType instanceof Node) {
+                continue;
+            }
+
+            if (! $this->hasYields($dataProviderClassMethod)) {
+                continue;
+            }
+
+            $dataProviderClassMethod->returnType = new FullyQualified('Iterator');
+            $hasChanged = true;
+        }
+
+        if ($hasChanged) {
+            return $node;
+        }
+
+        return null;
+    }
+
+    private function hasYields(ClassMethod $classMethod): bool
+    {
+        $yields = $this->betterNodeFinder->findInstancesOfScoped((array) $classMethod->stmts, Yield_::class);
+
+        return $yields !== [];
+    }
+}

src/Config/Level/TypeDeclarationLevel.php

@@ -4,6 +4,7 @@
 
 namespace Rector\Config\Level;
 
+use Rector\CodeQuality\Rector\Class_\ReturnIteratorInDataProviderRector;
 use Rector\Contract\Rector\RectorInterface;
 use Rector\Symfony\CodeQuality\Rector\ClassMethod\ResponseReturnTypeControllerActionRector;
 use Rector\TypeDeclaration\Rector\ArrowFunction\AddArrowFunctionReturnTypeRector;
@@ -78,6 +79,7 @@ final class TypeDeclarationLevel
         AddClosureVoidReturnTypeWhereNoReturnRector::class,
         AddFunctionVoidReturnTypeWhereNoReturnRector::class,
         AddTestsVoidReturnTypeWhereNoReturnRector::class,
+        ReturnIteratorInDataProviderRector::class,
 
         ReturnTypeFromMockObjectRector::class,
         TypedPropertyFromCreateMockAssignRector::class,