[code-quality] Add ParamTypeFromDependsRector

Author: TomasVotruba

config/sets/phpunit-code-quality.php

@@ -3,6 +3,7 @@
 declare(strict_types=1);
 
 use Rector\Config\RectorConfig;
+use Rector\PHPUnit\CodeQuality\Rector\Class_\AddParamTypeFromDependsRector;
 use Rector\PHPUnit\CodeQuality\Rector\Class_\ConstructClassMethodToSetUpTestCaseRector;
 use Rector\PHPUnit\CodeQuality\Rector\Class_\NarrowUnusedSetUpDefinedPropertyRector;
 use Rector\PHPUnit\CodeQuality\Rector\Class_\PreferPHPUnitThisCallRector;
@@ -70,6 +71,7 @@
         // type declarations
         TypeWillReturnCallableArrowFunctionRector::class,
         StringCastAssertStringContainsStringRector::class,
+        AddParamTypeFromDependsRector::class,
 
         NarrowUnusedSetUpDefinedPropertyRector::class,
 

rules-tests/CodeQuality/Rector/Class_/AddParamTypeFromDependsRector/AddParamTypeFromDependsRectorTest.php

@@ -0,0 +1,28 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Rector\PHPUnit\Tests\CodeQuality\Rector\Class_\AddParamTypeFromDependsRector;
+
+use Iterator;
+use PHPUnit\Framework\Attributes\DataProvider;
+use Rector\Testing\PHPUnit\AbstractRectorTestCase;
+
+final class AddParamTypeFromDependsRectorTest 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/CodeQuality/Rector/Class_/AddParamTypeFromDependsRector/Fixture/depends_with_brackets.php.inc

@@ -0,0 +1,45 @@
+<?php
+
+namespace Rector\PHPUnit\Tests\CodeQuality\Rector\Class_\AddParamTypeFromDependsRector\Fixture;
+
+use PHPUnit\Framework\TestCase;
+
+final class DependsWithBrackets extends TestCase
+{
+    public function test(): \stdClass
+    {
+        return new \stdClass();
+    }
+
+    /**
+     * @depends test()
+     */
+    public function testWithDepends($value)
+    {
+    }
+}
+
+?>
+-----
+<?php
+
+namespace Rector\PHPUnit\Tests\CodeQuality\Rector\Class_\AddParamTypeFromDependsRector\Fixture;
+
+use PHPUnit\Framework\TestCase;
+
+final class DependsWithBrackets extends TestCase
+{
+    public function test(): \stdClass
+    {
+        return new \stdClass();
+    }
+
+    /**
+     * @depends test()
+     */
+    public function testWithDepends(\stdClass $value)
+    {
+    }
+}
+
+?>

rules-tests/CodeQuality/Rector/Class_/AddParamTypeFromDependsRector/Fixture/skip_known_param.php.inc

@@ -0,0 +1,20 @@
+<?php
+
+namespace Rector\PHPUnit\Tests\CodeQuality\Rector\Class_\AddParamTypeFromDependsRector\Fixture;
+
+use PHPUnit\Framework\TestCase;
+
+final class SkipKnownParam extends TestCase
+{
+    public function test(): \stdClass
+    {
+        return new \stdClass();
+    }
+
+    /**
+     * @depends test
+     */
+    public function testWithDepends(\stdClass $value)
+    {
+    }
+}

rules-tests/CodeQuality/Rector/Class_/AddParamTypeFromDependsRector/Fixture/some_test.php.inc

@@ -0,0 +1,45 @@
+<?php
+
+namespace Rector\PHPUnit\Tests\CodeQuality\Rector\Class_\AddParamTypeFromDependsRector\Fixture;
+
+use PHPUnit\Framework\TestCase;
+
+final class SomeFileTest extends TestCase
+{
+    public function test(): \stdClass
+    {
+        return new \stdClass();
+    }
+
+    /**
+     * @depends test
+     */
+    public function testWithDepends($value)
+    {
+    }
+}
+
+?>
+-----
+<?php
+
+namespace Rector\PHPUnit\Tests\CodeQuality\Rector\Class_\AddParamTypeFromDependsRector\Fixture;
+
+use PHPUnit\Framework\TestCase;
+
+final class SomeFileTest extends TestCase
+{
+    public function test(): \stdClass
+    {
+        return new \stdClass();
+    }
+
+    /**
+     * @depends test
+     */
+    public function testWithDepends(\stdClass $value)
+    {
+    }
+}
+
+?>

rules-tests/CodeQuality/Rector/Class_/AddParamTypeFromDependsRector/config/configured_rule.php

