mirror of
https://github.com/rectorphp/rector.git
synced 2024-05-28 23:10:51 +00:00
4333c09758
dfbbb02dec
[PHP 8.0] Fix DowngradeNamedArgumentRector named arguments (#373)
135 lines
4.9 KiB
PHP
135 lines
4.9 KiB
PHP
<?php
|
|
|
|
declare (strict_types=1);
|
|
namespace Rector\CodingStyle\Rector\ClassConst;
|
|
|
|
use PhpParser\Node;
|
|
use PhpParser\Node\Stmt\ClassConst;
|
|
use PHPStan\PhpDocParser\Ast\Type\ArrayTypeNode;
|
|
use PHPStan\PhpDocParser\Ast\Type\GenericTypeNode;
|
|
use PHPStan\PhpDocParser\Ast\Type\UnionTypeNode;
|
|
use PHPStan\Type\ArrayType;
|
|
use PHPStan\Type\Constant\ConstantArrayType;
|
|
use PHPStan\Type\MixedType;
|
|
use PHPStan\Type\Type;
|
|
use Rector\BetterPhpDocParser\PhpDocInfo\PhpDocInfo;
|
|
use Rector\BetterPhpDocParser\PhpDocManipulator\PhpDocTypeChanger;
|
|
use Rector\Core\Rector\AbstractRector;
|
|
use Rector\NodeTypeResolver\TypeComparator\TypeComparator;
|
|
use Rector\PHPStanStaticTypeMapper\ValueObject\TypeKind;
|
|
use Symplify\RuleDocGenerator\ValueObject\CodeSample\CodeSample;
|
|
use Symplify\RuleDocGenerator\ValueObject\RuleDefinition;
|
|
/**
|
|
* @see \Rector\Tests\CodingStyle\Rector\ClassConst\VarConstantCommentRector\VarConstantCommentRectorTest
|
|
*/
|
|
final class VarConstantCommentRector extends \Rector\Core\Rector\AbstractRector
|
|
{
|
|
/**
|
|
* @var \Rector\NodeTypeResolver\TypeComparator\TypeComparator
|
|
*/
|
|
private $typeComparator;
|
|
/**
|
|
* @var \Rector\BetterPhpDocParser\PhpDocManipulator\PhpDocTypeChanger
|
|
*/
|
|
private $phpDocTypeChanger;
|
|
public function __construct(\Rector\NodeTypeResolver\TypeComparator\TypeComparator $typeComparator, \Rector\BetterPhpDocParser\PhpDocManipulator\PhpDocTypeChanger $phpDocTypeChanger)
|
|
{
|
|
$this->typeComparator = $typeComparator;
|
|
$this->phpDocTypeChanger = $phpDocTypeChanger;
|
|
}
|
|
public function getRuleDefinition() : \Symplify\RuleDocGenerator\ValueObject\RuleDefinition
|
|
{
|
|
return new \Symplify\RuleDocGenerator\ValueObject\RuleDefinition('Constant should have a @var comment with type', [new \Symplify\RuleDocGenerator\ValueObject\CodeSample\CodeSample(<<<'CODE_SAMPLE'
|
|
class SomeClass
|
|
{
|
|
const HI = 'hi';
|
|
}
|
|
CODE_SAMPLE
|
|
, <<<'CODE_SAMPLE'
|
|
class SomeClass
|
|
{
|
|
/**
|
|
* @var string
|
|
*/
|
|
const HI = 'hi';
|
|
}
|
|
CODE_SAMPLE
|
|
)]);
|
|
}
|
|
/**
|
|
* @return array<class-string<Node>>
|
|
*/
|
|
public function getNodeTypes() : array
|
|
{
|
|
return [\PhpParser\Node\Stmt\ClassConst::class];
|
|
}
|
|
/**
|
|
* @param ClassConst $node
|
|
*/
|
|
public function refactor(\PhpParser\Node $node) : ?\PhpParser\Node
|
|
{
|
|
if (\count($node->consts) > 1) {
|
|
return null;
|
|
}
|
|
$constType = $this->getStaticType($node->consts[0]->value);
|
|
if ($constType instanceof \PHPStan\Type\MixedType) {
|
|
return null;
|
|
}
|
|
$phpDocInfo = $this->phpDocInfoFactory->createFromNodeOrEmpty($node);
|
|
if ($this->shouldSkipConstantArrayType($constType, $phpDocInfo)) {
|
|
return null;
|
|
}
|
|
if ($this->typeComparator->isSubtype($constType, $phpDocInfo->getVarType())) {
|
|
return null;
|
|
}
|
|
$this->phpDocTypeChanger->changeVarType($phpDocInfo, $constType);
|
|
return $node;
|
|
}
|
|
private function hasTwoAndMoreGenericClassStringTypes(\PHPStan\Type\Constant\ConstantArrayType $constantArrayType) : bool
|
|
{
|
|
$typeNode = $this->staticTypeMapper->mapPHPStanTypeToPHPStanPhpDocTypeNode($constantArrayType, \Rector\PHPStanStaticTypeMapper\ValueObject\TypeKind::RETURN());
|
|
if (!$typeNode instanceof \PHPStan\PhpDocParser\Ast\Type\ArrayTypeNode) {
|
|
return \false;
|
|
}
|
|
if (!$typeNode->type instanceof \PHPStan\PhpDocParser\Ast\Type\UnionTypeNode) {
|
|
return \false;
|
|
}
|
|
$genericTypeNodeCount = 0;
|
|
foreach ($typeNode->type->types as $unionedTypeNode) {
|
|
if ($unionedTypeNode instanceof \PHPStan\PhpDocParser\Ast\Type\GenericTypeNode) {
|
|
++$genericTypeNodeCount;
|
|
}
|
|
}
|
|
return $genericTypeNodeCount > 1;
|
|
}
|
|
/**
|
|
* Skip big arrays and mixed[] constants
|
|
*/
|
|
private function shouldSkipConstantArrayType(\PHPStan\Type\Type $constType, \Rector\BetterPhpDocParser\PhpDocInfo\PhpDocInfo $phpDocInfo) : bool
|
|
{
|
|
if (!$constType instanceof \PHPStan\Type\Constant\ConstantArrayType) {
|
|
return \false;
|
|
}
|
|
$currentVarType = $phpDocInfo->getVarType();
|
|
if ($currentVarType instanceof \PHPStan\Type\ArrayType && $currentVarType->getItemType() instanceof \PHPStan\Type\MixedType) {
|
|
return \true;
|
|
}
|
|
if ($this->hasTwoAndMoreGenericClassStringTypes($constType)) {
|
|
return \true;
|
|
}
|
|
return $this->isHugeNestedConstantArrayTyp($constType);
|
|
}
|
|
private function isHugeNestedConstantArrayTyp(\PHPStan\Type\Constant\ConstantArrayType $constantArrayType) : bool
|
|
{
|
|
if (\count($constantArrayType->getValueTypes()) <= 3) {
|
|
return \false;
|
|
}
|
|
foreach ($constantArrayType->getValueTypes() as $constValueType) {
|
|
if ($constValueType instanceof \PHPStan\Type\Constant\ConstantArrayType) {
|
|
return \true;
|
|
}
|
|
}
|
|
return \false;
|
|
}
|
|
}
|