Implement ReturnTypeFromStrictParamRector (#4501)

* Implement ReturnTypeFromStrictParamRector

* more tests

* Create skip_closure.php.inc

* Update skip_closure.php.inc

* fix

* more tests

* fix names

* more tests, symplify

* skip union return types

* simplify

* skip magic

* Update skip_closure.php.inc

* cleanup

* fix

* Update type-declaration.php

* Create skip_already_return_typed.inc

* Update skip_already_return_typed.inc

* cover indirect modification by reference

* Update skip_assign_by_ref.php.inc

* simplify

Co-authored-by: Abdul Malik Ikhsan <samsonasik@gmail.com>

* earlier $node->stmts check

* fix

* Revert "fix"

This reverts commit 82107dd.

* Revert "earlier $node->stmts check"

This reverts commit 6d61b59.

* fix phpstan

---------

Co-authored-by: Abdul Malik Ikhsan <samsonasik@gmail.com>

config/set/type-declaration.php

@@ -26,6 +26,7 @@
 use Rector\TypeDeclaration\Rector\ClassMethod\ReturnTypeFromStrictConstantReturnRector;
 use Rector\TypeDeclaration\Rector\ClassMethod\ReturnTypeFromStrictNativeCallRector;
 use Rector\TypeDeclaration\Rector\ClassMethod\ReturnTypeFromStrictNewArrayRector;
+use Rector\TypeDeclaration\Rector\ClassMethod\ReturnTypeFromStrictParamRector;
 use Rector\TypeDeclaration\Rector\ClassMethod\ReturnTypeFromStrictTypedCallRector;
 use Rector\TypeDeclaration\Rector\ClassMethod\ReturnTypeFromStrictTypedPropertyRector;
 use Rector\TypeDeclaration\Rector\ClassMethod\StrictArrayParamDimFetchRector;
@@ -62,6 +63,7 @@
         ReturnTypeFromStrictNativeCallRector::class,
         ReturnTypeFromStrictNewArrayRector::class,
         ReturnTypeFromStrictScalarReturnExprRector::class,
+        ReturnTypeFromStrictParamRector::class,
         TypedPropertyFromStrictSetUpRector::class,
         ParamTypeByParentCallTypeRector::class,
         AddParamTypeSplFixedArrayRector::class,

rules-tests/TypeDeclaration/Rector/ClassMethod/ReturnTypeFromStrictParamRector/Fixture/example.php.inc

@@ -0,0 +1,23 @@
+<?php
+
+namespace Rector\Tests\TypeDeclaration\Rector\ClassMethod\ReturnTypeFromStrictParamRector\Fixture;
+
+class Example {
+    public function doFoo(Example $param) {
+        return $param;
+    }
+}
+
+?>
+-----
+<?php
+
+namespace Rector\Tests\TypeDeclaration\Rector\ClassMethod\ReturnTypeFromStrictParamRector\Fixture;
+
+class Example {
+    public function doFoo(Example $param): Example {
+        return $param;
+    }
+}
+
+?>

rules-tests/TypeDeclaration/Rector/ClassMethod/ReturnTypeFromStrictParamRector/Fixture/example_nullable.php.inc

@@ -0,0 +1,23 @@
+<?php
+
+namespace Rector\Tests\TypeDeclaration\Rector\ClassMethod\ReturnTypeFromStrictParamRector\Fixture;
+
+class ExampleNullable {
+    public function doFoo(?ExampleNullable $param) {
+        return $param;
+    }
+}
+
+?>
+-----
+<?php
+
+namespace Rector\Tests\TypeDeclaration\Rector\ClassMethod\ReturnTypeFromStrictParamRector\Fixture;
+
+class ExampleNullable {
+    public function doFoo(?ExampleNullable $param): ?ExampleNullable {
+        return $param;
+    }
+}
+
+?>

rules-tests/TypeDeclaration/Rector/ClassMethod/ReturnTypeFromStrictParamRector/Fixture/example_scalar.php.inc

@@ -0,0 +1,23 @@
+<?php
+
+namespace Rector\Tests\TypeDeclaration\Rector\ClassMethod\ReturnTypeFromStrictParamRector\Fixture;
+
+class ExampleInt {
+    public function doFoo(int $param) {
+        return $param;
+    }
+}
+
+?>
+-----
+<?php
+
+namespace Rector\Tests\TypeDeclaration\Rector\ClassMethod\ReturnTypeFromStrictParamRector\Fixture;
+
+class ExampleInt {
+    public function doFoo(int $param): int {
+        return $param;
+    }
+}
+
+?>

rules-tests/TypeDeclaration/Rector/ClassMethod/ReturnTypeFromStrictParamRector/Fixture/example_with_call.php.inc

@@ -0,0 +1,31 @@
+<?php
+
+namespace Rector\Tests\TypeDeclaration\Rector\ClassMethod\ReturnTypeFromStrictParamRector\Fixture;
+
+class ExampleWithCall {
+    public function doFoo(ExampleWithCall $param) {
+        $this->doBar($param);
+
+        return $param;
+    }
+
+    public function doBar($ref) {}
+}
+
+?>
+-----
+<?php
+
+namespace Rector\Tests\TypeDeclaration\Rector\ClassMethod\ReturnTypeFromStrictParamRector\Fixture;
+
+class ExampleWithCall {
+    public function doFoo(ExampleWithCall $param): ExampleWithCall {
+        $this->doBar($param);
+
+        return $param;
+    }
+
+    public function doBar($ref) {}
+}
+
+?>

rules-tests/TypeDeclaration/Rector/ClassMethod/ReturnTypeFromStrictParamRector/Fixture/skill_null_return.php.inc

@@ -0,0 +1,12 @@
+<?php
+
+namespace Rector\Tests\TypeDeclaration\Rector\ClassMethod\ReturnTypeFromStrictParamRector\Fixture;
+
+class SkipNullReturn {
+    public function doFoo(SkipNullReturn $param) {
+        if (rand(0,1)) {
+            return null;
+        }
+        return $param;
+    }
+}

rules-tests/TypeDeclaration/Rector/ClassMethod/ReturnTypeFromStrictParamRector/Fixture/skip_already_return_typed.inc

@@ -0,0 +1,10 @@
+<?php
+
+namespace Rector\Tests\TypeDeclaration\Rector\ClassMethod\ReturnTypeFromStrictParamRector\Fixture;
+
+class SkipAlreadyReturnTyped {
+    public function doFoo(SkipAlreadyReturnTyped $param): int {
+        return $param;
+    }
+}
+

rules-tests/TypeDeclaration/Rector/ClassMethod/ReturnTypeFromStrictParamRector/Fixture/skip_assign.php.inc

@@ -0,0 +1,12 @@
+<?php
+
+namespace Rector\Tests\TypeDeclaration\Rector\ClassMethod\ReturnTypeFromStrictParamRector\Fixture;
+
+class SkipAssign {
+    public function doFoo(SkipAssign $param) {
+        $param = 4;
+
+        return $param;
+    }
+}
+

rules-tests/TypeDeclaration/Rector/ClassMethod/ReturnTypeFromStrictParamRector/Fixture/skip_assign_by_ref.php.inc

@@ -0,0 +1,14 @@
+<?php
+
+namespace Rector\Tests\TypeDeclaration\Rector\ClassMethod\ReturnTypeFromStrictParamRector\Fixture;
+
+class SkipAssignByRef {
+    public function doFoo(SkipAssignByRef $param) {
+        $z = &$param;
+
+        $z = 5;
+
+        return $param;
+    }
+}
+

rules-tests/TypeDeclaration/Rector/ClassMethod/ReturnTypeFromStrictParamRector/Fixture/skip_call_by_ref.php.inc

@@ -0,0 +1,14 @@
+<?php
+
+namespace Rector\Tests\TypeDeclaration\Rector\ClassMethod\ReturnTypeFromStrictParamRector\Fixture;
+
+class SkipCallbByRef {
+    public function doFoo(SkipCallbByRef $param) {
+        $this->doBar($param);
+
+        return $param;
+    }
+
+    public function doBar(&$ref) {}
+}
+

rules-tests/TypeDeclaration/Rector/ClassMethod/ReturnTypeFromStrictParamRector/Fixture/skip_closure.php.inc

@@ -0,0 +1,14 @@
+<?php
+
+namespace Rector\Tests\TypeDeclaration\Rector\ClassMethod\ReturnTypeFromStrictParamRector\Fixture;
+
+class SkipClosure {
+    public function doFoo() {
+        // we have other rules which add closure return types
+        // leave it as is
+        $c = function (SkipClosure $param) {
+            return $param;
+        };
+        return $c;
+    }
+}

rules-tests/TypeDeclaration/Rector/ClassMethod/ReturnTypeFromStrictParamRector/Fixture/skip_conditional_return.php.inc

@@ -0,0 +1,14 @@
+<?php
+
+namespace Rector\Tests\TypeDeclaration\Rector\ClassMethod\ReturnTypeFromStrictParamRector\Fixture;
+
+class SkipConditionalReturn {
+    public function doFoo(SkipAssign $param) {
+        if (rand(0,1)) {
+            return 4;
+        }
+
+        return $param;
+    }
+}
+

rules-tests/TypeDeclaration/Rector/ClassMethod/ReturnTypeFromStrictParamRector/Fixture/skip_magic.php.inc

@@ -0,0 +1,11 @@
+<?php
+
+namespace Rector\Tests\TypeDeclaration\Rector\ClassMethod\ReturnTypeFromStrictParamRector\Fixture;
+
+class SkipMagic
+{
+    public function __get(string $name)
+    {
+        return $name;
+    }
+}

rules-tests/TypeDeclaration/Rector/ClassMethod/ReturnTypeFromStrictParamRector/Fixture/skip_multiple_returns.php.inc

@@ -0,0 +1,15 @@
+<?php
+
+namespace Rector\Tests\TypeDeclaration\Rector\ClassMethod\ReturnTypeFromStrictParamRector\Fixture;
+
+class SkipMultipleReturns {
+    public function doFoo(SkipMultipleReturns $param, B $param2) {
+        if (rand(0,1)) {
+            return $param2;
+        }
+
+        return $param;
+    }
+}
+
+class B {}

rules-tests/TypeDeclaration/Rector/ClassMethod/ReturnTypeFromStrictParamRector/Fixture/skip_parent_overridden.php.inc

@@ -0,0 +1,15 @@
+<?php
+
+namespace Rector\Tests\TypeDeclaration\Rector\ClassMethod\ReturnTypeFromStrictParamRector\Fixture;
+
+class SkipParentOverridden extends SkipParentOverriddenBase {
+    public function doFoo(SkipParentOverridden $param) {
+        return $param;
+    }
+}
+
+
+class SkipParentOverriddenBase {
+    public function doFoo(SkipParentOverridden $param) {
+    }
+}

rules-tests/TypeDeclaration/Rector/ClassMethod/ReturnTypeFromStrictParamRector/Fixture/skip_phpdoc.php.inc

@@ -0,0 +1,13 @@
+<?php
+
+namespace Rector\Tests\TypeDeclaration\Rector\ClassMethod\ReturnTypeFromStrictParamRector\Fixture;
+
+class SkipPhpdoc {
+    /**
+     * @param SkipPhpdoc  $param
+     */
+    public function doFoo($param) {
+        return $param;
+    }
+}
+

rules-tests/TypeDeclaration/Rector/ClassMethod/ReturnTypeFromStrictParamRector/Fixture/skip_union.php.inc

@@ -0,0 +1,14 @@
+<?php
+
+namespace Rector\Tests\TypeDeclaration\Rector\ClassMethod\ReturnTypeFromStrictParamRector\Fixture;
+
+class SkipUnion
+{
+    public function run(A|B $p)
+    {
+        return $p;
+    }
+}
+
+class A {}
+class B {}

rules-tests/TypeDeclaration/Rector/ClassMethod/ReturnTypeFromStrictParamRector/Fixture/skip_void.php.inc

@@ -0,0 +1,13 @@
+<?php
+
+namespace Rector\Tests\TypeDeclaration\Rector\ClassMethod\ReturnTypeFromStrictParamRector\Fixture;
+
+class SkipPossibleVoid
+{
+    public function run(int $p)
+    {
+        if (rand(0, 1)) {
+            return $p;
+        }
+    }
+}

rules-tests/TypeDeclaration/Rector/ClassMethod/ReturnTypeFromStrictParamRector/ReturnTypeFromStrictParamRectorTest.php

@@ -0,0 +1,28 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Rector\Tests\TypeDeclaration\Rector\ClassMethod\ReturnTypeFromStrictParamRector;
+
+use Iterator;
+use PHPUnit\Framework\Attributes\DataProvider;
+use Rector\Testing\PHPUnit\AbstractRectorTestCase;
+
+final class ReturnTypeFromStrictParamRectorTest 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/TypeDeclaration/Rector/ClassMethod/ReturnTypeFromStrictParamRector/config/configured_rule.php

@@ -0,0 +1,12 @@
+<?php
+
+declare(strict_types=1);
+
+use Rector\Config\RectorConfig;
+use Rector\Core\ValueObject\PhpVersion;
+use Rector\TypeDeclaration\Rector\ClassMethod\ReturnTypeFromStrictParamRector;
+
+return static function (RectorConfig $rectorConfig): void {
+    $rectorConfig->rule(ReturnTypeFromStrictParamRector::class);
+    $rectorConfig->phpVersion(PhpVersion::PHP_74);
+};