[TypeDeclaration] Add BoolReturnTypeFromStrictScalarReturnsRector (#3898

)

build/target-repository/docs/rector_rules_overview.md

@@ -1,4 +1,4 @@
-# 404 Rules Overview
+# 405 Rules Overview
 
 <br>
 
@@ -62,7 +62,7 @@
 
 - [Transform](#transform) (29)
 
-- [TypeDeclaration](#typedeclaration) (39)
+- [TypeDeclaration](#typedeclaration) (40)
 
 - [Visibility](#visibility) (3)
 
@@ -9084,6 +9084,29 @@ Change && and || between nullable objects to instanceof compares
 
 <br>
 
+### BoolReturnTypeFromStrictScalarReturnsRector
+
+Change return type based on strict returns type operations
+
+- class: [`Rector\TypeDeclaration\Rector\ClassMethod\BoolReturnTypeFromStrictScalarReturnsRector`](../rules/TypeDeclaration/Rector/ClassMethod/BoolReturnTypeFromStrictScalarReturnsRector.php)
+
+```diff
+ class SomeClass
+ {
+-    public function resolve($first, $second)
++    public function resolve($first, $second): bool
+     {
+         if ($first) {
+             return false;
+         }
+
+         return $first > $second;
+     }
+ }
+```
+
+<br>
+
 ### DeclareStrictTypesRector
 
 Add declare(strict_types=1) if missing

config/set/type-declaration.php

@@ -13,6 +13,7 @@
 use Rector\TypeDeclaration\Rector\ClassMethod\AddReturnTypeDeclarationBasedOnParentClassMethodRector;
 use Rector\TypeDeclaration\Rector\ClassMethod\AddVoidReturnTypeWhereNoReturnRector;
 use Rector\TypeDeclaration\Rector\ClassMethod\ArrayShapeFromConstantArrayReturnRector;
+use Rector\TypeDeclaration\Rector\ClassMethod\BoolReturnTypeFromStrictScalarReturnsRector;
 use Rector\TypeDeclaration\Rector\ClassMethod\ParamAnnotationIncorrectNullableRector;
 use Rector\TypeDeclaration\Rector\ClassMethod\ParamTypeByMethodCallTypeRector;
 use Rector\TypeDeclaration\Rector\ClassMethod\ParamTypeByParentCallTypeRector;
@@ -72,5 +73,6 @@
         EmptyOnNullableObjectToInstanceOfRector::class,
         PropertyTypeFromStrictSetterGetterRector::class,
         ReturnTypeFromStrictTernaryRector::class,
+        BoolReturnTypeFromStrictScalarReturnsRector::class,
     ]);
 };

phpstan.neon

@@ -763,3 +763,6 @@ parameters:
         - '#Parameter \#3 \$assign of method Rector\\CodeQuality\\Rector\\FunctionLike\\SimplifyUselessVariableRector\:\:processSimplifyUselessVariable\(\) expects PhpParser\\Node\\Expr\\Assign\|PhpParser\\Node\\Expr\\AssignOp, PhpParser\\Node\\Expr given#'
         - '#Anonymous variable in a `\$stmtsAware\->stmts\[\$key \- 1\]\->\.\.\.\(\)` method call can lead to false dead methods\. Make sure the variable type is known#'
         - '#Anonymous variable in a `\$parentNode\->stmts\[\$key\]\->\.\.\.\(\)` method call can lead to false dead methods\. Make sure the variable type is known#'
+        - '#Anonymous variable in a `\$stmtsAware\->stmts\[\$key\]\->\.\.\.\(\)` method call can lead to false dead methods\. Make sure the variable type is known#'
+
+        - '#Cognitive complexity for "Rector\\TypeDeclaration\\Rector\\ClassMethod\\BoolReturnTypeFromStrictScalarReturnsRector\:\:hasOnlyBoolScalarReturnExprs\(\)" is 11, keep it under 10#'

rules-tests/TypeDeclaration/Rector/ClassMethod/BoolReturnTypeFromStrictScalarReturnsRector/BoolReturnTypeFromStrictScalarReturnsRectorTest.php

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

@@ -0,0 +1,17 @@
+<?php
+
+namespace Rector\Tests\TypeDeclaration\Rector\ClassMethod\BoolReturnTypeFromStrictScalarReturnsRector\Fixture;
+
+final class SkipAllNested
+{
+    public function resolve($first, $second)
+    {
+        if ($first) {
+            return false;
+        }
+
+        if ($second) {
+            return $first > $second;
+        }
+    }
+}

rules-tests/TypeDeclaration/Rector/ClassMethod/BoolReturnTypeFromStrictScalarReturnsRector/Fixture/some_class.php.inc

@@ -0,0 +1,35 @@
+<?php
+
+namespace Rector\Tests\TypeDeclaration\Rector\ClassMethod\BoolReturnTypeFromStrictScalarReturnsRector\Fixture;
+
+class SomeClass
+{
+    public function resolve($first, $second)
+    {
+        if ($first) {
+            return false;
+        }
+
+        return $first > $second;
+    }
+}
+
+?>
+-----
+<?php
+
+namespace Rector\Tests\TypeDeclaration\Rector\ClassMethod\BoolReturnTypeFromStrictScalarReturnsRector\Fixture;
+
+class SomeClass
+{
+    public function resolve($first, $second): bool
+    {
+        if ($first) {
+            return false;
+        }
+
+        return $first > $second;
+    }
+}
+
+?>

rules-tests/TypeDeclaration/Rector/ClassMethod/BoolReturnTypeFromStrictScalarReturnsRector/Fixture/with_simple_function.php.inc

@@ -0,0 +1,43 @@
+<?php
+
+namespace Rector\Tests\TypeDeclaration\Rector\ClassMethod\BoolReturnTypeFromStrictScalarReturnsRector\Fixture;
+
+final class WithSimpleFunction
+{
+    public function resolve($first, $second)
+    {
+        if ($first) {
+            return false;
+        }
+
+        if ($second) {
+            return $first > $second;
+        }
+
+        return is_bool($second);
+    }
+}
+
+?>
+-----
+<?php
+
+namespace Rector\Tests\TypeDeclaration\Rector\ClassMethod\BoolReturnTypeFromStrictScalarReturnsRector\Fixture;
+
+final class WithSimpleFunction
+{
+    public function resolve($first, $second): bool
+    {
+        if ($first) {
+            return false;
+        }
+
+        if ($second) {
+            return $first > $second;
+        }
+
+        return is_bool($second);
+    }
+}
+
+?>

rules-tests/TypeDeclaration/Rector/ClassMethod/BoolReturnTypeFromStrictScalarReturnsRector/config/configured_rule.php

@@ -0,0 +1,11 @@
+<?php
+
+declare(strict_types=1);
+
+use Rector\Config\RectorConfig;
+
+use Rector\TypeDeclaration\Rector\ClassMethod\BoolReturnTypeFromStrictScalarReturnsRector;
+
+return static function (RectorConfig $rectorConfig): void {
+    $rectorConfig->rule(BoolReturnTypeFromStrictScalarReturnsRector::class);
+};