[dead-code] Add RemoveVoidDocblockFromMagicMethodRector (#7822)

* feature: add handling for void magic methods

* rename to shorter RemoveVoidDocblockFromMagicMethodsRector

* singular, register in dead-code level

* combine if

* misc

---------

Co-authored-by: Paul Rijke <[email protected]>

Author: TomasVotruba

rules-tests/DeadCode/Rector/ClassMethod/RemoveVoidDocblockFromMagicMethodRector/Fixture/remove_return_clone.php.inc

@@ -0,0 +1,35 @@
+<?php
+
+namespace Rector\Tests\DeadCode\Rector\ClassMethod\RemoveVoidDocblockFromMagicMethodRector\Fixture;
+
+class RemoveReturnClone
+{
+    /**
+     * Other comments
+     *
+     * @return void
+     */
+    function __clone()
+    {
+        //
+    }
+}
+
+?>
+-----
+<?php
+
+namespace Rector\Tests\DeadCode\Rector\ClassMethod\RemoveVoidDocblockFromMagicMethodRector\Fixture;
+
+class RemoveReturnClone
+{
+    /**
+     * Other comments
+     */
+    function __clone()
+    {
+        //
+    }
+}
+
+?>

rules-tests/DeadCode/Rector/ClassMethod/RemoveVoidDocblockFromMagicMethodRector/Fixture/remove_return_construct.php.inc

@@ -0,0 +1,30 @@
+<?php
+
+namespace Rector\Tests\DeadCode\Rector\ClassMethod\RemoveVoidDocblockFromMagicMethodRector\Fixture;
+
+class RemoveReturnConstruct
+{
+    /**
+     * @return void
+     */
+    function __construct()
+    {
+        //
+    }
+}
+
+?>
+-----
+<?php
+
+namespace Rector\Tests\DeadCode\Rector\ClassMethod\RemoveVoidDocblockFromMagicMethodRector\Fixture;
+
+class RemoveReturnConstruct
+{
+    function __construct()
+    {
+        //
+    }
+}
+
+?>

rules-tests/DeadCode/Rector/ClassMethod/RemoveVoidDocblockFromMagicMethodRector/Fixture/remove_return_destruct.php.inc

@@ -0,0 +1,30 @@
+<?php
+
+namespace Rector\Tests\DeadCode\Rector\ClassMethod\RemoveVoidDocblockFromMagicMethodRector\Fixture;
+
+class RemoveReturnDestruct
+{
+    /**
+     * @return void
+     */
+    function __destruct()
+    {
+        //
+    }
+}
+
+?>
+-----
+<?php
+
+namespace Rector\Tests\DeadCode\Rector\ClassMethod\RemoveVoidDocblockFromMagicMethodRector\Fixture;
+
+class RemoveReturnDestruct
+{
+    function __destruct()
+    {
+        //
+    }
+}
+
+?>

rules-tests/DeadCode/Rector/ClassMethod/RemoveVoidDocblockFromMagicMethodRector/RemoveVoidDocblockFromMagicMethodRectorTest.php

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

@@ -0,0 +1,9 @@
+<?php
+
+declare(strict_types=1);
+
+use Rector\Config\RectorConfig;
+use Rector\DeadCode\Rector\ClassMethod\RemoveVoidDocblockFromMagicMethodRector;
+
+return RectorConfig::configure()
+    ->withRules([RemoveVoidDocblockFromMagicMethodRector::class]);

rules/DeadCode/Rector/ClassMethod/RemoveVoidDocblockFromMagicMethodRector.php

@@ -0,0 +1,108 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Rector\DeadCode\Rector\ClassMethod;
+
+use PhpParser\Node;
+use PhpParser\Node\Stmt\ClassMethod;
+use PHPStan\PhpDocParser\Ast\PhpDoc\ReturnTagValueNode;
+use PHPStan\PhpDocParser\Ast\Type\IdentifierTypeNode;
+use Rector\BetterPhpDocParser\PhpDocInfo\PhpDocInfoFactory;
+use Rector\Comments\NodeDocBlock\DocBlockUpdater;
+use Rector\Rector\AbstractRector;
+use Rector\ValueObject\MethodName;
+use Symplify\RuleDocGenerator\ValueObject\CodeSample\CodeSample;
+use Symplify\RuleDocGenerator\ValueObject\RuleDefinition;
+
+/**
+ * @see \Rector\Tests\DeadCode\Rector\ClassMethod\RemoveVoidDocblockFromMagicMethodRector\RemoveVoidDocblockFromMagicMethodRectorTest
+ */
+final class RemoveVoidDocblockFromMagicMethodRector extends AbstractRector
+{
+    public function __construct(
+        private readonly DocBlockUpdater $docBlockUpdater,
+        private readonly PhpDocInfoFactory $phpDocInfoFactory,
+    ) {
+    }
+
+    public function getRuleDefinition(): RuleDefinition
+    {
+        return new RuleDefinition(
+            'Remove useless @return void docblock from magic methods __construct, __destruct, and __clone',
+            [
+                new CodeSample(
+                    <<<'CODE_SAMPLE'
+class SomeClass
+{
+    /**
+     * @return void
+     */
+    public function __construct() {}
+
+    /**
+     * @return void
+     */
+    public function __destruct() {}
+
+    /**
+     * @return void
+     */
+    public function __clone() {}
+}
+CODE_SAMPLE
+                    ,
+                    <<<'CODE_SAMPLE'
+class SomeClass
+{
+    public function __construct() {}
+
+    public function __destruct() {}
+
+    public function __clone() {}
+}
+CODE_SAMPLE
+                ),
+            ]
+        );
+    }
+
+    public function getNodeTypes(): array
+    {
+        return [ClassMethod::class];
+    }
+
+    /**
+     * @param ClassMethod $node
+     */
+    public function refactor(Node $node): ?Node
+    {
+        if ($node->returnType instanceof Node) {
+            return null;
+        }
+
+        if (! $this->isNames($node, [MethodName::CONSTRUCT, MethodName::DESTRUCT, MethodName::CLONE])) {
+            return null;
+        }
+
+        $phpDocInfo = $this->phpDocInfoFactory->createFromNodeOrEmpty($node);
+
+        $returnTagValueNode = $phpDocInfo->getReturnTagValue();
+        if (! $returnTagValueNode instanceof ReturnTagValueNode) {
+            return null;
+        }
+
+        if ($returnTagValueNode->description !== '') {
+            return null;
+        }
+
+        if (! $returnTagValueNode->type instanceof IdentifierTypeNode || $returnTagValueNode->type->name !== 'void') {
+            return null;
+        }
+
+        $phpDocInfo->removeByType(ReturnTagValueNode::class);
+
+        $this->docBlockUpdater->updateRefactoredNodeWithPhpDocInfo($node);
+        return $node;
+    }
+}

rules/DeadCode/Rector/If_/RemoveDeadIfBlockRector.php

@@ -7,6 +7,7 @@
 use PhpParser\Node;
 use PhpParser\Node\Expr\BinaryOp\BooleanAnd;
 use PhpParser\Node\Stmt\Else_;
+use PhpParser\Node\Stmt\ElseIf_;
 use PhpParser\Node\Stmt\If_;
 use PhpParser\NodeVisitor;
 use Rector\DeadCode\SideEffect\SideEffectNodeDetector;
@@ -100,16 +101,16 @@ public function refactor(Node $node): int|null|If_
             return $this->refactor($node) ?? $node;
         }
 
