mirror of https://github.com/rectorphp/rector.git
182 lines
6.7 KiB
PHP
182 lines
6.7 KiB
PHP
<?php
|
|
|
|
declare (strict_types=1);
|
|
namespace Rector\Php81\Rector\Class_;
|
|
|
|
use PhpParser\Node;
|
|
use PhpParser\Node\Name\FullyQualified;
|
|
use PhpParser\Node\Param;
|
|
use PhpParser\Node\Stmt\Class_;
|
|
use PhpParser\Node\Stmt\ClassMethod;
|
|
use PhpParser\Node\Stmt\Property;
|
|
use PHPStan\Reflection\MethodReflection;
|
|
use PHPStan\Reflection\ParametersAcceptorSelector;
|
|
use Rector\BetterPhpDocParser\PhpDocInfo\PhpDocInfo;
|
|
use Rector\BetterPhpDocParser\PhpDocManipulator\PhpDocTagRemover;
|
|
use Rector\Core\Rector\AbstractRector;
|
|
use Rector\Core\Reflection\ReflectionResolver;
|
|
use Rector\Php80\NodeAnalyzer\EnumParamAnalyzer;
|
|
use Rector\Php80\ValueObject\ClassNameAndTagValueNode;
|
|
use Rector\Php81\NodeAnalyzer\EnumConstListClassDetector;
|
|
use Rector\Php81\NodeFactory\EnumFactory;
|
|
use Symplify\RuleDocGenerator\ValueObject\CodeSample\CodeSample;
|
|
use Symplify\RuleDocGenerator\ValueObject\RuleDefinition;
|
|
/**
|
|
* @see \Rector\Tests\Php81\Rector\Class_\ConstantListClassToEnumRector\ConstantListClassToEnumRectorTest
|
|
*/
|
|
final class ConstantListClassToEnumRector extends AbstractRector
|
|
{
|
|
/**
|
|
* @readonly
|
|
* @var \Rector\Php81\NodeAnalyzer\EnumConstListClassDetector
|
|
*/
|
|
private $enumConstListClassDetector;
|
|
/**
|
|
* @readonly
|
|
* @var \Rector\Php81\NodeFactory\EnumFactory
|
|
*/
|
|
private $enumFactory;
|
|
/**
|
|
* @readonly
|
|
* @var \Rector\Php80\NodeAnalyzer\EnumParamAnalyzer
|
|
*/
|
|
private $enumParamAnalyzer;
|
|
/**
|
|
* @readonly
|
|
* @var \Rector\Core\Reflection\ReflectionResolver
|
|
*/
|
|
private $reflectionResolver;
|
|
/**
|
|
* @readonly
|
|
* @var \Rector\BetterPhpDocParser\PhpDocManipulator\PhpDocTagRemover
|
|
*/
|
|
private $phpDocTagRemover;
|
|
public function __construct(EnumConstListClassDetector $enumConstListClassDetector, EnumFactory $enumFactory, EnumParamAnalyzer $enumParamAnalyzer, ReflectionResolver $reflectionResolver, PhpDocTagRemover $phpDocTagRemover)
|
|
{
|
|
$this->enumConstListClassDetector = $enumConstListClassDetector;
|
|
$this->enumFactory = $enumFactory;
|
|
$this->enumParamAnalyzer = $enumParamAnalyzer;
|
|
$this->reflectionResolver = $reflectionResolver;
|
|
$this->phpDocTagRemover = $phpDocTagRemover;
|
|
}
|
|
public function getRuleDefinition() : RuleDefinition
|
|
{
|
|
return new RuleDefinition('Upgrade constant list classes to full blown enum', [new CodeSample(<<<'CODE_SAMPLE'
|
|
class Direction
|
|
{
|
|
public const LEFT = 'left';
|
|
|
|
public const RIGHT = 'right';
|
|
}
|
|
CODE_SAMPLE
|
|
, <<<'CODE_SAMPLE'
|
|
enum Direction
|
|
{
|
|
case LEFT;
|
|
|
|
case RIGHT;
|
|
}
|
|
CODE_SAMPLE
|
|
)]);
|
|
}
|
|
/**
|
|
* @return array<class-string<Node>>
|
|
*/
|
|
public function getNodeTypes() : array
|
|
{
|
|
return [Class_::class, ClassMethod::class, Property::class];
|
|
}
|
|
/**
|
|
* @param Class_|ClassMethod|Property $node
|
|
*/
|
|
public function refactor(Node $node) : ?Node
|
|
{
|
|
if ($node instanceof Class_) {
|
|
if (!$this->enumConstListClassDetector->detect($node)) {
|
|
return null;
|
|
}
|
|
return $this->enumFactory->createFromClass($node);
|
|
}
|
|
if ($node instanceof ClassMethod) {
|
|
return $this->refactorClassMethod($node);
|
|
}
|
|
return $this->refactorProperty($node);
|
|
}
|
|
private function refactorClassMethod(ClassMethod $classMethod) : ?ClassMethod
|
|
{
|
|
// enum param types doc requires a docblock
|
|
$phpDocInfo = $this->phpDocInfoFactory->createFromNode($classMethod);
|
|
if (!$phpDocInfo instanceof PhpDocInfo) {
|
|
return null;
|
|
}
|
|
$methodReflection = $this->reflectionResolver->resolveMethodReflectionFromClassMethod($classMethod);
|
|
if (!$methodReflection instanceof MethodReflection) {
|
|
return null;
|
|
}
|
|
// refactor params
|
|
$haveParamsChanged = $this->refactorParams($methodReflection, $phpDocInfo, $classMethod);
|
|
$hasReturnChanged = $this->refactorReturn($phpDocInfo, $classMethod);
|
|
if ($haveParamsChanged) {
|
|
return $classMethod;
|
|
}
|
|
if ($hasReturnChanged) {
|
|
return $classMethod;
|
|
}
|
|
return null;
|
|
}
|
|
private function getParamByName(ClassMethod $classMethod, string $desiredParamName) : ?Param
|
|
{
|
|
foreach ($classMethod->params as $param) {
|
|
if (!$this->nodeNameResolver->isName($param, $desiredParamName)) {
|
|
continue;
|
|
}
|
|
return $param;
|
|
}
|
|
return null;
|
|
}
|
|
private function refactorParams(MethodReflection $methodReflection, PhpDocInfo $phpDocInfo, ClassMethod $classMethod) : bool
|
|
{
|
|
$hasNodeChanged = \false;
|
|
$parametersAcceptor = ParametersAcceptorSelector::selectSingle($methodReflection->getVariants());
|
|
foreach ($parametersAcceptor->getParameters() as $parameterReflection) {
|
|
$classNameAndTagValueNode = $this->enumParamAnalyzer->matchParameterClassName($parameterReflection, $phpDocInfo);
|
|
if (!$classNameAndTagValueNode instanceof ClassNameAndTagValueNode) {
|
|
continue;
|
|
}
|
|
$param = $this->getParamByName($classMethod, $parameterReflection->getName());
|
|
if (!$param instanceof Param) {
|
|
continue;
|
|
}
|
|
// change and remove
|
|
$param->type = new FullyQualified($classNameAndTagValueNode->getEnumClass());
|
|
$hasNodeChanged = \true;
|
|
$this->phpDocTagRemover->removeTagValueFromNode($phpDocInfo, $classNameAndTagValueNode->getTagValueNode());
|
|
}
|
|
return $hasNodeChanged;
|
|
}
|
|
private function refactorReturn(PhpDocInfo $phpDocInfo, ClassMethod $classMethod) : bool
|
|
{
|
|
$classNameAndTagValueNode = $this->enumParamAnalyzer->matchReturnClassName($phpDocInfo);
|
|
if (!$classNameAndTagValueNode instanceof ClassNameAndTagValueNode) {
|
|
return \false;
|
|
}
|
|
$classMethod->returnType = new FullyQualified($classNameAndTagValueNode->getEnumClass());
|
|
$this->phpDocTagRemover->removeTagValueFromNode($phpDocInfo, $classNameAndTagValueNode->getTagValueNode());
|
|
return \true;
|
|
}
|
|
private function refactorProperty(Property $property) : ?Property
|
|
{
|
|
$phpDocInfo = $this->phpDocInfoFactory->createFromNode($property);
|
|
if (!$phpDocInfo instanceof PhpDocInfo) {
|
|
return null;
|
|
}
|
|
$classNameAndTagValueNode = $this->enumParamAnalyzer->matchPropertyClassName($phpDocInfo);
|
|
if (!$classNameAndTagValueNode instanceof ClassNameAndTagValueNode) {
|
|
return null;
|
|
}
|
|
$property->type = new FullyQualified($classNameAndTagValueNode->getEnumClass());
|
|
$this->phpDocTagRemover->removeTagValueFromNode($phpDocInfo, $classNameAndTagValueNode->getTagValueNode());
|
|
return $property;
|
|
}
|
|
}
|