octoleo
/
rector
mirror of https://github.com/rectorphp/rector.git
1
1
Fork 0
Code Issues Packages Projects Releases Wiki Activity

Updated Rector to commit 287eab3a7040f8d42fa10701d5fbfc2998fdcc25 

287eab3a70 [DeadCode] Add RemoveNullTagValueNodeRector (#5352)
This commit is contained in:
Tomas Votruba 2023-12-10 16:32:52 +00:00
parent e216058787
commit fffe49e4aa
5 changed files with 177 additions and 4 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

25
docs/rector_rules_overview.md
View File

@ -1,4 +1,4 @@
# 352 Rules Overview
# 353 Rules Overview
<br>
@ -10,7 +10,7 @@
- [CodingStyle](#codingstyle) (27)
- [DeadCode](#deadcode) (42)
- [DeadCode](#deadcode) (43)
- [EarlyReturn](#earlyreturn) (9)
@ -2509,6 +2509,27 @@ Remove initialization with null value from property declarations
<br>
### RemoveNullTagValueNodeRector
Remove `@var/@param/@return` null docblock
- class: [`Rector\DeadCode\Rector\ClassMethod\RemoveNullTagValueNodeRector`](../rules/DeadCode/Rector/ClassMethod/RemoveNullTagValueNodeRector.php)
```diff
class SomeClass
{
- /**
- * @return null
- */
public function foo()
{
return null;
}
}
```
<br>
### RemoveParentCallWithoutParentRector
Remove unused parent call with no parent class

150
rules/DeadCode/Rector/ClassMethod/RemoveNullTagValueNodeRector.php Normal file
View File

@ -0,0 +1,150 @@
<?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\Core\Rector\AbstractRector;
use Rector\PhpDocParser\PhpDocParser\PhpDocNodeTraverser;
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 \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;
}
/**
* @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;
}
}

4
src/Application/VersionResolver.php
View File

@ -19,12 +19,12 @@ final class VersionResolver
* @api
* @var string
*/
public const PACKAGE_VERSION = 'f8c3a2e313d5eee15c2aca53177ccf377042a65c';
public const PACKAGE_VERSION = '287eab3a7040f8d42fa10701d5fbfc2998fdcc25';
/**
* @api
* @var string
*/
public const RELEASE_DATE = '2023-12-10 13:33:42';
public const RELEASE_DATE = '2023-12-10 17:30:26';
/**
* @var int
*/

1
vendor/composer/autoload_classmap.php vendored
View File

@ -1332,6 +1332,7 @@ return array(
'Rector\\DeadCode\\Rector\\ClassConst\\RemoveUnusedPrivateClassConstantRector' => $baseDir . '/rules/DeadCode/Rector/ClassConst/RemoveUnusedPrivateClassConstantRector.php',
'Rector\\DeadCode\\Rector\\ClassLike\\RemoveAnnotationRector' => $baseDir . '/rules/DeadCode/Rector/ClassLike/RemoveAnnotationRector.php',
'Rector\\DeadCode\\Rector\\ClassMethod\\RemoveEmptyClassMethodRector' => $baseDir . '/rules/DeadCode/Rector/ClassMethod/RemoveEmptyClassMethodRector.php',
'Rector\\DeadCode\\Rector\\ClassMethod\\RemoveNullTagValueNodeRector' => $baseDir . '/rules/DeadCode/Rector/ClassMethod/RemoveNullTagValueNodeRector.php',
'Rector\\DeadCode\\Rector\\ClassMethod\\RemoveUnusedConstructorParamRector' => $baseDir . '/rules/DeadCode/Rector/ClassMethod/RemoveUnusedConstructorParamRector.php',
'Rector\\DeadCode\\Rector\\ClassMethod\\RemoveUnusedPrivateMethodParameterRector' => $baseDir . '/rules/DeadCode/Rector/ClassMethod/RemoveUnusedPrivateMethodParameterRector.php',
'Rector\\DeadCode\\Rector\\ClassMethod\\RemoveUnusedPrivateMethodRector' => $baseDir . '/rules/DeadCode/Rector/ClassMethod/RemoveUnusedPrivateMethodRector.php',

1
vendor/composer/autoload_static.php vendored
View File

@ -1550,6 +1550,7 @@ class ComposerStaticInita55c41c7fa52abd86138c6f32df1d185
'Rector\\DeadCode\\Rector\\ClassConst\\RemoveUnusedPrivateClassConstantRector' => __DIR__ . '/../..' . '/rules/DeadCode/Rector/ClassConst/RemoveUnusedPrivateClassConstantRector.php',
'Rector\\DeadCode\\Rector\\ClassLike\\RemoveAnnotationRector' => __DIR__ . '/../..' . '/rules/DeadCode/Rector/ClassLike/RemoveAnnotationRector.php',
'Rector\\DeadCode\\Rector\\ClassMethod\\RemoveEmptyClassMethodRector' => __DIR__ . '/../..' . '/rules/DeadCode/Rector/ClassMethod/RemoveEmptyClassMethodRector.php',
'Rector\\DeadCode\\Rector\\ClassMethod\\RemoveNullTagValueNodeRector' => __DIR__ . '/../..' . '/rules/DeadCode/Rector/ClassMethod/RemoveNullTagValueNodeRector.php',
'Rector\\DeadCode\\Rector\\ClassMethod\\RemoveUnusedConstructorParamRector' => __DIR__ . '/../..' . '/rules/DeadCode/Rector/ClassMethod/RemoveUnusedConstructorParamRector.php',
'Rector\\DeadCode\\Rector\\ClassMethod\\RemoveUnusedPrivateMethodParameterRector' => __DIR__ . '/../..' . '/rules/DeadCode/Rector/ClassMethod/RemoveUnusedPrivateMethodParameterRector.php',
'Rector\\DeadCode\\Rector\\ClassMethod\\RemoveUnusedPrivateMethodRector' => __DIR__ . '/../..' . '/rules/DeadCode/Rector/ClassMethod/RemoveUnusedPrivateMethodRector.php',