From bcc5055d48dc129eaaa6d2f1dc7e967f15c7f2cd Mon Sep 17 00:00:00 2001
From: TomasVotruba <tomas.vot@gmail.com>
Date: Wed, 27 May 2020 00:22:22 +0200
Subject: [PATCH] [Privatization] Add PrivatizeFinalClassMethodRector

---
 config/set/privatization/privatization.yaml   |   1 +
 .../PrivatizeFinalClassMethodRector.php       | 123 ++++++++++++++++++
 .../change_parent_without_care.php.inc        |  29 +++++
 .../Fixture/fixture.php.inc                   |  25 ++++
 .../Fixture/keep_create_component.php.inc     |  10 ++
 .../keep_parent_protected_method.php.inc      |  12 ++
 .../PrivatizeFinalClassMethodRectorTest.php   |  30 +++++
 .../AbstractClassWithProtectedClassMethod.php |  12 ++
 .../change_parent_without_care.php.inc        |   4 +-
 .../Fixture/keep_parent_protected.php.inc     |   2 +-
 .../AbstractClassWithProtectedProperty.php    |   2 +-
 11 files changed, 246 insertions(+), 4 deletions(-)
 create mode 100644 rules/privatization/src/Rector/ClassMethod/PrivatizeFinalClassMethodRector.php
 create mode 100644 rules/privatization/tests/Rector/ClassMethod/PrivatizeFinalClassMethodRector/Fixture/change_parent_without_care.php.inc
 create mode 100644 rules/privatization/tests/Rector/ClassMethod/PrivatizeFinalClassMethodRector/Fixture/fixture.php.inc
 create mode 100644 rules/privatization/tests/Rector/ClassMethod/PrivatizeFinalClassMethodRector/Fixture/keep_create_component.php.inc
 create mode 100644 rules/privatization/tests/Rector/ClassMethod/PrivatizeFinalClassMethodRector/Fixture/keep_parent_protected_method.php.inc
 create mode 100644 rules/privatization/tests/Rector/ClassMethod/PrivatizeFinalClassMethodRector/PrivatizeFinalClassMethodRectorTest.php
 create mode 100644 rules/privatization/tests/Rector/ClassMethod/PrivatizeFinalClassMethodRector/Source/AbstractClassWithProtectedClassMethod.php
 rename rules/privatization/tests/Rector/Property/PrivatizeFinalClassPropertyRector/{ => Source}/AbstractClassWithProtectedProperty.php (87%)

diff --git a/config/set/privatization/privatization.yaml b/config/set/privatization/privatization.yaml
index 810d032e6132..79ad2da098fe 100644
--- a/config/set/privatization/privatization.yaml
+++ b/config/set/privatization/privatization.yaml
@@ -4,3 +4,4 @@ services:
     Rector\Privatization\Rector\Property\PrivatizeLocalPropertyToPrivatePropertyRector: null
     Rector\Privatization\Rector\ClassConst\PrivatizeLocalClassConstantRector: null
     Rector\Privatization\Rector\Property\PrivatizeFinalClassPropertyRector: null