-        if ($node->elseifs !== []) {
-            foreach ($node->elseifs as $elseif) {
-                $keep_elseifs = array_filter(
-                    $node->elseifs,
-                    fn ($elseif) => $elseif->stmts !== [] || $this->sideEffectNodeDetector->detect($elseif->cond)
-                );
-                if (count($node->elseifs) !== count($keep_elseifs)) {
-                    $node->elseifs = $keep_elseifs;
-                    return $this->refactor($node) ?? $node;
-                }
+        foreach ($node->elseifs as $elseif) {
+            $keep_elseifs = array_filter(
+                $node->elseifs,
+                fn (ElseIf_ $elseif): bool => $elseif->stmts !== [] || $this->sideEffectNodeDetector->detect(
+                    $elseif->cond
+                )
+            );
+            if (count($node->elseifs) !== count($keep_elseifs)) {
+                $node->elseifs = $keep_elseifs;
+                return $this->refactor($node) ?? $node;
             }
         }
 
@@ -141,6 +142,7 @@ public function refactor(Node $node): int|null|If_
             if (count($node->elseifs) > 1) {
                 $if->elseifs = \array_slice($node->elseifs, 1);
             }
+
             return $this->refactor($if) ?? $if;
         }
 

src/Config/Level/DeadCodeLevel.php

@@ -27,6 +27,7 @@
 use Rector\DeadCode\Rector\ClassMethod\RemoveUselessParamTagRector;
 use Rector\DeadCode\Rector\ClassMethod\RemoveUselessReturnExprInConstructRector;
 use Rector\DeadCode\Rector\ClassMethod\RemoveUselessReturnTagRector;
+use Rector\DeadCode\Rector\ClassMethod\RemoveVoidDocblockFromMagicMethodRector;
 use Rector\DeadCode\Rector\Closure\RemoveUnusedClosureVariableUseRector;
 use Rector\DeadCode\Rector\Concat\RemoveConcatAutocastRector;
 use Rector\DeadCode\Rector\ConstFetch\RemovePhpVersionIdCheckRector;
@@ -109,6 +110,7 @@ final class DeadCodeLevel
         RemoveDeadZeroAndOneOperationRector::class,
 
         // docblock
+        RemoveVoidDocblockFromMagicMethodRector::class,
         RemoveUselessParamTagRector::class,
         RemoveUselessReturnTagRector::class,
         RemoveUselessReadOnlyTagRector::class,

src/PhpParser/Node/BetterNodeFinder.php

@@ -4,14 +4,14 @@
 
 namespace Rector\PhpParser\Node;
 
-use PhpParser\Node\Stmt\ClassMethod;
 use PhpParser\Node;
 use PhpParser\Node\Expr\Variable;
 use PhpParser\Node\Expr\Yield_;
 use PhpParser\Node\Expr\YieldFrom;
 use PhpParser\Node\FunctionLike;
 use PhpParser\Node\Stmt;
 use PhpParser\Node\Stmt\Class_;
+use PhpParser\Node\Stmt\ClassMethod;
 use PhpParser\Node\Stmt\Return_;
 use PhpParser\NodeFinder;
 use PhpParser\NodeVisitor;