extracted MethodTypeDetector to ease re-use (#63)

Co-authored-by: Tomas Votruba <tomas.vot@gmail.com>
TomasVotruba · Jun 26, 2023 · 1520e42 · 1520e42
1 parent 46d3aab
commit 1520e42
Show file tree

Hide file tree

Showing 3 changed files with 58 additions and 38 deletions.
diff --git a/config/extension.neon b/config/extension.neon
@@ -21,6 +21,7 @@ parameters:
 
 services:
     - TomasVotruba\UnusedPublic\PublicClassMethodMatcher
+    - TomasVotruba\UnusedPublic\MethodTypeDetector
     - TomasVotruba\UnusedPublic\ClassTypeDetector
     - TomasVotruba\UnusedPublic\ApiDocStmtAnalyzer
     - TomasVotruba\UnusedPublic\ClassMethodCallReferenceResolver

diff --git a/src/Collectors/PublicClassMethodCollector.php b/src/Collectors/PublicClassMethodCollector.php
@@ -13,6 +13,7 @@
 use PHPStan\Reflection\ResolvedMethodReflection;
 use TomasVotruba\UnusedPublic\ApiDocStmtAnalyzer;
 use TomasVotruba\UnusedPublic\Configuration;
+use TomasVotruba\UnusedPublic\MethodTypeDetector;
 use TomasVotruba\UnusedPublic\PublicClassMethodMatcher;
 
 /**
@@ -38,9 +39,10 @@ final class PublicClassMethodCollector implements Collector
     ];
 
     public function __construct(
-        private readonly ApiDocStmtAnalyzer $apiDocStmtAnalyzer,
+        private readonly ApiDocStmtAnalyzer       $apiDocStmtAnalyzer,
         private readonly PublicClassMethodMatcher $publicClassMethodMatcher,
-        private readonly Configuration $configuration,
+        private readonly MethodTypeDetector       $methodMatcher,
+        private readonly Configuration            $configuration,
     ) {
     }
 
@@ -59,11 +61,11 @@ public function processNode(Node $node, Scope $scope): ?array
             return null;
         }
 
-        if ($this->isTestMethod($node, $scope)) {
+        if ($this->methodMatcher->isTestMethod($node, $scope)) {
             return null;
         }
 
-        if ($this->isTraitMethod($node, $scope)) {
+        if ($this->methodMatcher->isTraitMethod($node, $scope)) {
             return null;
         }
 
@@ -105,39 +107,5 @@ public function processNode(Node $node, Scope $scope): ?array
         return [$classReflection->getName(), $methodName, $node->getLine()];
     }
 
-    private function isTestMethod(ClassMethod $classMethod, Scope $scope): bool
-    {
-        $classMethodName = $classMethod->name->toString();
-        if (str_starts_with($classMethodName, 'test')) {
-            return true;
-        }
-
-        $classReflection = $scope->getClassReflection();
-        if (! $classReflection instanceof ClassReflection) {
-            return false;
-        }
-
-        $extendedMethodReflection = $classReflection->getMethod($classMethodName, $scope);
 
-        if ($extendedMethodReflection->getDocComment() === null) {
-            return false;
-        }
-
-        return str_contains($extendedMethodReflection->getDocComment(), '@test');
-    }
-
-    private function isTraitMethod(ClassMethod $classMethod, Scope $scope): bool
-    {
-        $classReflection = $scope->getClassReflection();
-        if (! $classReflection instanceof ClassReflection) {
-            return false;
-        }
-
-        $extendedMethodReflection = $classReflection->getMethod($classMethod->name->toString(), $scope);
-        if ($extendedMethodReflection instanceof PhpMethodReflection || $extendedMethodReflection instanceof ResolvedMethodReflection) {
-            return $extendedMethodReflection->getDeclaringTrait() instanceof ClassReflection;
-        }
-
-        return false;
-    }
 }
diff --git a/src/MethodTypeDetector.php b/src/MethodTypeDetector.php
@@ -0,0 +1,51 @@
+<?php
+
+declare(strict_types=1);
+
+namespace TomasVotruba\UnusedPublic;
+
+use PhpParser\Comment\Doc;
+use PhpParser\Node\Stmt\ClassMethod;
+use PHPStan\Analyser\Scope;
+use PHPStan\Reflection\ClassReflection;
+use PHPStan\Reflection\Php\PhpMethodReflection;
+use PHPStan\Reflection\ResolvedMethodReflection;
+
+final class MethodTypeDetector
+{
+    public function isTestMethod(ClassMethod $classMethod, Scope $scope): bool
+    {
+        $classMethodName = $classMethod->name->toString();
+        if (str_starts_with($classMethodName, 'test')) {
+            return true;
+        }
+
+        $classReflection = $scope->getClassReflection();
+        if (! $classReflection instanceof ClassReflection) {
+            return false;
+        }
+
+        $extendedMethodReflection = $classReflection->getMethod($classMethodName, $scope);
+
+        if ($extendedMethodReflection->getDocComment() === null) {
+            return false;
+        }
+
+        return str_contains($extendedMethodReflection->getDocComment(), '@test');
+    }
+
+    public function isTraitMethod(ClassMethod $classMethod, Scope $scope): bool
+    {
+        $classReflection = $scope->getClassReflection();
+        if (! $classReflection instanceof ClassReflection) {
+            return false;
+        }
+
+        $extendedMethodReflection = $classReflection->getMethod($classMethod->name->toString(), $scope);
+        if ($extendedMethodReflection instanceof PhpMethodReflection || $extendedMethodReflection instanceof ResolvedMethodReflection) {
+            return $extendedMethodReflection->getDeclaringTrait() instanceof ClassReflection;
+        }
+
+        return false;
+    }
+}