[DX] Decouple AssignVariableNameResolver

rectorphp · Dec 8, 2021 · a3bebbd · a3bebbd
1 parent ee3ca5a
commit a3bebbd
Show file tree

Hide file tree

Showing 6 changed files with 120 additions and 38 deletions.
diff --git a/easy-ci.php b/easy-ci.php
@@ -13,6 +13,7 @@
 use Rector\DependencyInjection\NodeManipulator\PropertyConstructorInjectionManipulator;
 use Rector\FileFormatter\Contract\Formatter\FileFormatterInterface;
 use Rector\FileSystemRector\Parser\FileInfoParser;
+use Rector\Naming\Contract\AssignVariableNameResolverInterface;
 use Rector\Naming\Contract\Guard\ConflictingNameGuardInterface;
 use Rector\NodeNameResolver\Contract\NodeNameResolverInterface;
 use Rector\NodeTypeResolver\Contract\NodeTypeResolverInterface;
@@ -64,6 +65,7 @@
         OutputStyleInterface::class,
         FileFormatterInterface::class,
         MethodCallManipulator::class,
+        AssignVariableNameResolverInterface::class,
         // fix later - rector-symfony
         PropertyConstructorInjectionManipulator::class,
         // used in tests

diff --git a/rules/Naming/AssignVariableNameResolver/NewAssignVariableNameResolver.php b/rules/Naming/AssignVariableNameResolver/NewAssignVariableNameResolver.php
@@ -0,0 +1,40 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Rector\Naming\AssignVariableNameResolver;
+
+use PhpParser\Node;
+use PhpParser\Node\Expr\New_;
+use Rector\Core\Exception\NotImplementedYetException;
+use Rector\Naming\Contract\AssignVariableNameResolverInterface;
+use Rector\NodeNameResolver\NodeNameResolver;
+
+/**
+ * @implements AssignVariableNameResolverInterface<New_>
+ */
+final class NewAssignVariableNameResolver implements AssignVariableNameResolverInterface
+{
+    public function __construct(
+        private readonly NodeNameResolver $nodeNameResolver
+    ) {
+    }
+
+    public function match(Node $node): bool
+    {
+        return $node instanceof New_;
+    }
+
+    /**
+     * @param New_ $node
+     */
+    public function resolve(Node $node): string
+    {
+        $className = $this->nodeNameResolver->getName($node->class);
+        if ($className === null) {
+            throw new NotImplementedYetException();
+        }
+
+        return $this->nodeNameResolver->getShortName($className);
+    }
+}
diff --git a/rules/Naming/AssignVariableNameResolver/PropertyFetchAssignVariableNameResolver.php b/rules/Naming/AssignVariableNameResolver/PropertyFetchAssignVariableNameResolver.php
@@ -0,0 +1,49 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Rector\Naming\AssignVariableNameResolver;
+
+use PhpParser\Node;
+use PhpParser\Node\Expr\PropertyFetch;
+use Rector\Core\Exception\NotImplementedYetException;
+use Rector\Naming\Contract\AssignVariableNameResolverInterface;
+use Rector\NodeNameResolver\NodeNameResolver;
+
+/**
+ * @implements AssignVariableNameResolverInterface<PropertyFetch>
+ */
+final class PropertyFetchAssignVariableNameResolver implements AssignVariableNameResolverInterface
+{
+    public function __construct(
+        private readonly NodeNameResolver $nodeNameResolver
+    ) {
+    }
+
+    public function match(Node $node): bool
+    {
+        return $node instanceof PropertyFetch;
+    }
+
+    /**
+     * @param PropertyFetch $node
+     */
+    public function resolve(Node $node): string
+    {
+        $varName = $this->nodeNameResolver->getName($node->var);
+        if (! is_string($varName)) {
+            throw new NotImplementedYetException();
+        }
+
+        $propertyName = $this->nodeNameResolver->getName($node->name);
+        if (! is_string($propertyName)) {
+            throw new NotImplementedYetException();
+        }
+
+        if ($varName === 'this') {
+            return $propertyName;
+        }
+
+        return $varName . ucfirst($propertyName);
+    }
+}
diff --git a/rules/Naming/Contract/AssignVariableNameResolverInterface.php b/rules/Naming/Contract/AssignVariableNameResolverInterface.php
@@ -0,0 +1,20 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Rector\Naming\Contract;
+
+use PhpParser\Node;
+
+/**
+ * @template TNode as Node
+ */
+interface AssignVariableNameResolverInterface
+{
+    public function match(Node $node): bool;
+
+    /**
+     * @param TNode $node
+     */
+    public function resolve(Node $node): string;
+}
diff --git a/rules/Naming/Naming/VariableNaming.php b/rules/Naming/Naming/VariableNaming.php
@@ -11,9 +11,7 @@
 use PhpParser\Node\Expr\Cast;
 use PhpParser\Node\Expr\FuncCall;
 use PhpParser\Node\Expr\MethodCall;