+    Rector\Privatization\Rector\ClassMethod\PrivatizeFinalClassMethodRector: null
diff --git a/rules/privatization/src/Rector/ClassMethod/PrivatizeFinalClassMethodRector.php b/rules/privatization/src/Rector/ClassMethod/PrivatizeFinalClassMethodRector.php
new file mode 100644
index 000000000000..26fb950e8787
--- /dev/null
+++ b/rules/privatization/src/Rector/ClassMethod/PrivatizeFinalClassMethodRector.php
@@ -0,0 +1,123 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Rector\Privatization\Rector\ClassMethod;
+
+use PhpParser\Node;
+use PhpParser\Node\Stmt\Class_;
+use PhpParser\Node\Stmt\ClassMethod;
+use Rector\Core\Rector\AbstractRector;
+use Rector\Core\RectorDefinition\CodeSample;
+use Rector\Core\RectorDefinition\RectorDefinition;
+use Rector\NodeTypeResolver\Node\AttributeKey;
+
+/**
+ * @see \Rector\Privatization\Tests\Rector\ClassMethod\PrivatizeFinalClassMethodRector\PrivatizeFinalClassMethodRectorTest
+ */
+final class PrivatizeFinalClassMethodRector extends AbstractRector
+{
+    public function getDefinition(): RectorDefinition
+    {
+        return new RectorDefinition('Change protected class method to private if possible', [
+            new CodeSample(
+                <<<'PHP'
+final class SomeClass
+{
+    protected function someMethod()
+    {
+    }
+}
+PHP
+,
+                <<<'PHP'
+final class SomeClass
+{
+    private function someMethod()
+    {
+    }
+}
+PHP
+
+            ),
+        ]);
+    }
+
+    /**
+     * @return string[]
+     */
+    public function getNodeTypes(): array
+    {
+        return [ClassMethod::class];
+    }
+
+    /**
+     * @param ClassMethod $node
+     */
+    public function refactor(Node $node): ?Node
+    {
+        $class = $node->getAttribute(AttributeKey::CLASS_NODE);
+        if (! $class instanceof Class_) {
+            return null;
+        }
+
+        if (! $class->isFinal()) {
+            return null;
+        }
+
+        if ($this->shouldSkipClassMethod($node)) {
+            return null;
+        }
+
+        if ($class->extends === null) {
+            $this->makePrivate($node);
+            return $node;
+        }
+
+        if ($this->isClassMethodVisibilityGuardedByParent($node, $class)) {
+            return null;
+        }
+
+        $this->makePrivate($node);
+
+        return $node;
+    }
+
+    private function shouldSkipClassMethod(ClassMethod $classMethod): bool
+    {
+        if ($this->isName($classMethod, 'createComponent*')) {
+            return true;
+        }
+
+        return ! $classMethod->isProtected();
+    }
+
+    private function isClassMethodVisibilityGuardedByParent(ClassMethod $classMethod, Class_ $class): bool
+    {
+        if ($class->extends === null) {
+            return false;
+        }
+
+        $parentClasses = $this->getParentClasses($class);
+        $propertyName = $this->getName($classMethod);
+
+        foreach ($parentClasses as $parentClass) {
+            if (method_exists($parentClass, $propertyName)) {
+                return true;
+            }
+        }
+
+        return false;
+    }
+
+    /**
+     * @return string[]
+     */
+    private function getParentClasses(Class_ $class): array
+    {
+        /** @var string $className */
+        $className = $this->getName($class);
+
+        return class_parents($className);
+    }
+}
diff --git a/rules/privatization/tests/Rector/ClassMethod/PrivatizeFinalClassMethodRector/Fixture/change_parent_without_care.php.inc b/rules/privatization/tests/Rector/ClassMethod/PrivatizeFinalClassMethodRector/Fixture/change_parent_without_care.php.inc
new file mode 100644
index 000000000000..257a2c04d35f
--- /dev/null
+++ b/rules/privatization/tests/Rector/ClassMethod/PrivatizeFinalClassMethodRector/Fixture/change_parent_without_care.php.inc
@@ -0,0 +1,29 @@
+<?php
+
+namespace Rector\Privatization\Tests\Rector\ClassMethod\PrivatizeFinalClassMethodRector\Fixture;
+
+use Rector\Privatization\Tests\Rector\ClassMethod\PrivatizeFinalClassMethodRector\Source\AbstractClassWithProtectedClassMethod;
+
+final class ChangeParentWithoutCare extends AbstractClassWithProtectedClassMethod
+{
+    protected function getSome()
+    {
+    }
+}
+
+?>
+-----
+<?php
+
+namespace Rector\Privatization\Tests\Rector\ClassMethod\PrivatizeFinalClassMethodRector\Fixture;
+
+use Rector\Privatization\Tests\Rector\ClassMethod\PrivatizeFinalClassMethodRector\Source\AbstractClassWithProtectedClassMethod;
+
+final class ChangeParentWithoutCare extends AbstractClassWithProtectedClassMethod
+{
+    private function getSome()
+    {
+    }
+}
+
+?>
diff --git a/rules/privatization/tests/Rector/ClassMethod/PrivatizeFinalClassMethodRector/Fixture/fixture.php.inc b/rules/privatization/tests/Rector/ClassMethod/PrivatizeFinalClassMethodRector/Fixture/fixture.php.inc
new file mode 100644
index 000000000000..aceed24af59a
--- /dev/null
+++ b/rules/privatization/tests/Rector/ClassMethod/PrivatizeFinalClassMethodRector/Fixture/fixture.php.inc
@@ -0,0 +1,25 @@
+<?php
+
+namespace Rector\Privatization\Tests\Rector\ClassMethod\PrivatizeFinalClassMethodRector\Fixture;
+
+final class SomeClass
+{
+    protected function someMethod()
+    {
+    }
+}
+
+?>
+-----
+<?php
+
+namespace Rector\Privatization\Tests\Rector\ClassMethod\PrivatizeFinalClassMethodRector\Fixture;
+
+final class SomeClass
+{
+    private function someMethod()
+    {
+    }
+}
+
+?>
diff --git a/rules/privatization/tests/Rector/ClassMethod/PrivatizeFinalClassMethodRector/Fixture/keep_create_component.php.inc b/rules/privatization/tests/Rector/ClassMethod/PrivatizeFinalClassMethodRector/Fixture/keep_create_component.php.inc
new file mode 100644
index 000000000000..45209f8c3431
--- /dev/null
+++ b/rules/privatization/tests/Rector/ClassMethod/PrivatizeFinalClassMethodRector/Fixture/keep_create_component.php.inc
@@ -0,0 +1,10 @@
+<?php
+
+namespace Rector\Privatization\Tests\Rector\ClassMethod\PrivatizeFinalClassMethodRector\Fixture;
+
+final class KeepCreateComponent
+{
+    protected function createComponentCrab()
+    {
+    }
+}
diff --git a/rules/privatization/tests/Rector/ClassMethod/PrivatizeFinalClassMethodRector/Fixture/keep_parent_protected_method.php.inc b/rules/privatization/tests/Rector/ClassMethod/PrivatizeFinalClassMethodRector/Fixture/keep_parent_protected_method.php.inc
new file mode 100644
index 000000000000..6629106ddd86
--- /dev/null
+++ b/rules/privatization/tests/Rector/ClassMethod/PrivatizeFinalClassMethodRector/Fixture/keep_parent_protected_method.php.inc
@@ -0,0 +1,12 @@
+<?php
+
+namespace Rector\Privatization\Tests\Rector\ClassMethod\PrivatizeFinalClassMethodRector\Fixture;
+
+use Rector\Privatization\Tests\Rector\ClassMethod\PrivatizeFinalClassMethodRector\Source\AbstractClassWithProtectedClassMethod;
+
+final class KeepParentProtected extends AbstractClassWithProtectedClassMethod
+{
+    protected function getName()
+    {
+    }
+}
diff --git a/rules/privatization/tests/Rector/ClassMethod/PrivatizeFinalClassMethodRector/PrivatizeFinalClassMethodRectorTest.php b/rules/privatization/tests/Rector/ClassMethod/PrivatizeFinalClassMethodRector/PrivatizeFinalClassMethodRectorTest.php
new file mode 100644
index 000000000000..6f9dc70e11b7
--- /dev/null
+++ b/rules/privatization/tests/Rector/ClassMethod/PrivatizeFinalClassMethodRector/PrivatizeFinalClassMethodRectorTest.php
@@ -0,0 +1,30 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Rector\Privatization\Tests\Rector\ClassMethod\PrivatizeFinalClassMethodRector;
+
+use Iterator;
+use Rector\Core\Testing\PHPUnit\AbstractRectorTestCase;
+use Rector\Privatization\Rector\ClassMethod\PrivatizeFinalClassMethodRector;
+
+final class PrivatizeFinalClassMethodRectorTest extends AbstractRectorTestCase
+{
+    /**
+     * @dataProvider provideData()
+     */
+    public function test(string $file): void
+    {
+        $this->doTestFile($file);
+    }
+
+    public function provideData(): Iterator
+    {
+        return $this->yieldFilesFromDirectory(__DIR__ . '/Fixture');
+    }
+
+    protected function getRectorClass(): string
+    {
+        return PrivatizeFinalClassMethodRector::class;
+    }
+}
diff --git a/rules/privatization/tests/Rector/ClassMethod/PrivatizeFinalClassMethodRector/Source/AbstractClassWithProtectedClassMethod.php b/rules/privatization/tests/Rector/ClassMethod/PrivatizeFinalClassMethodRector/Source/AbstractClassWithProtectedClassMethod.php
new file mode 100644
index 000000000000..c6e013fe815f
--- /dev/null
+++ b/rules/privatization/tests/Rector/ClassMethod/PrivatizeFinalClassMethodRector/Source/AbstractClassWithProtectedClassMethod.php
@@ -0,0 +1,12 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Rector\Privatization\Tests\Rector\ClassMethod\PrivatizeFinalClassMethodRector\Source;
+
+abstract class AbstractClassWithProtectedClassMethod
+{
+    protected function getName()
+    {
+    }
+}
diff --git a/rules/privatization/tests/Rector/Property/PrivatizeFinalClassPropertyRector/Fixture/change_parent_without_care.php.inc b/rules/privatization/tests/Rector/Property/PrivatizeFinalClassPropertyRector/Fixture/change_parent_without_care.php.inc
index 3725f0e5f12f..91c2f2c3e5b9 100644
--- a/rules/privatization/tests/Rector/Property/PrivatizeFinalClassPropertyRector/Fixture/change_parent_without_care.php.inc
+++ b/rules/privatization/tests/Rector/Property/PrivatizeFinalClassPropertyRector/Fixture/change_parent_without_care.php.inc
@@ -2,7 +2,7 @@
 
 namespace Rector\Privatization\Tests\Rector\Property\PrivatizeFinalClassPropertyRector\Fixture;
 
