Introduce new UseSafeCallablesRule

Author: spawnia

phpstan-safe-rule.neon

@@ -1,4 +1,8 @@
 services:
+  -
+    class: TheCodingMachine\Safe\PHPStan\Rules\UseSafeCallablesRule
+    tags:
+      - phpstan.rules.rule
   -
     class: TheCodingMachine\Safe\PHPStan\Rules\UseSafeFunctionsRule
     tags:

src/Rules/UseSafeCallablesRule.php

@@ -0,0 +1,44 @@
+<?php
+
+namespace TheCodingMachine\Safe\PHPStan\Rules;
+
+use PhpParser\Node;
+use PHPStan\Analyser\Scope;
+use PHPStan\Rules\Rule;
+use PHPStan\Node\FunctionCallableNode;
+use TheCodingMachine\Safe\PHPStan\Rules\Error\SafeFunctionRuleError;
+use TheCodingMachine\Safe\PHPStan\Utils\FunctionListLoader;
+
+/**
+ * This rule checks that no "unsafe" functions are used in code.
+ *
+ * @implements Rule<FunctionCallableNode>
+ */
+class UseSafeCallablesRule implements Rule
+{
+    /**
+     * @see JSON_THROW_ON_ERROR
+     */
+    const JSON_THROW_ON_ERROR = 4194304;
+
+    public function getNodeType(): string
+    {
+        return FunctionCallableNode::class;
+    }
+
+    public function processNode(Node $node, Scope $scope): array
+    {
+        $name = $node->getName();
+        if (!$name instanceof Node\Name) {
+            return [];
+        }
+        $functionName = $name->toString();
+        $unsafeFunctions = FunctionListLoader::getFunctionList();
+
+        if (isset($unsafeFunctions[$functionName])) {
+            return [new SafeFunctionRuleError($name, $node->getStartLine())];
+        }
+
+        return [];
+    }
+}

src/Rules/UseSafeFunctionsRule.php

@@ -1,6 +1,5 @@
 <?php
 
-
 namespace TheCodingMachine\Safe\PHPStan\Rules;
 
 use PhpParser\Node;
@@ -31,41 +30,40 @@ public function getNodeType(): string
 
     public function processNode(Node $node, Scope $scope): array
     {
-        if (!$node->name instanceof Node\Name) {
+        $name = $node->name;
+        if (!$name instanceof Node\Name) {
             return [];
         }
-        $functionName = $node->name->toString();
+        $functionName = $name->toString();
         $unsafeFunctions = FunctionListLoader::getFunctionList();
 
         if (isset($unsafeFunctions[$functionName])) {
-            if (! $node->isFirstClassCallable()) {
-                if ($functionName === "json_decode" || $functionName === "json_encode") {
-                    foreach ($node->args as $arg) {
-                        if ($arg instanceof Node\Arg &&
-                            $arg->name instanceof Node\Identifier &&
-                            $arg->name->toLowerString() === "flags"
-                        ) {
-                            if ($this->argValueIncludeJSONTHROWONERROR($arg)) {
-                                return [];
-                            }
+            if ($functionName === "json_decode" || $functionName === "json_encode") {
+                foreach ($node->args as $arg) {
+                    if ($arg instanceof Node\Arg &&
+                        $arg->name instanceof Node\Identifier &&
+                        $arg->name->toLowerString() === "flags"
+                    ) {
+                        if ($this->argValueIncludeJSONTHROWONERROR($arg)) {
+                            return [];
                         }
                     }
                 }
+            }
 
-                if ($functionName === "json_decode"
-                    && $this->argValueIncludeJSONTHROWONERROR($node->getArgs()[3] ?? null)
-                ) {
-                    return [];
-                }
+            if ($functionName === "json_decode"
+                && $this->argValueIncludeJSONTHROWONERROR($node->getArgs()[3] ?? null)
+            ) {
+                return [];
+            }
 
-                if ($functionName === "json_encode"
-                    && $this->argValueIncludeJSONTHROWONERROR($node->getArgs()[1] ?? null)
-                ) {
-                    return [];
-                }
+            if ($functionName === "json_encode"
+                && $this->argValueIncludeJSONTHROWONERROR($node->getArgs()[1] ?? null)
+            ) {
+                return [];
             }
 
-            return [new SafeFunctionRuleError($node->name, $node->getStartLine())];
+            return [new SafeFunctionRuleError($name, $node->getStartLine())];
         }
 
         return [];

tests/Rules/UseSafeCallablesRuleTest.php

@@ -0,0 +1,27 @@
+<?php
+
+namespace TheCodingMachine\Safe\PHPStan\Rules;
+
+use PHPStan\Rules\Rule;
+use PHPStan\Testing\RuleTestCase;
+
+/**
+ * @template-extends RuleTestCase<UseSafeCallablesRule>
+ */
+class UseSafeCallablesRuleTest extends RuleTestCase
+{
+    protected function getRule(): Rule
+    {
+        return new UseSafeCallablesRule();
+    }
+
+    public function testFirstClassCallable(): void
+    {
+        $this->analyse([__DIR__ . '/data/first_class_callable.php'], [
+            [
+                "Function json_encode is unsafe to use. It can return FALSE instead of throwing an exception. Please add 'use function Safe\\json_encode;' at the beginning of the file to use the variant provided by the 'thecodingmachine/safe' library.",
+                3,
+            ],
+        ]);
+    }
+}

tests/Rules/UseSafeFunctionsRuleTest.php

@@ -44,14 +44,4 @@ public function testJSONEncodeNoCatchSafe(): void
     {
         $this->analyse([__DIR__ . '/data/safe_json_encode.php'], []);
     }
-
-    public function testFirstClassCallable(): void
-    {
-        $this->analyse([__DIR__ . '/data/first_class_callable.php'], [
-            [
-                "Function json_encode is unsafe to use. It can return FALSE instead of throwing an exception. Please add 'use function Safe\\json_encode;' at the beginning of the file to use the variant provided by the 'thecodingmachine/safe' library.",
-                3,
-            ],
-        ]);
-    }
 }