chore: move laravel model logic to a separate service

Author: calebdw

rules/Privatization/Guard/LaravelModelGuard.php

@@ -0,0 +1,79 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Rector\Privatization\Guard;
+
+use PhpParser\Node;
+use PhpParser\Node\Stmt\ClassMethod;
+use PHPStan\Reflection\ClassReflection;
+use PHPStan\Type\ObjectType;
+use Rector\NodeNameResolver\NodeNameResolver;
+use Rector\NodeTypeResolver\NodeTypeResolver;
+use Rector\Php80\NodeAnalyzer\PhpAttributeAnalyzer;
+use Rector\Util\StringUtils;
+
+/**
+ * Guards against privatizing Laravel model attributes and scopes
+ */
+final readonly class LaravelModelGuard
+{
+    /**
+     * @var string
+     * @see https://regex101.com/r/Dx0WN5/2
+     */
+    private const LARAVEL_MODEL_ATTRIBUTE_REGEX = '#^[gs]et.+Attribute$#';
+
+    /**
+     * @var string
+     * @see https://regex101.com/r/hxOGeN/2
+     */
+    private const LARAVEL_MODEL_SCOPE_REGEX = '#^scope.+$#';
+
+    public function __construct(
+        private PhpAttributeAnalyzer $phpAttributeAnalyzer,
+        private NodeNameResolver $nodeNameResolver,
+        private NodeTypeResolver $nodeTypeResolver,
+    ) {
+    }
+
+    public function isProtectedMethod(ClassReflection $classReflection, ClassMethod $classMethod): bool
+    {
+        if (! $classReflection->is('Illuminate\Database\Eloquent\Model')) {
+            return false;
+        }
+
+        $name = (string) $this->nodeNameResolver->getName($classMethod->name);
+
+        return $this->isAttributeMethod($name, $classMethod)
+            || $this->isScopeMethod($name, $classMethod);
+    }
+
+    private function isAttributeMethod(string $name, ClassMethod $classMethod): bool
+    {
+        if (StringUtils::isMatch($name, self::LARAVEL_MODEL_ATTRIBUTE_REGEX)) {
+            return true;
+        }
+
+        if (! $classMethod->returnType instanceof Node) {
+            return false;
+        }
+
+        return $this->nodeTypeResolver->isObjectType(
+            $classMethod->returnType,
+            new ObjectType('Illuminate\Database\Eloquent\Casts\Attribute')
+        );
+    }
+
+    private function isScopeMethod(string $name, ClassMethod $classMethod): bool
+    {
+        if (StringUtils::isMatch($name, self::LARAVEL_MODEL_SCOPE_REGEX)) {
+            return true;
+        }
+
+        return $this->phpAttributeAnalyzer->hasPhpAttribute(
+            $classMethod,
+            'Illuminate\Database\Eloquent\Attributes\Scope'
+        );
+    }
+}

rules/Privatization/Rector/ClassMethod/PrivatizeFinalClassMethodRector.php

@@ -9,15 +9,13 @@
 use PhpParser\Node\Stmt\Class_;
 use PhpParser\Node\Stmt\ClassMethod;
 use PHPStan\Reflection\ClassReflection;
-use PHPStan\Type\ObjectType;
-use Rector\Php80\NodeAnalyzer\PhpAttributeAnalyzer;
 use Rector\PhpParser\Node\BetterNodeFinder;
 use Rector\PHPStan\ScopeFetcher;
+use Rector\Privatization\Guard\LaravelModelGuard;
 use Rector\Privatization\Guard\OverrideByParentClassGuard;
 use Rector\Privatization\NodeManipulator\VisibilityManipulator;
 use Rector\Privatization\VisibilityGuard\ClassMethodVisibilityGuard;
 use Rector\Rector\AbstractRector;
-use Rector\Util\StringUtils;
 use Symplify\RuleDocGenerator\ValueObject\CodeSample\CodeSample;
 use Symplify\RuleDocGenerator\ValueObject\RuleDefinition;
 
@@ -26,24 +24,12 @@
  */
 final class PrivatizeFinalClassMethodRector extends AbstractRector
 {
-    /**
-     * @var string
-     * @see https://regex101.com/r/Dx0WN5/2
-     */
-    private const LARAVEL_MODEL_ATTRIBUTE_REGEX = '/^[gs]et.+Attribute$/';
-
-    /**
-     * @var string
-     * @see https://regex101.com/r/hxOGeN/2
-     */
-    private const LARAVEL_MODEL_SCOPE_REGEX = '/^scope.+$/';
-
     public function __construct(
         private readonly ClassMethodVisibilityGuard $classMethodVisibilityGuard,
         private readonly VisibilityManipulator $visibilityManipulator,
         private readonly OverrideByParentClassGuard $overrideByParentClassGuard,
         private readonly BetterNodeFinder $betterNodeFinder,
-        private readonly PhpAttributeAnalyzer $phpAttributeAnalyzer,
+        private readonly LaravelModelGuard $laravelModelGuard,
     ) {
     }
 
@@ -105,7 +91,11 @@ public function refactor(Node $node): ?Node
         $hasChanged = false;
 
         foreach ($node->getMethods() as $classMethod) {
-            if ($this->shouldSkipClassMethod($classReflection, $classMethod)) {
+            if ($this->shouldSkipClassMethod($classMethod)) {
+                continue;
+            }
+
+            if ($this->laravelModelGuard->isProtectedMethod($classReflection, $classMethod)) {
                 continue;
             }
 
@@ -134,7 +124,7 @@ public function refactor(Node $node): ?Node
         return null;
     }
 
-    private function shouldSkipClassMethod(ClassReflection $classReflection, ClassMethod $classMethod): bool
+    private function shouldSkipClassMethod(ClassMethod $classMethod): bool
     {
         // edge case in nette framework
         /** @var string $methodName */
@@ -151,10 +141,6 @@ private function shouldSkipClassMethod(ClassReflection $classReflection, ClassMe
             return true;
         }
 
-        if ($this->shouldSkipClassMethodLaravel($classReflection, $classMethod)) {
-            return true;
-        }
-
         // if has parent call, its probably overriding parent one → skip it
         $hasParentCall = (bool) $this->betterNodeFinder->findFirst(
             (array) $classMethod->stmts,
@@ -169,38 +155,4 @@ function (Node $node): bool {
 
         return $hasParentCall;
     }
-
-    private function shouldSkipClassMethodLaravel(ClassReflection $classReflection, ClassMethod $classMethod): bool
-    {
-        if (! $classReflection->is('Illuminate\Database\Eloquent\Model')) {
-            return false;
-        }
-
-        $name = (string) $this->getName($classMethod->name);
-        $returnType = $classMethod->returnType;
-
-        // Model attributes should be protected
-        if (
-            StringUtils::isMatch($name, self::LARAVEL_MODEL_ATTRIBUTE_REGEX)
-            || ($returnType instanceof Node && $this->isObjectType(
-                $returnType,
-                new ObjectType('Illuminate\Database\Eloquent\Casts\Attribute')
-            ))
-        ) {
-            return true;
-        }
-
-        // Model scopes should be protected
-        if (
-            StringUtils::isMatch($name, self::LARAVEL_MODEL_SCOPE_REGEX)
-            || $this->phpAttributeAnalyzer->hasPhpAttribute(
-                $classMethod,
-                'Illuminate\Database\Eloquent\Attributes\Scope'
-            )
-        ) {
-            return true;
-        }
-
-        return false;
-    }
 }