Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Original file line number Diff line number Diff line change
@@ -0,0 +1,28 @@
<?php

namespace Rector\Tests\TypeDeclaration\Rector\ClassMethod\AddParamTypeBasedOnPHPUnitDataProviderRector\Fixture;

use PHPUnit\Framework\TestCase;

final class SkipYieldFromCombinedWithYield extends TestCase
{
/**
* @dataProvider provideData
*/
public function test($value): void
{
}

public static function provideData(): iterable
{
yield from self::provideMoreData();
yield ['name'];
}

public static function provideMoreData(): iterable
{
yield [100];
}
}

?>
Original file line number Diff line number Diff line change
@@ -0,0 +1,33 @@
<?php

namespace Rector\Tests\TypeDeclaration\Rector\ClassMethod\AddParamTypeBasedOnPHPUnitDataProviderRector\Fixture;

use DateTimeImmutable;
use PHPUnit\Framework\TestCase;

final class SkipYieldVariableMultipleTypes extends TestCase
{
/**
* @dataProvider provideData
*/
public function test(bool $expected, $datumEzl): void
{
}

public static function provideData(): iterable
{
$erstZulassung = new DateTimeImmutable('-8 months');

$cases = [
[true, $erstZulassung],
[false, $erstZulassung],
];

foreach ($cases as $case) {
yield $case;
yield [$case[0], $case[1]->format('Y-m-d')];
}
}
}

?>
Original file line number Diff line number Diff line change
@@ -0,0 +1,67 @@
<?php

namespace Rector\Tests\TypeDeclaration\Rector\ClassMethod\AddParamTypeBasedOnPHPUnitDataProviderRector\FixtureUnion;

use DateTimeImmutable;
use PHPUnit\Framework\TestCase;

final class YieldVariableMultipleTypes extends TestCase
{
/**
* @dataProvider provideData
*/
public function test(bool $expected, $datumEzl): void
{
}

public static function provideData(): iterable
{
$erstZulassung = new DateTimeImmutable('-8 months');

$cases = [
[true, $erstZulassung],
[false, $erstZulassung],
];

foreach ($cases as $case) {
yield $case;
yield [$case[0], $case[1]->format('Y-m-d')];
}
}
}

?>
-----
<?php

namespace Rector\Tests\TypeDeclaration\Rector\ClassMethod\AddParamTypeBasedOnPHPUnitDataProviderRector\FixtureUnion;

use DateTimeImmutable;
use PHPUnit\Framework\TestCase;

final class YieldVariableMultipleTypes extends TestCase
{
/**
* @dataProvider provideData
*/
public function test(bool $expected, \DateTimeImmutable|string $datumEzl): void
{
}

public static function provideData(): iterable
{
$erstZulassung = new DateTimeImmutable('-8 months');

$cases = [
[true, $erstZulassung],
[false, $erstZulassung],
];

foreach ($cases as $case) {
yield $case;
yield [$case[0], $case[1]->format('Y-m-d')];
}
}
}

?>
Original file line number Diff line number Diff line change
@@ -0,0 +1,28 @@
<?php

declare(strict_types=1);

namespace Rector\Tests\TypeDeclaration\Rector\ClassMethod\AddParamTypeBasedOnPHPUnitDataProviderRector;

use Iterator;
use PHPUnit\Framework\Attributes\DataProvider;
use Rector\Testing\PHPUnit\AbstractRectorTestCase;

final class UnionTest extends AbstractRectorTestCase
{
#[DataProvider('provideData')]
public function test(string $filePath): void
{
$this->doTestFile($filePath);
}

public static function provideData(): Iterator
{
return self::yieldFilesFromDirectory(__DIR__ . '/FixtureUnion');
}

public function provideConfigFilePath(): string
{
return __DIR__ . '/config/union_config.php';
}
}
Original file line number Diff line number Diff line change
@@ -0,0 +1,13 @@
<?php

declare(strict_types=1);

use Rector\Config\RectorConfig;
use Rector\TypeDeclaration\Rector\ClassMethod\AddParamTypeBasedOnPHPUnitDataProviderRector;
use Rector\ValueObject\PhpVersionFeature;

