Added possibility to override rule error file

Author: lookyman

src/Analyser/Analyser.php

@@ -5,6 +5,7 @@
 use Nette\Utils\Json;
 use PHPStan\File\FileHelper;
 use PHPStan\Parser\Parser;
+use PHPStan\Rules\FileRuleError;
 use PHPStan\Rules\LineRuleError;
 use PHPStan\Rules\Registry;
 
@@ -164,6 +165,7 @@ function (\PhpParser\Node $node, Scope $scope) use (&$fileErrors, $file, &$scope
 
 foreach ($ruleErrors as $ruleError) {
 $line = $node->getLine();
+$fileName = $scope->getFileDescription();
 if (is_string($ruleError)) {
 $message = $ruleError;
 } else {
@@ -174,8 +176,14 @@ function (\PhpParser\Node $node, Scope $scope) use (&$fileErrors, $file, &$scope
 ) {
 $line = $ruleError->getLine();
 }
+if (
+$ruleError instanceof FileRuleError
+&& $ruleError->getFile() !== ''
+) {
+$fileName = $ruleError->getFile();
+}
 }
-$fileErrors[] = new Error($message, $scope->getFileDescription(), $line);
+$fileErrors[] = new Error($message, $fileName, $line);
 }
 }
 

src/Rules/FileRuleError.php

@@ -0,0 +1,10 @@
+<?php declare(strict_types = 1);
+
+namespace PHPStan\Rules;
+
+interface FileRuleError extends RuleError
+{
+
+public function getFile(): string;
+
+}

src/Rules/RuleErrorBuilder.php

@@ -3,7 +3,9 @@
 namespace PHPStan\Rules;
 
 use PHPStan\Rules\RuleErrors\RuleErrorWithMessage;
+use PHPStan\Rules\RuleErrors\RuleErrorWithMessageAndFile;
 use PHPStan\Rules\RuleErrors\RuleErrorWithMessageAndLine;
+use PHPStan\Rules\RuleErrors\RuleErrorWithMessageAndLineAndFile;
 
 class RuleErrorBuilder
 {
@@ -14,6 +16,9 @@ class RuleErrorBuilder
 /** @var int|null */
 private $line;
 
+/** @var string|null */
+private $file;
+
 private function __construct()
 {
 }
@@ -33,11 +38,24 @@ public function line(int $line): self
 return $this;
 }
 
+public function file(string $file): self
+{
+$this->file = $file;
+
+return $this;
+}
+
 public function build(): RuleError
 {
-if ($this->line !== null) {
+if ($this->line !== null && $this->file !== null) {
+return new RuleErrorWithMessageAndLineAndFile($this->message, $this->line, $this->file);
+}
+if ($this->line !== null && $this->file === null) {
 return new RuleErrorWithMessageAndLine($this->message, $this->line);
 }
+if ($this->line === null && $this->file !== null) {
+return new RuleErrorWithMessageAndFile($this->message, $this->file);
+}
 
 return new RuleErrorWithMessage($this->message);
 }

src/Rules/RuleErrors/RuleErrorWithMessageAndFile.php

@@ -0,0 +1,32 @@
+<?php declare(strict_types = 1);
+
+namespace PHPStan\Rules\RuleErrors;
+
+use PHPStan\Rules\FileRuleError;
+
+class RuleErrorWithMessageAndFile implements FileRuleError
+{
+
+/** @var string */
+private $message;
+
+/** @var string */
+private $file;
+
+public function __construct(string $message, string $file)
+{
+$this->message = $message;
+$this->file = $file;
+}
+
+public function getMessage(): string
+{
+return $this->message;
+}
+
+public function getFile(): string
+{
+return $this->file;
+}
+
+}

src/Rules/RuleErrors/RuleErrorWithMessageAndLineAndFile.php

@@ -0,0 +1,42 @@
+<?php declare(strict_types = 1);
+
+namespace PHPStan\Rules\RuleErrors;
+
+use PHPStan\Rules\FileRuleError;
+use PHPStan\Rules\LineRuleError;
+
+class RuleErrorWithMessageAndLineAndFile implements LineRuleError, FileRuleError
+{
+
+/** @var string */
+private $message;
+
+/** @var int */
+private $line;
+
+/** @var string */
+private $file;
+
+public function __construct(string $message, int $line, string $file)
+{
+$this->message = $message;
+$this->line = $line;
+$this->file = $file;
+}
+
+public function getMessage(): string
+{
+return $this->message;
+}
+
+public function getLine(): int
+{
+return $this->line;
+}
+
+public function getFile(): string
+{
+return $this->file;
+}
+
+}

tests/PHPStan/Rules/RuleErrorBuilderTest.php

@@ -24,4 +24,26 @@ public function testMessageAndLineAndBuild(): void
 $this->assertSame(25, $ruleError->getLine());
 }
 
+public function testMessageAndFileAndBuild(): void
+{
+$builder = RuleErrorBuilder::message('Foo')->file('Bar.php');
+$ruleError = $builder->build();
+$this->assertSame('Foo', $ruleError->getMessage());
+
+$this->assertInstanceOf(FileRuleError::class, $ruleError);
+$this->assertSame('Bar.php', $ruleError->getFile());
+}
+
+public function testMessageAndLineAndFileAndBuild(): void
+{
+$builder = RuleErrorBuilder::message('Foo')->line(25)->file('Bar.php');
+$ruleError = $builder->build();
+$this->assertSame('Foo', $ruleError->getMessage());
+
+$this->assertInstanceOf(LineRuleError::class, $ruleError);
+$this->assertInstanceOf(FileRuleError::class, $ruleError);
+$this->assertSame(25, $ruleError->getLine());
+$this->assertSame('Bar.php', $ruleError->getFile());
+}
+
 }