mirror of
https://github.com/rectorphp/rector.git
synced 2024-05-30 07:50:53 +00:00
7e7a2f067a
476cfb00cb
disable fallback for now
151 lines
5.3 KiB
PHP
151 lines
5.3 KiB
PHP
<?php
|
|
|
|
declare (strict_types=1);
|
|
namespace Rector\DeadCode\Rector\ClassMethod;
|
|
|
|
use PhpParser\Node;
|
|
use PhpParser\Node\Stmt\ClassMethod;
|
|
use PhpParser\Node\Stmt\Expression;
|
|
use PhpParser\Node\Stmt\Function_;
|
|
use PhpParser\Node\Stmt\Property;
|
|
use PHPStan\PhpDocParser\Ast\Node as AstNode;
|
|
use PHPStan\PhpDocParser\Ast\PhpDoc\ParamTagValueNode;
|
|
use PHPStan\PhpDocParser\Ast\PhpDoc\PhpDocTagNode;
|
|
use PHPStan\PhpDocParser\Ast\PhpDoc\ReturnTagValueNode;
|
|
use PHPStan\PhpDocParser\Ast\PhpDoc\VarTagValueNode;
|
|
use PHPStan\PhpDocParser\Ast\Type\IdentifierTypeNode;
|
|
use Rector\BetterPhpDocParser\PhpDocInfo\PhpDocInfo;
|
|
use Rector\BetterPhpDocParser\PhpDocInfo\PhpDocInfoFactory;
|
|
use Rector\Comments\NodeDocBlock\DocBlockUpdater;
|
|
use Rector\PhpDocParser\PhpDocParser\PhpDocNodeTraverser;
|
|
use Rector\Rector\AbstractRector;
|
|
use Symplify\RuleDocGenerator\ValueObject\CodeSample\CodeSample;
|
|
use Symplify\RuleDocGenerator\ValueObject\RuleDefinition;
|
|
/**
|
|
* @see \Rector\Tests\DeadCode\Rector\ClassMethod\RemoveNullTagValueNodeRector\RemoveNullTagValueNodeRectorTest
|
|
*/
|
|
final class RemoveNullTagValueNodeRector extends AbstractRector
|
|
{
|
|
/**
|
|
* @readonly
|
|
* @var \Rector\Comments\NodeDocBlock\DocBlockUpdater
|
|
*/
|
|
private $docBlockUpdater;
|
|
/**
|
|
* @readonly
|
|
* @var \Rector\BetterPhpDocParser\PhpDocInfo\PhpDocInfoFactory
|
|
*/
|
|
private $phpDocInfoFactory;
|
|
public function __construct(DocBlockUpdater $docBlockUpdater, PhpDocInfoFactory $phpDocInfoFactory)
|
|
{
|
|
$this->docBlockUpdater = $docBlockUpdater;
|
|
$this->phpDocInfoFactory = $phpDocInfoFactory;
|
|
}
|
|
public function getRuleDefinition() : RuleDefinition
|
|
{
|
|
return new RuleDefinition('Remove @var/@param/@return null docblock', [new CodeSample(<<<'CODE_SAMPLE'
|
|
class SomeClass
|
|
{
|
|
/**
|
|
* @return null
|
|
*/
|
|
public function foo()
|
|
{
|
|
return null;
|
|
}
|
|
}
|
|
CODE_SAMPLE
|
|
, <<<'CODE_SAMPLE'
|
|
class SomeClass
|
|
{
|
|
public function foo()
|
|
{
|
|
return null;
|
|
}
|
|
}
|
|
CODE_SAMPLE
|
|
)]);
|
|
}
|
|
/**
|
|
* @return array<class-string<Node>>
|
|
*/
|
|
public function getNodeTypes() : array
|
|
{
|
|
return [ClassMethod::class, Function_::class, Expression::class, Property::class];
|
|
}
|
|
/**
|
|
* @param ClassMethod|Function_|Expression|Property $node
|
|
*/
|
|
public function refactor(Node $node) : ?Node
|
|
{
|
|
if ($node instanceof Expression || $node instanceof Property) {
|
|
return $this->processVarTagNull($node);
|
|
}
|
|
$phpdocInfo = $this->phpDocInfoFactory->createFromNodeOrEmpty($node);
|
|
$removedParamNames = [];
|
|
foreach ($node->params as $param) {
|
|
$paramName = $this->getName($param);
|
|
$paramTagValueNode = $phpdocInfo->getParamTagValueByName($paramName);
|
|
if ($paramTagValueNode instanceof ParamTagValueNode && $this->isNull($paramTagValueNode)) {
|
|
$removedParamNames[] = $paramTagValueNode->parameterName;
|
|
}
|
|
}
|
|
$hasRemoved = \false;
|
|
if ($removedParamNames !== []) {
|
|
$this->removeParamNullTag($phpdocInfo, $removedParamNames);
|
|
$this->docBlockUpdater->updateRefactoredNodeWithPhpDocInfo($node);
|
|
$hasRemoved = \true;
|
|
}
|
|
$returnTagValueNode = $phpdocInfo->getReturnTagValue();
|
|
if ($returnTagValueNode instanceof ReturnTagValueNode && $this->isNull($returnTagValueNode)) {
|
|
$phpdocInfo->removeByType(ReturnTagValueNode::class);
|
|
$this->docBlockUpdater->updateRefactoredNodeWithPhpDocInfo($node);
|
|
$hasRemoved = \true;
|
|
}
|
|
if (!$hasRemoved) {
|
|
return null;
|
|
}
|
|
return $node;
|
|
}
|
|
/**
|
|
* @param \PHPStan\PhpDocParser\Ast\PhpDoc\VarTagValueNode|\PHPStan\PhpDocParser\Ast\PhpDoc\ParamTagValueNode|\PHPStan\PhpDocParser\Ast\PhpDoc\ReturnTagValueNode $tag
|
|
*/
|
|
private function isNull($tag) : bool
|
|
{
|
|
return $tag->type instanceof IdentifierTypeNode && $tag->type->__toString() === 'null' && $tag->description === '';
|
|
}
|
|
/**
|
|
* @param string[] $paramNames
|
|
*/
|
|
private function removeParamNullTag(PhpDocInfo $phpDocInfo, array $paramNames) : void
|
|
{
|
|
$phpDocNodeTraverser = new PhpDocNodeTraverser();
|
|
$phpDocNodeTraverser->traverseWithCallable($phpDocInfo->getPhpDocNode(), '', static function (AstNode $astNode) use($paramNames) : ?int {
|
|
if (!$astNode instanceof PhpDocTagNode) {
|
|
return null;
|
|
}
|
|
if (!$astNode->value instanceof ParamTagValueNode) {
|
|
return null;
|
|
}
|
|
if (\in_array($astNode->value->parameterName, $paramNames, \true)) {
|
|
return PhpDocNodeTraverser::NODE_REMOVE;
|
|
}
|
|
return null;
|
|
});
|
|
}
|
|
/**
|
|
* @param \PhpParser\Node\Stmt\Expression|\PhpParser\Node\Stmt\Property $node
|
|
*/
|
|
private function processVarTagNull($node) : ?Node
|
|
{
|
|
$phpdocInfo = $this->phpDocInfoFactory->createFromNodeOrEmpty($node);
|
|
$varTagValueNode = $phpdocInfo->getVarTagValueNode();
|
|
if ($varTagValueNode instanceof VarTagValueNode && $this->isNull($varTagValueNode)) {
|
|
$phpdocInfo->removeByType(VarTagValueNode::class);
|
|
$this->docBlockUpdater->updateRefactoredNodeWithPhpDocInfo($node);
|
|
return $node;
|
|
}
|
|
return null;
|
|
}
|
|
}
|