ForbidCustomFunctionsRule: better config validation (#83)

shipmonk-rnd · Feb 3, 2023 · c99e2b9 · c99e2b9
1 parent 411a5b3
commit c99e2b9
Show file tree

Hide file tree

Showing 2 changed files with 25 additions and 2 deletions.
diff --git a/src/Rule/ForbidCustomFunctionsRule.php b/src/Rule/ForbidCustomFunctionsRule.php
@@ -20,6 +20,7 @@
 use PHPStan\Type\TypeUtils;
 use function count;
 use function explode;
+use function gettype;
 use function is_string;
 use function sprintf;
 
@@ -40,15 +41,19 @@ class ForbidCustomFunctionsRule implements Rule
     private ReflectionProvider $reflectionProvider;
 
     /**
-     * @param array<string, mixed> $forbiddenFunctions
+     * @param array<mixed, mixed> $forbiddenFunctions
      */
     public function __construct(array $forbiddenFunctions, ReflectionProvider $reflectionProvider)
     {
         $this->reflectionProvider = $reflectionProvider;
 
         foreach ($forbiddenFunctions as $forbiddenFunction => $description) {
+            if (!is_string($forbiddenFunction)) {
+                throw new LogicException("Unexpected forbidden function name, string expected, got $forbiddenFunction. Usage: ['var_dump' => 'Remove debug code!'].");
+            }
+
             if (!is_string($description)) {
-                throw new LogicException('Unexpected forbidden function description, string expected');
+                throw new LogicException('Unexpected forbidden function description, string expected, got ' . gettype($description) . '. Usage: [\'var_dump\' => \'Remove debug code!\'].');
             }
 
             $parts = explode('::', $forbiddenFunction);

diff --git a/tests/Rule/ForbidCustomFunctionsRuleTest.php b/tests/Rule/ForbidCustomFunctionsRuleTest.php
@@ -35,4 +35,22 @@ public function testClass(): void
         $this->analyseFile(__DIR__ . '/data/ForbidCustomFunctionsRule/code.php');
     }
 
+    public function testInvalidConfig1(): void
+    {
+        self::expectExceptionMessage("Unexpected forbidden function name, string expected, got 0. Usage: ['var_dump' => 'Remove debug code!'].");
+        new ForbidCustomFunctionsRule(['var_dump'], $this->createMock(ReflectionProvider::class));
+    }
+
+    public function testInvalidConfig2(): void
+    {
+        self::expectExceptionMessage("Unexpected forbidden function description, string expected, got array. Usage: ['var_dump' => 'Remove debug code!'].");
+        new ForbidCustomFunctionsRule(['var_dump' => []], $this->createMock(ReflectionProvider::class));
+    }
+
+    public function testInvalidConfig3(): void
+    {
+        self::expectExceptionMessage('Unexpected format of forbidden function Class::method::12, expected Namespace\Class::methodName');
+        new ForbidCustomFunctionsRule(['Class::method::12' => 'Description'], $this->createMock(ReflectionProvider::class));
+    }
+
 }