From 8ff7747eab74154d32f76c9db4443762567e6dda Mon Sep 17 00:00:00 2001
From: Jean-Luc Herren <jlh@gmx.ch>
Date: Wed, 29 Mar 2023 00:36:37 +0200
Subject: [PATCH] RemoveNonExistingVarAnnotationRector: Allow return
 annotations (#3534)

Fixes rectorphp/rector#7859
---
 .../Fixture/return_annotation_invalid.php.inc | 28 +++++++++++++++++++
 .../return_annotation_unwanted.php.inc        | 28 +++++++++++++++++++
 .../skip_direct_return_func_call.php.inc      | 12 ++++++++
 .../RemoveNonExistingVarAnnotationRector.php  | 14 ++++++++++
 4 files changed, 82 insertions(+)
 create mode 100644 rules-tests/DeadCode/Rector/Node/RemoveNonExistingVarAnnotationRector/Fixture/return_annotation_invalid.php.inc
 create mode 100644 rules-tests/DeadCode/Rector/Node/RemoveNonExistingVarAnnotationRector/Fixture/return_annotation_unwanted.php.inc
 create mode 100644 rules-tests/DeadCode/Rector/Node/RemoveNonExistingVarAnnotationRector/Fixture/skip_direct_return_func_call.php.inc

diff --git a/rules-tests/DeadCode/Rector/Node/RemoveNonExistingVarAnnotationRector/Fixture/return_annotation_invalid.php.inc b/rules-tests/DeadCode/Rector/Node/RemoveNonExistingVarAnnotationRector/Fixture/return_annotation_invalid.php.inc
new file mode 100644
index 00000000000..b1c385cbc17
--- /dev/null
+++ b/rules-tests/DeadCode/Rector/Node/RemoveNonExistingVarAnnotationRector/Fixture/return_annotation_invalid.php.inc
@@ -0,0 +1,28 @@
+<?php
+
+namespace Rector\Tests\DeadCode\Rector\Node\RemoveNonExistingVarAnnotationRector\Fixture;
+
+class ReturnAnnotationInvalid
+{
+    public function getValue()
+    {
+        /** @var int */
+        return;
+    }
+}
+
+?>
+-----
+<?php
+
+namespace Rector\Tests\DeadCode\Rector\Node\RemoveNonExistingVarAnnotationRector\Fixture;
+
+class ReturnAnnotationInvalid
+{
+    public function getValue()
+    {
+        return;
+    }
+}
+
+?>
diff --git a/rules-tests/DeadCode/Rector/Node/RemoveNonExistingVarAnnotationRector/Fixture/return_annotation_unwanted.php.inc b/rules-tests/DeadCode/Rector/Node/RemoveNonExistingVarAnnotationRector/Fixture/return_annotation_unwanted.php.inc
new file mode 100644
index 00000000000..3fdd8fa12e0
--- /dev/null
+++ b/rules-tests/DeadCode/Rector/Node/RemoveNonExistingVarAnnotationRector/Fixture/return_annotation_unwanted.php.inc
@@ -0,0 +1,28 @@
+<?php
+
+namespace Rector\Tests\DeadCode\Rector\Node\RemoveNonExistingVarAnnotationRector\Fixture;
+
+class ReturnAnnotationUnwanted
+{
+    public function getValue()
+    {
+        /** @var array<string, string> */
+        return new stdClass;
+    }
+}
+
+?>
+-----
+<?php
+
+namespace Rector\Tests\DeadCode\Rector\Node\RemoveNonExistingVarAnnotationRector\Fixture;
+
+class ReturnAnnotationUnwanted
+{
+    public function getValue()
+    {
+        return new stdClass;
+    }
+}
+
+?>
diff --git a/rules-tests/DeadCode/Rector/Node/RemoveNonExistingVarAnnotationRector/Fixture/skip_direct_return_func_call.php.inc b/rules-tests/DeadCode/Rector/Node/RemoveNonExistingVarAnnotationRector/Fixture/skip_direct_return_func_call.php.inc
new file mode 100644
index 00000000000..ab88a4fdafd
--- /dev/null
+++ b/rules-tests/DeadCode/Rector/Node/RemoveNonExistingVarAnnotationRector/Fixture/skip_direct_return_func_call.php.inc
@@ -0,0 +1,12 @@
+<?php
+
+namespace Rector\Tests\DeadCode\Rector\Node\RemoveNonExistingVarAnnotationRector\Fixture;
+
+class SkipDirectReturnFuncCall
+{
+    public function getValue(): int|false|null
+    {
+        /** @var int|false|null */
+        return filter_input(INPUT_GET, 'value', FILTER_VALIDATE_INT);
+    }
+}
diff --git a/rules/DeadCode/Rector/Node/RemoveNonExistingVarAnnotationRector.php b/rules/DeadCode/Rector/Node/RemoveNonExistingVarAnnotationRector.php
index 15bd54e78c5..ea22c8c2162 100644
--- a/rules/DeadCode/Rector/Node/RemoveNonExistingVarAnnotationRector.php
+++ b/rules/DeadCode/Rector/Node/RemoveNonExistingVarAnnotationRector.php
@@ -7,7 +7,9 @@
 use PhpParser\Node;
 use PhpParser\Node\Expr\Assign;
 use PhpParser\Node\Expr\AssignRef;
+use PhpParser\Node\Expr\CallLike;
 use PhpParser\Node\Expr\FuncCall;
+use PhpParser\Node\Expr\New_;
 use PhpParser\Node\Expr\Variable;
 use PhpParser\Node\Stmt\Echo_;
 use PhpParser\Node\Stmt\Expression;
@@ -114,6 +116,11 @@ public function refactor(Node $node): ?Node
         }
 
         $variableName = ltrim($varTagValueNode->variableName, '$');
+
+        if ($variableName === '' && $this->isAnnotatableReturn($node)) {
+            return null;
+        }
+
         if ($this->hasVariableName($node, $variableName)) {
             return null;
         }
@@ -197,4 +204,11 @@ private function isObjectShapePseudoType(VarTagValueNode $varTagValueNode): bool
 
         return str_contains($varTagValueNode->description, '}');
     }
+
+    private function isAnnotatableReturn(Node $node): bool
+    {
+        return $node instanceof Return_
+            && $node->expr instanceof CallLike
+            && ! $node->expr instanceof New_;
+    }
 }