Skip to content
Merged
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,49 @@
<?php

namespace Rector\Tests\TypeDeclarationDocblocks\Rector\ClassMethod\AddParamArrayDocblockFromDataProviderRector\Fixture;

use PHPUnit\Framework\Attributes\DataProvider;
use PHPUnit\Framework\TestCase;

final class OverrideDummyArrayParam extends TestCase
{
/**
* @param array $names
*/
#[DataProvider('provideData')]
public function test(array $names): void
{
}

public static function provideData()
{
yield [['Tom', 'John']];
}
}

?>
-----
<?php

namespace Rector\Tests\TypeDeclarationDocblocks\Rector\ClassMethod\AddParamArrayDocblockFromDataProviderRector\Fixture;

use PHPUnit\Framework\Attributes\DataProvider;
use PHPUnit\Framework\TestCase;

final class OverrideDummyArrayParam extends TestCase
{
/**
* @param string[] $names
*/
#[DataProvider('provideData')]
public function test(array $names): void
{
}

public static function provideData()
{
yield [['Tom', 'John']];
}
}

?>
4 changes: 4 additions & 0 deletions rules/TypeDeclarationDocblocks/NodeDocblockTypeDecorator.php
Original file line number Diff line number Diff line change
Expand Up @@ -130,6 +130,10 @@ private function addTagValueNodeAndUpdatePhpDocInfo(

private function isBareMixedType(Type $type): bool
{
if ($type instanceof MixedType) {
return true;
}

$normalizedResolvedParameterType = $this->typeNormalizer->generalizeConstantTypes($type);

// most likely mixed, skip
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,6 @@
use PhpParser\Node;
use PhpParser\Node\Identifier;
use PhpParser\Node\Stmt\ClassMethod;
use PHPStan\PhpDocParser\Ast\PhpDoc\ParamTagValueNode;
use PHPStan\Type\ArrayType;
use PHPStan\Type\MixedType;
use Rector\BetterPhpDocParser\PhpDocInfo\PhpDocInfoFactory;
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -6,17 +6,13 @@

use PhpParser\Node;
use PhpParser\Node\Stmt\Class_;
use PHPStan\PhpDocParser\Ast\PhpDoc\ParamTagValueNode;
use PHPStan\Type\ArrayType;
use PHPStan\Type\MixedType;
use Rector\BetterPhpDocParser\PhpDocInfo\PhpDocInfoFactory;
use Rector\Comments\NodeDocBlock\DocBlockUpdater;
use Rector\PHPUnit\NodeAnalyzer\TestsNodeAnalyzer;
use Rector\Privatization\TypeManipulator\TypeNormalizer;
use Rector\Rector\AbstractRector;
use Rector\StaticTypeMapper\StaticTypeMapper;
use Rector\TypeDeclaration\TypeAnalyzer\ParameterTypeFromDataProviderResolver;
use Rector\TypeDeclarationDocblocks\NodeDocblockTypeDecorator;
use Rector\TypeDeclarationDocblocks\NodeFinder\DataProviderMethodsFinder;
use Rector\TypeDeclarationDocblocks\TagNodeAnalyzer\UsefulArrayTagNodeAnalyzer;
use Symplify\RuleDocGenerator\ValueObject\CodeSample\CodeSample;
use Symplify\RuleDocGenerator\ValueObject\RuleDefinition;

Expand All @@ -27,12 +23,11 @@ final class AddParamArrayDocblockFromDataProviderRector extends AbstractRector
{
public function __construct(
private readonly PhpDocInfoFactory $phpDocInfoFactory,
private readonly DocBlockUpdater $docBlockUpdater,
private readonly TestsNodeAnalyzer $testsNodeAnalyzer,
private readonly DataProviderMethodsFinder $dataProviderMethodsFinder,
private readonly ParameterTypeFromDataProviderResolver $parameterTypeFromDataProviderResolver,
private readonly StaticTypeMapper $staticTypeMapper,
private readonly TypeNormalizer $typeNormalizer,
private readonly UsefulArrayTagNodeAnalyzer $usefulArrayTagNodeAnalyzer,
private readonly NodeDocblockTypeDecorator $nodeDocblockTypeDecorator
) {
}

Expand Down Expand Up @@ -137,7 +132,7 @@ public function refactor(Node $node): ?Node
$paramTagValueNode = $phpDocInfo->getParamTagValueByName($paramName);

// already defined, lets skip it
if ($paramTagValueNode instanceof ParamTagValueNode) {
if ($this->usefulArrayTagNodeAnalyzer->isUsefulArrayTag($paramTagValueNode)) {
continue;
}

Expand All @@ -146,26 +141,19 @@ public function refactor(Node $node): ?Node
$dataProviderNodes->getClassMethods()
);

// skip mixed type, as it is not informative
if ($parameterType instanceof ArrayType && $parameterType->getItemType() instanceof MixedType) {
continue;
}
$hasParamTypeChanged = $this->nodeDocblockTypeDecorator->decorateGenericIterableParamType(
$parameterType,
$phpDocInfo,
$classMethod,
$param,
$paramName
);

if ($parameterType instanceof MixedType) {
if (! $hasParamTypeChanged) {
continue;
}

$generalizedParameterType = $this->typeNormalizer->generalizeConstantTypes($parameterType);

$parameterTypeNode = $this->staticTypeMapper->mapPHPStanTypeToPHPStanPhpDocTypeNode(
$generalizedParameterType
);

$paramTagValueNode = new ParamTagValueNode($parameterTypeNode, false, '$' . $paramName, '', false);
$phpDocInfo->addTagValueNode($paramTagValueNode);
$hasChanged = true;

$this->docBlockUpdater->updateRefactoredNodeWithPhpDocInfo($classMethod);
}

}
Expand Down