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
2 changes: 1 addition & 1 deletion composer.json
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@
"rector/type-perfect": "^2.1",
"symfony/config": "^6.4",
"symfony/dependency-injection": "^6.4",
"symfony/http-kernel": "^7.0",
"symfony/http-kernel": "^7.3",
"symfony/routing": "^6.4",
"symfony/security-core": "^6.4",
"symfony/security-http": "^6.4",
Expand Down
3 changes: 3 additions & 0 deletions config/sets/symfony/configs.php
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,7 @@
declare(strict_types=1);

use Rector\Config\RectorConfig;
use Rector\Symfony\Configs\Rector\Closure\FromServicePublicToDefaultsPublicRector;
use Rector\Symfony\Configs\Rector\Closure\MergeServiceNameTypeRector;
use Rector\Symfony\Configs\Rector\Closure\RemoveConstructorAutowireServiceRector;
use Rector\Symfony\Configs\Rector\Closure\ServiceArgsToServiceNamedArgRector;
Expand All @@ -18,5 +19,7 @@
ServiceSettersToSettersAutodiscoveryRector::class,
ServiceTagsToDefaultsAutoconfigureRector::class,
RemoveConstructorAutowireServiceRector::class,

FromServicePublicToDefaultsPublicRector::class,
]);
};
8 changes: 4 additions & 4 deletions phpstan.neon
Original file line number Diff line number Diff line change
Expand Up @@ -51,11 +51,11 @@ parameters:
- identifier: argument.type
- identifier: assign.propertyType

# avoid notice on run on php 8.3
- identifier: typeCoverage.constantTypeCoverage

# false postitive
-
identifier: typePerfect.narrowPublicClassMethodParamType
path: src/NodeAnalyzer/SymfonyPhpClosureDetector.php
paths:
- src/NodeAnalyzer/SymfonyPhpClosureDetector.php
- rules/Configs/NodeDecorator/ServiceDefaultsCallClosureDecorator.php

- '#Parameter 1 should use "PHPStan\\BetterReflection\\Reflection\\Adapter\\ReflectionMethod" type as the only type passed to this method#'
Original file line number Diff line number Diff line change
@@ -0,0 +1,34 @@
<?php

namespace Rector\Symfony\Tests\Configs\Rector\Closure\ServiceTagsToDefaultsAutoconfigureRector\Fixture;

use Symfony\Component\DependencyInjection\Loader\Configurator\ContainerConfigurator;

return static function (ContainerConfigurator $containerConfigurator): void {
$services = $containerConfigurator->services();

$services->set(SomeCommand::class)
->public();

$services->set(AnotherCommand::class)
->public();
};

?>
-----
<?php

namespace Rector\Symfony\Tests\Configs\Rector\Closure\ServiceTagsToDefaultsAutoconfigureRector\Fixture;

use Symfony\Component\DependencyInjection\Loader\Configurator\ContainerConfigurator;

return static function (ContainerConfigurator $containerConfigurator): void {
$services = $containerConfigurator->services();
$services->defaults()->public();

$services->set(SomeCommand::class);

$services->set(AnotherCommand::class);
};

?>
Original file line number Diff line number Diff line change
@@ -0,0 +1,28 @@
<?php

declare(strict_types=1);

namespace Rector\Symfony\Tests\Configs\Rector\Closure\FromServicePublicToDefaultsPublicRector;

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

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

public static function provideData(): Iterator
{
return self::yieldFilesFromDirectory(__DIR__ . '/Fixture');
}

public function provideConfigFilePath(): string
{
return __DIR__ . '/config/configured_rule.php';
}
}
Original file line number Diff line number Diff line change
@@ -0,0 +1,10 @@
<?php

declare(strict_types=1);

use Rector\Config\RectorConfig;
use Rector\Symfony\Configs\Rector\Closure\FromServicePublicToDefaultsPublicRector;

return static function (RectorConfig $rectorConfig): void {
$rectorConfig->rule(FromServicePublicToDefaultsPublicRector::class);
};
Original file line number Diff line number Diff line change
@@ -0,0 +1,51 @@
<?php

declare(strict_types=1);

namespace Rector\Symfony\Configs\NodeDecorator;

use PhpParser\Node\Expr\Assign;
use PhpParser\Node\Expr\Closure;
use PhpParser\Node\Expr\MethodCall;
use PhpParser\Node\Expr\Variable;
use PhpParser\Node\Stmt\Expression;

