mirror of
https://github.com/rectorphp/rector.git
synced 2024-06-03 18:00:50 +00:00
1127b0c4e2
bc9d2d48d5
[DX] Add MissedRectorDueVersionChecker (#465)
160 lines
5.9 KiB
PHP
160 lines
5.9 KiB
PHP
<?php
|
|
|
|
declare (strict_types=1);
|
|
namespace Rector\TypeDeclaration\Rector\Param;
|
|
|
|
use PhpParser\Node;
|
|
use PhpParser\Node\Expr\Assign;
|
|
use PhpParser\Node\Expr\PropertyFetch;
|
|
use PhpParser\Node\FunctionLike;
|
|
use PhpParser\Node\NullableType;
|
|
use PhpParser\Node\Param;
|
|
use PhpParser\Node\UnionType;
|
|
use PHPStan\Analyser\Scope;
|
|
use PHPStan\Reflection\Php\PhpPropertyReflection;
|
|
use PHPStan\Type\MixedType;
|
|
use PHPStan\Type\Type;
|
|
use Rector\Core\Rector\AbstractRector;
|
|
use Rector\Core\Reflection\ReflectionResolver;
|
|
use Rector\Core\ValueObject\PhpVersionFeature;
|
|
use Rector\NodeTypeResolver\Node\AttributeKey;
|
|
use Rector\PHPStanStaticTypeMapper\ValueObject\TypeKind;
|
|
use Rector\VersionBonding\Contract\MinPhpVersionInterface;
|
|
use Symplify\RuleDocGenerator\ValueObject\CodeSample\CodeSample;
|
|
use Symplify\RuleDocGenerator\ValueObject\RuleDefinition;
|
|
/**
|
|
* @see \Rector\Tests\TypeDeclaration\Rector\Param\ParamTypeFromStrictTypedPropertyRector\ParamTypeFromStrictTypedPropertyRectorTest
|
|
*/
|
|
final class ParamTypeFromStrictTypedPropertyRector extends \Rector\Core\Rector\AbstractRector implements \Rector\VersionBonding\Contract\MinPhpVersionInterface
|
|
{
|
|
/**
|
|
* @var \Rector\Core\Reflection\ReflectionResolver
|
|
*/
|
|
private $reflectionResolver;
|
|
public function __construct(\Rector\Core\Reflection\ReflectionResolver $reflectionResolver)
|
|
{
|
|
$this->reflectionResolver = $reflectionResolver;
|
|
}
|
|
public function getRuleDefinition() : \Symplify\RuleDocGenerator\ValueObject\RuleDefinition
|
|
{
|
|
return new \Symplify\RuleDocGenerator\ValueObject\RuleDefinition('Add param type from $param set to typed property', [new \Symplify\RuleDocGenerator\ValueObject\CodeSample\CodeSample(<<<'CODE_SAMPLE'
|
|
final class SomeClass
|
|
{
|
|
private int $age;
|
|
|
|
public function setAge($age)
|
|
{
|
|
$this->age = $age;
|
|
}
|
|
}
|
|
CODE_SAMPLE
|
|
, <<<'CODE_SAMPLE'
|
|
final class SomeClass
|
|
{
|
|
private int $age;
|
|
|
|
public function setAge(int $age)
|
|
{
|
|
$this->age = $age;
|
|
}
|
|
}
|
|
CODE_SAMPLE
|
|
)]);
|
|
}
|
|
/**
|
|
* @return array<class-string<Node>>
|
|
*/
|
|
public function getNodeTypes() : array
|
|
{
|
|
return [\PhpParser\Node\Param::class];
|
|
}
|
|
/**
|
|
* @param Param $node
|
|
*/
|
|
public function refactor(\PhpParser\Node $node) : ?\PhpParser\Node
|
|
{
|
|
$parent = $node->getAttribute(\Rector\NodeTypeResolver\Node\AttributeKey::PARENT_NODE);
|
|
if (!$parent instanceof \PhpParser\Node\FunctionLike) {
|
|
return null;
|
|
}
|
|
return $this->decorateParamWithType($parent, $node);
|
|
}
|
|
public function decorateParamWithType(\PhpParser\Node\FunctionLike $functionLike, \PhpParser\Node\Param $param) : ?\PhpParser\Node\Param
|
|
{
|
|
if ($param->type !== null) {
|
|
return null;
|
|
}
|
|
$originalParamType = $this->resolveParamOriginalType($param);
|
|
$paramName = $this->getName($param);
|
|
/** @var Assign[] $assigns */
|
|
$assigns = $this->betterNodeFinder->findInstanceOf((array) $functionLike->getStmts(), \PhpParser\Node\Expr\Assign::class);
|
|
foreach ($assigns as $assign) {
|
|
if (!$this->nodeComparator->areNodesEqual($assign->expr, $param->var)) {
|
|
continue;
|
|
}
|
|
if (!$assign->var instanceof \PhpParser\Node\Expr\PropertyFetch) {
|
|
continue;
|
|
}
|
|
if ($this->hasTypeChangedBeforeAssign($assign, $paramName, $originalParamType)) {
|
|
return null;
|
|
}
|
|
$singlePropertyTypeNode = $this->matchPropertySingleTypeNode($assign->var);
|
|
if (!$singlePropertyTypeNode instanceof \PhpParser\Node) {
|
|
return null;
|
|
}
|
|
$param->type = $singlePropertyTypeNode;
|
|
return $param;
|
|
}
|
|
return null;
|
|
}
|
|
public function provideMinPhpVersion() : int
|
|
{
|
|
return \Rector\Core\ValueObject\PhpVersionFeature::TYPED_PROPERTIES;
|
|
}
|
|
/**
|
|
* @return Node\Name|UnionType|NullableType|null
|
|
*/
|
|
private function matchPropertySingleTypeNode(\PhpParser\Node\Expr\PropertyFetch $propertyFetch) : ?\PhpParser\Node
|
|
{
|
|
$phpPropertyReflection = $this->reflectionResolver->resolvePropertyReflectionFromPropertyFetch($propertyFetch);
|
|
if (!$phpPropertyReflection instanceof \PHPStan\Reflection\Php\PhpPropertyReflection) {
|
|
return null;
|
|
}
|
|
$propertyType = $phpPropertyReflection->getNativeType();
|
|
if ($propertyType instanceof \PHPStan\Type\MixedType) {
|
|
return null;
|
|
}
|
|
if ($propertyType instanceof \PHPStan\Type\UnionType) {
|
|
return null;
|
|
}
|
|
if ($propertyType instanceof \PhpParser\Node\NullableType) {
|
|
return null;
|
|
}
|
|
return $this->staticTypeMapper->mapPHPStanTypeToPhpParserNode($propertyType, \Rector\PHPStanStaticTypeMapper\ValueObject\TypeKind::PROPERTY());
|
|
}
|
|
private function hasTypeChangedBeforeAssign(\PhpParser\Node\Expr\Assign $assign, string $paramName, \PHPStan\Type\Type $originalType) : bool
|
|
{
|
|
$scope = $assign->getAttribute(\Rector\NodeTypeResolver\Node\AttributeKey::SCOPE);
|
|
if (!$scope instanceof \PHPStan\Analyser\Scope) {
|
|
return \false;
|
|
}
|
|
if (!$scope->hasVariableType($paramName)->yes()) {
|
|
return \false;
|
|
}
|
|
$currentParamType = $scope->getVariableType($paramName);
|
|
return !$currentParamType->equals($originalType);
|
|
}
|
|
private function resolveParamOriginalType(\PhpParser\Node\Param $param) : \PHPStan\Type\Type
|
|
{
|
|
$scope = $param->getAttribute(\Rector\NodeTypeResolver\Node\AttributeKey::SCOPE);
|
|
if (!$scope instanceof \PHPStan\Analyser\Scope) {
|
|
return new \PHPStan\Type\MixedType();
|
|
}
|
|
$paramName = $this->getName($param);
|
|
if (!$scope->hasVariableType($paramName)->yes()) {
|
|
return new \PHPStan\Type\MixedType();
|
|
}
|
|
return $scope->getVariableType($paramName);
|
|
}
|
|
}
|