Merge pull request #781 from abenerd/feature/phpstan-rule

[1.x] Add phpstan rule to detect ray calls

composer.json

@@ -29,7 +29,7 @@
         "illuminate/support": "6.x|^8.18|^9.0",
         "nesbot/carbon": "^2.63",
         "pestphp/pest": "^1.22",
-        "phpstan/phpstan": "^0.12.92",
+        "phpstan/phpstan": "^1.10",
         "phpunit/phpunit": "^9.5",
         "spatie/phpunit-snapshot-assertions": "^4.2",
         "spatie/test-time": "^1.2"

docs/advanced-usage/configure-phpstan.md

@@ -0,0 +1,19 @@
+---
+title: Configure PHPStan to detect ray calls
+weight: 2
+---
+
+Ray allows you to specify a custom PHPStan rule that lets you detect remaining ray calls in your application
+
+```neon
+rules:
+    - Spatie\Ray\PHPStan\RemainingRayCallRule
+```
+
+All remaining ray calls would then be reported by phpstan
+
+![screenshot](/docs/ray/v1/images/phpstan-failing-result.png.png)
+
+
+
+

phpstan-baseline.neon

@@ -1,13 +1,5 @@
 parameters:
 	ignoreErrors:
-		-
-			message: "#^Undefined variable\\: \\$this$#"
-			path: */tests/*.php
-		-
-			message: "#^Function base_path not found\\.$#"
-			count: 1
-			path: src/Ray.php
-
 		-
 			message: "#^Function app not found\\.$#"
 			count: 1

phpstan.neon.dist

@@ -9,3 +9,6 @@ parameters:
 
 	ignoreErrors:
 		- '#Unsafe usage of new static\(\)#'
+		-
+		    message: '#Undefined variable\: \$this#'
+		    path: test

src/PHPStan/RemainingRayCallRule.php

@@ -0,0 +1,32 @@
+<?php
+
+namespace Spatie\Ray\PHPStan;
+
+use PhpParser\Node;
+use PHPStan\Analyser\Scope;
+use PHPStan\Rules\Rule;
+use PHPStan\Rules\RuleErrorBuilder;
+
+class RemainingRayCallRule implements Rule
+{
+    public function getNodeType(): string
+    {
+        return Node\Expr\FuncCall::class;
+    }
+
+    public function processNode(Node $node, Scope $scope): array
+    {
+        if (! $node instanceof Node\Expr\FuncCall) {
+            return [];
+        }
+
+        if ($node->name->parts[0] !== 'ray') {
+            return [];
+        }
+
+        return [
+            RuleErrorBuilder::message('Remaining ray call in application code')
+                ->build(),
+        ];
+    }
+}

tests/PHPStan/RemainingRayCallRuleTest.php

@@ -0,0 +1,48 @@
+<?php
+
+namespace Spatie\Ray\Tests\PHPStan;
+
+use PHPStan\Rules\Rule;
+use PHPStan\Testing\RuleTestCase;
+use Spatie\Ray\PHPStan\RemainingRayCallRule;
+
+class RemainingRayCallRuleTest extends RuleTestCase
+{
+    protected function getRule(): Rule
+    {
+        return new RemainingRayCallRule();
+    }
+
+    /**
+     * @dataProvider failingTestCasesProvider
+     */
+    public function testTheRuleCanDetectRayCalls(string $path, int $line): void
+    {
+        $this->analyse([$path], [
+            [
+                'Remaining ray call in application code',
+                $line,
+            ],
+        ]);
+    }
+
+    /**
+     * @dataProvider passingTestCasesProvider
+     */
+    public function testTheRuleWillNotRaiseWhenNoRayCallIsPerformed(string $path): void
+    {
+        $this->analyse([$path], []);
+    }
+
+    public static function failingTestCasesProvider()
+    {
+        yield [__DIR__ . '/testdata/ClassContainingARayCall.php', 9];
+        yield [__DIR__ . '/testdata/PHPFileContainingARayCall.php', 3];
+    }
+
+    public static function passingTestCasesProvider()
+    {
+        yield [__DIR__ . '/testdata/ClassNotContainingARayCall.php'];
+        yield [__DIR__ . '/testdata/PHPFileNotContainingARayCall.php'];
+    }
+}

tests/PHPStan/testdata/ClassContainingARayCall.php

@@ -0,0 +1,11 @@
+<?php
+
+namespace Spatie\Ray\Tests\PHPStan\testdata;
+
+class ClassContainingARayCall
+{
+    public function __construct()
+    {
+        ray('I am being constructed, therefore I am');
+    }
+}

tests/PHPStan/testdata/ClassNotContainingARayCall.php

@@ -0,0 +1,7 @@
+<?php
+
+namespace Spatie\Ray\Tests\PHPStan\testdata;
+
+class ClassNotContainingARayCall
+{
+}

tests/PHPStan/testdata/PHPFileContainingARayCall.php

@@ -0,0 +1,3 @@
+<?php
+
+ray('Why hello there!');

tests/PHPStan/testdata/PHPFileNotContainingARayCall.php

@@ -0,0 +1 @@
+<?php