[doctrine-fixtures] Add AddGetReferenceTypeRector (#381)

TomasVotruba · web-flow · commit 208b9ef54e45 · 2025-05-04T22:20:11.000Z
* cs

* [data-fixture] Add AddGetReferenceTypeRector
diff --git a/README.md b/README.md
@@ -20,21 +20,11 @@ To add a set to your config, use `->withPreparedSets` method, and pick one of co
 use Rector\Config\RectorConfig;
 
 return RectorConfig::configure()
-    ->withPreparedSets(doctrineCodeQuality: true);
+    ->withPreparedSets(doctrineCodeQuality: true)
+    ->withComposerBased(doctrine: true);
 ```
 
-If you're on PHP 7.x, you can use withSets() instead, for `doctrineCodeQuality` set, so you can define:
-
-```php
-use Rector\Config\RectorConfig;
-use Rector\Doctrine\Set\DoctrineSetList;
-
-return RectorConfig::configure()
-    ->withSets([
-        DoctrineSetList::DOCTRINE_CODE_QUALITY,
-    ]);
-```
-See [documentation](https://getrector.com/documentation)
+See [documentation](https://getrector.com/documentation) for more.
 
 <br>
 
diff --git a/composer.json b/composer.json
@@ -5,20 +5,20 @@
     "description": "Rector upgrades rules for Doctrine",
     "require": {
         "php": ">=8.2",
-        "symfony/yaml": "^7.1"
+        "symfony/yaml": "^7.2"
     },
     "require-dev": {
         "doctrine/doctrine-bundle": "^2.13",
         "doctrine/orm": "^2.20",
         "phpstan/extension-installer": "^1.4",
-        "phpstan/phpstan": "^2.1.8",
+        "phpstan/phpstan": "^2.1.14",
         "phpstan/phpstan-deprecation-rules": "^2.0",
         "phpstan/phpstan-webmozart-assert": "^2.0",
         "phpunit/phpunit": "^11.5",
         "rector/rector-src": "dev-main",
-        "rector/type-perfect": "^2.0",
+        "rector/type-perfect": "^2.1",
         "phpecs/phpecs": "^2.1",
-        "symplify/phpstan-rules": "^14.0",
+        "symplify/phpstan-rules": "^14.6.9",
         "symplify/vendor-patches": "^11.3",
         "tomasvotruba/class-leak": "^2.0",
         "tracy/tracy": "^2.10"
diff --git a/config/sets/data-fixtures-16.php b/config/sets/data-fixtures-16.php
@@ -0,0 +1,10 @@
+<?php
+
+declare(strict_types=1);
+
+use Rector\Config\RectorConfig;
+use Rector\Doctrine\DoctrineFixture\Rector\MethodCall\AddGetReferenceTypeRector;
+
+return static function (RectorConfig $rectorConfig): void {
+    $rectorConfig->rules([AddGetReferenceTypeRector::class]);
+};
diff --git a/rules-tests/DoctrineFixture/Rector/MethodCall/AddGetReferenceTypeRector/AddGetReferenceTypeRectorTest.php b/rules-tests/DoctrineFixture/Rector/MethodCall/AddGetReferenceTypeRector/AddGetReferenceTypeRectorTest.php
@@ -0,0 +1,28 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Rector\Doctrine\Tests\DoctrineFixture\Rector\MethodCall\AddGetReferenceTypeRector;
+
+use Iterator;
+use PHPUnit\Framework\Attributes\DataProvider;
+use Rector\Testing\PHPUnit\AbstractRectorTestCase;
+
+final class AddGetReferenceTypeRectorTest 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';
+    }
+}
diff --git a/rules-tests/DoctrineFixture/Rector/MethodCall/AddGetReferenceTypeRector/Fixture/simple_get_reference.php.inc b/rules-tests/DoctrineFixture/Rector/MethodCall/AddGetReferenceTypeRector/Fixture/simple_get_reference.php.inc
@@ -0,0 +1,37 @@
+<?php
+
+namespace Rector\Doctrine\Tests\DoctrineFixture\Rector\MethodCall\AddGetReferenceTypeRector\Fixture;
+
+use Doctrine\Common\DataFixtures\AbstractFixture;
+use Rector\Doctrine\Tests\DoctrineFixture\Rector\MethodCall\AddGetReferenceTypeRector\Source\SomeEntity;
+
+final class SimpleGetReference extends AbstractFixture
+{
+    public function run(SomeEntity $someEntity)
+    {
+        $someEntity->setSomePassedEntity(
+            $this->getReference('some-id')
+        );
+    }
+}
+
+?>
+-----
+<?php
+
+namespace Rector\Doctrine\Tests\DoctrineFixture\Rector\MethodCall\AddGetReferenceTypeRector\Fixture;
+
+use Doctrine\Common\DataFixtures\AbstractFixture;
+use Rector\Doctrine\Tests\DoctrineFixture\Rector\MethodCall\AddGetReferenceTypeRector\Source\SomeEntity;
+
+final class SimpleGetReference extends AbstractFixture
+{
+    public function run(SomeEntity $someEntity)
+    {
+        $someEntity->setSomePassedEntity(
+            $this->getReference('some-id', \Rector\Doctrine\Tests\DoctrineFixture\Rector\MethodCall\AddGetReferenceTypeRector\Source\SomePassedEntity::class)
+        );
+    }
+}
+
+?>
diff --git a/rules-tests/DoctrineFixture/Rector/MethodCall/AddGetReferenceTypeRector/Fixture/skip_already_filled_type.php.inc b/rules-tests/DoctrineFixture/Rector/MethodCall/AddGetReferenceTypeRector/Fixture/skip_already_filled_type.php.inc
@@ -0,0 +1,17 @@
+<?php
+
+namespace Rector\Doctrine\Tests\DoctrineFixture\Rector\MethodCall\AddGetReferenceTypeRector\Fixture;
+
+use Doctrine\Common\DataFixtures\AbstractFixture;
+use Rector\Doctrine\Tests\DoctrineFixture\Rector\MethodCall\AddGetReferenceTypeRector\Source\SomeEntity;
+use Rector\Doctrine\Tests\DoctrineFixture\Rector\MethodCall\AddGetReferenceTypeRector\Source\SomePassedEntity;
+
+final class SkipAlreadyFilledType extends AbstractFixture
+{
+    public function run(SomeEntity $someEntity)
+    {
+        $someEntity->setSomePassedEntity(
+            $this->getReference('some-id', SomePassedEntity::class)
+        );
+    }
+}
diff --git a/rules-tests/DoctrineFixture/Rector/MethodCall/AddGetReferenceTypeRector/Fixture/skip_no_abstract_fixture.php.inc b/rules-tests/DoctrineFixture/Rector/MethodCall/AddGetReferenceTypeRector/Fixture/skip_no_abstract_fixture.php.inc
@@ -0,0 +1,16 @@
+<?php
+
+namespace Rector\Doctrine\Tests\DoctrineFixture\Rector\MethodCall\AddGetReferenceTypeRector\Fixture;
+
+use Doctrine\Common\DataFixtures\AbstractFixture;
+use Rector\Doctrine\Tests\DoctrineFixture\Rector\MethodCall\AddGetReferenceTypeRector\Source\SomeEntity;
+
+final class SimpleGetReference
+{
+    public function run(SomeEntity $someEntity)
+    {
+        $someEntity->setSomePassedEntity(
+            $this->getReference('some-id')
+        );
+    }
+}
diff --git a/rules-tests/DoctrineFixture/Rector/MethodCall/AddGetReferenceTypeRector/Fixture/skip_outside_getter.php.inc b/rules-tests/DoctrineFixture/Rector/MethodCall/AddGetReferenceTypeRector/Fixture/skip_outside_getter.php.inc
@@ -0,0 +1,17 @@
+<?php
+
+namespace Rector\Doctrine\Tests\DoctrineFixture\Rector\MethodCall\AddGetReferenceTypeRector\Fixture;
+
+use Doctrine\Common\DataFixtures\AbstractFixture;
+use Rector\Doctrine\Tests\DoctrineFixture\Rector\MethodCall\AddGetReferenceTypeRector\Source\SomeEntity;
+
+final class SkipOutsideGetter extends AbstractFixture
+{
+    public function run(SomeEntity $someEntity)
+    {
+        $unableToResolve = $this->getReference('some-id');
+        $someEntity->setSomePassedEntity(
+            $unableToResolve
+        );
+    }
+}
diff --git a/rules-tests/DoctrineFixture/Rector/MethodCall/AddGetReferenceTypeRector/Source/SomeEntity.php b/rules-tests/DoctrineFixture/Rector/MethodCall/AddGetReferenceTypeRector/Source/SomeEntity.php
@@ -0,0 +1,13 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Rector\Doctrine\Tests\DoctrineFixture\Rector\MethodCall\AddGetReferenceTypeRector\Source;
+
+final class SomeEntity
+{
+    public function setSomePassedEntity(?SomePassedEntity $somePassedEntity)
+    {
+
+    }
+}
diff --git a/rules-tests/DoctrineFixture/Rector/MethodCall/AddGetReferenceTypeRector/Source/SomePassedEntity.php b/rules-tests/DoctrineFixture/Rector/MethodCall/AddGetReferenceTypeRector/Source/SomePassedEntity.php
@@ -0,0 +1,7 @@
+<?php
+
+namespace Rector\Doctrine\Tests\DoctrineFixture\Rector\MethodCall\AddGetReferenceTypeRector\Source;
+
+class SomePassedEntity
+{
+}
diff --git a/rules-tests/DoctrineFixture/Rector/MethodCall/AddGetReferenceTypeRector/config/configured_rule.php b/rules-tests/DoctrineFixture/Rector/MethodCall/AddGetReferenceTypeRector/config/configured_rule.php
@@ -0,0 +1,10 @@
+<?php
+
+declare(strict_types=1);
+
+use Rector\Config\RectorConfig;
+use Rector\Doctrine\DoctrineFixture\Rector\MethodCall\AddGetReferenceTypeRector;
+
+return static function (RectorConfig $rectorConfig): void {
+    $rectorConfig->rule(AddGetReferenceTypeRector::class);
+};
diff --git a/rules/CodeQuality/Rector/Property/ImproveDoctrineCollectionDocTypeInEntityRector.php b/rules/CodeQuality/Rector/Property/ImproveDoctrineCollectionDocTypeInEntityRector.php
@@ -230,7 +230,7 @@ private function refactorPropertyPhpDocInfo(Property $property, PhpDocInfo $phpD
             $hasChanged = $this->phpDocTypeChanger->changeVarType($property, $phpDocInfo, $newVarType);
         }
 
-        if (!$hasChanged) {
+        if (! $hasChanged) {
             return null;
         }
 
diff --git a/rules/DoctrineFixture/Rector/MethodCall/AddGetReferenceTypeRector.php b/rules/DoctrineFixture/Rector/MethodCall/AddGetReferenceTypeRector.php
@@ -0,0 +1,129 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Rector\Doctrine\DoctrineFixture\Rector\MethodCall;
+
+use PhpParser\Node;
+use PhpParser\Node\Arg;
+use PhpParser\Node\Expr\ClassConstFetch;
+use PhpParser\Node\Expr\MethodCall;
+use PhpParser\Node\Name\FullyQualified;
+use PHPStan\Reflection\ClassReflection;
+use PHPStan\Type\ObjectType;
+use Rector\Doctrine\DoctrineFixture\Reflection\ParameterTypeResolver;
+use Rector\Doctrine\Enum\DoctrineClass;
+use Rector\PHPStan\ScopeFetcher;
+use Rector\Rector\AbstractRector;
+use Symplify\RuleDocGenerator\ValueObject\CodeSample\CodeSample;
+use Symplify\RuleDocGenerator\ValueObject\RuleDefinition;
+
+/**
+ * @see \Rector\Doctrine\Tests\DoctrineFixture\Rector\MethodCall\AddGetReferenceTypeRector\AddGetReferenceTypeRectorTest
+ *
+ * @see https://github.com/doctrine/data-fixtures/pull/409/files
+ */
+final class AddGetReferenceTypeRector extends AbstractRector
+{
+    public function __construct(
+        private readonly ParameterTypeResolver $parameterTypeResolver,
+    ) {
+    }
+
+    /**
+     * @return array<class-string<Node>>
+     */
+    public function getNodeTypes(): array
+    {
+        return [MethodCall::class];
+    }
+
+    public function getRuleDefinition(): RuleDefinition
+    {
+        return new RuleDefinition(
+            'Change $this->getReference() in data fixtures to fill reference class directly',
+            [
+                new CodeSample(
+                    <<<'CODE_SAMPLE'
+use Doctrine\Common\DataFixtures\AbstractDataFixture;
+
+final class SomeFixture extends AbstractDataFixture
+{
+    public function run(SomeEntity $someEntity)
+    {
+        $someEntity->setSomePassedEntity($this->getReference('some-key'));
+    }
+}
+CODE_SAMPLE
+                    ,
+                    <<<'CODE_SAMPLE'
+use Doctrine\Common\DataFixtures\AbstractDataFixture;
+
+final class SomeFixture extends AbstractDataFixture
+{
+    public function run(SomeEntity $someEntity)
+    {
+        $someEntity->setSomePassedEntity($this->getReference('some-key'), SomeReference::class);
+    }
+}
+CODE_SAMPLE
+                ),
+            ]
+        );
+    }
+
+    /**
+     * @param MethodCall $node
+     */
+    public function refactor(Node $node): MethodCall|null
+    {
+        if (! $this->isInAbstractFixture($node)) {
+            return null;
+        }
+
+        if ($node->isFirstClassCallable()) {
+            return null;
+        }
+
+        if (count($node->getArgs()) !== 1) {
+            return null;
+        }
+
+        $soleArg = $node->getArgs()[0];
+        if (! $soleArg->value instanceof MethodCall) {
+            return null;
+        }
+
+        $nestedMethodCall = $soleArg->value;
+        if (! $this->isName($nestedMethodCall->name, 'getReference')) {
+            return null;
+        }
+
+        // already filled type
+        if (count($nestedMethodCall->getArgs()) === 2) {
+            return null;
+        }
+
+        $callerParameterObjetType = $this->parameterTypeResolver->resolveCallerFirstParameterObjectType($node);
+        if (! $callerParameterObjetType instanceof ObjectType) {
+            return null;
+        }
+
+        $nestedMethodCall->args[] = new Arg(new ClassConstFetch(new FullyQualified(
+            $callerParameterObjetType->getClassName()
+        ), 'class'));
+        return $node;
+    }
+
+    private function isInAbstractFixture(MethodCall $methodCall): bool
+    {
+        $scope = ScopeFetcher::fetch($methodCall);
+
+        $classReflection = $scope->getClassReflection();
+        if (! $classReflection instanceof ClassReflection) {
+            return false;
+        }
+
+        return $classReflection->is(DoctrineClass::ABSTRACT_FIXTURE);
+    }
+}
diff --git a/rules/DoctrineFixture/Reflection/ParameterTypeResolver.php b/rules/DoctrineFixture/Reflection/ParameterTypeResolver.php
diff --git a/src/Enum/DoctrineClass.php b/src/Enum/DoctrineClass.php
diff --git a/src/Set/SetProvider/DoctrineSetProvider.php b/src/Set/SetProvider/DoctrineSetProvider.php
diff --git a/stubs/Doctrine/Common/DataFixtures/AbstractFixture.php b/stubs/Doctrine/Common/DataFixtures/AbstractFixture.php
diff --git a/tests/Set/DoctrineCOLLECTION22Set/Fixture/criteria_to_order.php.inc b/tests/Set/DoctrineCOLLECTION22Set/Fixture/criteria_to_order.php.inc

-Original file line number
+Diff line change
@@ @@ -0,0 +1,7 @@ @@
 +<?php
++
 +namespace Rector\Doctrine\Tests\DoctrineFixture\Rector\MethodCall\AddGetReferenceTypeRector\Source;
++
 +class SomePassedEntity
 +{
 +}