Test real-world NodeCallbackInvoker rule

Author: ondrejmirtes

tests/PHPStan/Rules/NodeCallbackInvokerRule.php

@@ -0,0 +1,43 @@
+<?php declare(strict_types = 1);
+
+namespace PHPStan\Rules;
+
+use PhpParser\Node;
+use PHPStan\Analyser\NodeCallbackInvoker;
+use PHPStan\Analyser\Scope;
+
+/**
+ * @implements Rule<Node\Stmt\Echo_>
+ */
+class NodeCallbackInvokerRule implements Rule
+{
+
+	public function getNodeType(): string
+	{
+		return Node\Stmt\Echo_::class;
+	}
+
+	public function processNode(Node $node, NodeCallbackInvoker&Scope $scope): array
+	{
+		if ((bool) $node->getAttribute('virtual', false)) {
+			// prevent infinite recursion
+			return [
+				RuleErrorBuilder::message('found virtual echo')
+					->identifier('tests.nodeCallbackInvoker')
+					->build(),
+			];
+		}
+
+		$scope->invokeNodeCallback(new Node\Stmt\Echo_(
+			[new Node\Scalar\String_('virtual')],
+			['startLine' => $node->getStartLine() + 1, 'virtual' => true],
+		));
+
+		return [
+			RuleErrorBuilder::message('found echo')
+				->identifier('tests.nodeCallbackInvoker')
+				->build(),
+		];
+	}
+
+}

tests/PHPStan/Rules/NodeCallbackInvokerRuleTest.php

@@ -0,0 +1,32 @@
+<?php declare(strict_types = 1);
+
+namespace PHPStan\Rules;
+
+use PHPStan\Testing\RuleTestCase;
+
+/**
+ * @extends RuleTestCase<NodeCallbackInvokerRule>
+ */
+class NodeCallbackInvokerRuleTest extends RuleTestCase
+{
+
+	protected function getRule(): Rule
+	{
+		return new NodeCallbackInvokerRule();
+	}
+
+	public function testRule(): void
+	{
+		$this->analyse([__DIR__ . '/data/node-callback-invoker.php'], [
+			[
+				'found virtual echo',
+				6,
+			],
+			[
+				'found echo',
+				5,
+			],
+		]);
+	}
+
+}

tests/PHPStan/Rules/data/node-callback-invoker.php

@@ -0,0 +1,7 @@
+<?php
+
+namespace NodeCallbackInvoker;
+
+echo 'foo';
+
+// something something