[TypeDeclaration] Add ReturnTypeFromStrictNativeFuncCallRector (#2570)

rectorphp · Jun 26, 2022 · 237f255 · 237f255
1 parent e424660
commit 237f255
Show file tree

Hide file tree

Showing 22 changed files with 564 additions and 175 deletions.
diff --git a/build/target-repository/docs/rector_rules_overview.md b/build/target-repository/docs/rector_rules_overview.md
@@ -1,4 +1,4 @@
-# 519 Rules Overview
+# 520 Rules Overview
 
 <br>
 
@@ -94,7 +94,7 @@
 
 - [Transform](#transform) (36)
 
-- [TypeDeclaration](#typedeclaration) (27)
+- [TypeDeclaration](#typedeclaration) (28)
 
 - [Visibility](#visibility) (3)
 
@@ -11894,11 +11894,11 @@ Add return type to function like with return new
 
 <br>
 
-### ReturnTypeFromStrictReturnExprRector
+### ReturnTypeFromStrictBoolReturnExprRector
 
 Add strict return type based on returned strict expr type
 
-- class: [`Rector\TypeDeclaration\Rector\ClassMethod\ReturnTypeFromStrictReturnExprRector`](../rules/TypeDeclaration/Rector/ClassMethod/ReturnTypeFromStrictReturnExprRector.php)
+- class: [`Rector\TypeDeclaration\Rector\ClassMethod\ReturnTypeFromStrictBoolReturnExprRector`](../rules/TypeDeclaration/Rector/ClassMethod/ReturnTypeFromStrictBoolReturnExprRector.php)
 
 ```diff
  final class SomeClass
@@ -11913,6 +11913,25 @@ Add strict return type based on returned strict expr type
 
 <br>
 
+### ReturnTypeFromStrictNativeFuncCallRector
+
+Add strict return type based native function return
+
+- class: [`Rector\TypeDeclaration\Rector\ClassMethod\ReturnTypeFromStrictNativeFuncCallRector`](../rules/TypeDeclaration/Rector/ClassMethod/ReturnTypeFromStrictNativeFuncCallRector.php)
+
+```diff
+ final class SomeClass
+ {
+-    public function run()
++    public function run(): int
+     {
+         return strlen('value');
+     }
+ }
+```
+
+<br>
+
 ### ReturnTypeFromStrictTypedCallRector
 
 Add return type from strict return type of call

diff --git a/config/set/type-declaration-strict.php b/config/set/type-declaration-strict.php
@@ -3,11 +3,13 @@
 declare(strict_types=1);
 
 use Rector\Config\RectorConfig;
+
 use Rector\TypeDeclaration\Rector\ClassMethod\AddMethodCallBasedStrictParamTypeRector;
 use Rector\TypeDeclaration\Rector\ClassMethod\AddVoidReturnTypeWhereNoReturnRector;
 use Rector\TypeDeclaration\Rector\ClassMethod\ArrayShapeFromConstantArrayReturnRector;
 use Rector\TypeDeclaration\Rector\ClassMethod\ReturnTypeFromReturnNewRector;
-use Rector\TypeDeclaration\Rector\ClassMethod\ReturnTypeFromStrictReturnExprRector;
+use Rector\TypeDeclaration\Rector\ClassMethod\ReturnTypeFromStrictBoolReturnExprRector;
+use Rector\TypeDeclaration\Rector\ClassMethod\ReturnTypeFromStrictNativeFuncCallRector;
 use Rector\TypeDeclaration\Rector\ClassMethod\ReturnTypeFromStrictTypedCallRector;
 use Rector\TypeDeclaration\Rector\ClassMethod\ReturnTypeFromStrictTypedPropertyRector;
 use Rector\TypeDeclaration\Rector\Closure\AddClosureReturnTypeRector;
@@ -27,6 +29,7 @@
         TypedPropertyFromStrictGetterMethodReturnTypeRector::class,
         AddMethodCallBasedStrictParamTypeRector::class,
         ArrayShapeFromConstantArrayReturnRector::class,
-        ReturnTypeFromStrictReturnExprRector::class,
+        ReturnTypeFromStrictBoolReturnExprRector::class,
     ]);
+    $rectorConfig->rule(ReturnTypeFromStrictNativeFuncCallRector::class);
 };
diff --git a/...or/Fixture/multi_returns_all_bool.php.inc → ...or/Fixture/multi_returns_all_bool.php.inc b/...or/Fixture/multi_returns_all_bool.php.inc → ...or/Fixture/multi_returns_all_bool.php.inc
@@ -1,6 +1,6 @@
 <?php
 
-namespace Rector\Tests\TypeDeclaration\Rector\ClassMethod\ReturnTypeFromStrictReturnExprRector\Fixture;
+namespace Rector\Tests\TypeDeclaration\Rector\ClassMethod\ReturnTypeFromStrictBoolReturnExprRector\Fixture;
 
 final class MultiReturnsAllBool
 {
@@ -18,7 +18,7 @@ final class MultiReturnsAllBool
 -----
 <?php
 
-namespace Rector\Tests\TypeDeclaration\Rector\ClassMethod\ReturnTypeFromStrictReturnExprRector\Fixture;
+namespace Rector\Tests\TypeDeclaration\Rector\ClassMethod\ReturnTypeFromStrictBoolReturnExprRector\Fixture;
 
 final class MultiReturnsAllBool
 {

diff --git a/...ixture/skip_multi_returns_no_root.php.inc → ...ixture/skip_multi_returns_no_root.php.inc b/...ixture/skip_multi_returns_no_root.php.inc → ...ixture/skip_multi_returns_no_root.php.inc
@@ -1,6 +1,6 @@
 <?php
 
-namespace Rector\Tests\TypeDeclaration\Rector\ClassMethod\ReturnTypeFromStrictReturnExprRector\Fixture;
+namespace Rector\Tests\TypeDeclaration\Rector\ClassMethod\ReturnTypeFromStrictBoolReturnExprRector\Fixture;
 
 final class SkipMultiReturnsNoRoot
 {

diff --git a/...Rector/Fixture/skip_nested_return.php.inc → ...Rector/Fixture/skip_nested_return.php.inc b/...Rector/Fixture/skip_nested_return.php.inc → ...Rector/Fixture/skip_nested_return.php.inc
@@ -1,6 +1,6 @@
 <?php
 
-namespace Rector\Tests\TypeDeclaration\Rector\ClassMethod\ReturnTypeFromStrictReturnExprRector\Fixture;
+namespace Rector\Tests\TypeDeclaration\Rector\ClassMethod\ReturnTypeFromStrictBoolReturnExprRector\Fixture;
 
 final class SkipNestedReturn
 {

diff --git a/...ip_root_return_with_nested_return.php.inc → ...ip_root_return_with_nested_return.php.inc b/...ip_root_return_with_nested_return.php.inc → ...ip_root_return_with_nested_return.php.inc
@@ -1,6 +1,6 @@
 <?php
 
-namespace Rector\Tests\TypeDeclaration\Rector\ClassMethod\ReturnTypeFromStrictReturnExprRector\Fixture;
+namespace Rector\Tests\TypeDeclaration\Rector\ClassMethod\ReturnTypeFromStrictBoolReturnExprRector\Fixture;
 
 final class SkipRootReturnWithNestedReturn
 {

diff --git a/...prRector/Fixture/skip_void_return.php.inc → ...prRector/Fixture/skip_void_return.php.inc b/...prRector/Fixture/skip_void_return.php.inc → ...prRector/Fixture/skip_void_return.php.inc
@@ -1,6 +1,6 @@
 <?php
 
-namespace Rector\Tests\TypeDeclaration\Rector\ClassMethod\ReturnTypeFromStrictReturnExprRector\Fixture;
+namespace Rector\Tests\TypeDeclaration\Rector\ClassMethod\ReturnTypeFromStrictBoolReturnExprRector\Fixture;
 
 final class SkipVoidReturn
 {

diff --git a/...turnExprRector/Fixture/some_class.php.inc → ...turnExprRector/Fixture/some_class.php.inc b/...turnExprRector/Fixture/some_class.php.inc → ...turnExprRector/Fixture/some_class.php.inc
@@ -1,6 +1,6 @@
 <?php
 
-namespace Rector\Tests\TypeDeclaration\Rector\ClassMethod\ReturnTypeFromStrictReturnExprRector\Fixture;
+namespace Rector\Tests\TypeDeclaration\Rector\ClassMethod\ReturnTypeFromStrictBoolReturnExprRector\Fixture;
 
 final class SomeClass
 {
@@ -19,7 +19,7 @@ final class SomeClass
 -----
 <?php
 
-namespace Rector\Tests\TypeDeclaration\Rector\ClassMethod\ReturnTypeFromStrictReturnExprRector\Fixture;
+namespace Rector\Tests\TypeDeclaration\Rector\ClassMethod\ReturnTypeFromStrictBoolReturnExprRector\Fixture;
 
 final class SomeClass
 {

diff --git a/.../Rector/ClassMethod/ReturnTypeFromStrictBoolReturnExprRector/Fixture/some_closure.php.inc b/.../Rector/ClassMethod/ReturnTypeFromStrictBoolReturnExprRector/Fixture/some_closure.php.inc
@@ -0,0 +1,31 @@
+<?php
+
+namespace Rector\Tests\TypeDeclaration\Rector\ClassMethod\ReturnTypeFromStrictBoolReturnExprRector\Fixture;
+
+final class SomeClosure
+{
+    public function run()
+    {
+        return function () {
+            return 100 && true;
+        };
+    }
+}
+
+?>
+-----
+<?php
+
+namespace Rector\Tests\TypeDeclaration\Rector\ClassMethod\ReturnTypeFromStrictBoolReturnExprRector\Fixture;
+
+final class SomeClosure
+{
+    public function run()
+    {
+        return function (): bool {
+            return 100 && true;
+        };
+    }
+}
+
+?>
diff --git a/...ure/void_return_in_inner_function.php.inc → ...ure/void_return_in_inner_function.php.inc b/...ure/void_return_in_inner_function.php.inc → ...ure/void_return_in_inner_function.php.inc
@@ -1,6 +1,6 @@
 <?php
 
-namespace Rector\Tests\TypeDeclaration\Rector\ClassMethod\ReturnTypeFromStrictReturnExprRector\Fixture;
+namespace Rector\Tests\TypeDeclaration\Rector\ClassMethod\ReturnTypeFromStrictBoolReturnExprRector\Fixture;
 
 final class VoidReturnInInnerFunction
 {
@@ -23,7 +23,7 @@ final class VoidReturnInInnerFunction
 -----
 <?php
 
-namespace Rector\Tests\TypeDeclaration\Rector\ClassMethod\ReturnTypeFromStrictReturnExprRector\Fixture;
+namespace Rector\Tests\TypeDeclaration\Rector\ClassMethod\ReturnTypeFromStrictBoolReturnExprRector\Fixture;
 
 final class VoidReturnInInnerFunction
 {

diff --git a/...xture/yield_parent_inner_function.php.inc → ...xture/yield_parent_inner_function.php.inc b/...xture/yield_parent_inner_function.php.inc → ...xture/yield_parent_inner_function.php.inc
@@ -1,6 +1,6 @@
 <?php
 
-namespace Rector\Tests\TypeDeclaration\Rector\ClassMethod\ReturnTypeFromStrictReturnExprRector\Fixture;
+namespace Rector\Tests\TypeDeclaration\Rector\ClassMethod\ReturnTypeFromStrictBoolReturnExprRector\Fixture;
 
 final class YieldParentInnerFunction
 {
@@ -23,7 +23,7 @@ final class YieldParentInnerFunction
 -----
 <?php
 
-namespace Rector\Tests\TypeDeclaration\Rector\ClassMethod\ReturnTypeFromStrictReturnExprRector\Fixture;
+namespace Rector\Tests\TypeDeclaration\Rector\ClassMethod\ReturnTypeFromStrictBoolReturnExprRector\Fixture;
 
 final class YieldParentInnerFunction
 {
@@ -42,4 +42,4 @@ final class YieldParentInnerFunction
     }
 }
 
-?>
+?>
diff --git a/...urnTypeFromStrictReturnExprRectorTest.php → ...ypeFromStrictBoolReturnExprRectorTest.php b/...urnTypeFromStrictReturnExprRectorTest.php → ...ypeFromStrictBoolReturnExprRectorTest.php
@@ -2,13 +2,13 @@
 
 declare(strict_types=1);
 
-namespace Rector\Tests\TypeDeclaration\Rector\ClassMethod\ReturnTypeFromStrictReturnExprRector;
+namespace Rector\Tests\TypeDeclaration\Rector\ClassMethod\ReturnTypeFromStrictBoolReturnExprRector;
 
 use Iterator;
 use Rector\Testing\PHPUnit\AbstractRectorTestCase;
 use Symplify\SmartFileSystem\SmartFileInfo;
 
-final class ReturnTypeFromStrictReturnExprRectorTest extends AbstractRectorTestCase
+final class ReturnTypeFromStrictBoolReturnExprRectorTest extends AbstractRectorTestCase
 {
     /**
      * @dataProvider provideData()

diff --git a/...turnExprRector/config/configured_rule.php → ...turnExprRector/config/configured_rule.php b/...turnExprRector/config/configured_rule.php → ...turnExprRector/config/configured_rule.php
@@ -3,8 +3,8 @@
 declare(strict_types=1);
 
 use Rector\Config\RectorConfig;
-use Rector\TypeDeclaration\Rector\ClassMethod\ReturnTypeFromStrictReturnExprRector;
+use Rector\TypeDeclaration\Rector\ClassMethod\ReturnTypeFromStrictBoolReturnExprRector;
 
 return static function (RectorConfig $rectorConfig): void {
-    $rectorConfig->rule(ReturnTypeFromStrictReturnExprRector::class);
+    $rectorConfig->rule(ReturnTypeFromStrictBoolReturnExprRector::class);
 };
diff --git a/...on/Rector/ClassMethod/ReturnTypeFromStrictNativeFuncCallRector/Fixture/some_class.php.inc b/...on/Rector/ClassMethod/ReturnTypeFromStrictNativeFuncCallRector/Fixture/some_class.php.inc
@@ -0,0 +1,27 @@
+<?php
+
+namespace Rector\Tests\TypeDeclaration\Rector\ClassMethod\ReturnTypeFromStrictNativeFuncCallRector\Fixture;
+
+final class SomeClass
+{
+    public function run()
+    {
+        return strlen('value');
+    }
+}
+
+?>
+-----
+<?php
+
+namespace Rector\Tests\TypeDeclaration\Rector\ClassMethod\ReturnTypeFromStrictNativeFuncCallRector\Fixture;
+
+final class SomeClass
+{
+    public function run(): int
+    {
+        return strlen('value');
+    }
+}
+
+?>
diff --git a/...ReturnTypeFromStrictNativeFuncCallRector/ReturnTypeFromStrictNativeFuncCallRectorTest.php b/...ReturnTypeFromStrictNativeFuncCallRector/ReturnTypeFromStrictNativeFuncCallRectorTest.php
@@ -0,0 +1,33 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Rector\Tests\TypeDeclaration\Rector\ClassMethod\ReturnTypeFromStrictNativeFuncCallRector;
+
+use Iterator;
+use Rector\Testing\PHPUnit\AbstractRectorTestCase;
+use Symplify\SmartFileSystem\SmartFileInfo;
+
+final class ReturnTypeFromStrictNativeFuncCallRectorTest extends AbstractRectorTestCase
+{
+    /**
+     * @dataProvider provideData()
+     */
+    public function test(SmartFileInfo $fileInfo): void
+    {
+        $this->doTestFileInfo($fileInfo);
+    }
+
+    /**
+     * @return Iterator<SmartFileInfo>
+     */
+    public function provideData(): Iterator
+    {
+        return $this->yieldFilesFromDirectory(__DIR__ . '/Fixture');
+    }
+
+    public function provideConfigFilePath(): string
+    {
+        return __DIR__ . '/config/configured_rule.php';
+    }
+}
diff --git a/...on/Rector/ClassMethod/ReturnTypeFromStrictNativeFuncCallRector/config/configured_rule.php b/...on/Rector/ClassMethod/ReturnTypeFromStrictNativeFuncCallRector/config/configured_rule.php
@@ -0,0 +1,11 @@
+<?php
+
+declare(strict_types=1);
+
+use Rector\Config\RectorConfig;
+
+use Rector\TypeDeclaration\Rector\ClassMethod\ReturnTypeFromStrictNativeFuncCallRector;
+
+return static function (RectorConfig $rectorConfig): void {
+    $rectorConfig->rule(ReturnTypeFromStrictNativeFuncCallRector::class);
+};
diff --git a/rules/TypeDeclaration/NodeAnalyzer/ReturnFilter/ExclusiveNativeFuncCallReturnMatcher.php b/rules/TypeDeclaration/NodeAnalyzer/ReturnFilter/ExclusiveNativeFuncCallReturnMatcher.php
@@ -0,0 +1,52 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Rector\TypeDeclaration\NodeAnalyzer\ReturnFilter;
+
+use PhpParser\Node\Expr;
+use PhpParser\Node\Expr\FuncCall;
+use PhpParser\Node\Stmt\Return_;
+use PHPStan\Reflection\FunctionReflection;
+use Rector\Core\Reflection\ReflectionResolver;
+
+final class ExclusiveNativeFuncCallReturnMatcher
+{
+    public function __construct(
+        private readonly ReflectionResolver $reflectionResolver,
+    ) {
+    }
+
+    /**
+     * @param Return_[] $returns
+     * @return FuncCall[]|null
+     */
+    public function match(array $returns): array|null
+    {
+        $funcCalls = [];
+
+        foreach ($returns as $return) {
+            // we need exact expr return
+            if (! $return->expr instanceof Expr) {
+                return null;
+            }
+
+            if (! $return->expr instanceof FuncCall) {
+                return null;
+            }
+
+            $functionReflection = $this->reflectionResolver->resolveFunctionLikeReflectionFromCall($return->expr);
+            if (! $functionReflection instanceof FunctionReflection) {
+                return null;
+            }
+
+            if (! $functionReflection->isBuiltin()) {
+                return null;
+            }
+
+            $funcCalls[] = $return->expr;
+        }
+
+        return $funcCalls;
+    }
+}