Reduce memory consumption of collectors (#131)

TomasVotruba · Sep 16, 2024 · c82b690 · c82b690
1 parent 0d3003f
commit c82b690
Show file tree

Hide file tree

Showing 13 changed files with 42 additions and 22 deletions.
diff --git a/src/Collectors/Callable_/AttributeCallableCollector.php b/src/Collectors/Callable_/AttributeCallableCollector.php
@@ -17,7 +17,7 @@
 use TomasVotruba\UnusedPublic\ValueObject\ClassAndMethodArrayExprs;
 
 /**
- * @implements Collector<AttributeGroup, array<string>|null>
+ * @implements Collector<AttributeGroup, non-empty-array<string>|null>
  */
 final readonly class AttributeCallableCollector implements Collector
 {

diff --git a/src/Collectors/Callable_/CallUserFuncCollector.php b/src/Collectors/Callable_/CallUserFuncCollector.php
@@ -15,7 +15,7 @@
 use TomasVotruba\UnusedPublic\Configuration;
 
 /**
- * @implements Collector<FuncCall, array<string>|null>
+ * @implements Collector<FuncCall, non-empty-array<string>|null>
  */
 final readonly class CallUserFuncCollector implements Collector
 {

diff --git a/src/Collectors/ClassConstFetchCollector.php b/src/Collectors/ClassConstFetchCollector.php
@@ -15,7 +15,7 @@
 use TomasVotruba\UnusedPublic\Configuration;
 
 /**
- * @implements Collector<ClassConstFetch, string[]>
+ * @implements Collector<ClassConstFetch, non-empty-array<string>|null>
  */
 final readonly class ClassConstFetchCollector implements Collector
 {
@@ -32,12 +32,12 @@ public function getNodeType(): string
 
     /**
      * @param ClassConstFetch $node
-     * @return string[]|null
+     * @return non-empty-array<string>|null
      */
     public function processNode(Node $node, Scope $scope): ?array
     {
         if (! $this->configuration->isUnusedConstantsEnabled()) {
-            return [];
+            return null;
         }
 
         if (! $node->class instanceof Name) {

diff --git a/src/Collectors/FormTypeClassCollector.php b/src/Collectors/FormTypeClassCollector.php
@@ -14,7 +14,7 @@
 
 /**
  * Match Symfony data_class element in forms types, as those use magic setters/getters
- * @implements Collector<ArrayItem, array<string>|null>
+ * @implements Collector<ArrayItem, non-empty-array<string>|null>
  */
 final readonly class FormTypeClassCollector implements Collector
 {
@@ -30,7 +30,7 @@ public function getNodeType(): string
 
     /**
      * @param ArrayItem $node
-     * @return string[]|null
+     * @return non-empty-array<string>|null
      */
     public function processNode(Node $node, Scope $scope): ?array
     {

diff --git a/src/Collectors/MethodCall/MethodCallCollector.php b/src/Collectors/MethodCall/MethodCallCollector.php
@@ -17,7 +17,7 @@
 use TomasVotruba\UnusedPublic\Configuration;
 
 /**
- * @implements Collector<MethodCall, array<string>|null>
+ * @implements Collector<MethodCall, non-empty-array<string>|null>
  */
 final readonly class MethodCallCollector implements Collector
 {

diff --git a/src/Collectors/MethodCall/MethodCallableCollector.php b/src/Collectors/MethodCall/MethodCallableCollector.php
@@ -16,7 +16,7 @@
 use TomasVotruba\UnusedPublic\Configuration;
 
 /**
- * @implements Collector<MethodCallableNode, array<string>|null>
+ * @implements Collector<MethodCallableNode, non-empty-array<string>|null>
  */
 final readonly class MethodCallableCollector implements Collector
 {

diff --git a/src/Collectors/PublicClassLikeConstCollector.php b/src/Collectors/PublicClassLikeConstCollector.php
@@ -13,7 +13,7 @@
 use TomasVotruba\UnusedPublic\Configuration;
 
 /**
- * @implements Collector<ClassConst, array<array{class-string, string, int}>>
+ * @implements Collector<ClassConst, non-empty-array<array{class-string, string, int}>|null>
  */
 final readonly class PublicClassLikeConstCollector implements Collector
 {
@@ -30,12 +30,12 @@ public function getNodeType(): string
 
     /**
      * @param ClassConst $node
-     * @return array<array{class-string, string, int}>|null
+     * @return non-empty-array<array{class-string, string, int}>|null
      */
     public function processNode(Node $node, Scope $scope): ?array
     {
         if (! $this->configuration->isUnusedConstantsEnabled()) {
-            return [];
+            return null;
         }
 
         if (! $node->isPublic()) {
@@ -56,6 +56,10 @@ public function processNode(Node $node, Scope $scope): ?array
             $constantNames[] = [$classReflection->getName(), $constConst->name->toString(), $node->getLine()];
         }
 
+        if ([] === $constantNames) {
+            return null;
+        }
+
         return $constantNames;
     }
 }
diff --git a/src/Collectors/PublicPropertyCollector.php b/src/Collectors/PublicPropertyCollector.php
@@ -15,7 +15,7 @@
 use TomasVotruba\UnusedPublic\Configuration;
 
 /**
- * @implements Collector<InClassNode, array<array{class-string, string, int}>>
+ * @implements Collector<InClassNode, non-empty-array<array{class-string, string, int}>>
  */
 final readonly class PublicPropertyCollector implements Collector
 {
@@ -40,7 +40,7 @@ public function getNodeType(): string
 
     /**
      * @param InClassNode $node
-     * @return array<array{string, string, int}>|null
+     * @return non-empty-array<array{string, string, int}>|null
      */
     public function processNode(Node $node, Scope $scope): ?array
     {
@@ -79,6 +79,10 @@ public function processNode(Node $node, Scope $scope): ?array
             }
         }
 
+        if ($publicPropertyNames === []) {
+            return null;
+        }
+
         return $publicPropertyNames;
     }
 

diff --git a/src/Collectors/PublicPropertyFetchCollector.php b/src/Collectors/PublicPropertyFetchCollector.php
@@ -15,7 +15,7 @@
 use TomasVotruba\UnusedPublic\Configuration;
 
 /**
- * @implements Collector<PropertyFetch, string[]>
+ * @implements Collector<PropertyFetch, non-empty-array<string>|null>
  */
 final readonly class PublicPropertyFetchCollector implements Collector
 {
@@ -35,7 +35,7 @@ public function getNodeType(): string
 
     /**
      * @param PropertyFetch $node
-     * @return string[]|null
+     * @return non-empty-array<string>|null
      */
     public function processNode(Node $node, Scope $scope): ?array
     {
@@ -70,6 +70,10 @@ public function processNode(Node $node, Scope $scope): ?array
             $result[] = $propertyReflection->getDeclaringClass()->getName() . '::' . $propertyName;
         }
 
+        if ($result === []) {
+            return null;
+        }
+
         return $result;
     }
 }
diff --git a/src/Collectors/PublicStaticPropertyFetchCollector.php b/src/Collectors/PublicStaticPropertyFetchCollector.php
@@ -15,7 +15,7 @@
 use TomasVotruba\UnusedPublic\Configuration;
 
 /**
- * @implements Collector<StaticPropertyFetch, string[]>
+ * @implements Collector<StaticPropertyFetch, non-empty-array<string>|null>
  */
 final readonly class PublicStaticPropertyFetchCollector implements Collector
 {
@@ -32,7 +32,7 @@ public function getNodeType(): string
 
     /**
      * @param StaticPropertyFetch $node
-     * @return string[]|null
+     * @return non-empty-array<string>|null
      */
     public function processNode(Node $node, Scope $scope): ?array
     {
@@ -73,6 +73,10 @@ public function processNode(Node $node, Scope $scope): ?array
             $result[] = $propertyReflection->getDeclaringClass()->getName() . '::' . $propertyName;
         }
 
+        if ($result === []) {
+            return null;
+        }
+
         return $result;
     }
 }
diff --git a/src/Collectors/StaticCall/StaticMethodCallCollector.php b/src/Collectors/StaticCall/StaticMethodCallCollector.php
@@ -15,7 +15,7 @@
 use TomasVotruba\UnusedPublic\Configuration;
 
 /**
- * @implements Collector<StaticCall, array<string>|null>
+ * @implements Collector<StaticCall, non-empty-array<string>|null>
  */
 final readonly class StaticMethodCallCollector implements Collector
 {
@@ -32,7 +32,7 @@ public function getNodeType(): string
 
     /**
      * @param StaticCall $node
-     * @return string[]|null
+     * @return non-empty-array<string>|null
      */
     public function processNode(Node $node, Scope $scope): ?array
     {

diff --git a/src/Collectors/StaticCall/StaticMethodCallableCollector.php b/src/Collectors/StaticCall/StaticMethodCallableCollector.php
@@ -15,7 +15,7 @@
 use TomasVotruba\UnusedPublic\Configuration;
 
 /**
- * @implements Collector<StaticMethodCallableNode, array<string>|null>
+ * @implements Collector<StaticMethodCallableNode, non-empty-array<string>|null>
  */
 final readonly class StaticMethodCallableCollector implements Collector
 {
@@ -32,7 +32,7 @@ public function getNodeType(): string
 
     /**
      * @param StaticMethodCallableNode $node
-     * @return string[]|null
+     * @return non-empty-array<string>|null
      */
     public function processNode(Node $node, Scope $scope): ?array
     {

diff --git a/src/Rules/UnusedPublicClassConstRule.php b/src/Rules/UnusedPublicClassConstRule.php
@@ -67,6 +67,10 @@ public function processNode(Node $node, Scope $scope): array
 
         foreach ($publicClassLikeConstCollector as $filePath => $declarationsGroups) {
             foreach ($declarationsGroups as $declarationGroup) {
+                if ($declarationGroup === null) {
+                    continue;
+                }
+
                 foreach ($declarationGroup as [$className, $constantName, $line]) {
                     if ($this->isClassConstantUsed(
                         $className,