Detect Laravel version within the AddGenericReturnTypeToRelationsRector rule

Author: GeniJaho

src/Rector/ClassMethod/AddGenericReturnTypeToRelationsRector.php

@@ -22,20 +22,19 @@
 use Rector\BetterPhpDocParser\PhpDocInfo\PhpDocInfoFactory;
 use Rector\BetterPhpDocParser\ValueObject\Type\FullyQualifiedIdentifierTypeNode;
 use Rector\Comments\NodeDocBlock\DocBlockUpdater;
-use Rector\Contract\Rector\ConfigurableRectorInterface;
 use Rector\NodeTypeResolver\TypeComparator\TypeComparator;
 use Rector\PhpParser\Node\BetterNodeFinder;
 use Rector\Rector\AbstractScopeAwareRector;
 use Rector\StaticTypeMapper\StaticTypeMapper;
-use Symplify\RuleDocGenerator\ValueObject\CodeSample\ConfiguredCodeSample;
+use ReflectionClassConstant;
+use Symplify\RuleDocGenerator\ValueObject\CodeSample\CodeSample;
 use Symplify\RuleDocGenerator\ValueObject\RuleDefinition;
-use Webmozart\Assert\Assert;
 
 /**
  * @see \RectorLaravel\Tests\Rector\ClassMethod\AddGenericReturnTypeToRelationsRector\AddGenericReturnTypeToRelationsRectorNewGenericsTest
  * @see \RectorLaravel\Tests\Rector\ClassMethod\AddGenericReturnTypeToRelationsRector\AddGenericReturnTypeToRelationsRectorOldGenericsTest
  */
-class AddGenericReturnTypeToRelationsRector extends AbstractScopeAwareRector implements ConfigurableRectorInterface
+class AddGenericReturnTypeToRelationsRector extends AbstractScopeAwareRector
 {
     // Relation methods which are supported by this Rector.
     private const RELATION_METHODS = [
@@ -59,6 +58,7 @@ public function __construct(
         private readonly PhpDocInfoFactory $phpDocInfoFactory,
         private readonly BetterNodeFinder $betterNodeFinder,
         private readonly StaticTypeMapper $staticTypeMapper,
+        private readonly string $applicationClass = 'Illuminate\Foundation\Application',
     ) {
     }
 
@@ -67,7 +67,7 @@ public function getRuleDefinition(): RuleDefinition
         return new RuleDefinition(
             'Add generic return type to relations in child of Illuminate\Database\Eloquent\Model',
             [
-                new ConfiguredCodeSample(
+                new CodeSample(
                     <<<'CODE_SAMPLE'
 use App\Account;
 use Illuminate\Database\Eloquent\Model;
@@ -96,9 +96,9 @@ public function accounts(): HasMany
         return $this->hasMany(Account::class);
     }
 }
-CODE_SAMPLE,
-                    ['shouldUseNewGenerics' => false]),
-                new ConfiguredCodeSample(
+CODE_SAMPLE
+                ),
+                new CodeSample(
                     <<<'CODE_SAMPLE'
 use App\Account;
 use Illuminate\Database\Eloquent\Model;
@@ -127,8 +127,8 @@ public function accounts(): HasMany
         return $this->hasMany(Account::class);
     }
 }
-CODE_SAMPLE,
-                    ['shouldUseNewGenerics' => true]),
+CODE_SAMPLE
+                ),
             ]
         );
     }
@@ -196,6 +196,9 @@ public function refactorWithScope(Node $node, Scope $scope): ?Node
             return null;
         }
 
+        // Put here to make the check as late as possible
+        $this->setShouldUseNewGenerics();
+
         $classForChildGeneric = $this->getClassForChildGeneric($scope, $relationMethodCall);
         $classForIntermediateGeneric = $this->getClassForIntermediateGeneric($relationMethodCall);
 
@@ -232,24 +235,6 @@ public function refactorWithScope(Node $node, Scope $scope): ?Node
         return $node;
     }
 
