mirror of https://github.com/rectorphp/rector.git
141 lines
4.2 KiB
PHP
141 lines
4.2 KiB
PHP
<?php
|
|
|
|
declare (strict_types=1);
|
|
namespace Rector\DeadCode\Rector\ClassMethod;
|
|
|
|
use PhpParser\Node;
|
|
use PhpParser\Node\Expr\MethodCall;
|
|
use PhpParser\Node\Expr\Variable;
|
|
use PhpParser\Node\Stmt\Class_;
|
|
use PhpParser\Node\Stmt\ClassMethod;
|
|
use PHPStan\Reflection\ClassReflection;
|
|
use Rector\Core\Rector\AbstractRector;
|
|
use Rector\Core\Reflection\ReflectionResolver;
|
|
use Rector\Core\ValueObject\MethodName;
|
|
use Rector\DeadCode\NodeAnalyzer\IsClassMethodUsedAnalyzer;
|
|
use Symplify\RuleDocGenerator\ValueObject\CodeSample\CodeSample;
|
|
use Symplify\RuleDocGenerator\ValueObject\RuleDefinition;
|
|
/**
|
|
* @see \Rector\Tests\DeadCode\Rector\ClassMethod\RemoveUnusedPrivateMethodRector\RemoveUnusedPrivateMethodRectorTest
|
|
*/
|
|
final class RemoveUnusedPrivateMethodRector extends AbstractRector
|
|
{
|
|
/**
|
|
* @readonly
|
|
* @var \Rector\DeadCode\NodeAnalyzer\IsClassMethodUsedAnalyzer
|
|
*/
|
|
private $isClassMethodUsedAnalyzer;
|
|
/**
|
|
* @readonly
|
|
* @var \Rector\Core\Reflection\ReflectionResolver
|
|
*/
|
|
private $reflectionResolver;
|
|
public function __construct(IsClassMethodUsedAnalyzer $isClassMethodUsedAnalyzer, ReflectionResolver $reflectionResolver)
|
|
{
|
|
$this->isClassMethodUsedAnalyzer = $isClassMethodUsedAnalyzer;
|
|
$this->reflectionResolver = $reflectionResolver;
|
|
}
|
|
public function getRuleDefinition() : RuleDefinition
|
|
{
|
|
return new RuleDefinition('Remove unused private method', [new CodeSample(<<<'CODE_SAMPLE'
|
|
final class SomeController
|
|
{
|
|
public function run()
|
|
{
|
|
return 5;
|
|
}
|
|
|
|
private function skip()
|
|
{
|
|
return 10;
|
|
}
|
|
}
|
|
CODE_SAMPLE
|
|
, <<<'CODE_SAMPLE'
|
|
final class SomeController
|
|
{
|
|
public function run()
|
|
{
|
|
return 5;
|
|
}
|
|
}
|
|
CODE_SAMPLE
|
|
)]);
|
|
}
|
|
/**
|
|
* @return array<class-string<Node>>
|
|
*/
|
|
public function getNodeTypes() : array
|
|
{
|
|
return [ClassMethod::class];
|
|
}
|
|
/**
|
|
* @param ClassMethod $node
|
|
*/
|
|
public function refactor(Node $node) : ?Node
|
|
{
|
|
if ($this->shouldSkip($node)) {
|
|
return null;
|
|
}
|
|
if ($this->isClassMethodUsedAnalyzer->isClassMethodUsed($node)) {
|
|
return null;
|
|
}
|
|
if ($this->hasDynamicMethodCallOnFetchThis($node)) {
|
|
return null;
|
|
}
|
|
$this->removeNode($node);
|
|
return $node;
|
|
}
|
|
private function shouldSkip(ClassMethod $classMethod) : bool
|
|
{
|
|
$classReflection = $this->reflectionResolver->resolveClassReflection($classMethod);
|
|
if (!$classReflection instanceof ClassReflection) {
|
|
return \true;
|
|
}
|
|
// unreliable to detect trait, interface doesn't make sense
|
|
if ($classReflection->isTrait()) {
|
|
return \true;
|
|
}
|
|
if ($classReflection->isInterface()) {
|
|
return \true;
|
|
}
|
|
if ($classReflection->isAnonymous()) {
|
|
return \true;
|
|
}
|
|
// skips interfaces by default too
|
|
if (!$classMethod->isPrivate()) {
|
|
return \true;
|
|
}
|
|
// skip magic methods - @see https://www.php.net/manual/en/language.oop5.magic.php
|
|
if ($classMethod->isMagic()) {
|
|
return \true;
|
|
}
|
|
return $classReflection->hasMethod(MethodName::CALL);
|
|
}
|
|
private function hasDynamicMethodCallOnFetchThis(ClassMethod $classMethod) : bool
|
|
{
|
|
$class = $this->betterNodeFinder->findParentType($classMethod, Class_::class);
|
|
if (!$class instanceof Class_) {
|
|
return \false;
|
|
}
|
|
foreach ($class->getMethods() as $method) {
|
|
$isFound = (bool) $this->betterNodeFinder->findFirst((array) $method->getStmts(), function (Node $subNode) : bool {
|
|
if (!$subNode instanceof MethodCall) {
|
|
return \false;
|
|
}
|
|
if (!$subNode->var instanceof Variable) {
|
|
return \false;
|
|
}
|
|
if (!$this->nodeNameResolver->isName($subNode->var, 'this')) {
|
|
return \false;
|
|
}
|
|
return $subNode->name instanceof Variable;
|
|
});
|
|
if ($isFound) {
|
|
return \true;
|
|
}
|
|
}
|
|
return \false;
|
|
}
|
|
}
|