RemoveMethodCallParamRector.php

<?php

declare(strict_types=1);

namespace Rector\Arguments\Rector\MethodCall;

use PhpParser\Node;
use PhpParser\Node\Expr\MethodCall;
use PhpParser\Node\Expr\StaticCall;
use PHPStan\Reflection\FunctionReflection;
use PHPStan\Reflection\MethodReflection;
use PHPStan\Reflection\ParametersAcceptorSelector;
use Rector\Arguments\ValueObject\RemoveMethodCallParam;
use Rector\Contract\Rector\ConfigurableRectorInterface;
use Rector\NodeAnalyzer\ArgsAnalyzer;
use Rector\Rector\AbstractRector;
use Rector\Reflection\ReflectionResolver;
use Rector\RuleDoc\CodeSample\ConfiguredCodeSample;
use Rector\RuleDoc\RuleDefinition;
use Webmozart\Assert\Assert;

/**
 * @note used extensively https://github.com/search?q=RemoveMethodCallParamRector%3A%3Aclass+language%3APHP&type=code&l=PHP
 * @see \Rector\Tests\Arguments\Rector\MethodCall\RemoveMethodCallParamRector\RemoveMethodCallParamRectorTest
 */
final class RemoveMethodCallParamRector extends AbstractRector implements ConfigurableRectorInterface
{
    /**
     * @var array<string, RemoveMethodCallParam[]>
     */
    private array $removeMethodCallParamsByMethod = [];

    public function __construct(
        private readonly ReflectionResolver $reflectionResolver,
        private readonly ArgsAnalyzer $argsAnalyzer,
    ) {
    }

    public function getRuleDefinition(): RuleDefinition
    {
        return new RuleDefinition('Remove parameter of method call', [
            new ConfiguredCodeSample(
                <<<'CODE_SAMPLE'
final class SomeClass
{
    public function run(Caller $caller)
    {
        $caller->process(1, 2);
    }
}
CODE_SAMPLE
                ,
                <<<'CODE_SAMPLE'
final class SomeClass
{
    public function run(Caller $caller)
    {
        $caller->process(1);
    }
}
CODE_SAMPLE
                ,
                [new RemoveMethodCallParam('Caller', 'process', 1)]
            ),
        ]);
    }

    /**
     * @return array<class-string<Node>>
     */
    public function getNodeTypes(): array
    {
        return [MethodCall::class, StaticCall::class];
    }

    /**
     * @param MethodCall|StaticCall $node
     */
    public function refactor(Node $node): ?Node
    {
        $hasChanged = false;

        if ($node->isFirstClassCallable()) {
            return null;
        }

        $methodName = $this->getName($node->name);
        if ($methodName === null) {
            return null;
        }

        foreach ($this->removeMethodCallParamsByMethod[strtolower($methodName)] ?? [] as $removeMethodCallParam) {
            if (! $this->isCallerObjectType($node, $removeMethodCallParam)) {
                continue;
            }

            $args = $node->getArgs();
            $position = $removeMethodCallParam->getParamPosition();
            $firstNamedArgPosition = $this->argsAnalyzer->resolveFirstNamedArgPosition($args);

            // if the call has named arguments and the argument that we want to remove is not
            // before any named argument, we need to check if it is in the list of named arguments
            // if it is, we use the position of the named argument as the position to remove
            // if it is not, we cannot remove it
            if ($firstNamedArgPosition !== null && $position >= $firstNamedArgPosition) {
                $reflection = $this->reflectionResolver->resolveFunctionLikeReflectionFromCall($node);
                if (! $reflection instanceof MethodReflection && ! $reflection instanceof FunctionReflection) {
                    return null;
                }

                $parametersAcceptor = ParametersAcceptorSelector::combineAcceptors($reflection->getVariants());
                $parameterReflection = $parametersAcceptor->getParameters()[$position] ?? null;

                $newPosition = -1;
                if ($parameterReflection !== null) {
                    $newPosition = $this->argsAnalyzer->resolveArgPosition(
                        $args,
                        $parameterReflection->getName(),
                        $newPosition
                    );
                }

                if ($newPosition === -1) {
                    return null;
                }

                $position = $newPosition;
            }

            if (! isset($args[$position])) {
                continue;
            }

            unset($node->args[$position]);
            $hasChanged = true;
        }

        if (! $hasChanged) {
            return null;
        }

        return $node;
    }

    /**
     * @param mixed[] $configuration
     */
    public function configure(array $configuration): void
    {
        Assert::allIsInstanceOf($configuration, RemoveMethodCallParam::class);

        $this->removeMethodCallParamsByMethod = [];
        foreach ($configuration as $removeMethodCallParam) {
            $this->removeMethodCallParamsByMethod[strtolower($removeMethodCallParam->getMethodName())][] = $removeMethodCallParam;
        }
    }

    private function isCallerObjectType(StaticCall|MethodCall $call, RemoveMethodCallParam $removeMethodCallParam): bool
    {
        if ($call instanceof MethodCall) {
            return $this->isObjectType($call->var, $removeMethodCallParam->getObjectType());
        }

        return $this->isObjectType($call->class, $removeMethodCallParam->getObjectType());
    }
}