return static function (RectorConfig $rectorConfig): void {
$rectorConfig->rule(AddParamTypeBasedOnPHPUnitDataProviderRector::class);

$rectorConfig->phpVersion(PhpVersionFeature::UNION_TYPES);
};
Original file line number Diff line number Diff line change
Expand Up @@ -5,14 +5,17 @@
namespace Rector\TypeDeclaration\TypeAnalyzer;

use PhpParser\Node\ArrayItem;
use PhpParser\Node\Expr;
use PhpParser\Node\Expr\Array_;
use PhpParser\Node\Expr\Yield_;
use PhpParser\Node\Expr\YieldFrom;
use PhpParser\Node\Stmt\ClassMethod;
use PhpParser\Node\Stmt\Return_;
use PHPStan\Type\Constant\ConstantArrayType;
use PHPStan\Type\MixedType;
use PHPStan\Type\Type;
use PHPStan\Type\TypeCombinator;
use PHPStan\Type\UnionType;
use Rector\NodeTypeResolver\NodeTypeResolver;
use Rector\NodeTypeResolver\PHPStan\Type\TypeFactory;
use Rector\PhpParser\Node\BetterNodeFinder;
Expand Down Expand Up @@ -51,6 +54,16 @@ private function resolveParameterTypeFromDataProvider(
return $this->resolveReturnStaticArrayTypeByParameterPosition($returns, $parameterPosition);
}

$yieldFromNodes = $this->betterNodeFinder->findInstancesOfInFunctionLikeScoped(
$dataProviderClassMethod,
YieldFrom::class
);

// "yield from" data sets are not resolved here → the resolved type would be incomplete
if ($yieldFromNodes !== []) {
return new MixedType();
}

/** @var Yield_[] $yields */
$yields = $this->betterNodeFinder->findInstancesOfInFunctionLikeScoped($dataProviderClassMethod, Yield_::class);
return $this->resolveYieldStaticArrayTypeByParameterPosition($yields, $parameterPosition);
Expand Down Expand Up @@ -83,22 +96,25 @@ private function resolveYieldStaticArrayTypeByParameterPosition(array $yields, i
$paramOnPositionTypes = [];

foreach ($yields as $yield) {
if (! $yield->value instanceof Array_) {
continue;
if (! $yield->value instanceof Expr) {
return new MixedType();
}

$type = $this->getTypeFromClassMethodYield($yield->value);
$constantArrayTypes = $this->resolveYieldedConstantArrayTypes($yield->value);

if (! $type instanceof ConstantArrayType) {
return $type;
// one of the yielded data sets cannot be resolved → the resolved type would be incomplete
if ($constantArrayTypes === []) {
return new MixedType();
}

foreach ($type->getValueTypes() as $position => $valueType) {
if ($position !== $parameterPosition) {
continue;
}
foreach ($constantArrayTypes as $constantArrayType) {
foreach ($constantArrayType->getValueTypes() as $position => $valueType) {
if ($position !== $parameterPosition) {
continue;
}

$paramOnPositionTypes[] = $valueType;
$paramOnPositionTypes[] = $valueType;
}
}
}

Expand All @@ -109,16 +125,32 @@ private function resolveYieldStaticArrayTypeByParameterPosition(array $yields, i
return $this->typeFactory->createMixedPassedOrUnionType($paramOnPositionTypes);
}

private function getTypeFromClassMethodYield(Array_ $classMethodYieldArray): MixedType|ConstantArrayType
/**
* @return ConstantArrayType[]
*/
private function resolveYieldedConstantArrayTypes(Expr $expr): array
{
$arrayType = $this->nodeTypeResolver->getType($classMethodYieldArray);
$yieldedType = $this->nodeTypeResolver->getType($expr);

// impossible to resolve
if (! $arrayType instanceof ConstantArrayType) {
return new MixedType();
if ($yieldedType instanceof ConstantArrayType) {
return [$yieldedType];
}

if (! $yieldedType instanceof UnionType) {
return [];
}

$constantArrayTypes = [];
foreach ($yieldedType->getTypes() as $unionedType) {
// impossible to resolve
if (! $unionedType instanceof ConstantArrayType) {
return [];
}

$constantArrayTypes[] = $unionedType;
}

return $arrayType;
return $constantArrayTypes;
}

/**
Expand Down
Loading