Support for collectors in RuleTestCase

Author: ondrejmirtes

Diff for: src/Testing/RuleTestCase.php

@@ -8,12 +8,14 @@
 use PHPStan\Analyser\FileAnalyser;
 use PHPStan\Analyser\NodeScopeResolver;
 use PHPStan\Analyser\RuleErrorTransformer;
+use PHPStan\Analyser\ScopeContext;
 use PHPStan\Analyser\TypeSpecifier;
 use PHPStan\Collectors\Collector;
 use PHPStan\Collectors\Registry as CollectorRegistry;
 use PHPStan\Dependency\DependencyResolver;
 use PHPStan\DependencyInjection\Type\DynamicThrowTypeExtensionProvider;
 use PHPStan\File\FileHelper;
+use PHPStan\Node\CollectedDataNode;
 use PHPStan\Php\PhpVersion;
 use PHPStan\PhpDoc\PhpDocInheritanceResolver;
 use PHPStan\PhpDoc\StubPhpDocProvider;
@@ -118,7 +120,25 @@ public function analyse(array $files, array $expectedErrors): void
 		if (count($analyserResult->getInternalErrors()) > 0) {
 			$this->fail(implode("\n", $analyserResult->getInternalErrors()));
 		}
+
 		$actualErrors = $analyserResult->getUnorderedErrors();
+		$ruleErrorTransformer = new RuleErrorTransformer();
+		if (count($analyserResult->getCollectedData()) > 0) {
+			$ruleRegistry = new RuleRegistry([
+				$this->getRule(),
+			]);
+
+			$nodeType = CollectedDataNode::class;
+			$node = new CollectedDataNode($analyserResult->getCollectedData());
+			$scopeFactory = $this->createScopeFactory($this->createReflectionProvider(), $this->getTypeSpecifier());
+			$scope = $scopeFactory->create(ScopeContext::create('irrelevant'));
+			foreach ($ruleRegistry->getRules($nodeType) as $rule) {
+				$ruleErrors = $rule->processNode($node, $scope);
+				foreach ($ruleErrors as $ruleError) {
+					$actualErrors[] = $ruleErrorTransformer->transform($ruleError, $scope, $nodeType, $node->getLine());
+				}
+			}
+		}
 
 		$strictlyTypedSprintf = static function (int $line, string $message, ?string $tip): string {
 			$message = sprintf('%02d: %s', $line, $message);

Diff for: tests/PHPStan/Rules/DummyCollector.php

@@ -0,0 +1,30 @@
+<?php declare(strict_types = 1);
+
+namespace PHPStan\Rules;
+
+use PhpParser\Node;
+use PhpParser\Node\Expr\MethodCall;
+use PHPStan\Analyser\Scope;
+use PHPStan\Collectors\Collector;
+
+/**
+ * @implements Collector<MethodCall, string>
+ */
+class DummyCollector implements Collector
+{
+
+	public function getNodeType(): string
+	{
+		return MethodCall::class;
+	}
+
+	public function processNode(Node $node, Scope $scope)
+	{
+		if (!$node->name instanceof Node\Identifier) {
+			return null;
+		}
+
+		return $node->name->toString();
+	}
+
+}

Diff for: tests/PHPStan/Rules/DummyCollectorRule.php

@@ -0,0 +1,49 @@
+<?php declare(strict_types = 1);
+
+namespace PHPStan\Rules;
+
+use PhpParser\Node;
+use PHPStan\Analyser\Scope;
+use PHPStan\Node\CollectedDataNode;
+use function implode;
+use function sprintf;
+
+/**
+ * @implements Rule<CollectedDataNode>
+ */
+class DummyCollectorRule implements Rule
+{
+
+	public function getNodeType(): string
+	{
+		return CollectedDataNode::class;
+	}
+
+	public function processNode(Node $node, Scope $scope): array
+	{
+		$data = $node->get(DummyCollector::class);
+		$methods = [];
+		foreach ($data as $methodNames) {
+			foreach ($methodNames as $methodName) {
+				if (!isset($methods[$methodName])) {
+					$methods[$methodName] = 0;
+				}
+
+				$methods[$methodName]++;
+			}
+		}
+
+		$parts = [];
+		foreach ($methods as $methodName => $count) {
+			$parts[] = sprintf('%d× %s', $count, $methodName);
+		}
+
+		return [
+			RuleErrorBuilder::message(implode(', ', $parts))
+				->file(__DIR__ . '/data/dummy-collector.php')
+				->line(5)
+				->build(),
+		];
+	}
+
+}

Diff for: tests/PHPStan/Rules/DummyCollectorRuleTest.php

@@ -0,0 +1,35 @@
+<?php declare(strict_types = 1);
+
+namespace PHPStan\Rules;
+
+use PHPStan\Testing\RuleTestCase;
+
+/**
+ * @extends RuleTestCase<DummyCollectorRule>
+ */
+class DummyCollectorRuleTest extends RuleTestCase
+{
+
+	protected function getRule(): Rule
+	{
+		return new DummyCollectorRule();
+	}
+
+	protected function getCollectors(): array
+	{
+		return [
+			new DummyCollector(),
+		];
+	}
+
+	public function testRule(): void
+	{
+		$this->analyse([__DIR__ . '/data/dummy-collector.php'], [
+			[
+				'2× doFoo, 2× doBar',
+				5,
+			],
+		]);
+	}
+
+}

Diff for: tests/PHPStan/Rules/data/dummy-collector.php

@@ -0,0 +1,25 @@
+<?php
+
+namespace DummyCollector;
+
+class Foo
+{
+
+	public function doFoo()
+	{
+		$this->doFoo();
+		$this->doBar();
+	}
+
+}
+
+class Bar
+{
+
+	public function doBar()
+	{
+		$this->doFoo();
+		$this->doBar();
+	}
+
+}