[DeadCode] Add RemoveEmptyAbstractClassRector (#5558)

Co-authored-by: kaizen-ci <info@kaizen-ci.org>

rules/dead-code/src/Rector/Class_/RemoveEmptyAbstractClassRector.php

@@ -0,0 +1,134 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Rector\DeadCode\Rector\Class_;
+
+use PhpParser\Node;
+use PhpParser\Node\Name\FullyQualified;
+use PhpParser\Node\Stmt\Class_;
+use Rector\Core\PhpParser\Node\CustomNode\FileNode;
+use Rector\Core\Rector\AbstractRector;
+use Rector\NodeTypeResolver\Node\AttributeKey;
+use Symplify\RuleDocGenerator\ValueObject\CodeSample\CodeSample;
+use Symplify\RuleDocGenerator\ValueObject\RuleDefinition;
+
+/**
+ * @see \Rector\DeadCode\Tests\Rector\Class_\RemoveEmptyAbstractClassRector\RemoveEmptyAbstractClassRectorTest
+ */
+final class RemoveEmptyAbstractClassRector extends AbstractRector
+{
+    /**
+     * @var FullyQualified[]
+     */
+    private $fullyQualifieds = [];
+
+    /**
+     * @return string[]
+     */
+    public function getNodeTypes(): array
+    {
+        return [FileNode::class, Class_::class];
+    }
+
+    /**
+     * @param FileNode|Class_ $node
+     */
+    public function refactor(Node $node): ?Node
+    {
+        if ($node instanceof FileNode) {
+            /** @var FullyQualified[] $fullyQualifieds */
+            $fullyQualifieds = $this->betterNodeFinder->findInstanceOf($node, FullyQualified::class);
+            foreach ($fullyQualifieds as $fullyQualified) {
+                $parent = $fullyQualified->getAttribute(AttributeKey::PARENT_NODE);
+                if ($parent instanceof Class_) {
+                    continue;
+                }
+
+                $this->fullyQualifieds[] = $fullyQualified;
+            }
+            return $node;
+        }
+
+        if ($this->shouldSkip($node)) {
+            return null;
+        }
+
+        return $this->processRemove($node);
+    }
+
+    public function getRuleDefinition(): RuleDefinition
+    {
+        return new RuleDefinition(
+            'Empty abstract class that does nothing',
+            [
+                new CodeSample(
+<<<'CODE_SAMPLE'
+class SomeClass extends SomeAbstractClass
+{
+}
+
+abstract class SomeAbstractClass extends AnotherAbstractClass
+{
+}
+
+abstract class AnotherAbstractClass
+{
+     public function getName()
+     {
+        return 'name';
+     }
+}
+CODE_SAMPLE
+,
+<<<'CODE_SAMPLE'
+class SomeClass extends AnotherAbstractClass
+{
+}
+
+abstracst clas AnotherAbstractClass
+{
+     public function getName()
+     {
+          return 'cowo';
+     }
+}
+CODE_SAMPLE
+                ),
+
+            ]);
+    }
+
+    private function shouldSkip(Class_ $class): bool
+    {
+        if (! $class->isAbstract()) {
+            return true;
+        }
+
+        if ($class->implements !== []) {
+            return true;
+        }
+
+        $stmts = $class->stmts;
+        return $stmts !== [];
+    }
+
+    private function processRemove(Class_ $class): ?Class_
+    {
+        $className = $class->namespacedName->toString();
+        foreach ($this->fullyQualifieds as $fullyQualified) {
+            if ($className === $fullyQualified->toString()) {
+                return null;
+            }
+        }
+
+        $children = $this->nodeRepository->findChildrenOfClass($this->getName($class->namespacedName));
+        $extends = $class->extends;
+        foreach ($children as $child) {
+            $child->extends = $extends;
+        }
+
+        $this->removeNode($class);
+        return $class;
+    }
+}

rules/dead-code/tests/Rector/Class_/RemoveEmptyAbstractClassRector/Fixture/abstract_class_used_multi.php.inc

@@ -0,0 +1,43 @@
+<?php
+
+namespace Rector\DeadCode\Tests\Rector\Class_\RemoveEmptyAbstractClassRector\Fixture;
+
+abstract class AbstractClassMulti
+{
+}
+
+abstract class AbstractClassUsedMulti extends AbstractClassMulti
+{
+}
+
+final class AnyClass2
+{
+	public function process($some)
+    {
+        if ($some instanceof AbstractClassUsedMulti) {
+
+        }
+    }
+}
+
+?>
+-----
+<?php
+
+namespace Rector\DeadCode\Tests\Rector\Class_\RemoveEmptyAbstractClassRector\Fixture;
+
+abstract class AbstractClassUsedMulti
+{
+}
+
+final class AnyClass2
+{
+	public function process($some)
+    {
+        if ($some instanceof AbstractClassUsedMulti) {
+
+        }
+    }
+}
+
+?>

rules/dead-code/tests/Rector/Class_/RemoveEmptyAbstractClassRector/Fixture/abstract_class_used_multi_upper.php.inc

@@ -0,0 +1,43 @@
+<?php
+
+namespace Rector\DeadCode\Tests\Rector\Class_\RemoveEmptyAbstractClassRector\Fixture;
+
+abstract class AbstractClassMultiUpper
+{
+}
+
+abstract class AbstractClassUsedMultiUpper extends AbstractClassMultiUpper
+{
+}
+
+final class AnyClass3
+{
+	public function process($some)
+    {
+        if ($some instanceof AbstractClassMultiUpper) {
+
+        }
+    }
+}
+
+?>
+-----
+<?php
+
+namespace Rector\DeadCode\Tests\Rector\Class_\RemoveEmptyAbstractClassRector\Fixture;
+
+abstract class AbstractClassMultiUpper
+{
+}
+
+final class AnyClass3
+{
+	public function process($some)
+    {
+        if ($some instanceof AbstractClassMultiUpper) {
+
+        }
+    }
+}
+
+?>

rules/dead-code/tests/Rector/Class_/RemoveEmptyAbstractClassRector/Fixture/fixture.php.inc

@@ -0,0 +1,39 @@
+<?php
+
+namespace Rector\DeadCode\Tests\Rector\Class_\RemoveEmptyAbstractClassRector\Fixture;
+
+abstract class AnotherAbstractClass
+{
+     public function getName()
+     {
+        return 'name';
+     }
+}
+
+abstract class SomeAbstractClass extends AnotherAbstractClass
+{
+}
+
+class SomeClass extends SomeAbstractClass
+{
+}
+
+?>
+-----
+<?php
+
+namespace Rector\DeadCode\Tests\Rector\Class_\RemoveEmptyAbstractClassRector\Fixture;
+
+abstract class AnotherAbstractClass
+{
+     public function getName()
+     {
+        return 'name';
+     }
+}
+
+class SomeClass extends AnotherAbstractClass
+{
+}
+
+?>

rules/dead-code/tests/Rector/Class_/RemoveEmptyAbstractClassRector/Fixture/multi_extends.php.inc

@@ -0,0 +1,43 @@
+<?php
+
+namespace Rector\DeadCode\Tests\Rector\Class_\RemoveEmptyAbstractClassRector\Fixture;
+
+abstract class AnotherAbstractClassMulti
+{
+     public function getName()
+     {
+        return 'name';
+     }
+}
+
+abstract class SomeAbstractClassMulti1 extends AnotherAbstractClassMulti
+{
+}
+
+abstract class SomeAbstractClassMulti2 extends SomeAbstractClassMulti1
+{
+}
+
+class MultiExtends extends SomeAbstractClassMulti2
+{
+}
+
+?>
+-----
+<?php
+
+namespace Rector\DeadCode\Tests\Rector\Class_\RemoveEmptyAbstractClassRector\Fixture;
+
+abstract class AnotherAbstractClassMulti
+{
+     public function getName()
+     {
+        return 'name';
+     }
+}
+
+class MultiExtends extends AnotherAbstractClassMulti
+{
+}
+
+?>

rules/dead-code/tests/Rector/Class_/RemoveEmptyAbstractClassRector/Fixture/single_empty_abstract.php.inc

@@ -0,0 +1,23 @@
+<?php
+
+namespace Rector\DeadCode\Tests\Rector\Class_\RemoveEmptyAbstractClassRector\Fixture;
+
+abstract class SingleEmptyAbstract
+{
+}
+
+class Single extends SingleEmptyAbstract
+{
+}
+
+?>
+-----
+<?php
+
+namespace Rector\DeadCode\Tests\Rector\Class_\RemoveEmptyAbstractClassRector\Fixture;
+
+class Single
+{
+}
+
+?>

rules/dead-code/tests/Rector/Class_/RemoveEmptyAbstractClassRector/Fixture/skip_abstract_class_used.php.inc

@@ -0,0 +1,21 @@
+<?php
+
+namespace Rector\DeadCode\Tests\Rector\Class_\RemoveEmptyAbstractClassRector\Fixture;
+
+abstract class AbstractClassUsed
+{
+}
+
+class skipAbstractClassUsed extends AbstractClassUsed
+{
+}
+
+final class AnyClass
+{
+	public function process($some)
+    {
+        if ($some instanceof AbstractClassUsed) {
+
+        }
+    }
+}

rules/dead-code/tests/Rector/Class_/RemoveEmptyAbstractClassRector/Fixture/skip_has_constant.php.inc

@@ -0,0 +1,8 @@
+<?php
+
+namespace Rector\DeadCode\Tests\Rector\Class_\RemoveEmptyAbstractClassRector\Fixture;
+
+abstract class SkipHasConstant
+{
+    protected const A_CONSTANT = 'foo';
+}

rules/dead-code/tests/Rector/Class_/RemoveEmptyAbstractClassRector/Fixture/skip_has_method.php.inc

@@ -0,0 +1,8 @@
+<?php
+
+namespace Rector\DeadCode\Tests\Rector\Class_\RemoveEmptyAbstractClassRector\Fixture;
+
+abstract class SkipHasMethod
+{
+    public abstract function run();
+}

rules/dead-code/tests/Rector/Class_/RemoveEmptyAbstractClassRector/Fixture/skip_has_property.php.inc

@@ -0,0 +1,8 @@
+<?php
+
+namespace Rector\DeadCode\Tests\Rector\Class_\RemoveEmptyAbstractClassRector\Fixture;
+
+abstract class SkipHasProperty
+{
+    protected $foo;
+}

rules/dead-code/tests/Rector/Class_/RemoveEmptyAbstractClassRector/Fixture/skip_has_trait.php.inc

@@ -0,0 +1,10 @@
+<?php
+
+namespace Rector\DeadCode\Tests\Rector\Class_\RemoveEmptyAbstractClassRector\Fixture;
+
+use Rector\DeadCode\Tests\Rector\Class_\RemoveEmptyAbstractClassRector\Source\ATrait;
+
+abstract class SkipHasTrait
+{
+    use ATrait;
+}

rules/dead-code/tests/Rector/Class_/RemoveEmptyAbstractClassRector/Fixture/skip_implements_interface.php.inc

@@ -0,0 +1,9 @@
+<?php
+
+namespace Rector\DeadCode\Tests\Rector\Class_\RemoveEmptyAbstractClassRector\Fixture;
+
+use Rector\DeadCode\Tests\Rector\Class_\RemoveEmptyAbstractClassRector\Source\AnInterface;
+
+abstract class SkipImplementsInterface implements AnInterface
+{
+}

rules/dead-code/tests/Rector/Class_/RemoveEmptyAbstractClassRector/Fixture/skip_not_abstract.php.inc

@@ -0,0 +1,7 @@
+<?php
+
+namespace Rector\DeadCode\Tests\Rector\Class_\RemoveEmptyAbstractClassRector\Fixture;
+
+final class SkipNotAbstract
+{
+}

rules/dead-code/tests/Rector/Class_/RemoveEmptyAbstractClassRector/Fixture/skip_single_empty_abstract_used.php.inc

@@ -0,0 +1,19 @@
+<?php
+
+namespace Rector\DeadCode\Tests\Rector\Class_\RemoveEmptyAbstractClassRector\Fixture;
+
+abstract class SkipSingleEmptyAbstractUsed
+{
+}
+
+class Single2
+{
+    function run($some)
+    {
+        if ($some instanceof SkipSingleEmptyAbstractUsed) {
+
+        }
+    }
+}
+
+?>

rules/dead-code/tests/Rector/Class_/RemoveEmptyAbstractClassRector/RemoveEmptyAbstractClassRectorTest.php

@@ -0,0 +1,31 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Rector\DeadCode\Tests\Rector\Class_\RemoveEmptyAbstractClassRector;
+
+use Iterator;
+use Rector\DeadCode\Rector\Class_\RemoveEmptyAbstractClassRector;
+use Rector\Testing\PHPUnit\AbstractRectorTestCase;
+use Symplify\SmartFileSystem\SmartFileInfo;
+
+final class RemoveEmptyAbstractClassRectorTest extends AbstractRectorTestCase
+{
+    /**
+     * @dataProvider provideData()
+     */
+    public function test(SmartFileInfo $fileInfo): void
+    {
+        $this->doTestFileInfo($fileInfo);
+    }
+
+    public function provideData(): Iterator
+    {
+        return $this->yieldFilesFromDirectory(__DIR__ . '/Fixture');
+    }
+
+    protected function getRectorClass(): string
+    {
+        return RemoveEmptyAbstractClassRector::class;
+    }
+}

rules/dead-code/tests/Rector/Class_/RemoveEmptyAbstractClassRector/Source/ATrait.php

@@ -0,0 +1,6 @@
+<?php
+
+namespace Rector\DeadCode\Tests\Rector\Class_\RemoveEmptyAbstractClassRector\Source;
+
+trait ATrait
+{}

rules/dead-code/tests/Rector/Class_/RemoveEmptyAbstractClassRector/Source/AnInterface.php

@@ -0,0 +1,6 @@
+<?php
+
+namespace Rector\DeadCode\Tests\Rector\Class_\RemoveEmptyAbstractClassRector\Source;
+
+interface AnInterface
+{}