Detect callables in any static array (TomasVotruba#140)

* Detect callables in any static array

* more tests

* Update CallableTypeCollector.php

Author: staabm

config/extension.neon

@@ -101,7 +101,7 @@ services:
             - phpstan.collector
 
     -
-        class: TomasVotruba\UnusedPublic\Collectors\Callable_\CallbackFunctionCollector
+        class: TomasVotruba\UnusedPublic\Collectors\Callable_\CallableTypeCollector
         tags:
             - phpstan.collector
 

src/Collectors/Callable_/CallbackFunctionCollector.php src/Collectors/Callable_/CallableTypeCollector.php

@@ -13,9 +13,9 @@
 use TomasVotruba\UnusedPublic\Configuration;
 
 /**
- * @implements Collector<FuncCall, non-empty-array<string>|null>
+ * @implements Collector<Expr\Array_, non-empty-array<string>|null>
  */
-final readonly class CallbackFunctionCollector implements Collector
+final readonly class CallableTypeCollector implements Collector
 {
     public function __construct(
         private Configuration $configuration,
@@ -24,11 +24,11 @@ public function __construct(
 
     public function getNodeType(): string
     {
-        return FuncCall::class;
+        return Expr\Array_::class;
     }
 
     /**
-     * @param FuncCall $node
+     * @param Expr\Array_ $node
      * @return string[]|null
      */
     public function processNode(Node $node, Scope $scope): ?array
@@ -37,16 +37,7 @@ public function processNode(Node $node, Scope $scope): ?array
             return null;
         }
 
-        if ($this->shouldSkipNode($node)) {
-            return null;
-        }
-
-        $args = $node->getArgs();
-        if (count($args) < 1) {
-            return null;
-        }
-
-        $callableType = $scope->getType($args[0]->value);
+        $callableType = $scope->getType($node);
         if (! $callableType instanceof ConstantArrayType) {
             return null;
         }
@@ -72,20 +63,4 @@ public function processNode(Node $node, Scope $scope): ?array
         return $classMethodReferences;
     }
 
-    /**
-     * @param FuncCall $node
-     */
-    private function shouldSkipNode(Node $node): bool
-    {
-        // unable to resolve method name
-        if ($node->name instanceof Expr) {
-            return true;
-        }
-
-        return !in_array(
-            strtolower($node->name->toString()),
-            ['call_user_func', 'register_shutdown_function'],
-            true
-        );
-    }
 }

src/NodeCollectorExtractor.php

@@ -7,7 +7,7 @@
 use PHPStan\Node\CollectedDataNode;
 use TomasVotruba\UnusedPublic\CollectorMapper\MethodCallCollectorMapper;
 use TomasVotruba\UnusedPublic\Collectors\Callable_\AttributeCallableCollector;
-use TomasVotruba\UnusedPublic\Collectors\Callable_\CallbackFunctionCollector;
+use TomasVotruba\UnusedPublic\Collectors\Callable_\CallableTypeCollector;
 use TomasVotruba\UnusedPublic\Collectors\MethodCall\MethodCallableCollector;
 use TomasVotruba\UnusedPublic\Collectors\MethodCall\MethodCallCollector;
 use TomasVotruba\UnusedPublic\Collectors\StaticCall\StaticMethodCallableCollector;
@@ -49,7 +49,7 @@ private function extractCollectedDatas(CollectedDataNode $collectedDataNode): ar
             $collectedDataNode->get(StaticMethodCallCollector::class),
             $collectedDataNode->get(StaticMethodCallableCollector::class),
             $collectedDataNode->get(AttributeCallableCollector::class),
-            $collectedDataNode->get(CallbackFunctionCollector::class),
+            $collectedDataNode->get(CallableTypeCollector::class),
         ];
     }
 }

tests/Rules/LocalOnlyPublicClassMethodRule/LocalOnlyPublicClassMethodRuleTest.php

@@ -10,7 +10,7 @@
 use PHPStan\Testing\RuleTestCase;
 use PHPUnit\Framework\Attributes\DataProvider;
 use TomasVotruba\UnusedPublic\Collectors\Callable_\AttributeCallableCollector;
-use TomasVotruba\UnusedPublic\Collectors\Callable_\CallbackFunctionCollector;
+use TomasVotruba\UnusedPublic\Collectors\Callable_\CallableTypeCollector;
 use TomasVotruba\UnusedPublic\Collectors\MethodCall\MethodCallCollector;
 use TomasVotruba\UnusedPublic\Collectors\PublicClassMethodCollector;
 use TomasVotruba\UnusedPublic\Collectors\StaticCall\StaticMethodCallCollector;
@@ -91,7 +91,7 @@ protected function getCollectors(): array
             self::getContainer()->getByType(MethodCallCollector::class),
             self::getContainer()->getByType(StaticMethodCallCollector::class),
             self::getContainer()->getByType(AttributeCallableCollector::class),
