mirror of
https://github.com/rectorphp/rector.git
synced 2024-06-03 18:00:50 +00:00
1127b0c4e2
bc9d2d48d5
[DX] Add MissedRectorDueVersionChecker (#465)
197 lines
8.1 KiB
PHP
197 lines
8.1 KiB
PHP
<?php
|
|
|
|
declare (strict_types=1);
|
|
namespace Rector\Php80\Rector\FunctionLike;
|
|
|
|
use PhpParser\Node;
|
|
use PhpParser\Node\Expr\ArrowFunction;
|
|
use PhpParser\Node\Expr\Closure;
|
|
use PhpParser\Node\Name;
|
|
use PhpParser\Node\Param;
|
|
use PhpParser\Node\Stmt\ClassMethod;
|
|
use PhpParser\Node\Stmt\Function_;
|
|
use PhpParser\Node\UnionType as PhpParserUnionType;
|
|
use PHPStan\Type\ArrayType;
|
|
use PHPStan\Type\Type;
|
|
use PHPStan\Type\UnionType;
|
|
use Rector\BetterPhpDocParser\PhpDocInfo\PhpDocInfo;
|
|
use Rector\Core\Rector\AbstractRector;
|
|
use Rector\Core\ValueObject\PhpVersionFeature;
|
|
use Rector\DeadCode\PhpDoc\TagRemover\ParamTagRemover;
|
|
use Rector\DeadCode\PhpDoc\TagRemover\ReturnTagRemover;
|
|
use Rector\NodeTypeResolver\PHPStan\Type\TypeFactory;
|
|
use Rector\PHPStanStaticTypeMapper\TypeAnalyzer\UnionTypeAnalyzer;
|
|
use Rector\PHPStanStaticTypeMapper\ValueObject\TypeKind;
|
|
use Rector\VendorLocker\NodeVendorLocker\ClassMethodParamVendorLockResolver;
|
|
use Rector\VersionBonding\Contract\MinPhpVersionInterface;
|
|
use Symplify\RuleDocGenerator\ValueObject\CodeSample\CodeSample;
|
|
use Symplify\RuleDocGenerator\ValueObject\RuleDefinition;
|
|
/**
|
|
* @see \Rector\Tests\Php80\Rector\FunctionLike\UnionTypesRector\UnionTypesRectorTest
|
|
*/
|
|
final class UnionTypesRector extends \Rector\Core\Rector\AbstractRector implements \Rector\VersionBonding\Contract\MinPhpVersionInterface
|
|
{
|
|
/**
|
|
* @var \Rector\DeadCode\PhpDoc\TagRemover\ReturnTagRemover
|
|
*/
|
|
private $returnTagRemover;
|
|
/**
|
|
* @var \Rector\DeadCode\PhpDoc\TagRemover\ParamTagRemover
|
|
*/
|
|
private $paramTagRemover;
|
|
/**
|
|
* @var \Rector\VendorLocker\NodeVendorLocker\ClassMethodParamVendorLockResolver
|
|
*/
|
|
private $classMethodParamVendorLockResolver;
|
|
/**
|
|
* @var \Rector\PHPStanStaticTypeMapper\TypeAnalyzer\UnionTypeAnalyzer
|
|
*/
|
|
private $unionTypeAnalyzer;
|
|
/**
|
|
* @var \Rector\NodeTypeResolver\PHPStan\Type\TypeFactory
|
|
*/
|
|
private $typeFactory;
|
|
public function __construct(\Rector\DeadCode\PhpDoc\TagRemover\ReturnTagRemover $returnTagRemover, \Rector\DeadCode\PhpDoc\TagRemover\ParamTagRemover $paramTagRemover, \Rector\VendorLocker\NodeVendorLocker\ClassMethodParamVendorLockResolver $classMethodParamVendorLockResolver, \Rector\PHPStanStaticTypeMapper\TypeAnalyzer\UnionTypeAnalyzer $unionTypeAnalyzer, \Rector\NodeTypeResolver\PHPStan\Type\TypeFactory $typeFactory)
|
|
{
|
|
$this->returnTagRemover = $returnTagRemover;
|
|
$this->paramTagRemover = $paramTagRemover;
|
|
$this->classMethodParamVendorLockResolver = $classMethodParamVendorLockResolver;
|
|
$this->unionTypeAnalyzer = $unionTypeAnalyzer;
|
|
$this->typeFactory = $typeFactory;
|
|
}
|
|
public function getRuleDefinition() : \Symplify\RuleDocGenerator\ValueObject\RuleDefinition
|
|
{
|
|
return new \Symplify\RuleDocGenerator\ValueObject\RuleDefinition('Change docs types to union types, where possible (properties are covered by TypedPropertiesRector)', [new \Symplify\RuleDocGenerator\ValueObject\CodeSample\CodeSample(<<<'CODE_SAMPLE'
|
|
class SomeClass
|
|
{
|
|
/**
|
|
* @param array|int $number
|
|
* @return bool|float
|
|
*/
|
|
public function go($number)
|
|
{
|
|
}
|
|
}
|
|
CODE_SAMPLE
|
|
, <<<'CODE_SAMPLE'
|
|
class SomeClass
|
|
{
|
|
public function go(array|int $number): bool|float
|
|
{
|
|
}
|
|
}
|
|
CODE_SAMPLE
|
|
)]);
|
|
}
|
|
/**
|
|
* @return array<class-string<Node>>
|
|
*/
|
|
public function getNodeTypes() : array
|
|
{
|
|
return [\PhpParser\Node\Stmt\ClassMethod::class, \PhpParser\Node\Stmt\Function_::class, \PhpParser\Node\Expr\Closure::class, \PhpParser\Node\Expr\ArrowFunction::class];
|
|
}
|
|
/**
|
|
* @param ClassMethod | Function_ | Closure | ArrowFunction $node
|
|
*/
|
|
public function refactor(\PhpParser\Node $node) : ?\PhpParser\Node
|
|
{
|
|
$phpDocInfo = $this->phpDocInfoFactory->createFromNodeOrEmpty($node);
|
|
$this->refactorParamTypes($node, $phpDocInfo);
|
|
$this->refactorReturnType($node, $phpDocInfo);
|
|
$this->paramTagRemover->removeParamTagsIfUseless($phpDocInfo, $node);
|
|
$this->returnTagRemover->removeReturnTagIfUseless($phpDocInfo, $node);
|
|
return $node;
|
|
}
|
|
public function provideMinPhpVersion() : int
|
|
{
|
|
return \Rector\Core\ValueObject\PhpVersionFeature::UNION_TYPES;
|
|
}
|
|
/**
|
|
* @param \PhpParser\Node\Stmt\ClassMethod|\PhpParser\Node\Stmt\Function_|\PhpParser\Node\Expr\Closure|\PhpParser\Node\Expr\ArrowFunction $functionLike
|
|
*/
|
|
private function refactorParamTypes($functionLike, \Rector\BetterPhpDocParser\PhpDocInfo\PhpDocInfo $phpDocInfo) : void
|
|
{
|
|
if ($functionLike instanceof \PhpParser\Node\Stmt\ClassMethod && $this->classMethodParamVendorLockResolver->isVendorLocked($functionLike)) {
|
|
return;
|
|
}
|
|
foreach ($functionLike->getParams() as $param) {
|
|
/** @var string $paramName */
|
|
$paramName = $this->getName($param->var);
|
|
$paramType = $phpDocInfo->getParamType($paramName);
|
|
if (!$paramType instanceof \PHPStan\Type\UnionType) {
|
|
continue;
|
|
}
|
|
if ($this->unionTypeAnalyzer->hasObjectWithoutClassType($paramType)) {
|
|
$this->changeObjectWithoutClassType($param, $paramType);
|
|
continue;
|
|
}
|
|
$uniqueatedParamType = $this->filterOutDuplicatedArrayTypes($paramType);
|
|
if (!$uniqueatedParamType instanceof \PHPStan\Type\UnionType) {
|
|
continue;
|
|
}
|
|
$phpParserUnionType = $this->staticTypeMapper->mapPHPStanTypeToPhpParserNode($uniqueatedParamType, \Rector\PHPStanStaticTypeMapper\ValueObject\TypeKind::PARAM());
|
|
if (!$phpParserUnionType instanceof \PhpParser\Node\UnionType) {
|
|
continue;
|
|
}
|
|
if ($param->type instanceof \PhpParser\Node\UnionType) {
|
|
continue;
|
|
}
|
|
$param->type = $phpParserUnionType;
|
|
}
|
|
}
|
|
private function changeObjectWithoutClassType(\PhpParser\Node\Param $param, \PHPStan\Type\UnionType $unionType) : void
|
|
{
|
|
if (!$this->unionTypeAnalyzer->hasObjectWithoutClassTypeWithOnlyFullyQualifiedObjectType($unionType)) {
|
|
return;
|
|
}
|
|
$param->type = new \PhpParser\Node\Name('object');
|
|
}
|
|
/**
|
|
* @param \PhpParser\Node\Stmt\ClassMethod|\PhpParser\Node\Stmt\Function_|\PhpParser\Node\Expr\Closure|\PhpParser\Node\Expr\ArrowFunction $functionLike
|
|
*/
|
|
private function refactorReturnType($functionLike, \Rector\BetterPhpDocParser\PhpDocInfo\PhpDocInfo $phpDocInfo) : void
|
|
{
|
|
// do not override existing return type
|
|
if ($functionLike->getReturnType() !== null) {
|
|
return;
|
|
}
|
|
$returnType = $phpDocInfo->getReturnType();
|
|
if (!$returnType instanceof \PHPStan\Type\UnionType) {
|
|
return;
|
|
}
|
|
$uniqueatedReturnType = $this->filterOutDuplicatedArrayTypes($returnType);
|
|
if (!$uniqueatedReturnType instanceof \PHPStan\Type\UnionType) {
|
|
return;
|
|
}
|
|
$phpParserUnionType = $this->staticTypeMapper->mapPHPStanTypeToPhpParserNode($uniqueatedReturnType, \Rector\PHPStanStaticTypeMapper\ValueObject\TypeKind::RETURN());
|
|
if (!$phpParserUnionType instanceof \PhpParser\Node\UnionType) {
|
|
return;
|
|
}
|
|
$functionLike->returnType = $phpParserUnionType;
|
|
}
|
|
/**
|
|
* @return \PHPStan\Type\UnionType|\PHPStan\Type\Type
|
|
*/
|
|
private function filterOutDuplicatedArrayTypes(\PHPStan\Type\UnionType $unionType)
|
|
{
|
|
$hasArrayType = \false;
|
|
$singleArrayTypes = [];
|
|
$originalTypeCount = \count($unionType->getTypes());
|
|
foreach ($unionType->getTypes() as $unionedType) {
|
|
if ($unionedType instanceof \PHPStan\Type\ArrayType) {
|
|
if ($hasArrayType) {
|
|
continue;
|
|
}
|
|
$singleArrayTypes[] = $unionedType;
|
|
$hasArrayType = \true;
|
|
continue;
|
|
}
|
|
$singleArrayTypes[] = $unionedType;
|
|
}
|
|
if ($originalTypeCount === \count($singleArrayTypes)) {
|
|
return $unionType;
|
|
}
|
|
return $this->typeFactory->createMixedPassedOrUnionType($singleArrayTypes);
|
|
}
|
|
}
|