-    /**
-     * {@inheritDoc}
-     */
-    public function configure(array $configuration): void
-    {
-        if ($configuration === []) {
-            $this->shouldUseNewGenerics = false;
-
-            return;
-        }
-
-        Assert::count($configuration, 1);
-        Assert::keyExists($configuration, 'shouldUseNewGenerics');
-        Assert::boolean($configuration['shouldUseNewGenerics']);
-
-        $this->shouldUseNewGenerics = $configuration['shouldUseNewGenerics'];
-    }
-
     private function getRelatedModelClassFromMethodCall(MethodCall $methodCall): ?string
     {
         $argType = $this->getType($methodCall->getArgs()[0]->value);
@@ -489,4 +474,13 @@ private function getGenericTypes(string $relatedClass, ?string $childClass, ?str
 
         return $generics;
     }
+
+    private function setShouldUseNewGenerics(): void
+    {
+        $laravelVersion = new ReflectionClassConstant($this->applicationClass, 'VERSION');
+
+        if (is_string($laravelVersion->getValue())) {
+            $this->shouldUseNewGenerics = version_compare($laravelVersion->getValue(), '11.15.0', '>=');
+        }
+    }
 }

tests/Rector/ClassMethod/AddGenericReturnTypeToRelationsRector/AddGenericReturnTypeToRelationsRectorNewGenericsTest.php

@@ -12,7 +12,6 @@ final class AddGenericReturnTypeToRelationsRectorNewGenericsTest extends Abstrac
 {
     public static function provideData(): Iterator
     {
-        //        yield [__DIR__ . '/Fixture/NewGenerics/has-one-through.php.inc'];
         return self::yieldFilesFromDirectory(__DIR__ . '/Fixture/NewGenerics');
     }
 

tests/Rector/ClassMethod/AddGenericReturnTypeToRelationsRector/Source/NewApplication.php

@@ -0,0 +1,10 @@
+<?php
+
+namespace RectorLaravel\Tests\Rector\ClassMethod\AddGenericReturnTypeToRelationsRector\Source;
+
+use Illuminate\Foundation\Application;
+
+class NewApplication extends Application
+{
+    const VERSION = '11.15.0';
+}

tests/Rector/ClassMethod/AddGenericReturnTypeToRelationsRector/Source/OldApplication.php

@@ -0,0 +1,10 @@
+<?php
+
+namespace RectorLaravel\Tests\Rector\ClassMethod\AddGenericReturnTypeToRelationsRector\Source;
+
+use Illuminate\Foundation\Application;
+
+class OldApplication extends Application
+{
+    const VERSION = '11.14.0';
+}

tests/Rector/ClassMethod/AddGenericReturnTypeToRelationsRector/config/use_new_generics_configured_rule.php

@@ -4,11 +4,14 @@
 
 use Rector\Config\RectorConfig;
 use RectorLaravel\Rector\ClassMethod\AddGenericReturnTypeToRelationsRector;
+use RectorLaravel\Tests\Rector\ClassMethod\AddGenericReturnTypeToRelationsRector\Source\NewApplication;
 
 return static function (RectorConfig $rectorConfig): void {
     $rectorConfig->import(__DIR__ . '/../../../../../config/config.php');
 
-    $rectorConfig->ruleWithConfiguration(AddGenericReturnTypeToRelationsRector::class, [
-        'shouldUseNewGenerics' => true,
-    ]);
+    $rectorConfig->when(AddGenericReturnTypeToRelationsRector::class)
+        ->needs('$applicationClass')
+        ->give(NewApplication::class);
+
+    $rectorConfig->rule(AddGenericReturnTypeToRelationsRector::class);
 };

tests/Rector/ClassMethod/AddGenericReturnTypeToRelationsRector/config/use_old_generics_configured_rule.php

@@ -4,9 +4,14 @@
 
 use Rector\Config\RectorConfig;
 use RectorLaravel\Rector\ClassMethod\AddGenericReturnTypeToRelationsRector;
+use RectorLaravel\Tests\Rector\ClassMethod\AddGenericReturnTypeToRelationsRector\Source\OldApplication;
 
 return static function (RectorConfig $rectorConfig): void {
     $rectorConfig->import(__DIR__ . '/../../../../../config/config.php');
 
-    $rectorConfig->ruleWithConfiguration(AddGenericReturnTypeToRelationsRector::class, []);
+    $rectorConfig->when(AddGenericReturnTypeToRelationsRector::class)
+        ->needs('$applicationClass')
+        ->give(OldApplication::class);
+
+    $rectorConfig->rule(AddGenericReturnTypeToRelationsRector::class);
 };