-use PhpParser\Node\Expr\New_;
 use PhpParser\Node\Expr\NullsafeMethodCall;
-use PhpParser\Node\Expr\PropertyFetch;
 use PhpParser\Node\Expr\StaticCall;
 use PhpParser\Node\Expr\Ternary;
 use PhpParser\Node\Name;
@@ -22,15 +20,20 @@
 use PHPStan\Type\ThisType;
 use PHPStan\Type\Type;
 use Rector\Core\Exception\NotImplementedYetException;
+use Rector\Naming\Contract\AssignVariableNameResolverInterface;
 use Rector\NodeNameResolver\NodeNameResolver;
 use Rector\NodeTypeResolver\NodeTypeResolver;
 use Symfony\Component\String\UnicodeString;
 
 final class VariableNaming
 {
+    /**
+     * @param AssignVariableNameResolverInterface[] $assignVariableNameResolvers
+     */
     public function __construct(
         private readonly NodeNameResolver $nodeNameResolver,
         private readonly NodeTypeResolver $nodeTypeResolver,
+        private readonly array $assignVariableNameResolvers
     ) {
     }
 
@@ -114,18 +117,16 @@ private function resolveBareFromNode(Node $node): ?string
     {
         $node = $this->unwrapNode($node);
 
-        if ($node instanceof PropertyFetch) {
-            return $this->resolveFromPropertyFetch($node);
+        foreach ($this->assignVariableNameResolvers as $assignVariableNameResolver) {
+            if ($assignVariableNameResolver->match($node)) {
+                return $assignVariableNameResolver->resolve($node);
+            }
         }
 
         if ($node !== null && ($node instanceof MethodCall || $node instanceof NullsafeMethodCall || $node instanceof StaticCall)) {
             return $this->resolveFromMethodCall($node);
         }
 
-        if ($node instanceof New_) {
-            return $this->resolveFromNew($node);
-        }
-
         if ($node instanceof FuncCall) {
             return $this->resolveFromNode($node->name);
         }
@@ -146,25 +147,6 @@ private function resolveBareFromNode(Node $node): ?string
         return null;
     }
 
-    private function resolveFromPropertyFetch(PropertyFetch $propertyFetch): string
-    {
-        $varName = $this->nodeNameResolver->getName($propertyFetch->var);
-        if (! is_string($varName)) {
-            throw new NotImplementedYetException();
-        }
-
-        $propertyName = $this->nodeNameResolver->getName($propertyFetch->name);
-        if (! is_string($propertyName)) {
-            throw new NotImplementedYetException();
-        }
-
-        if ($varName === 'this') {
-            return $propertyName;
-        }
-
-        return $varName . ucfirst($propertyName);
-    }
-
     private function resolveFromMethodCall(MethodCall | NullsafeMethodCall | StaticCall $node): ?string
     {
         if ($node->name instanceof MethodCall) {
@@ -179,16 +161,6 @@ private function resolveFromMethodCall(MethodCall | NullsafeMethodCall | StaticC
         return $methodName;
     }
 
-    private function resolveFromNew(New_ $new): string
-    {
-        $className = $this->nodeNameResolver->getName($new->class);
-        if ($className === null) {
-            throw new NotImplementedYetException();
-        }
-
-        return $this->nodeNameResolver->getShortName($className);
-    }
-
     private function unwrapNode(Node $node): ?Node
     {
         if ($node instanceof Arg) {

diff --git a/rules/Privatization/Naming/ConstantNaming.php b/rules/Privatization/Naming/ConstantNaming.php
@@ -36,7 +36,6 @@ public function createFromVariable(Variable $variable): string|null
     private function createUnderscoreUppercaseString(string $propertyName): string
     {
         $propertyNameUnicodeString = new UnicodeString($propertyName);
-
         return $propertyNameUnicodeString->snake()
             ->upper()
             ->toString();