[DependencyInjection] Extract GetByTypeMethodCallToConstructorInjectionRector to make migration smoother (#685)

* tidy up

* [DependencyInjection] Extract GetByTypeMethodCallToConstructorInjectionRector to make migration smoother

Author: TomasVotruba

config/sets/symfony/symfony-constructor-injection.php

@@ -9,6 +9,10 @@
 
 return static function (RectorConfig $rectorConfig): void {
     $rectorConfig->rules([
+        // modern step-by-step narrow approach
+        \Rector\Symfony\DependencyInjection\Rector\Class_\ControllerGetByTypeToConstructorInjectionRector::class,
+
+        // legacy rules that require container fetch
         ContainerGetToConstructorInjectionRector::class,
         ContainerGetNameToTypeInTestsRector::class,
         GetToConstructorInjectionRector::class,

rules-tests/DependencyInjection/Rector/Class_/ControllerGetByTypeToConstructorInjectionRector/ControllerGetByTypeToConstructorInjectionRectorTest.php

@@ -0,0 +1,28 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Rector\Symfony\Tests\DependencyInjection\Rector\Class_\ControllerGetByTypeToConstructorInjectionRector;
+
+use Iterator;
+use PHPUnit\Framework\Attributes\DataProvider;
+use Rector\Testing\PHPUnit\AbstractRectorTestCase;
+
+final class ControllerGetByTypeToConstructorInjectionRectorTest 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';
+    }
+}

rules-tests/DependencyInjection/Rector/Class_/ControllerGetByTypeToConstructorInjectionRector/Fixture/controller_get_with_type.php.inc

@@ -0,0 +1,36 @@
+<?php
+
+namespace Rector\Symfony\Tests\DependencyInjection\Rector\Class_\ControllerGetByTypeToConstructorInjectionRector\Fixture;
+
+use Rector\Symfony\Tests\DependencyInjection\Rector\Class_\ControllerGetByTypeToConstructorInjectionRector\Source\SomeService;
+use Symfony\Bundle\FrameworkBundle\Controller\Controller;
+
+final class ControllerGetWithType extends Controller
+{
+    public function configure()
+    {
+        $someType = $this->get(SomeService::class);
+    }
+}
+
+?>
+-----
+<?php
+
+namespace Rector\Symfony\Tests\DependencyInjection\Rector\Class_\ControllerGetByTypeToConstructorInjectionRector\Fixture;
+
+use Rector\Symfony\Tests\DependencyInjection\Rector\Class_\ControllerGetByTypeToConstructorInjectionRector\Source\SomeService;
+use Symfony\Bundle\FrameworkBundle\Controller\Controller;
+
+final class ControllerGetWithType extends Controller
+{
+    public function __construct(private \Rector\Symfony\Tests\DependencyInjection\Rector\Class_\ControllerGetByTypeToConstructorInjectionRector\Source\SomeService $someService)
+    {
+    }
+    public function configure()
+    {
+        $someType = $this->someService;
+    }
+}
+
+?>

rules-tests/DependencyInjection/Rector/Class_/ControllerGetByTypeToConstructorInjectionRector/Fixture/skip_another_get.php.inc

@@ -0,0 +1,14 @@
+<?php
+
+namespace Rector\Symfony\Tests\DependencyInjection\Rector\Class_\ControllerGetByTypeToConstructorInjectionRector\Fixture;
+
+use Rector\Symfony\Tests\DependencyInjection\Rector\Class_\ControllerGetByTypeToConstructorInjectionRector\Source\SomeService;
+use Symfony\Bundle\FrameworkBundle\Controller\Controller;
+
+final class SkipAnotherGet extends Controller
+{
+    public function configure()
+    {
+        $someType = $this->some->get(SomeService::class);
+    }
+}

rules-tests/DependencyInjection/Rector/Class_/ControllerGetByTypeToConstructorInjectionRector/Fixture/skip_non_controller.php.inc

@@ -0,0 +1,13 @@
+<?php
+
+namespace Rector\Symfony\Tests\DependencyInjection\Rector\Class_\ControllerGetByTypeToConstructorInjectionRector\Fixture;
+
+use Rector\Symfony\Tests\DependencyInjection\Rector\Class_\ControllerGetByTypeToConstructorInjectionRector\Source\SomeService;
+
+final class SkipNonController
+{
+    public function configure()
+    {
+        $someType = $this->get(SomeService::class);
+    }
+}

rules-tests/DependencyInjection/Rector/Class_/ControllerGetByTypeToConstructorInjectionRector/Source/SomeService.php

@@ -0,0 +1,8 @@
+<?php
+
+namespace Rector\Symfony\Tests\DependencyInjection\Rector\Class_\ControllerGetByTypeToConstructorInjectionRector\Source;
+
+final class SomeService
+{
+
+}

rules-tests/DependencyInjection/Rector/Class_/ControllerGetByTypeToConstructorInjectionRector/config/configured_rule.php

@@ -0,0 +1,11 @@
+<?php
+
+declare(strict_types=1);
+
+use Rector\Config\RectorConfig;
+
+return static function (RectorConfig $rectorConfig): void {
+    $rectorConfig->rule(
+        \Rector\Symfony\DependencyInjection\Rector\Class_\ControllerGetByTypeToConstructorInjectionRector::class
+    );
+};

rules-tests/Symfony42/Rector/MethodCall/ContainerGetToConstructorInjectionRector/Fixture/skip_test_case_static_call.php.inc

@@ -0,0 +1,44 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Rector\Symfony\DependencyInjection\NodeDecorator;
+
+use PhpParser\Node\Expr\StaticCall;
+use PhpParser\Node\Name;
+use PhpParser\Node\Stmt\Class_;
+use PhpParser\Node\Stmt\ClassMethod;
+use PhpParser\Node\Stmt\Expression;
+use PHPStan\Type\ObjectType;
+use Rector\NodeTypeResolver\NodeTypeResolver;
+use Rector\ValueObject\MethodName;
+
+final class CommandConstructorDecorator
+{
+    public function __construct(
+        private NodeTypeResolver $nodeTypeResolver
+    ) {
+    }
+
+    public function decorate(Class_ $class): void
+    {
+        // special case for command to keep parent constructor call
+        if (! $this->nodeTypeResolver->isObjectType(
+            $class,
+            new ObjectType('Symfony\Component\Console\Command\Command')
+        )) {
+            return;
+        }
+
+        $constuctClassMethod = $class->getMethod(MethodName::CONSTRUCT);
+        if (! $constuctClassMethod instanceof ClassMethod) {
+            return;
+        }
+
+        // empty stmts? add parent::__construct() to setup command
+        if ((array) $constuctClassMethod->stmts === []) {
+            $parentConstructStaticCall = new StaticCall(new Name('parent'), '__construct');
+            $constuctClassMethod->stmts[] = new Expression($parentConstructStaticCall);
+        }
+    }
+}