[PHP 8.0] Add FinalPrivateToPrivateVisibilityRector (#4794)

config/set/php80.php

@@ -10,6 +10,7 @@ use Rector\Php80\Rector\Class_\AnnotationToAttributeRector;
 use Rector\Php80\Rector\Class_\ClassPropertyAssignToConstructorPromotionRector;
 use Rector\Php80\Rector\Class_\StringableForToStringRector;
 use Rector\Php80\Rector\ClassMethod\SetStateToStaticRector;
+use Rector\Php80\Rector\ClassMethod\FinalPrivateToPrivateVisibilityRector;
 use Rector\Php80\Rector\FuncCall\ClassOnObjectRector;
 use Rector\Php80\Rector\FuncCall\TokenGetAllToObjectRector;
 use Rector\Php80\Rector\FunctionLike\UnionTypesRector;
@@ -58,4 +59,5 @@ return static function (ContainerConfigurator $containerConfigurator): void {
 
     $services->set(RemoveParentCallWithoutParentRector::class);
     $services->set(SetStateToStaticRector::class);
+    $services->set(FinalPrivateToPrivateVisibilityRector::class);
 };

rules/php80/src/Rector/ClassMethod/FinalPrivateToPrivateVisibilityRector.php

@@ -0,0 +1,79 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Rector\Php80\Rector\ClassMethod;
+
+use PhpParser\Node;
+use PhpParser\Node\Stmt\ClassMethod;
+use Rector\Core\Rector\AbstractRector;
+use Symplify\RuleDocGenerator\ValueObject\CodeSample\CodeSample;
+use Symplify\RuleDocGenerator\ValueObject\RuleDefinition;
+
+/**
+ * @see \Rector\Php80\Tests\Rector\ClassMethod\FinalPrivateToPrivateVisibilityRector\FinalPrivateToPrivateVisibilityRectorTest
+ */
+final class FinalPrivateToPrivateVisibilityRector extends AbstractRector
+{
+    public function getRuleDefinition(): RuleDefinition
+    {
+        return new RuleDefinition('Changes method visibility from final private to only private', [
+            new CodeSample(
+                <<<'CODE_SAMPLE'
+class SomeClass
+{
+    final private function getter() {
+        return $this;
+    }
+}
+CODE_SAMPLE
+,
+                <<<'CODE_SAMPLE'
+class SomeClass
+{
+    private function getter() {
+        return $this;
+    }
+}
+CODE_SAMPLE
+            ),
+        ]);
+    }
+
+    /**
+     * @return string[]
+     */
+    public function getNodeTypes(): array
+    {
+        return [
+            ClassMethod::class,
+        ];
+    }
+
+    /**
+     * @param ClassMethod $node
+     */
+    public function refactor(Node $node): ?Node
+    {
+        if ($this->shouldSkip($node)) {
+            return null;
+        }
+
+        $this->makeNonFinal($node);
+
+        return $node;
+    }
+
+    private function shouldSkip(ClassMethod $classMethod): bool
+    {
+        if (! $classMethod->isFinal()) {
+            return true;
+        }
+
+        if (! $classMethod->isPrivate()) {
+            return true;
+        }
+
+        return false;
+    }
+}

rules/php80/tests/Rector/ClassMethod/FinalPrivateToPrivateVisibilityRector/FinalPrivateToPrivateVisibilityRectorTest.php

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

rules/php80/tests/Rector/ClassMethod/FinalPrivateToPrivateVisibilityRector/Fixture/final_private.php.inc

@@ -0,0 +1,27 @@
+<?php
+
+namespace Rector\Php80\Tests\Rector\ClassMethod\FinalPrivateToPrivateVisibilityRector\Fixture;
+
+class FinalPrivate
+{
+    final private function run($array)
+    {
+        return $this;
+    }
+}
+
+?>
+-----
+<?php
+
+namespace Rector\Php80\Tests\Rector\ClassMethod\FinalPrivateToPrivateVisibilityRector\Fixture;
+
+class FinalPrivate
+{
+    private function run($array)
+    {
+        return $this;
+    }
+}
+
+?>

src/PhpParser/Node/Manipulator/VisibilityManipulator.php

@@ -75,6 +75,18 @@ final class VisibilityManipulator
         $this->addVisibilityFlag($node, self::FINAL);
     }
 
+    /**
+     * @param Class_|ClassMethod $node
+     */
+    public function makeNonFinal(Node $node): void
+    {
+        if (! $node->isFinal()) {
+            return;
+        }
+
+        $node->flags -= Class_::MODIFIER_FINAL;
+    }
+
     /**
      * This way "abstract", "static", "final" are kept
      *

src/Rector/AbstractRector/VisibilityTrait.php

@@ -98,4 +98,12 @@ trait VisibilityTrait
     {
         $this->visibilityManipulator->makeNonStatic($node);
     }
+
+    /**
+     * @param ClassMethod|Class_ $class
+     */
+    public function makeNonFinal(Node $class): void
+    {
+        $this->visibilityManipulator->makeNonFinal($class);
+    }
 }