Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
7 changes: 6 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -67,11 +67,16 @@ use SavinMikhail\AddNamedArgumentsRector\Config\PhpyhStrategy;
return static function (RectorConfig $rectorConfig): void {
$rectorConfig->ruleWithConfiguration(
AddNamedArgumentsRector::class,
[PhpyhStrategy::class]
[
AddNamedArgumentsRector::STRATEGY => PhpyhStrategy::class,
AddNamedArgumentsRector::ALLOW_NAMED_VARIADIC_ARGUMENTS => false,
]
);
};
```

`ALLOW_NAMED_VARIADIC_ARGUMENTS` is enabled by default. If you set it to `false`, calls that include variadic arguments are skipped.

#### Implementing Your Own Strategy

See `PhpyhStrategy` as example, you can create your own strategy by implementing the `ConfigStrategy` interface. For example:
Expand Down
95 changes: 85 additions & 10 deletions src/AddNamedArgumentsRector.php
Original file line number Diff line number Diff line change
Expand Up @@ -40,8 +40,14 @@
*/
final class AddNamedArgumentsRector extends AbstractRector implements MinPhpVersionInterface, ConfigurableRectorInterface
{
public const STRATEGY = 0;

public const ALLOW_NAMED_VARIADIC_ARGUMENTS = 1;

private string $configStrategy = DefaultStrategy::class;

private bool $allowNamedVariadicArguments = true;

private readonly Reflection $reflectionService;

private readonly ConstExprEvaluator $constExprEvaluator;
Expand Down Expand Up @@ -95,6 +101,10 @@ public function refactor(Node $node): ?Node
return null;
}

if (! $this->allowNamedVariadicArguments && $this->hasVariadicArguments($node, $parameters)) {
return null;
}

$hasChanges = $this->addNamesToArgs(node: $node, parameters: $parameters);

if (! $hasChanges) {
Expand All @@ -112,9 +122,10 @@ private function addNamesToArgs(
array $parameters,
): bool {
$namedArgs = [];
$variadicArgCounters = [];
$hasChanges = false;
foreach ($node->args as $index => $arg) {
$parameter = $parameters[$index] ?? null;
$parameter = $this->resolveParameterForArgumentIndex(parameters: $parameters, index: $index);
if ($parameter === null) {
$namedArgs[] = $arg;

Expand All @@ -127,13 +138,21 @@ private function addNamesToArgs(
continue;
}

if ($this->shouldSkipArg($arg, $parameter)) {
if (! $parameter->isVariadic() && $this->shouldSkipArg($arg, $parameter)) {
$hasChanges = true;

continue;
}

$arg->name = new Identifier(name: $parameter->getName());
if ($parameter->isVariadic()) {
$variadicParameterName = $parameter->getName();
$variadicIndex = ($variadicArgCounters[$variadicParameterName] ?? 0) + 1;
$variadicArgCounters[$variadicParameterName] = $variadicIndex;

$arg->name = new Identifier(name: $variadicParameterName . $variadicIndex);
} else {
$arg->name = new Identifier(name: $parameter->getName());
}
$namedArgs[] = $arg;
$hasChanges = true;
}
Expand Down Expand Up @@ -172,27 +191,83 @@ private function shouldSkipArg(Arg $arg, ExtendedParameterReflection $parameter)
return $argValue === $defaultValue;
}

/**
* @param ExtendedParameterReflection[] $parameters
*/
private function hasVariadicArguments(
FuncCall|StaticCall|MethodCall|New_ $node,
array $parameters,
): bool {
foreach ($node->args as $index => $arg) {
if ($arg instanceof Arg && $arg->unpack) {
continue;
}

$parameter = $this->resolveParameterForArgumentIndex(parameters: $parameters, index: $index);
if ($parameter !== null && $parameter->isVariadic()) {
return true;
}
}

return false;
}

/**
* @param ExtendedParameterReflection[] $parameters
*/
private function resolveParameterForArgumentIndex(array $parameters, int $index): ?ExtendedParameterReflection
{
if (isset($parameters[$index])) {
return $parameters[$index];
}

if ($parameters === []) {
return null;
}

$lastParameter = $parameters[array_key_last($parameters)];

if (! $lastParameter->isVariadic()) {
return null;
}

return $lastParameter;
}

public function provideMinPhpVersion(): int
{
return PhpVersion::PHP_80;
}

public function configure(array $configuration): void
{
Assert::lessThan(value: count(value: $configuration), limit: 2, message: 'You can pass only 1 strategy');
Assert::lessThan(value: count(value: $configuration), limit: 3, message: 'You can pass only 1 strategy and 1 variadic option');
if ($configuration === []) {
return;
}
$strategyClass = $configuration[0];

if (!class_exists(class: $strategyClass)) {
throw new InvalidArgumentException(message: "Class {$strategyClass} does not exist.");
$strategyClass = $configuration[self::STRATEGY] ?? null;
if (is_bool($strategyClass)) {
$this->allowNamedVariadicArguments = $strategyClass;

return;
}

$strategy = new $strategyClass();
if ($strategyClass !== null) {
if (! is_string($strategyClass) || ! class_exists(class: $strategyClass)) {
throw new InvalidArgumentException(message: "Class {$strategyClass} does not exist.");
}

$strategy = new $strategyClass();

Assert::isInstanceOf(value: $strategy, class: ConfigStrategy::class, message: 'Your strategy must implement ConfigStrategy interface');
Assert::isInstanceOf(value: $strategy, class: ConfigStrategy::class, message: 'Your strategy must implement ConfigStrategy interface');

$this->configStrategy = $strategyClass;
$this->configStrategy = $strategyClass;
}

if (array_key_exists(self::ALLOW_NAMED_VARIADIC_ARGUMENTS, $configuration)) {
Assert::boolean(value: $configuration[self::ALLOW_NAMED_VARIADIC_ARGUMENTS], message: 'Variadic option must be boolean');
$this->allowNamedVariadicArguments = $configuration[self::ALLOW_NAMED_VARIADIC_ARGUMENTS];
}
}
}
45 changes: 36 additions & 9 deletions src/Config/DefaultStrategy.php
Original file line number Diff line number Diff line change
Expand Up @@ -12,6 +12,7 @@
use PHPStan\BetterReflection\Reflection\Adapter\ReflectionClass;
use PHPStan\BetterReflection\Reflection\Adapter\ReflectionEnum;
use PHPStan\Reflection\ClassReflection;
use PHPStan\Reflection\ExtendedParameterReflection;
use ReflectionFunctionAbstract;
use SavinMikhail\AddNamedArgumentsRector\Reflection\Reflection;

Expand Down Expand Up @@ -57,15 +58,15 @@ private static function classAllowsNamedArguments(ClassReflection $classReflecti
return true;
}

/**
* @param Node[] $args
* @param ExtendedParameterReflection[] $parameters
*/
private static function areArgumentsSuitable(array $args, array $parameters): bool
{
foreach ($args as $index => $arg) {
if (!isset($parameters[$index])) {
return false;
}

// Skip variadic parameters (...$param)
if ($parameters[$index]->isVariadic()) {
$parameter = self::resolveParameterForArgumentIndex(parameters: $parameters, index: $index);
if ($parameter === null) {
return false;
}

Expand All @@ -74,15 +75,19 @@ private static function areArgumentsSuitable(array $args, array $parameters): bo
}

// Skip unpacking arguments (...$var)
if ($arg instanceof Node\Arg && $arg->unpack) {
if ($arg->unpack) {
return false;
}

// Allow already named arguments as long as they reference the parameter in the same position
if ($arg->name !== null) {
$argName = $arg->name instanceof Node\Identifier ? $arg->name->toString() : null;
if ($parameter->isVariadic()) {
continue;
}

if ($argName !== $parameters[$index]->getName()) {
$argName = $arg->name->toString();

if ($argName !== $parameter->getName()) {
return false;
}

Expand All @@ -93,6 +98,28 @@ private static function areArgumentsSuitable(array $args, array $parameters): bo
return true;
}

/**
* @param ExtendedParameterReflection[] $parameters
*/
private static function resolveParameterForArgumentIndex(array $parameters, int $index): ?ExtendedParameterReflection
{
if (isset($parameters[$index])) {
return $parameters[$index];
}

if ($parameters === []) {
return null;
}

$lastParameter = $parameters[array_key_last($parameters)];

if (! $lastParameter->isVariadic()) {
return null;
}

return $lastParameter;
}

private static function hasNoNamedArgumentsTag(ReflectionFunctionAbstract|ReflectionClass|ReflectionEnum $reflection): bool
{
$docComment = $reflection->getDocComment();
Expand Down
2 changes: 1 addition & 1 deletion tests/DefaultStrategy/Fixture/variadic.php.inc
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,6 @@ sprintf('%s/%s', 'foo', 'bar');
-----
<?php

sprintf('%s/%s', 'foo', 'bar');
sprintf(format: '%s/%s', values1: 'foo', values2: 'bar');

?>
25 changes: 25 additions & 0 deletions tests/DefaultStrategy/Fixture/variadic_mixed_signature.php.inc
Original file line number Diff line number Diff line change
@@ -0,0 +1,25 @@
<?php

final readonly class VariadicRunner
{
public function run(string $command, ...$args): void
{
}
}

(new VariadicRunner())->run('php', '--version', '--ansi');

?>
-----
<?php

final readonly class VariadicRunner
{
public function run(string $command, ...$args): void
{
}
}

(new VariadicRunner())->run(command: 'php', args1: '--version', args2: '--ansi');

?>
37 changes: 37 additions & 0 deletions tests/VariadicDisabledStrategy/AddNamedArgumentsRectorTest.php
Original file line number Diff line number Diff line change
@@ -0,0 +1,37 @@
<?php

declare(strict_types=1);

namespace SavinMikhail\Tests\AddNamedArgumentsRector\VariadicDisabledStrategy;

use Iterator;
use PHPUnit\Framework\Attributes\DataProvider;
use Rector\Testing\PHPUnit\AbstractRectorTestCase;
use SavinMikhail\AddNamedArgumentsRector\AddNamedArgumentsRector;

final class AddNamedArgumentsRectorTest extends AbstractRectorTestCase
{
#[DataProvider('provideCases')]
public function test(string $filePath): void
{
$this->doTestFile($filePath);
}

/**
* @return Iterator<array<int, string>>
*/
public static function provideCases(): iterable
{
return self::yieldFilesFromDirectory(__DIR__ . '/Fixture');
}

public function provideConfigFilePath(): string
{
return __DIR__ . '/config/rector.php';
}

protected function getRectorClass(): string
{
return AddNamedArgumentsRector::class;
}
}
13 changes: 13 additions & 0 deletions tests/VariadicDisabledStrategy/Fixture/variadic_disabled.php.inc
Original file line number Diff line number Diff line change
@@ -0,0 +1,13 @@
<?php

str_contains('foobar', 'foo');
sprintf('%s/%s', 'foo', 'bar');

?>
-----
<?php

str_contains(haystack: 'foobar', needle: 'foo');
sprintf('%s/%s', 'foo', 'bar');

?>
13 changes: 13 additions & 0 deletions tests/VariadicDisabledStrategy/config/rector.php
Original file line number Diff line number Diff line change
@@ -0,0 +1,13 @@
<?php

declare(strict_types=1);

use Rector\Config\RectorConfig;
use SavinMikhail\AddNamedArgumentsRector\AddNamedArgumentsRector;
use SavinMikhail\AddNamedArgumentsRector\Config\DefaultStrategy;

return RectorConfig::configure()
->withConfiguredRule(AddNamedArgumentsRector::class, [
AddNamedArgumentsRector::STRATEGY => DefaultStrategy::class,
AddNamedArgumentsRector::ALLOW_NAMED_VARIADIC_ARGUMENTS => false,
]);
Loading