WIP: Support named arguments #750
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,94 @@ | ||
| <?php declare(strict_types = 1); | ||
|
|
||
| namespace PHPStan\Analyser; | ||
|
|
||
| use PhpParser\Node\Arg; | ||
| use PhpParser\Node\Expr\CallLike; | ||
| use PhpParser\Node\Expr\FuncCall; | ||
| use PhpParser\Node\Expr\MethodCall; | ||
| use PhpParser\Node\Expr\StaticCall; | ||
| use PHPStan\Reflection\ParametersAcceptor; | ||
| use PHPStan\ShouldNotHappenException; | ||
|
|
||
| final class NamedArgumentsHelper | ||
| { | ||
|
|
||
| public static function reorderFuncArguments( | ||
| ParametersAcceptor $parametersAcceptor, | ||
| FuncCall $functionCall | ||
| ): FuncCall | ||
| { | ||
| return new FuncCall( | ||
| $functionCall->name, | ||
| self::reorderArgs($parametersAcceptor, $functionCall), | ||
| $functionCall->getAttributes() | ||
| ); | ||
| } | ||
|
|
||
| public static function reorderMethodArguments( | ||
| ParametersAcceptor $parametersAcceptor, | ||
| MethodCall $methodCall | ||
| ): MethodCall | ||
| { | ||
| return new MethodCall( | ||
| $methodCall->var, | ||
| $methodCall->name, | ||
| self::reorderArgs($parametersAcceptor, $methodCall), | ||
| $methodCall->getAttributes() | ||
| ); | ||
| } | ||
|
|
||
| public static function reorderStaticCallArguments( | ||
| ParametersAcceptor $parametersAcceptor, | ||
| StaticCall $staticCall | ||
| ): StaticCall | ||
| { | ||
| return new StaticCall( | ||
| $staticCall->class, | ||
| $staticCall->name, | ||
| self::reorderArgs($parametersAcceptor, $staticCall), | ||
| $staticCall->getAttributes() | ||
| ); | ||
| } | ||
|
|
||
| /** | ||
| * @return array<int, Arg> | ||
| */ | ||
| private static function reorderArgs(ParametersAcceptor $parametersAcceptor, CallLike $callLike): array | ||
| { | ||
| $signatureParameters = $parametersAcceptor->getParameters(); | ||
| $callArgs = $callLike->getArgs(); | ||
|
|
||
| $reorderedArgs = []; | ||
| $argumentPositions = []; | ||
| foreach ($signatureParameters as $i => $parameter) { | ||
| $argumentPositions[$parameter->getName()] = $i; | ||
|
|
||
| if ($parameter->isOptional()) { | ||
| $defaultValue = $parameter->getDefaultValue(); | ||
| if ($defaultValue === null) { | ||
| // a possible "null"-default value is indicated by NullType | ||
| throw new ShouldNotHappenException('A optional parameter must have a default value'); | ||
| } | ||
| $reorderedArgs[$i] = new Arg( | ||
| $defaultValue | ||
| ); | ||
| } | ||
| } | ||
|
|
||
| foreach ($callArgs as $i => $arg) { | ||
| if ($arg->name === null) { | ||
| // add regular args as is | ||
| $reorderedArgs[$i] = $arg; | ||
| } elseif (array_key_exists($arg->name->toString(), $argumentPositions)) { | ||
| // order named args into the position the signature expects them | ||
| $reorderedArgs[$argumentPositions[$arg->name->toString()]] = $arg; | ||
| } | ||
| } | ||
|
|
||
| ksort($reorderedArgs); | ||
|
|
||
| return $reorderedArgs; | ||
| } | ||
|
|
||
| } | ||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,94 @@ | ||
| <?php declare(strict_types = 1); | ||
|
|
||
| namespace PHPStan\Analyser; | ||
|
|
||
| use PhpParser\Node\Arg; | ||
| use PhpParser\Node\Expr\FuncCall; | ||
| use PhpParser\Node\Identifier; | ||
| use PhpParser\Node\Name; | ||
| use PhpParser\Node\Scalar\LNumber; | ||
| use PhpParser\Node\Scalar\String_; | ||
| use PHPStan\Reflection\ParametersAcceptor; | ||
| use PHPStan\Reflection\ParametersAcceptorSelector; | ||
| use PHPStan\Reflection\SignatureMap\NativeFunctionReflectionProvider; | ||
|
|
||
| final class NamedArgumentsHelperTest extends \PHPStan\Testing\PHPStanTestCase { | ||
|
Contributor
Author
There was a problem hiding this comment. initial round of unit tests for the new after the 2nd test - which does not pass atm - is fixed, I will add more test-cases |
||
| /** | ||
| * all arguments named and given in order | ||
| */ | ||
| public function testArgumentReorderAllNamed() { | ||
| $funcName = new Name('json_encode'); | ||
| $reflectionProvider = self::getContainer()->getByType(NativeFunctionReflectionProvider::class); | ||
| $functionReflection = $reflectionProvider->findFunctionReflection('json_encode'); | ||
| $parameterAcceptor = ParametersAcceptorSelector::selectSingle($functionReflection->getVariants()); | ||
|
|
||
| $args = [ | ||
| new Arg( | ||
| new LNumber(0), | ||
| false, | ||
| false, | ||
| [], | ||
| new Identifier('flags') | ||
| ), | ||
| new Arg( | ||
| new String_('my json value'), | ||
| false, | ||
| false, | ||
| [], | ||
| new Identifier('value') | ||
| ) | ||
| ]; | ||
| $funcCall = new FuncCall($funcName, $args); | ||
|
|
||
| $funcCall = NamedArgumentsHelper::reorderFuncArguments($parameterAcceptor, $funcCall); | ||
| $reorderedArgs = $funcCall->getArgs(); | ||
|
|
||
| $this->assertArrayHasKey(0 , $reorderedArgs); | ||
| $this->assertSame('value', $reorderedArgs[0]->name->toString()); | ||
|
|
||
| $this->assertArrayHasKey(1 , $reorderedArgs); | ||
| $this->assertSame('flags', $reorderedArgs[1]->name->toString()); | ||
| } | ||
|
|
||
| /** | ||
| * all args named, not in order | ||
| */ | ||
| public function testArgumentReorderAllNamedWithSkipped() { | ||
| $funcName = new Name('json_encode'); | ||
| $reflectionProvider = self::getContainer()->getByType(NativeFunctionReflectionProvider::class); | ||
| $functionReflection = $reflectionProvider->findFunctionReflection('json_encode'); | ||
| $parameterAcceptor = ParametersAcceptorSelector::selectSingle($functionReflection->getVariants()); | ||
|
|
||
| $args = [ | ||
| new Arg( | ||
| new LNumber(128), | ||
| false, | ||
| false, | ||
| [], | ||
| new Identifier('depth') | ||
| ), | ||
| new Arg( | ||
| new String_('my json value'), | ||
| false, | ||
| false, | ||
| [], | ||
| new Identifier('value') | ||
| ) | ||
| ]; | ||
| $funcCall = new FuncCall($funcName, $args); | ||
|
|
||
| $funcCall = NamedArgumentsHelper::reorderFuncArguments($parameterAcceptor, $funcCall); | ||
| $reorderedArgs = $funcCall->getArgs(); | ||
|
|
||
| $this->assertArrayHasKey(0 , $reorderedArgs); | ||
| $this->assertSame('value', $reorderedArgs[0]->name->toString()); | ||
|
|
||
| $this->assertArrayHasKey(1 , $reorderedArgs); | ||
| $this->assertSame('flags', $reorderedArgs[1]->name->toString()); | ||
| $this->assertInstanceOf(LNumber::class, $reorderedArgs[1]->value); | ||
| $this->assertSame(0, $reorderedArgs[1]->value->value); | ||
|
|
||
| $this->assertArrayHasKey(2 , $reorderedArgs); | ||
| $this->assertSame('depth', $reorderedArgs[2]->name->toString()); | ||
| } | ||
| } | ||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,26 @@ | ||
| <?php // lint >= 8.0 | ||
|
|
||
| namespace DynamicMethodReturnTypesNamespace; | ||
|
|
||
| use function PHPStan\Testing\assertType; | ||
|
|
||
| class FooNamedArgs | ||
| { | ||
|
|
||
| public function __construct() | ||
| { | ||
| } | ||
|
|
||
| public function doFoo() | ||
| { | ||
| $em = new EntityManager(); | ||
| $iem = new InheritedEntityManager(); | ||
|
|
||
| assertType('DynamicMethodReturnTypesNamespace\Foo', $em->getByPrimary(className: \DynamicMethodReturnTypesNamespace\Foo::class)); | ||
| assertType('DynamicMethodReturnTypesNamespace\Foo', $iem->getByPrimary(className: \DynamicMethodReturnTypesNamespace\Foo::class)); | ||
|
|
||
| assertType('DynamicMethodReturnTypesNamespace\Foo', \DynamicMethodReturnTypesNamespace\EntityManager::createManagerForEntity(className: \DynamicMethodReturnTypesNamespace\Foo::class)); | ||
| assertType('DynamicMethodReturnTypesNamespace\Foo', \DynamicMethodReturnTypesNamespace\InheritedEntityManager::createManagerForEntity(className: \DynamicMethodReturnTypesNamespace\Foo::class)); | ||
| } | ||
|
|
||
| } |
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Really nice! I'd like this class to have separate unit tests so that we can see what happens to those gaps between arguments if an optional one is skipped. To me it looks like this code still doesn't handle that.