-            self::getContainer()->getByType(CallbackFunctionCollector::class),
+            self::getContainer()->getByType(CallableTypeCollector::class),
         ];
     }
 

tests/Rules/RelativeUnusedPublicClassMethodRule/RelativeUnusedPublicClassMethodRuleTest.php

@@ -10,7 +10,7 @@
 use PHPStan\Testing\RuleTestCase;
 use PHPUnit\Framework\Attributes\DataProvider;
 use TomasVotruba\UnusedPublic\Collectors\Callable_\AttributeCallableCollector;
-use TomasVotruba\UnusedPublic\Collectors\Callable_\CallbackFunctionCollector;
+use TomasVotruba\UnusedPublic\Collectors\Callable_\CallableTypeCollector;
 use TomasVotruba\UnusedPublic\Collectors\FormTypeClassCollector;
 use TomasVotruba\UnusedPublic\Collectors\MethodCall\MethodCallableCollector;
 use TomasVotruba\UnusedPublic\Collectors\MethodCall\MethodCallCollector;
@@ -64,7 +64,7 @@ protected function getCollectors(): array
             // callables
             self::getContainer()->getByType(StaticMethodCallableCollector::class),
             self::getContainer()->getByType(AttributeCallableCollector::class),
-            self::getContainer()->getByType(CallbackFunctionCollector::class),
+            self::getContainer()->getByType(CallableTypeCollector::class),
         ];
     }
 

tests/Rules/UnusedPublicClassMethodRule/Fixture/plain-call-custom-function.php

@@ -0,0 +1,13 @@
+<?php
+
+declare(strict_types=1);
+
+namespace TomasVotruba\UnusedPublic\Tests\Rules\UnusedPublicClassMethodRule\Fixture;
+
+/**
+ * @var \TomasVotruba\UnusedPublic\Tests\Rules\UnusedPublicClassMethodRule\Source\Caller1 $caller1
+ */
+
+myFunc([$caller1, 'callIt']);
+
+function myFunc(callable $c) {}

tests/Rules/UnusedPublicClassMethodRule/Fixture/plain-call-custom-method.php

@@ -0,0 +1,16 @@
+<?php
+
+declare(strict_types=1);
+
+namespace TomasVotruba\UnusedPublic\Tests\Rules\UnusedPublicClassMethodRule\Fixture;
+
+/**
+ * @var \TomasVotruba\UnusedPublic\Tests\Rules\UnusedPublicClassMethodRule\Source\Caller1 $caller1
+ */
+
+$c = new MyClass();
+$c->myMethod([$caller1, 'callIt']);
+
+class MyClass {
+    function myMethod(callable $c) {}
+}

tests/Rules/UnusedPublicClassMethodRule/UnusedPublicClassMethodRuleTest.php

@@ -10,7 +10,7 @@
 use PHPStan\Testing\RuleTestCase;
 use PHPUnit\Framework\Attributes\DataProvider;
 use TomasVotruba\UnusedPublic\Collectors\Callable_\AttributeCallableCollector;
-use TomasVotruba\UnusedPublic\Collectors\Callable_\CallbackFunctionCollector;
+use TomasVotruba\UnusedPublic\Collectors\Callable_\CallableTypeCollector;
 use TomasVotruba\UnusedPublic\Collectors\FormTypeClassCollector;
 use TomasVotruba\UnusedPublic\Collectors\MethodCall\MethodCallableCollector;
 use TomasVotruba\UnusedPublic\Collectors\MethodCall\MethodCallCollector;
@@ -177,6 +177,8 @@ public static function provideData(): Iterator
         yield [[__DIR__ . '/Fixture/plain.php', __DIR__ . '/Source/Caller1.php'], []];
         yield [[__DIR__ . '/Fixture/plain-call-user-func.php', __DIR__ . '/Source/Caller1.php'], []];
         yield [[__DIR__ . '/Fixture/plain-call-shutdown-function.php', __DIR__ . '/Source/Caller1.php'], []];
+        yield [[__DIR__ . '/Fixture/plain-call-custom-function.php', __DIR__ . '/Source/Caller1.php'], []];
+        yield [[__DIR__ . '/Fixture/plain-call-custom-method.php', __DIR__ . '/Source/Caller1.php'], []];
         yield [[__DIR__ . '/Fixture/SkipCrashBug89.php.inc'], []];
 
         // internal
@@ -241,7 +243,7 @@ protected function getCollectors(): array
             // callables
             self::getContainer()->getByType(StaticMethodCallableCollector::class),
             self::getContainer()->getByType(AttributeCallableCollector::class),
-            self::getContainer()->getByType(CallbackFunctionCollector::class),
+            self::getContainer()->getByType(CallableTypeCollector::class),
         ];
     }