Laravel App Analyzer (#328)

* Simplify getting Laravel version * Updated --------- Co-authored-by: Geni Jaho <jahogeni@gmail.com>

Author: peterfox

phpstan.neon

@@ -28,9 +28,5 @@ parameters:
 
  - '#Parameter \#1 \$className of method Rector\\Reflection\\ReflectionResolver\:\:resolveMethodReflection\(\) expects class\-string, string given#'
 
- # Laravel Container not being recognized properly in some of the tests
- - '#Call to method needs\(\) on an unknown class Illuminate\\Contracts\\Container\\ContextualBindingBuilder#'
- - '#Cannot call method give\(\) on mixed.#'
-
  # No easy replacement for this check, it's also ignored in core Rector
  - '#Doing instanceof PHPStan\\Type\\Generic\\GenericObjectType is error\-prone and deprecated#'

src/NodeAnalyzer/ApplicationAnalyzer.php

@@ -0,0 +1,57 @@
+<?php
+
+namespace RectorLaravel\NodeAnalyzer;
+
+use ReflectionClassConstant;
+use RuntimeException;
+
+class ApplicationAnalyzer
+{
+ private ?string $version = null;
+
+ public function __construct(
+ private string $applicationClass = 'Illuminate\Foundation\Application',
+ ) {}
+
+ public function setVersion(?string $version): static
+ {
+ $this->version = $version;
+
+ return $this;
+ }
+
+ public function setApplicationClass(string $applicationClass): static
+ {
+ $this->applicationClass = $applicationClass;
+
+ return $this;
+ }
+
+ public function getApplicationClass(): string
+ {
+ return $this->applicationClass;
+ }
+
+ /**
+ * @param '>='|'='|'<=' $comparison
+ */
+ public function isVersion(string $comparison, string $version): bool
+ {
+ return version_compare($this->getVersion(), $version, $comparison);
+ }
+
+ public function getVersion(): string
+ {
+ if ($this->version !== null) {
+ return $this->version;
+ }
+
+ $reflectionClassConstant = new ReflectionClassConstant($this->applicationClass, 'VERSION');
+
+ if (! is_string($version = $reflectionClassConstant->getValue())) {
+ throw new RuntimeException('expected VERSION to be a string, got ' . gettype($version));
+ }
+
+ return $version;
+ }
+}

src/Rector/ClassMethod/AddGenericReturnTypeToRelationsRector.php

@@ -26,7 +26,7 @@
 use Rector\PHPStan\ScopeFetcher;
 use Rector\StaticTypeMapper\StaticTypeMapper;
 use RectorLaravel\AbstractRector;
-use ReflectionClassConstant;
+use RectorLaravel\NodeAnalyzer\ApplicationAnalyzer;
 use Symplify\RuleDocGenerator\ValueObject\CodeSample\CodeSample;
 use Symplify\RuleDocGenerator\ValueObject\RuleDefinition;
 
@@ -60,7 +60,7 @@ public function __construct(
  private readonly BetterNodeFinder $betterNodeFinder,
  private readonly StaticTypeMapper $staticTypeMapper,
  private readonly ReflectionProvider $reflectionProvider,
- private readonly string $applicationClass = 'Illuminate\Foundation\Application',
+ private readonly ApplicationAnalyzer $applicationAnalyzer,
  ) {}
 
  public function getRuleDefinition(): RuleDefinition
@@ -484,19 +484,17 @@ private function getGenericTypes(Node $node, string $relatedClass, ?string $chil
 
  private function setShouldUseNewGenerics(): void
  {
- $reflectionClassConstant = new ReflectionClassConstant($this->applicationClass, 'VERSION');
-
- if (is_string($reflectionClassConstant->getValue())) {
- $this->shouldUseNewGenerics = version_compare($reflectionClassConstant->getValue(), '11.15.0', '>=');
- }
+ $this->shouldUseNewGenerics = $this->applicationAnalyzer->isVersion(
+ '>=',
+ '11.15.0'
+ );
  }
 
  private function setShouldUsePivotGeneric(): void
  {
- $reflectionClassConstant = new ReflectionClassConstant($this->applicationClass, 'VERSION');
-
- if (is_string($reflectionClassConstant->getValue())) {
- $this->shouldUsePivotGeneric = version_compare($reflectionClassConstant->getValue(), '12.3.0', '>=');
- }
+ $this->shouldUsePivotGeneric = $this->applicationAnalyzer->isVersion(
+ '>=',
+ '12.3.0'
+ );
  }
 }

stubs/Illuminate/Foundation/Application.php

@@ -13,6 +13,8 @@
 
 class Application extends Container implements ApplicationContract
 {
+ const VERSION = '12.0.0';
+
  public function tagged(string $tagName): iterable
  {
  return [];

tests/Rector/ClassMethod/AddGenericReturnTypeToRelationsRector/AddGenericReturnTypeToRelationsRectorNewGenericsTest.php

@@ -7,9 +7,12 @@
 use Iterator;
 use PHPUnit\Framework\Attributes\DataProvider;
 use Rector\Testing\PHPUnit\AbstractRectorTestCase;
+use RectorLaravel\Tests\Support\InteractsWithLaravelVersion;
 
 final class AddGenericReturnTypeToRelationsRectorNewGenericsTest extends AbstractRectorTestCase
 {
+ use InteractsWithLaravelVersion;
+
  public static function provideData(): Iterator
  {
  return self::yieldFilesFromDirectory(__DIR__ . '/Fixture/NewGenerics');
@@ -26,6 +29,11 @@ public function test(string $filePath): void
 
  public function provideConfigFilePath(): string
  {
- return __DIR__ . '/config/use_new_generics_configured_rule.php';
+ return __DIR__ . '/config/configured_rule.php';
+ }
+
+ public function version(): string
+ {
+ return '12.3.0';
  }
 }

tests/Rector/ClassMethod/AddGenericReturnTypeToRelationsRector/AddGenericReturnTypeToRelationsRectorOldGenericsTest.php

@@ -7,9 +7,12 @@
 use Iterator;
 use PHPUnit\Framework\Attributes\DataProvider;
 use Rector\Testing\PHPUnit\AbstractRectorTestCase;
+use RectorLaravel\Tests\Support\InteractsWithLaravelVersion;
 
 final class AddGenericReturnTypeToRelationsRectorOldGenericsTest extends AbstractRectorTestCase
 {
+ use InteractsWithLaravelVersion;
+
  public static function provideData(): Iterator
  {
  return self::yieldFilesFromDirectory(__DIR__ . '/Fixture/OldGenerics');
@@ -26,6 +29,11 @@ public function test(string $filePath): void
 
  public function provideConfigFilePath(): string
  {
- return __DIR__ . '/config/use_old_generics_configured_rule.php';
+ return __DIR__ . '/config/configured_rule.php';
+ }
+
+ public function version(): string
+ {
+ return '11.14.0';
  }
 }

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

@@ -4,14 +4,9 @@
 
 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->when(AddGenericReturnTypeToRelationsRector::class)
- ->needs('$applicationClass')
- ->give(NewApplication::class);
-
  $rectorConfig->rule(AddGenericReturnTypeToRelationsRector::class);
 };