Update rule with proper syntax of ReturnArrayClassMethodToYieldRector

[gnutix]

No description provided.

[gnutix]

Also I was thinking : what about supporting methods referenced by the @dataProvider [methodName] PHPUnit annotation ? Do you think it should be implemented ? It would be more robust than the current provide* / dataProvider* matching, which isn't even a standard / recommended pattern from PHPUnit as far as I know ?

Example of a failing test case packages/CodingStyle/tests/Rector/ClassMethod/ReturnArrayClassMethodToYieldRector/Fixture/data_provider_via_annotation_only.php.inc :

<?php

namespace Rector\CodingStyle\Tests\Rector\ClassMethod\ReturnArrayClassMethodToYieldRector\Fixture;

use Rector\CodingStyle\Tests\Rector\ClassMethod\ReturnArrayClassMethodToYieldRector\Source\ParentTestCase;

class DataProviderViaAnnotationOnly extends ParentTestCase
{
    /**
     * @dataProvider someMethod
     */
    public function testSomething($arg1, $arg2, $arg3): void
    {
    }

    public function someMethod(): array
    {
        return [['some', 'test', 'arguments']];
    }
}

?>
-----
<?php

namespace Rector\CodingStyle\Tests\Rector\ClassMethod\ReturnArrayClassMethodToYieldRector\Fixture;

use Rector\CodingStyle\Tests\Rector\ClassMethod\ReturnArrayClassMethodToYieldRector\Source\ParentTestCase;

class DataProviderViaAnnotationOnly extends ParentTestCase
{
    /**
     * @dataProvider someMethod
     */
    public function testSomething($arg1, $arg2, $arg3): void
    {
    }

    public function someMethod(): \Iterator
    {
        yield ['some', 'test', 'arguments'];
    }
}

?>

Which would probably mean relying on a \PHPUnit\Framework\TestCase stub instead of this Source\ParentTestCase fake.

[TomasVotruba]

Well, this rule is generic and configurable to any class/pattern, not just data providers (it's just an example).

If you want to add such a rule for data providers, you can re-use this in a new rule, that would collect all method names from @dataProvider annotation and then apply the logic on there class methdos.