Add tests for collectors

Author: ruudk

e2e/ignore-error-extension/phpstan-baseline.neon

@@ -1,5 +1,29 @@
 parameters:
 	ignoreErrors:
+		-
+			message: '#^This is an error from a rule that uses a collector$#'
+			identifier: class.name
+			count: 1
+			path: src/ClassCollector.php
+
+		-
+			message: '#^This is an error from a rule that uses a collector$#'
+			identifier: class.name
+			count: 1
+			path: src/ClassRule.php
+
+		-
+			message: '#^This is an error from a rule that uses a collector$#'
+			identifier: class.name
+			count: 1
+			path: src/ControllerActionReturnTypeIgnoreExtension.php
+
+		-
+			message: '#^This is an error from a rule that uses a collector$#'
+			identifier: class.name
+			count: 1
+			path: src/ControllerClassNameIgnoreExtension.php
+
 		-
 			message: '#^Method App\\HomepageController\:\:contactAction\(\) has parameter \$someUnrelatedError with no type specified\.$#'
 			identifier: missingType.parameter

e2e/ignore-error-extension/phpstan.neon.dist

@@ -7,7 +7,19 @@ parameters:
 		- src
 
 services:
+	-
+		class: App\ClassCollector
+		tags:
+			- phpstan.collector
+	-
+		class: App\ClassRule
+		tags:
+			- phpstan.rules.rule
 	-
 		class: App\ControllerActionReturnTypeIgnoreExtension
 		tags:
 			- phpstan.ignoreErrorExtension
+	-
+		class: App\ControllerClassNameIgnoreExtension
+		tags:
+			- phpstan.ignoreErrorExtension

e2e/ignore-error-extension/src/ClassCollector.php

@@ -0,0 +1,29 @@
+<?php
+
+declare(strict_types = 1);
+
+namespace App;
+
+use PhpParser\Node;
+use PHPStan\Analyser\Scope;
+use PHPStan\Collectors\Collector;
+
+/**
+ * @implements Collector<Node\Stmt\Class_, array{string, int}>
+ */
+final class ClassCollector implements Collector
+{
+	public function getNodeType(): string
+	{
+		return Node\Stmt\Class_::class;
+	}
+
+	public function processNode(Node $node, Scope $scope) : ?array
+	{
+		if ($node->name === null) {
+			return null;
+		}
+
+		return [$node->name->name, $node->getStartLine()];
+	}
+}

e2e/ignore-error-extension/src/ClassRule.php

@@ -0,0 +1,43 @@
+<?php
+
+declare(strict_types=1);
+
+namespace App;
+
+use Override;
+use PhpParser\Node;
+use PHPStan\Analyser\Scope;
+use PHPStan\Node\CollectedDataNode;
+use PHPStan\Rules\Rule;
+use PHPStan\Rules\RuleErrorBuilder;
+
+/**
+ * @implements Rule<CollectedDataNode>
+ */
+final class ClassRule implements Rule
+{
+	#[Override]
+	public function getNodeType() : string
+	{
+		return CollectedDataNode::class;
+	}
+
+	#[Override]
+	public function processNode(Node $node, Scope $scope) : array
+	{
+		$errors = [];
+
+		foreach ($node->get(ClassCollector::class) as $file => $data) {
+			foreach ($data as [$className, $line]) {
+				$errors[] = RuleErrorBuilder::message('This is an error from a rule that uses a collector')
+					->file($file)
+					->line($line)
+					->identifier('class.name')
+					->build();
+			}
+		}
+
+		return $errors;
+	}
+
+}

e2e/ignore-error-extension/src/ControllerClassNameIgnoreExtension.php

@@ -0,0 +1,34 @@
+<?php
+
+declare(strict_types=1);
+
+namespace App;
+
+use PhpParser\Node;
+use PHPStan\Analyser\Error;
+use PHPStan\Analyser\IgnoreErrorExtension;
+use PHPStan\Analyser\Scope;
+use PHPStan\Node\CollectedDataNode;
+
+// This extension will ignore "class.name" errors for classes with names ending with "Controller".
+// These errors are reported by the ClassRule which triggers on CollectedDataNode coming from ClassCollector.
+final class ControllerClassNameIgnoreExtension implements IgnoreErrorExtension
+{
+	public function shouldIgnore(Error $error, Node $node, Scope $scope) : bool
+	{
+		if ($error->getIdentifier() !== 'class.name') {
+			return false;
+		}
+
+		// @phpstan-ignore phpstanApi.instanceofAssumption
+		if (!$node instanceof CollectedDataNode) {
+			return false;
+		}
+
+		if (!str_ends_with($error->getFile(), 'Controller.php')) {
+			return false;
+		}
+
+		return true;
+	}
+}