final class ServiceDefaultsCallClosureDecorator
{
public function decorate(Closure $closure, string $methodName): void
{
foreach ($closure->stmts as $key => $nodeStmt) {
if (! $nodeStmt instanceof Expression) {
continue;
}

if (! $nodeStmt->expr instanceof Assign) {
continue;
}

$assign = $nodeStmt->expr;
if (! $assign->var instanceof Variable) {
continue;
}

if ($assign->var->name !== 'services') {
continue;
}

$servicesVariable = $assign->var;

// add defaults here, right after assign :)
$autoconfigureExpression = $this->createDefaultsAutoconfigureExpression($methodName);
array_splice($closure->stmts, $key + 1, 0, [$autoconfigureExpression]);
break;
}
}

public function createDefaultsAutoconfigureExpression(string $methodName): Expression
{
$defaultsMethodCall = new MethodCall(new Variable('services'), 'defaults');
$autoconfigureMethodCall = new MethodCall($defaultsMethodCall, $methodName);

return new Expression($autoconfigureMethodCall);
}
}
Original file line number Diff line number Diff line change
@@ -0,0 +1,116 @@
<?php

declare(strict_types=1);

namespace Rector\Symfony\Configs\Rector\Closure;

use PhpParser\Node;
use PhpParser\Node\Expr;
use PhpParser\Node\Expr\Closure;
use PhpParser\Node\Expr\MethodCall;
use Rector\Rector\AbstractRector;
use Rector\Symfony\Configs\NodeDecorator\ServiceDefaultsCallClosureDecorator;
use Rector\Symfony\NodeAnalyzer\SymfonyPhpClosureDetector;
use Symplify\RuleDocGenerator\ValueObject\CodeSample\CodeSample;
use Symplify\RuleDocGenerator\ValueObject\RuleDefinition;

/**
* @see \Rector\Symfony\Tests\Configs\Rector\Closure\FromServicePublicToDefaultsPublicRector\FromServicePublicToDefaultsPublicRectorTest
*/
final class FromServicePublicToDefaultsPublicRector extends AbstractRector
{
public function __construct(
private readonly SymfonyPhpClosureDetector $symfonyPhpClosureDetector,
private readonly ServiceDefaultsCallClosureDecorator $serviceDefaultsCallClosureDecorator
) {
}

public function getRuleDefinition(): RuleDefinition
{
return new RuleDefinition(
'Instead of per service public() call, use it once in defaults()',
[
new CodeSample(
<<<'CODE_SAMPLE'
use Symfony\Component\DependencyInjection\Loader\Configurator\ContainerConfigurator;

return static function (ContainerConfigurator $containerConfigurator): void {
$services = $containerConfigurator->services();

$services->set(SomeCommand::class)
->public();

$services->set(AnotherCommand::class)
->public();

$services->set(NextCommand::class)
->public();
};
CODE_SAMPLE

,
<<<'CODE_SAMPLE'
use Symfony\Component\DependencyInjection\Loader\Configurator\ContainerConfigurator;

return static function (ContainerConfigurator $containerConfigurator): void {
$services = $containerConfigurator->services();

$services->defaults()->public();

$services->set(SomeCommand::class);
$services->set(AnotherCommand::class);
$services->set(NextCommand::class);
};
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;
}

$hasDefaultsPublic = $this->symfonyPhpClosureDetector->hasDefaultsConfigured($node, 'public');

$hasChanged = false;

$this->traverseNodesWithCallable($node->stmts, function (Node $node) use (&$hasChanged): ?Expr {
if (! $node instanceof MethodCall) {
return null;
}

if (! $this->isName($node->name, 'public') && $node->getArgs() === []) {
return null;
}

$hasChanged = true;

return $node->var;
});

if ($hasChanged === false) {
return null;
}

if ($hasDefaultsPublic === false) {
$this->serviceDefaultsCallClosureDecorator->decorate($node, 'public');
}

return $node;
}
}
6 changes: 2 additions & 4 deletions rules/Configs/Rector/Closure/MergeServiceNameTypeRector.php
Original file line number Diff line number Diff line change
Expand Up @@ -10,6 +10,7 @@
use PHPStan\Type\ObjectType;
use Rector\PhpParser\Node\Value\ValueResolver;
use Rector\Rector\AbstractRector;
use Rector\Symfony\Enum\SymfonyClass;
use Rector\Symfony\NodeAnalyzer\SymfonyPhpClosureDetector;
use Symplify\RuleDocGenerator\ValueObject\CodeSample\CodeSample;
use Symplify\RuleDocGenerator\ValueObject\RuleDefinition;
Expand Down Expand Up @@ -131,9 +132,6 @@ private function isSetServices(MethodCall $methodCall): bool
return false;
}

return $this->isObjectType(
$methodCall->var,
new ObjectType('Symfony\Component\DependencyInjection\Loader\Configurator\ServicesConfigurator')
);
return $this->isObjectType($methodCall->var, new ObjectType(SymfonyClass::SERVICES_CONFIGURATOR));
}
}
Original file line number Diff line number Diff line change
Expand Up @@ -21,6 +21,7 @@
use Rector\Exception\ShouldNotHappenException;
use Rector\PhpParser\Node\Value\ValueResolver;
use Rector\Rector\AbstractRector;
use Rector\Symfony\Enum\SymfonyClass;
use Rector\Symfony\MinimalSharedStringSolver;
use Rector\Symfony\NodeAnalyzer\SymfonyPhpClosureDetector;
use Rector\Symfony\ValueObject\ClassNameAndFilePath;
Expand Down Expand Up @@ -130,10 +131,7 @@ public function isBareServicesSetMethodCall(MethodCall $methodCall): bool
return false;
}

