-
Notifications
You must be signed in to change notification settings - Fork 82
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Add ServiceSettersToSettersAutodiscoveryRector
- Loading branch information
1 parent
948357f
commit 1b584d0
Showing
14 changed files
with
390 additions
and
35 deletions.
There are no files selected for viewing
This file contains 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 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 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 was deleted.
Oops, something went wrong.
This file contains 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 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
223 changes: 223 additions & 0 deletions
223
src/Rector/Closure/ServiceSettersToSettersAutodiscoveryRector.php
This file contains 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,223 @@ | ||
| <?php | ||
|
|
||
| declare(strict_types=1); | ||
|
|
||
| namespace Rector\Symfony\Rector\Closure; | ||
|
|
||
| use PhpParser\Node; | ||
| use PhpParser\Node\Arg; | ||
| use PhpParser\Node\Expr\BinaryOp\Concat; | ||
| use PhpParser\Node\Expr\ClassConstFetch; | ||
| use PhpParser\Node\Expr\Closure; | ||
| use PhpParser\Node\Expr\ConstFetch; | ||
| use PhpParser\Node\Expr\MethodCall; | ||
| use PhpParser\Node\Expr\Variable; | ||
| use PhpParser\Node\Name; | ||
| use PhpParser\Node\Scalar\String_; | ||
| use PhpParser\Node\Stmt\Expression; | ||
| use PHPStan\Reflection\ReflectionProvider; | ||
| use PHPStan\Type\ObjectType; | ||
| use Rector\Core\Exception\ShouldNotHappenException; | ||
| use Rector\Core\Rector\AbstractRector; | ||
| use Rector\Symfony\NodeAnalyzer\SymfonyPhpClosureDetector; | ||
| use Rector\Symfony\ValueObject\ClassNameAndFilePath; | ||
| use Symfony\Component\Filesystem\Filesystem; | ||
| use Symplify\RuleDocGenerator\ValueObject\CodeSample\CodeSample; | ||
| use Symplify\RuleDocGenerator\ValueObject\RuleDefinition; | ||
| use Triun\LongestCommonSubstring\Solver; | ||
|
|
||
| /** | ||
| * @see \Rector\Symfony\Tests\Rector\Closure\ServiceSettersToSettersAutodiscoveryRector\ServiceSettersToSettersAutodiscoveryRectorTest | ||
| */ | ||
| final class ServiceSettersToSettersAutodiscoveryRector extends AbstractRector | ||
| { | ||
| private readonly Solver $solver; | ||
|
|
||
| public function __construct( | ||
| private readonly SymfonyPhpClosureDetector $symfonyPhpClosureDetector, | ||
| private readonly ReflectionProvider $reflectionProvider, | ||
| private readonly Filesystem $filesystem, | ||
| ) { | ||
| $this->solver = new Solver(); | ||
| } | ||
|
|
||
| public function getRuleDefinition(): RuleDefinition | ||
| { | ||
| return new RuleDefinition('Change $services->set(..., ...) to $services->load(..., ...) where meaning ful', [ | ||
| new CodeSample( | ||
| <<<'CODE_SAMPLE' | ||
| use Symfony\Component\DependencyInjection\Loader\Configurator\ContainerConfigurator; | ||
| use App\Services\FistService; | ||
| use App\Services\SecondService; | ||
| return static function (ContainerConfigurator $containerConfigurator): void { | ||
| $parameters = $containerConfigurator->parameters(); | ||
| $services = $containerConfigurator->services(); | ||
| $services->set(FistService::class); | ||
| $services->set(SecondService::class); | ||
| }; | ||
| CODE_SAMPLE | ||
| , | ||
| <<<'CODE_SAMPLE' | ||
| use Symfony\Component\DependencyInjection\Loader\Configurator\ContainerConfigurator; | ||
| return static function (ContainerConfigurator $containerConfigurator): void { | ||
| $parameters = $containerConfigurator->parameters(); | ||
| $services = $containerConfigurator->services(); | ||
| $services->load('App\\Services\\', '../src/Services/*'); | ||
| }; | ||
| CODE_SAMPLE | ||
| ), | ||
| ]); | ||
| } | ||
|
|
||
| /** | ||
| * @return array<class-string<Node>> | ||
| */ | ||
| public function getNodeTypes(): array | ||
| { | ||
| return [Closure::class]; | ||
| } | ||
|
|
||
| /** | ||
| * @param Closure $node | ||
| */ | ||
| public function refactor(Node $node): ?Node | ||
| { | ||
| if (! $this->symfonyPhpClosureDetector->detect($node)) { | ||
| return null; | ||
| } | ||
|
|
||
| $bareServicesSetMethodCalls = $this->collectServiceSetMethodCalls($node); | ||
| if ($bareServicesSetMethodCalls === []) { | ||
| return null; | ||
| } | ||
|
|
||
| $classNamesAndFilesPaths = $this->createClassNamesAndFilePaths($bareServicesSetMethodCalls); | ||
|
|
||
| $classNames = array_map( | ||
| fn (ClassNameAndFilePath $classNameAndFilePath) => $classNameAndFilePath->getClassName(), | ||
| $classNamesAndFilesPaths | ||
| ); | ||
|
|
||
| $sharedNamespace = $this->solver->solve(...$classNames); | ||
| if (! is_string($sharedNamespace)) { | ||
| return null; | ||
| } | ||
|
|
||
| $firstClassNameAndFilePath = $classNamesAndFilesPaths[0]; | ||
| $classFilePath = $firstClassNameAndFilePath->getFilePath(); | ||
|
|
||
| $relativeDirectoryPath = $this->filesystem->makePathRelative( | ||
| dirname($classFilePath), | ||
| dirname($this->file->getFilePath()) | ||
| ); | ||
|
|
||
| $directoryConcat = new Concat( | ||
| new ConstFetch(new Name('__DIR__')), | ||
| new String_('/' . $relativeDirectoryPath) | ||
| ); | ||
| $args = [new Arg(new String_($sharedNamespace)), new Arg($directoryConcat)]; | ||
| $loadMethodCall = new MethodCall(new Variable('services'), 'load', $args); | ||
| $node->stmts[] = new Expression($loadMethodCall); | ||
|
|
||
| // remove all method calls | ||
| foreach ($bareServicesSetMethodCalls as $bareServiceSetMethodCall) { | ||
| $this->removeNode($bareServiceSetMethodCall); | ||
| } | ||
|
|
||
| return $node; | ||
| } | ||
|
|
||
| public function isBareServicesSetMethodCall(MethodCall $methodCall): bool | ||
| { | ||
| if (! $this->isObjectType( | ||
| $methodCall->var, | ||
| new ObjectType('Symfony\Component\DependencyInjection\Loader\Configurator\ServicesConfigurator') | ||
| )) { | ||
| return false; | ||
| } | ||
|
|
||
| if (! $this->isName($methodCall->name, 'set')) { | ||
| return false; | ||
| } | ||
|
|
||
| // must have exactly single argument | ||
| if (count($methodCall->getArgs()) !== 1) { | ||
| return false; | ||
| } | ||
|
|
||
| $firstArg = $methodCall->getArgs()[0]; | ||
|
|
||
| // first argument must be a class name, e.g. SomeClass::class | ||
| return $firstArg->value instanceof ClassConstFetch; | ||
| } | ||
|
|
||
| /** | ||
| * @return MethodCall[] | ||
| */ | ||
| private function collectServiceSetMethodCalls(Closure $closure): array | ||
| { | ||
| $servicesSetMethodCalls = []; | ||
|
|
||
| $this->traverseNodesWithCallable($closure, function (Node $node) use (&$servicesSetMethodCalls) { | ||
| if (! $node instanceof Expression) { | ||
| return null; | ||
| } | ||
|
|
||
| if (! $node->expr instanceof MethodCall) { | ||
| return null; | ||
| } | ||
|
|
||
| $methodCall = $node->expr; | ||
| if (! $this->isBareServicesSetMethodCall($methodCall)) { | ||
| return null; | ||
| } | ||
|
|
||
| $servicesSetMethodCalls[] = $methodCall; | ||
|
|
||
| return null; | ||
| }); | ||
|
|
||
| return $servicesSetMethodCalls; | ||
| } | ||
|
|
||
| /** | ||
| * @param MethodCall[] $methodsCalls | ||
| * @return ClassNameAndFilePath[] | ||
| */ | ||
| private function createClassNamesAndFilePaths(array $methodsCalls): array | ||
| { | ||
| $classNamesAndFilesPaths = []; | ||
|
|
||
| foreach ($methodsCalls as $methodCall) { | ||
| $firstArg = $methodCall->getArgs()[0]; | ||
| $serviceClassReference = $this->valueResolver->getValue($firstArg->value); | ||
|
|
||
| if (! is_string($serviceClassReference)) { | ||
| throw new ShouldNotHappenException(); | ||
| } | ||
|
|
||
| $classReflection = $this->reflectionProvider->getClass($serviceClassReference); | ||
|
|
||
| // we only work with known local classes | ||
| if ($classReflection->isInternal()) { | ||
| continue; | ||
| } | ||
|
|
||
| $filename = $classReflection->getFileName(); | ||
| if (! is_string($filename)) { | ||
| continue; | ||
| } | ||
|
|
||
| $classNamesAndFilesPaths[] = new ClassNameAndFilePath($classReflection->getName(), $filename); | ||
| } | ||
|
|
||
| return $classNamesAndFilesPaths; | ||
| } | ||
| } |
Oops, something went wrong.