@@ -0,0 +1,9 @@
+<?php
+
+declare(strict_types=1);
+
+use Rector\Config\RectorConfig;
+use Rector\PHPUnit\CodeQuality\Rector\Class_\AddParamTypeFromDependsRector;
+
+return RectorConfig::configure()
+    ->withRules([AddParamTypeFromDependsRector::class]);

rules/CodeQuality/Rector/Class_/AddParamTypeFromDependsRector.php

@@ -0,0 +1,153 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Rector\PHPUnit\CodeQuality\Rector\Class_;
+
+use PhpParser\Node;
+use PhpParser\Node\Stmt\Class_;
+use PhpParser\Node\Stmt\ClassMethod;
+use PHPStan\PhpDocParser\Ast\PhpDoc\PhpDocTagNode;
+use Rector\BetterPhpDocParser\PhpDocInfo\PhpDocInfo;
+use Rector\BetterPhpDocParser\PhpDocInfo\PhpDocInfoFactory;
+use Rector\PHPUnit\NodeAnalyzer\TestsNodeAnalyzer;
+use Rector\Rector\AbstractRector;
+use Symplify\RuleDocGenerator\ValueObject\CodeSample\CodeSample;
+use Symplify\RuleDocGenerator\ValueObject\RuleDefinition;
+
+/**
+ * @see \Rector\PHPUnit\Tests\CodeQuality\Rector\Class_\AddParamTypeFromDependsRector\AddParamTypeFromDependsRectorTest
+ */
+final class AddParamTypeFromDependsRector extends AbstractRector
+{
+    public function __construct(
+        private readonly TestsNodeAnalyzer $testsNodeAnalyzer,
+        private readonly PhpDocInfoFactory $phpDocInfoFactory,
+    ) {
+    }
+
+    public function getRuleDefinition(): RuleDefinition
+    {
+        return new RuleDefinition(
+            'Add param type declaration based on @depends test method return type',
+            [
+                new CodeSample(
+                    <<<'CODE_SAMPLE'
+use PHPUnit\Framework\TestCase;
+
+final class SomeTest extends TestCase
+{
+    public function test()
+    {
+        return new \stdClass();
+    }
+
+    /**
+     * @depends test
+     */
+    public function testAnother($someObject)
+    {
+    }
+}
+CODE_SAMPLE
+
+                    ,
+                    <<<'CODE_SAMPLE'
+use PHPUnit\Framework\TestCase;
+
+final class SomeTest extends TestCase
+{
+    public function test()
+    {
+        return new \stdClass();
+    }
+
+    /**
+     * @depends test
+     */
+    public function testAnother(\stdClass $someObject)
+    {
+    }
+}
+CODE_SAMPLE
+                ),
+            ]
+        );
+    }
+
+    /**
+     * @return array<class-string<Node>>
+     */
+    public function getNodeTypes(): array
+    {
+        return [Class_::class];
+    }
+
+    /**
+     * @param Class_ $node
+     */
+    public function refactor(Node $node): ?Node
+    {
+        if (! $this->testsNodeAnalyzer->isInTestClass($node)) {
+            return null;
+        }
+
+        $hasChanged = false;
+
+        foreach ($node->getMethods() as $classMethod) {
+            if (! $classMethod->isPublic()) {
+                continue;
+            }
+
+            if (count($classMethod->params) !== 1) {
+                continue;
+            }
+
+            $soleParam = $classMethod->getParams()[0];
+
+            // already known type
+            if ($soleParam->type instanceof Node) {
+                continue;
+            }
+
+            $dependsReturnType = $this->resolveReturnTypeOfDependsMethod($classMethod, $node);
+            if (! $dependsReturnType instanceof Node) {
+                continue;
+            }
+
+            $soleParam->type = $dependsReturnType;
+            $hasChanged = true;
+        }
+
+        if ($hasChanged === false) {
+            return null;
+        }
+
+        return $node;
+    }
+
+    private function resolveReturnTypeOfDependsMethod(ClassMethod $classMethod, Class_ $class): ?Node
+    {
+        $phpDocInfo = $this->phpDocInfoFactory->createFromNode($classMethod);
+        if (! $phpDocInfo instanceof PhpDocInfo) {
+            return null;
+        }
+
+        $dependsTagValueNode = $phpDocInfo->getByName('depends');
+        if (! $dependsTagValueNode instanceof PhpDocTagNode) {
+            return null;
+        }
+
+        $dependsMethodName = (string) $dependsTagValueNode->value;
+        $dependsMethodName = trim($dependsMethodName, '()');
+
+        $dependsClassMethod = $class->getMethod($dependsMethodName);
+
+        if (! $dependsClassMethod instanceof ClassMethod) {
+            return null;
+        }
+
+        // resolve return type here
+        return $dependsClassMethod->returnType;
+    }
+}