if (! $this->isObjectType(
$methodCall->var,
new ObjectType('Symfony\Component\DependencyInjection\Loader\Configurator\ServicesConfigurator')
)) {
if (! $this->isObjectType($methodCall->var, new ObjectType(SymfonyClass::SERVICES_CONFIGURATOR))) {
return false;
}

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -6,13 +6,11 @@

use PhpParser\Node;
use PhpParser\Node\Expr;
use PhpParser\Node\Expr\Assign;
use PhpParser\Node\Expr\Closure;
use PhpParser\Node\Expr\MethodCall;
use PhpParser\Node\Expr\Variable;
use PhpParser\Node\Stmt\Expression;
use Rector\PhpParser\Node\Value\ValueResolver;
use Rector\Rector\AbstractRector;
use Rector\Symfony\Configs\NodeDecorator\ServiceDefaultsCallClosureDecorator;
use Rector\Symfony\NodeAnalyzer\SymfonyPhpClosureDetector;
use Symplify\RuleDocGenerator\ValueObject\CodeSample\CodeSample;
use Symplify\RuleDocGenerator\ValueObject\RuleDefinition;
Expand All @@ -37,6 +35,7 @@ final class ServiceTagsToDefaultsAutoconfigureRector extends AbstractRector
public function __construct(
private readonly SymfonyPhpClosureDetector $symfonyPhpClosureDetector,
private readonly ValueResolver $valueResolver,
private readonly ServiceDefaultsCallClosureDecorator $serviceDefaultsCallClosureDecorator,
) {
}

Expand Down Expand Up @@ -130,44 +129,9 @@ public function refactor(Node $node): ?Node
}

if ($hasDefaultsAutoconfigure === false) {
$this->addDefaultAutoconfigure($node);
$this->serviceDefaultsCallClosureDecorator->decorate($node, 'autoconfigure');
}

return $node;
}

private function createDefaultsAutoconfigureExpression(): Expression
{
$defaultsMethodCall = new MethodCall(new Variable('services'), 'defaults');
$autoconfigureMethodCall = new MethodCall($defaultsMethodCall, 'autoconfigure');

return new Expression($autoconfigureMethodCall);
}

private function addDefaultAutoconfigure(Closure $closure): void
{
foreach ($closure->stmts as $key => $nodeStmt) {
if (! $nodeStmt instanceof Expression) {
continue;
}

if (! $nodeStmt->expr instanceof Assign) {
continue;
}

$assign = $nodeStmt->expr;
if (! $assign->var instanceof Variable) {
continue;
}

if (! $this->isName($assign->var, 'services')) {
continue;
}

// add defaults here, right after assign :)
$autoconfigureExpression = $this->createDefaultsAutoconfigureExpression();
array_splice($closure->stmts, $key + 1, 0, [$autoconfigureExpression]);
break;
}
}
}