ReturnUnionTypeRector now skips nullable types, to prepare space for new nullable rule as off PHP 7.1+

rules-tests/TypeDeclaration/Rector/ClassMethod/ReturnUnionTypeRector/Fixture/false_bool_docblock.php.inc

@@ -26,7 +26,7 @@ namespace Rector\Tests\TypeDeclaration\Rector\ClassMethod\ReturnUnionTypeRector\
 final class FalseBoolDocblock
 {
     /**
-     * @return array|false some description
+     * @return array|bool some description
      */
     public function run(): array|false
     {

rules-tests/TypeDeclaration/Rector/ClassMethod/ReturnUnionTypeRector/FixturePhp81/skip_nullable_handled_by_another_rule.php.inc

@@ -0,0 +1,15 @@
+<?php
+
+namespace Rector\Tests\TypeDeclaration\Rector\ClassMethod\ReturnUnionTypeRector\FixturePhp81;
+
+final class SkipNullableHandledByAnotherRule
+{
+    public function run($value)
+    {
+        if ($value) {
+            return null;
+        }
+
+        return false;
+    }
+}

rules-tests/TypeDeclaration/Rector/ClassMethod/ReturnUnionTypeRector/FixtureTrueInUnion/skip_nullable_handled_by_another_rule.php.inc

@@ -0,0 +1,16 @@
+<?php
+
+namespace Rector\Tests\TypeDeclaration\Rector\ClassMethod\ReturnUnionTypeRector\FixtureTrueInUnion;
+
+final class SkipNullableHandledByAnotherRule
+{
+    public function run($value)
+    {
+
+        if (rand(0, 1)) {
+            return false;
+        }
+
+        return null;
+    }
+}

rules-tests/TypeDeclaration/Rector/Closure/AddClosureUnionReturnTypeRector/Fixture/skip_nullable_array.php.inc

@@ -0,0 +1,17 @@
+<?php
+
+namespace Rector\Tests\TypeDeclaration\Rector\Closure\AddClosureUnionReturnTypeRector\Fixture;
+
+final class SkipNullableArray
+{
+    public function run()
+    {
+        function () {
+            if (rand(0, 1)) {
+                return [];
+            }
+
+            return null;
+        };
+    }
+}

rules/TypeDeclaration/NodeManipulator/AddUnionReturnType.php

@@ -6,16 +6,11 @@
 
 use PhpParser\Node;
 use PhpParser\Node\Expr\Closure;
+use PhpParser\Node\NullableType;
 use PhpParser\Node\Stmt\ClassMethod;
 use PhpParser\Node\Stmt\Function_;
 use PHPStan\Analyser\Scope;
-use PHPStan\PhpDocParser\Ast\PhpDoc\ReturnTagValueNode;
-use PHPStan\PhpDocParser\Ast\Type\IdentifierTypeNode;
-use PHPStan\Type\Constant\ConstantBooleanType;
 use PHPStan\Type\UnionType;
-use Rector\BetterPhpDocParser\PhpDocInfo\PhpDocInfoFactory;
-use Rector\BetterPhpDocParser\ValueObject\Type\BracketsAwareUnionTypeNode;
-use Rector\Comments\NodeDocBlock\DocBlockUpdater;
 use Rector\PHPStanStaticTypeMapper\Enum\TypeKind;
 use Rector\PHPStanStaticTypeMapper\TypeMapper\UnionTypeMapper;
 use Rector\TypeDeclaration\TypeInferer\ReturnTypeInferer;
@@ -26,18 +21,23 @@
     public function __construct(
         private ReturnTypeInferer $returnTypeInferer,
         private UnionTypeMapper $unionTypeMapper,
-        private PhpDocInfoFactory $phpDocInfoFactory,
-        private DocBlockUpdater $docBlockUpdater,
         private ClassMethodReturnTypeOverrideGuard $classMethodReturnTypeOverrideGuard,
     ) {
     }
 
+    /**
+     * @template TCallLike as ClassMethod|Function_|Closure
+     *
+     * @param TCallLike $node
+     * @return TCallLike|null
+     */
     public function add(ClassMethod|Function_|Closure $node, Scope $scope): ClassMethod|Function_|Closure|null
     {
         if ($node->stmts === null) {
             return null;
         }
 
+        // type is already known
         if ($node->returnType instanceof Node) {
             return null;
         }
@@ -59,45 +59,12 @@ public function add(ClassMethod|Function_|Closure $node, Scope $scope): ClassMet
             return null;
         }
 
-        $this->mapStandaloneSubType($node, $inferReturnType);
+        // handled by another PHP 7.1 rule with broader scope
+        if ($returnType instanceof NullableType) {
+            return null;
+        }
 
         $node->returnType = $returnType;
         return $node;
     }
-
-    private function mapStandaloneSubType(ClassMethod|Function_|Closure $node, UnionType $unionType): void
-    {
-        $value = null;
-
-        foreach ($unionType->getTypes() as $type) {
-            if ($type instanceof ConstantBooleanType) {
-                $value = $type->getValue() ? 'true' : 'false';
-                break;
-            }
-        }
-
-        if ($value === null) {
-            return;
-        }
-
-        $phpDocInfo = $this->phpDocInfoFactory->createFromNodeOrEmpty($node);
-        $returnType = $phpDocInfo->getReturnTagValue();
-
-        if (! $returnType instanceof ReturnTagValueNode) {
-            return;
-        }
-
-        if (! $returnType->type instanceof BracketsAwareUnionTypeNode) {
-            return;
-        }
-
-        foreach ($returnType->type->types as $key => $type) {
-            if ($type instanceof IdentifierTypeNode && $type->__toString() === 'bool') {
-                $returnType->type->types[$key] = new IdentifierTypeNode($value);
-                $this->docBlockUpdater->updateRefactoredNodeWithPhpDocInfo($node);
-
-                break;
-            }
-        }
-    }
 }