From 530b2f1310ab2dcffbe0d31502f9738b1103c97c Mon Sep 17 00:00:00 2001 From: Tomas Votruba Date: Sun, 23 Dec 2018 16:47:15 +0100 Subject: [PATCH 1/4] Add CallableCollectorPopulator --- .../src/StaticTypeToStringResolver.php | 94 ++++++++---------- .../CompleteVarDocTypePropertyRector.php | 1 - phpstan.neon | 2 + src/Collector/CallableCollectorPopulator.php | 84 ++++++++++++++++ .../CallableCollectorException.php | 9 ++ src/PhpParser/Node/Resolver/NameResolver.php | 97 +++++++++---------- 6 files changed, 184 insertions(+), 103 deletions(-) create mode 100644 src/Collector/CallableCollectorPopulator.php create mode 100644 src/Exception/DependencyInjection/CallableCollectorException.php diff --git a/packages/NodeTypeResolver/src/StaticTypeToStringResolver.php b/packages/NodeTypeResolver/src/StaticTypeToStringResolver.php index 6743a840267..1bde29b6a91 100644 --- a/packages/NodeTypeResolver/src/StaticTypeToStringResolver.php +++ b/packages/NodeTypeResolver/src/StaticTypeToStringResolver.php @@ -13,21 +13,50 @@ use PHPStan\Type\ObjectType; use PHPStan\Type\StringType; use PHPStan\Type\Type; use PHPStan\Type\UnionType; +use Rector\Collector\CallableCollectorPopulator; final class StaticTypeToStringResolver { /** - * @var string[] + * @var callable[] */ - private $typeClassToTypeHint = [ - CallableType::class => 'callable', - ClosureType::class => 'callable', - IntegerType::class => 'int', - FloatType::class => 'float', - BooleanType::class => 'bool', - StringType::class => 'string', - NullType::class => 'null', - ]; + private $resolversByArgumentType = []; + + public function __construct(CallableCollectorPopulator $callableCollectorPopulator) + { + $resolvers = [ + IntegerType::class => ['int'], + ClosureType::class => ['callable'], + CallableType::class => ['callable'], + FloatType::class => ['float'], + BooleanType::class => ['bool'], + StringType::class => ['string'], + NullType::class => ['null'], + // more complex callables + function (ArrayType $arrayType): array { + $types = $this->resolve($arrayType->getItemType()); + foreach ($types as $key => $type) { + $types[$key] = $type . '[]'; + } + + return $types; + }, + function (UnionType $unionType): array { + $types = []; + foreach ($unionType->getTypes() as $singleStaticType) { + $types = array_merge($types, $this->resolve($singleStaticType)); + } + + return $types; + }, + function (ObjectType $objectType): array { + // the must be absolute, since we have no other way to check absolute/local path + return ['\\' . $objectType->getClassName()]; + }, + ]; + + $this->resolversByArgumentType = $callableCollectorPopulator->populate($resolvers); + } /** * @return string[] @@ -38,51 +67,12 @@ final class StaticTypeToStringResolver return []; } - foreach ($this->typeClassToTypeHint as $typeClass => $typeHint) { - if (is_a($staticType, $typeClass, true)) { - return [$typeHint]; + foreach ($this->resolversByArgumentType as $type => $resolverCallable) { + if (is_a($staticType, $type, true)) { + return $resolverCallable($staticType); } } - if ($staticType instanceof UnionType) { - return $this->resolveUnionType($staticType); - } - - if ($staticType instanceof ArrayType) { - return $this->resolveArrayType($staticType); - } - - if ($staticType instanceof ObjectType) { - // the must be absolute, since we have no other way to check absolute/local path - return ['\\' . $staticType->getClassName()]; - } - return []; } - - /** - * @return string[] - */ - private function resolveUnionType(UnionType $unionType): array - { - $types = []; - foreach ($unionType->getTypes() as $singleStaticType) { - $types = array_merge($types, $this->resolve($singleStaticType)); - } - - return $types; - } - - /** - * @return string[] - */ - private function resolveArrayType(ArrayType $arrayType): array - { - $types = $this->resolve($arrayType->getItemType()); - foreach ($types as $key => $type) { - $types[$key] = $type . '[]'; - } - - return $types; - } } diff --git a/packages/Php/src/Rector/Property/CompleteVarDocTypePropertyRector.php b/packages/Php/src/Rector/Property/CompleteVarDocTypePropertyRector.php index 6e76b85214a..7f164f7f17c 100644 --- a/packages/Php/src/Rector/Property/CompleteVarDocTypePropertyRector.php +++ b/packages/Php/src/Rector/Property/CompleteVarDocTypePropertyRector.php @@ -122,7 +122,6 @@ CODE_SAMPLE } /** - * @todo extract * Based on static analysis of code, looking for property assigns */ private function resolveStaticVarTypeInfo(Property $propertyNode): ?VarTypeInfo diff --git a/phpstan.neon b/phpstan.neon index 625a210ef14..2d289281d2b 100644 --- a/phpstan.neon +++ b/phpstan.neon @@ -52,6 +52,7 @@ parameters: # irelevant - '#Call to function in_array\(\) with arguments string, (.*?) and true will always evaluate to false#' + - '#Parameter \#1 \$name of class ReflectionFunction constructor expects Closure\|string, callable given#' # known values - '#Access to an undefined property PhpParser\\Node\\Expr::\$left#' @@ -70,6 +71,7 @@ parameters: - '#Access to an undefined property PhpParser\\Node::\$(\w+)#' - '#Parameter \#2 \$boolConstFetchNode of method Rector\\CodeQuality\\Rector\\Identical\\SimplifyArraySearchRector::resolveIsNot\(\) expects PhpParser\\Node\\Expr\\ConstFetch, PhpParser\\Node given#' - '#Method Rector\\PhpParser\\Node\\BetterNodeFinder::findFirstAncestorInstanceOf\(\) should return PhpParser\\Node\|null but returns object#' + - '#Parameter \#1 \$callables of method Rector\\Collector\\CallableCollectorPopulator::populate\(\) expects array, (.*?) given#' # false positive, resolved in previous method - '#Parameter (.*?) of method Rector\\PhpParser\\Node\\Maintainer\\IdentifierMaintainer\:\:(.*?)\(\) expects PhpParser\\Node\\Expr\\ClassConstFetch\|PhpParser\\Node\\Expr\\MethodCall\|PhpParser\\Node\\Expr\\PropertyFetch\|PhpParser\\Node\\Expr\\StaticCall\|PhpParser\\Node\\Stmt\\ClassMethod, PhpParser\\Node given#' diff --git a/src/Collector/CallableCollectorPopulator.php b/src/Collector/CallableCollectorPopulator.php new file mode 100644 index 00000000000..39286a667a2 --- /dev/null +++ b/src/Collector/CallableCollectorPopulator.php @@ -0,0 +1,84 @@ + $callable) { + // 1. convert instant assign to callable + if (! is_callable($callable)) { + $populatedCallables[$key] = function () use ($callable) { + return $callable; + }; + continue; + } + + $parameterType = $this->resolveCallableParameterType($callable); + $this->ensureCallableParameterIsUnique($populatedCallables, $parameterType); + + $populatedCallables[$parameterType] = $callable; + } + + return $populatedCallables; + } + + private function resolveCallableParameterType(callable $callable): string + { + $reflectionFunction = new ReflectionFunction($callable); + $this->ensureCallableHasExactlyOneParameter($reflectionFunction); + + $reflectionParameter = $reflectionFunction->getParameters()[0]; + + $type = (string) $reflectionParameter->getType(); + $this->ensureParameterHasType($type); + + return $type; + } + + /** + * @param callable[] $callables + */ + private function ensureCallableParameterIsUnique(array $callables, string $parameterType): void + { + if (! isset($callables[$parameterType])) { + return; + } + + throw new CallableCollectorException(sprintf( + 'There can be only one callable for "%s" parameter type', + $parameterType + )); + } + + private function ensureCallableHasExactlyOneParameter(ReflectionFunction $reflectionFunction): void + { + if ($reflectionFunction->getNumberOfParameters() !== 1) { + throw new CallableCollectorException(sprintf( + 'Collector callable has to have exactly 1 parameter. %d found.', + $reflectionFunction->getNumberOfParameters() + )); + } + } + + private function ensureParameterHasType(string $type): void + { + if ($type) { + return; + } + + throw new CallableCollectorException('Collector callable parmaeter has to have type declaration.'); + } +} diff --git a/src/Exception/DependencyInjection/CallableCollectorException.php b/src/Exception/DependencyInjection/CallableCollectorException.php new file mode 100644 index 00000000000..c68ee1226af --- /dev/null +++ b/src/Exception/DependencyInjection/CallableCollectorException.php @@ -0,0 +1,9 @@ +nameResolversPerNode[ClassConst::class] = function (ClassConst $classConstNode) { - if (! count($classConstNode->consts)) { - return null; - } + $resolvers = [ + Empty_::class => 'empty', + // more complex + function (ClassConst $classConstNode): ?string { + if (! count($classConstNode->consts)) { + return null; + } - return $this->resolve($classConstNode->consts[0]); - }; + return $this->resolve($classConstNode->consts[0]); + }, + function (Property $propertyNode): ?string { + if (! count($propertyNode->props)) { + return null; + } - $this->nameResolversPerNode[Property::class] = function (Property $propertyNode): ?string { - if (! count($propertyNode->props)) { - return null; - } + return $this->resolve($propertyNode->props[0]); + }, + function (Use_ $useNode): ?string { + if (! count($useNode->uses)) { + return null; + } - return $this->resolve($propertyNode->props[0]); - }; + return $this->resolve($useNode->uses[0]); + }, + function (Param $paramNode): ?string { + return $this->resolve($paramNode->var); + }, + function (Name $nameNode): string { + $resolvedName = $nameNode->getAttribute(Attribute::RESOLVED_NAME); + if ($resolvedName instanceof FullyQualified) { + return $resolvedName->toString(); + } - $this->nameResolversPerNode[Use_::class] = function (Use_ $useNode): ?string { - if (! count($useNode->uses)) { - return null; - } + return $nameNode->toString(); + }, + function (Class_ $classNode): ?string { + if (isset($classNode->namespacedName)) { + return $classNode->namespacedName->toString(); + } - return $this->resolve($useNode->uses[0]); - }; + return $this->resolve($classNode->name); + }, + function (Interface_ $interfaceNode): ?string { + if (isset($interfaceNode->namespacedName)) { + return $interfaceNode->namespacedName->toString(); + } - $this->nameResolversPerNode[Param::class] = function (Param $paramNode): ?string { - return $this->resolve($paramNode->var); - }; + return $this->resolve($interfaceNode->name); + }, + ]; - $this->nameResolversPerNode[Name::class] = function (Name $nameNode): string { - $resolvedName = $nameNode->getAttribute(Attribute::RESOLVED_NAME); - if ($resolvedName instanceof FullyQualified) { - return $resolvedName->toString(); - } - - return $nameNode->toString(); - }; - - $this->nameResolversPerNode[Empty_::class] = function (): string { - return 'empty'; - }; - - $this->nameResolversPerNode[Class_::class] = function (Class_ $classNode): ?string { - if (isset($classNode->namespacedName)) { - return $classNode->namespacedName->toString(); - } - - return $this->resolve($classNode->name); - }; - - $this->nameResolversPerNode[Interface_::class] = function (Interface_ $interfaceNode): ?string { - if (isset($interfaceNode->namespacedName)) { - return $interfaceNode->namespacedName->toString(); - } - - return $this->resolve($interfaceNode->name); - }; + $this->nameResolversPerNode = $callableCollectorPopulator->populate($resolvers); } public function isName(Node $node, string $name): bool From e3ffb69230f890976cf4aabf1b05c8d9eb9813cd Mon Sep 17 00:00:00 2001 From: Tomas Votruba Date: Sun, 23 Dec 2018 17:55:28 +0100 Subject: [PATCH 2/4] move GenerateRectorOverview to GenerateDocs in ContributorTools --- .travis.yml | 2 +- composer.json | 3 +-- .../ContributorTools/src/Command/CreateRectorCommand.php | 3 ++- .../ContributorTools/src/Command/GenerateDocsCommand.php | 6 ++++-- .../src/Exception/Command/MaintainerCommandInterface.php | 8 ++++++++ 5 files changed, 16 insertions(+), 6 deletions(-) rename src/Console/Command/GenerateRectorOverviewCommand.php => packages/ContributorTools/src/Command/GenerateDocsCommand.php (97%) create mode 100644 packages/ContributorTools/src/Exception/Command/MaintainerCommandInterface.php diff --git a/.travis.yml b/.travis.yml index defe9284026..121d905c6cc 100644 --- a/.travis.yml +++ b/.travis.yml @@ -38,7 +38,7 @@ script: - | if [[ $RUN_RECTOR == true ]]; then bin/rector process src --level symfony40 --dry-run - bin/rector generate-rector-overview >> rector-overview.md + bin/rector docs >> rector-overview.md fi # Run standalone install in non-root package, ref https://github.com/rectorphp/rector/issues/732 diff --git a/composer.json b/composer.json index 72e8252f545..695a76e3583 100644 --- a/composer.json +++ b/composer.json @@ -103,9 +103,8 @@ "vendor/bin/ecs check bin packages src tests --fix", "bin/clean_trailing_spaces.sh" ], - "docs": "@update-docs", "phpstan": "vendor/bin/phpstan analyse packages src tests", - "update-docs": "bin/rector generate-rector-overview > docs/AllRectorsOverview.md", + "docs": "bin/rector generate-docs > docs/AllRectorsOverview.md", "pre-autoload-dump": [ "Rector\\Tests\\Composer\\AutoloadWrongCasesEventSubscriber::preAutoloadDump" ] diff --git a/packages/ContributorTools/src/Command/CreateRectorCommand.php b/packages/ContributorTools/src/Command/CreateRectorCommand.php index 2d2d3e996df..7161e65fee9 100644 --- a/packages/ContributorTools/src/Command/CreateRectorCommand.php +++ b/packages/ContributorTools/src/Command/CreateRectorCommand.php @@ -7,6 +7,7 @@ use Nette\Utils\Strings; use Rector\CodingStyle\AfterRectorCodingStyle; use Rector\ContributorTools\Configuration\Configuration; use Rector\ContributorTools\Configuration\ConfigurationFactory; +use Rector\ContributorTools\Exception\Command\MaintainerCommandInterface; use Rector\ContributorTools\TemplateVariablesFactory; use Symfony\Component\Console\Command\Command; use Symfony\Component\Console\Input\InputInterface; @@ -21,7 +22,7 @@ use function Safe\getcwd; use function Safe\sort; use function Safe\sprintf; -final class CreateRectorCommand extends Command +final class CreateRectorCommand extends Command implements MaintainerCommandInterface { /** * @var string diff --git a/src/Console/Command/GenerateRectorOverviewCommand.php b/packages/ContributorTools/src/Command/GenerateDocsCommand.php similarity index 97% rename from src/Console/Command/GenerateRectorOverviewCommand.php rename to packages/ContributorTools/src/Command/GenerateDocsCommand.php index 391de28a38b..9ce1a5a767c 100644 --- a/src/Console/Command/GenerateRectorOverviewCommand.php +++ b/packages/ContributorTools/src/Command/GenerateDocsCommand.php @@ -1,12 +1,14 @@ Date: Sun, 23 Dec 2018 17:57:39 +0100 Subject: [PATCH 3/4] use ContributorCommandInterface instead of explicit command checks --- .../src/Command/CreateRectorCommand.php | 4 ++-- .../src/Command/GenerateDocsCommand.php | 4 ++-- ...Interface.php => ContributorCommandInterface.php} | 5 ++--- src/Console/Application.php | 12 +++--------- 4 files changed, 9 insertions(+), 16 deletions(-) rename packages/ContributorTools/src/Exception/Command/{MaintainerCommandInterface.php => ContributorCommandInterface.php} (68%) diff --git a/packages/ContributorTools/src/Command/CreateRectorCommand.php b/packages/ContributorTools/src/Command/CreateRectorCommand.php index 7161e65fee9..dec170b08f2 100644 --- a/packages/ContributorTools/src/Command/CreateRectorCommand.php +++ b/packages/ContributorTools/src/Command/CreateRectorCommand.php @@ -7,7 +7,7 @@ use Nette\Utils\Strings; use Rector\CodingStyle\AfterRectorCodingStyle; use Rector\ContributorTools\Configuration\Configuration; use Rector\ContributorTools\Configuration\ConfigurationFactory; -use Rector\ContributorTools\Exception\Command\MaintainerCommandInterface; +use Rector\ContributorTools\Exception\Command\ContributorCommandInterface; use Rector\ContributorTools\TemplateVariablesFactory; use Symfony\Component\Console\Command\Command; use Symfony\Component\Console\Input\InputInterface; @@ -22,7 +22,7 @@ use function Safe\getcwd; use function Safe\sort; use function Safe\sprintf; -final class CreateRectorCommand extends Command implements MaintainerCommandInterface +final class CreateRectorCommand extends Command implements ContributorCommandInterface { /** * @var string diff --git a/packages/ContributorTools/src/Command/GenerateDocsCommand.php b/packages/ContributorTools/src/Command/GenerateDocsCommand.php index 9ce1a5a767c..803d537c492 100644 --- a/packages/ContributorTools/src/Command/GenerateDocsCommand.php +++ b/packages/ContributorTools/src/Command/GenerateDocsCommand.php @@ -8,7 +8,7 @@ use Rector\Console\Command\AbstractCommand; use Rector\Console\Shell; use Rector\ConsoleDiffer\MarkdownDifferAndFormatter; use Rector\Contract\Rector\RectorInterface; -use Rector\ContributorTools\Exception\Command\MaintainerCommandInterface; +use Rector\ContributorTools\Exception\Command\ContributorCommandInterface; use Rector\Error\ExceptionCorrector; use Rector\Exception\ShouldNotHappenException; use Rector\RectorDefinition\ConfiguredCodeSample; @@ -21,7 +21,7 @@ use Symplify\PackageBuilder\Console\Command\CommandNaming; use function Safe\ksort; use function Safe\sprintf; -final class GenerateDocsCommand extends AbstractCommand implements MaintainerCommandInterface +final class GenerateDocsCommand extends AbstractCommand implements ContributorCommandInterface { /** * @var SymfonyStyle diff --git a/packages/ContributorTools/src/Exception/Command/MaintainerCommandInterface.php b/packages/ContributorTools/src/Exception/Command/ContributorCommandInterface.php similarity index 68% rename from packages/ContributorTools/src/Exception/Command/MaintainerCommandInterface.php rename to packages/ContributorTools/src/Exception/Command/ContributorCommandInterface.php index 5ae1a54b6b4..7bca3f47f48 100644 --- a/packages/ContributorTools/src/Exception/Command/MaintainerCommandInterface.php +++ b/packages/ContributorTools/src/Exception/Command/ContributorCommandInterface.php @@ -2,7 +2,6 @@ namespace Rector\ContributorTools\Exception\Command; -interface MaintainerCommandInterface +interface ContributorCommandInterface { - -} \ No newline at end of file +} diff --git a/src/Console/Application.php b/src/Console/Application.php index 0a1ee809b77..bbfdaa985a4 100644 --- a/src/Console/Application.php +++ b/src/Console/Application.php @@ -3,8 +3,7 @@ namespace Rector\Console; use Jean85\PrettyVersions; -use Rector\Console\Command\GenerateRectorOverviewCommand; -use Rector\ContributorTools\Command\CreateRectorCommand; +use Rector\ContributorTools\Exception\Command\ContributorCommandInterface; use Symfony\Component\Console\Application as SymfonyApplication; use Symfony\Component\Console\Command\Command; use Symfony\Component\Console\Input\InputDefinition; @@ -12,7 +11,6 @@ use Symfony\Component\Console\Input\InputInterface; use Symfony\Component\Console\Input\InputOption; use Symfony\Component\Console\Output\OutputInterface; use Symfony\Component\EventDispatcher\EventDispatcherInterface; -use Symplify\PackageBuilder\Console\Command\CommandNaming; use function Safe\getcwd; use function Safe\realpath; @@ -47,7 +45,7 @@ final class Application extends SymfonyApplication $shouldFollowByNewline = false; // skip in this case, since generate content must be clear from meta-info - if ($input->getFirstArgument() === CommandNaming::classToName(GenerateRectorOverviewCommand::class)) { + if (is_a($input->getFirstArgument(), ContributorCommandInterface::class, true)) { return parent::doRun($input, $output); } @@ -92,11 +90,7 @@ final class Application extends SymfonyApplication } $filteredCommands = array_filter($commands, function (Command $command): bool { - return ! in_array( - get_class($command), - [CreateRectorCommand::class, GenerateRectorOverviewCommand::class], - true - ); + return ! $command instanceof ContributorCommandInterface; }); return array_values($filteredCommands); From 2178625375520c3b17e7b9cecffefcbc278105d5 Mon Sep 17 00:00:00 2001 From: Tomas Votruba Date: Tue, 25 Dec 2018 01:57:26 +0100 Subject: [PATCH 4/4] fix command name in travis --- .travis.yml | 2 +- packages/ContributorTools/src/Command/GenerateDocsCommand.php | 4 ++-- 2 files changed, 3 insertions(+), 3 deletions(-) diff --git a/.travis.yml b/.travis.yml index 121d905c6cc..915e5f60e72 100644 --- a/.travis.yml +++ b/.travis.yml @@ -38,7 +38,7 @@ script: - | if [[ $RUN_RECTOR == true ]]; then bin/rector process src --level symfony40 --dry-run - bin/rector docs >> rector-overview.md + bin/rector generate-docs >> rector-overview.md fi # Run standalone install in non-root package, ref https://github.com/rectorphp/rector/issues/732 diff --git a/packages/ContributorTools/src/Command/GenerateDocsCommand.php b/packages/ContributorTools/src/Command/GenerateDocsCommand.php index 803d537c492..c4f13363ddc 100644 --- a/packages/ContributorTools/src/Command/GenerateDocsCommand.php +++ b/packages/ContributorTools/src/Command/GenerateDocsCommand.php @@ -96,7 +96,7 @@ final class GenerateDocsCommand extends AbstractCommand implements ContributorCo */ private function getProjectsRectors(): array { - return $this->getRectorsFromDirectory([__DIR__ . '/../../../packages']); + return $this->getRectorsFromDirectory([__DIR__ . '/../../../../packages']); } /** @@ -121,7 +121,7 @@ final class GenerateDocsCommand extends AbstractCommand implements ContributorCo */ private function getGeneralRectors(): array { - return $this->getRectorsFromDirectory([__DIR__ . '/../../../src']); + return $this->getRectorsFromDirectory([__DIR__ . '/../../../../src']); } private function detectGroupFromRectorClass(string $rectorClass): string