-use Rector\Privatization\Tests\Rector\Property\PrivatizeFinalClassPropertyRector\AbstractClassWithProtectedProperty;
+use Rector\Privatization\Tests\Rector\Property\PrivatizeFinalClassPropertyRector\Source\AbstractClassWithProtectedProperty;
 
 final class ChangeParentWithoutCare extends AbstractClassWithProtectedProperty
 {
@@ -15,7 +15,7 @@ final class ChangeParentWithoutCare extends AbstractClassWithProtectedProperty
 
 namespace Rector\Privatization\Tests\Rector\Property\PrivatizeFinalClassPropertyRector\Fixture;
 
-use Rector\Privatization\Tests\Rector\Property\PrivatizeFinalClassPropertyRector\AbstractClassWithProtectedProperty;
+use Rector\Privatization\Tests\Rector\Property\PrivatizeFinalClassPropertyRector\Source\AbstractClassWithProtectedProperty;
 
 final class ChangeParentWithoutCare extends AbstractClassWithProtectedProperty
 {
diff --git a/rules/privatization/tests/Rector/Property/PrivatizeFinalClassPropertyRector/Fixture/keep_parent_protected.php.inc b/rules/privatization/tests/Rector/Property/PrivatizeFinalClassPropertyRector/Fixture/keep_parent_protected.php.inc
index 1497cf77cd73..1a321229d207 100644
--- a/rules/privatization/tests/Rector/Property/PrivatizeFinalClassPropertyRector/Fixture/keep_parent_protected.php.inc
+++ b/rules/privatization/tests/Rector/Property/PrivatizeFinalClassPropertyRector/Fixture/keep_parent_protected.php.inc
@@ -2,7 +2,7 @@
 
 namespace Rector\Privatization\Tests\Rector\Property\PrivatizeFinalClassPropertyRector\Fixture;
 
-use Rector\Privatization\Tests\Rector\Property\PrivatizeFinalClassPropertyRector\AbstractClassWithProtectedProperty;
+use Rector\Privatization\Tests\Rector\Property\PrivatizeFinalClassPropertyRector\Source\AbstractClassWithProtectedProperty;
 
 final class KeepParentProtected extends AbstractClassWithProtectedProperty
 {
diff --git a/rules/privatization/tests/Rector/Property/PrivatizeFinalClassPropertyRector/AbstractClassWithProtectedProperty.php b/rules/privatization/tests/Rector/Property/PrivatizeFinalClassPropertyRector/Source/AbstractClassWithProtectedProperty.php
similarity index 87%
rename from rules/privatization/tests/Rector/Property/PrivatizeFinalClassPropertyRector/AbstractClassWithProtectedProperty.php
rename to rules/privatization/tests/Rector/Property/PrivatizeFinalClassPropertyRector/Source/AbstractClassWithProtectedProperty.php
index 7f7e03907f39..1810cf0de82f 100644
--- a/rules/privatization/tests/Rector/Property/PrivatizeFinalClassPropertyRector/AbstractClassWithProtectedProperty.php
+++ b/rules/privatization/tests/Rector/Property/PrivatizeFinalClassPropertyRector/Source/AbstractClassWithProtectedProperty.php
@@ -2,7 +2,7 @@
 
 declare(strict_types=1);
 
-namespace Rector\Privatization\Tests\Rector\Property\PrivatizeFinalClassPropertyRector;
+namespace Rector\Privatization\Tests\Rector\Property\PrivatizeFinalClassPropertyRector\Source;
 
 abstract class AbstractClassWithProtectedProperty
 {