|
| 1 | +<?php |
| 2 | + |
| 3 | +declare (strict_types=1); |
| 4 | +namespace Rector\CodeQuality\Rector\CallLike; |
| 5 | + |
| 6 | +use PhpParser\Node; |
| 7 | +use PhpParser\Node\Arg; |
| 8 | +use PhpParser\Node\Expr\CallLike; |
| 9 | +use PhpParser\Node\Identifier; |
| 10 | +use PHPStan\Reflection\FunctionReflection; |
| 11 | +use PHPStan\Reflection\MethodReflection; |
| 12 | +use PHPStan\Reflection\ParameterReflection; |
| 13 | +use Rector\NodeTypeResolver\PHPStan\ParametersAcceptorSelectorVariantsWrapper; |
| 14 | +use Rector\PhpParser\Node\Value\ValueResolver; |
| 15 | +use Rector\PHPStan\ScopeFetcher; |
| 16 | +use Rector\Rector\AbstractRector; |
| 17 | +use Rector\Reflection\ReflectionResolver; |
| 18 | +use Symplify\RuleDocGenerator\ValueObject\CodeSample\CodeSample; |
| 19 | +use Symplify\RuleDocGenerator\ValueObject\RuleDefinition; |
| 20 | +/** |
| 21 | + * @see \Rector\Tests\CodeQuality\Rector\CallLike\AddNameToBooleanArgumentRector\AddNameToBooleanArgumentRectorTest |
| 22 | + */ |
| 23 | +final class AddNameToBooleanArgumentRector extends AbstractRector |
| 24 | +{ |
| 25 | + /** |
| 26 | + * @readonly |
| 27 | + */ |
| 28 | + private ReflectionResolver $reflectionResolver; |
| 29 | + /** |
| 30 | + * @readonly |
| 31 | + */ |
| 32 | + private ValueResolver $valueResolver; |
| 33 | + public function __construct(ReflectionResolver $reflectionResolver, ValueResolver $valueResolver) |
| 34 | + { |
| 35 | + $this->reflectionResolver = $reflectionResolver; |
| 36 | + $this->valueResolver = $valueResolver; |
| 37 | + } |
| 38 | + public function getRuleDefinition(): RuleDefinition |
| 39 | + { |
| 40 | + return new RuleDefinition('Add parameter names to boolean arguments.', [new CodeSample(<<<'CODE_SAMPLE' |
| 41 | +in_array($value, $array, true); |
| 42 | +CODE_SAMPLE |
| 43 | +, <<<'CODE_SAMPLE' |
| 44 | +in_array($value, $array, strict: true); |
| 45 | +CODE_SAMPLE |
| 46 | +)]); |
| 47 | + } |
| 48 | + /** |
| 49 | + * @return array<class-string<Node>> |
| 50 | + */ |
| 51 | + public function getNodeTypes(): array |
| 52 | + { |
| 53 | + return [CallLike::class]; |
| 54 | + } |
| 55 | + /** |
| 56 | + * @param CallLike $node |
| 57 | + */ |
| 58 | + public function refactor(Node $node): ?Node |
| 59 | + { |
| 60 | + if ($this->shouldSkip($node)) { |
| 61 | + return null; |
| 62 | + } |
| 63 | + $reflection = $this->reflectionResolver->resolveFunctionLikeReflectionFromCall($node); |
| 64 | + if (!$reflection instanceof FunctionReflection && !$reflection instanceof MethodReflection) { |
| 65 | + return null; |
| 66 | + } |
| 67 | + $scope = ScopeFetcher::fetch($node); |
| 68 | + $args = $node->getArgs(); |
| 69 | + $parameters = ParametersAcceptorSelectorVariantsWrapper::select($reflection, $node, $scope)->getParameters(); |
| 70 | + $position = $this->resolveFirstPositionToName($args, $parameters); |
| 71 | + if ($position === null) { |
| 72 | + return null; |
| 73 | + } |
| 74 | + $wasChanged = \false; |
| 75 | + for ($i = $position; $i < count($args); ++$i) { |
| 76 | + $arg = $args[$i]; |
| 77 | + if ($arg->name instanceof Identifier) { |
| 78 | + continue; |
| 79 | + } |
| 80 | + $parameterReflection = $this->resolveParameterReflection($arg, $i, $parameters); |
| 81 | + if (!$parameterReflection instanceof ParameterReflection) { |
| 82 | + return null; |
| 83 | + } |
| 84 | + $arg->name = new Identifier($parameterReflection->getName()); |
| 85 | + $wasChanged = \true; |
| 86 | + } |
| 87 | + if (!$wasChanged) { |
| 88 | + return null; |
| 89 | + } |
| 90 | + return $node; |
| 91 | + } |
| 92 | + private function shouldSkip(CallLike $callLike): bool |
| 93 | + { |
| 94 | + if ($callLike->isFirstClassCallable()) { |
| 95 | + return \true; |
| 96 | + } |
| 97 | + $args = $callLike->getArgs(); |
| 98 | + if ($args === []) { |
| 99 | + return \true; |
| 100 | + } |
| 101 | + foreach ($args as $arg) { |
| 102 | + if ($arg->unpack) { |
| 103 | + return \true; |
| 104 | + } |
| 105 | + } |
| 106 | + return \false; |
| 107 | + } |
| 108 | + /** |
| 109 | + * @param Arg[] $args |
| 110 | + * @param ParameterReflection[] $parameters |
| 111 | + */ |
| 112 | + private function resolveFirstPositionToName(array $args, array $parameters): ?int |
| 113 | + { |
| 114 | + foreach ($args as $position => $arg) { |
| 115 | + if ($arg->name instanceof Identifier) { |
| 116 | + continue; |
| 117 | + } |
| 118 | + if (!$this->valueResolver->isTrueOrFalse($arg->value)) { |
| 119 | + continue; |
| 120 | + } |
| 121 | + if ($this->canNameArgsFromPosition($args, $parameters, $position)) { |
| 122 | + return $position; |
| 123 | + } |
| 124 | + } |
| 125 | + return null; |
| 126 | + } |
| 127 | + /** |
| 128 | + * @param Arg[] $args |
| 129 | + * @param ParameterReflection[] $parameters |
| 130 | + */ |
| 131 | + private function canNameArgsFromPosition(array $args, array $parameters, int $position): bool |
| 132 | + { |
| 133 | + $count = count($args); |
| 134 | + for ($i = $position; $i < $count; ++$i) { |
| 135 | + $arg = $args[$i]; |
| 136 | + if ($arg->name instanceof Identifier) { |
| 137 | + continue; |
| 138 | + } |
| 139 | + $parameterReflection = $this->resolveParameterReflection($arg, $i, $parameters); |
| 140 | + if (!$parameterReflection instanceof ParameterReflection) { |
| 141 | + return \false; |
| 142 | + } |
| 143 | + if ($parameterReflection->isVariadic()) { |
| 144 | + return \false; |
| 145 | + } |
| 146 | + } |
| 147 | + return \true; |
| 148 | + } |
| 149 | + /** |
| 150 | + * @param ParameterReflection[] $parameters |
| 151 | + */ |
| 152 | + private function resolveParameterReflection(Arg $arg, int $position, array $parameters): ?ParameterReflection |
| 153 | + { |
| 154 | + if ($arg->name instanceof Identifier) { |
| 155 | + foreach ($parameters as $parameter) { |
| 156 | + if ($parameter->getName() === $arg->name->toString()) { |
| 157 | + return $parameter; |
| 158 | + } |
| 159 | + } |
| 160 | + return null; |
| 161 | + } |
| 162 | + $parameter = $parameters[$position] ?? null; |
| 163 | + if ($parameter instanceof ParameterReflection) { |
| 164 | + return $parameter; |
| 165 | + } |
| 166 | + $lastParameter = end($parameters); |
| 167 | + if ($lastParameter instanceof ParameterReflection && $lastParameter->isVariadic()) { |
| 168 | + return $lastParameter; |
| 169 | + } |
| 170 | + return null; |
| 171 | + } |
| 172 | +} |
0 commit comments