Error in trait can be ignored by both the class context file path and the trait file path

Author: ondrejmirtes

src/Analyser/Analyser.php

@@ -168,6 +168,13 @@ public function analyse(
 								$line = $node->getLine();
 								$fileName = $scope->getFileDescription();
 								$filePath = $scope->getFile();
+								$traitFilePath = null;
+								if ($scope->isInTrait()) {
+									$traitReflection = $scope->getTraitReflection();
+									if ($traitReflection->getFileName() !== false) {
+										$traitFilePath = $traitReflection->getFileName();
+									}
+								}
 								if (is_string($ruleError)) {
 									$message = $ruleError;
 								} else {
@@ -184,14 +191,16 @@ public function analyse(
 									) {
 										$fileName = $ruleError->getFile();
 										$filePath = $ruleError->getFile();
+										$traitFilePath = null;
 									}
 								}
 								$fileErrors[] = new Error(
 									$message,
 									$fileName,
 									$line,
 									true,
-									$filePath
+									$filePath,
+									$traitFilePath
 								);
 							}
 						}

src/Analyser/Error.php

@@ -20,19 +20,24 @@ class Error
 	/** @var string|null */
 	private $filePath;
 
+	/** @var string|null */
+	private $traitFilePath;
+
 	public function __construct(
 		string $message,
 		string $file,
 		?int $line = null,
 		bool $canBeIgnored = true,
-		?string $filePath = null
+		?string $filePath = null,
+		?string $traitFilePath = null
 	)
 	{
 		$this->message = $message;
 		$this->file = $file;
 		$this->line = $line;
 		$this->canBeIgnored = $canBeIgnored;
 		$this->filePath = $filePath;
+		$this->traitFilePath = $traitFilePath;
 	}
 
 	public function getMessage(): string
@@ -54,6 +59,11 @@ public function getFilePath(): string
 		return $this->filePath;
 	}
 
+	public function getTraitFilePath(): ?string
+	{
+		return $this->traitFilePath;
+	}
+
 	public function getLine(): ?int
 	{
 		return $this->line;

src/Analyser/IgnoredError.php

@@ -51,8 +51,16 @@ public static function shouldIgnore(
 		if ($path !== null) {
 			$fileExcluder = new FileExcluder($fileHelper, [$path]);
 
-			return \Nette\Utils\Strings::match($error->getMessage(), $ignoredErrorPattern) !== null
-				&& $fileExcluder->isExcludedFromAnalysing($error->getFilePath());
+			if (\Nette\Utils\Strings::match($error->getMessage(), $ignoredErrorPattern) === null) {
+				return false;
+			}
+
+			$isExcluded = $fileExcluder->isExcludedFromAnalysing($error->getFilePath());
+			if (!$isExcluded && $error->getTraitFilePath() !== null) {
+				return $fileExcluder->isExcludedFromAnalysing($error->getTraitFilePath());
+			}
+
+			return $isExcluded;
 		}
 
 		return \Nette\Utils\Strings::match($error->getMessage(), $ignoredErrorPattern) !== null;

tests/PHPStan/Analyser/AnalyserTest.php

@@ -213,6 +213,37 @@ public function testIgnoreErrorNotFoundInPath(): void
 		$this->assertSame('Ignored error pattern #Fail\.# in path ' . __DIR__ . '/data/not-existent-path.php was not matched in reported errors.', $result[0]);
 	}
 
+	public function dataIgnoreErrorInTraitUsingClassFilePath(): array
+	{
+		return [
+			[
+				__DIR__ . '/data/traits-ignore/Foo.php',
+			],
+			[
+				__DIR__ . '/data/traits-ignore/FooTrait.php',
+			],
+		];
+	}
+
+	/**
+	 * @dataProvider dataIgnoreErrorInTraitUsingClassFilePath
+	 * @param string $pathToIgnore
+	 */
+	public function testIgnoreErrorInTraitUsingClassFilePath(string $pathToIgnore): void
+	{
+		$ignoreErrors = [
+			[
+				'message' => '#Fail\.#',
+				'path' => $pathToIgnore,
+			],
+		];
+		$result = $this->runAnalyser($ignoreErrors, true, [
+			__DIR__ . '/data/traits-ignore/Foo.php',
+			__DIR__ . '/data/traits-ignore/FooTrait.php',
+		], true);
+		$this->assertCount(0, $result);
+	}
+
 	public function testIgnoredErrorMissingMessage(): void
 	{
 		$ignoreErrors = [
@@ -276,22 +307,29 @@ public function testReportMultipleParserErrorsAtOnce(): void
 	/**
 	 * @param mixed[] $ignoreErrors
 	 * @param bool $reportUnmatchedIgnoredErrors
-	 * @param string $filePath
+	 * @param string|string[] $filePaths
 	 * @param bool $onlyFiles
 	 * @return string[]|\PHPStan\Analyser\Error[]
 	 */
 	private function runAnalyser(
 		array $ignoreErrors,
 		bool $reportUnmatchedIgnoredErrors,
-		string $filePath,
+		$filePaths,
 		bool $onlyFiles
 	): array
 	{
 		$analyser = $this->createAnalyser(
 			$ignoreErrors,
 			$reportUnmatchedIgnoredErrors
 		);
-		return $analyser->analyse([$this->getFileHelper()->normalizePath($filePath)], $onlyFiles);
+
+		if (is_string($filePaths)) {
+			$filePaths = [$filePaths];
+		}
+
+		return $analyser->analyse(array_map(function (string $path): string {
+			return $this->getFileHelper()->normalizePath($path);
+		}, $filePaths), $onlyFiles);
 	}
 
 	/**

tests/PHPStan/Analyser/data/traits-ignore/Foo.php

@@ -0,0 +1,10 @@
+<?php declare(strict_types = 1);
+
+namespace TraitsIgnore;
+
+class Foo
+{
+
+	use FooTrait;
+
+}

tests/PHPStan/Analyser/data/traits-ignore/FooTrait.php

@@ -0,0 +1,13 @@
+<?php declare(strict_types = 1);
+
+namespace TraitsIgnore;
+
+trait FooTrait
+{
+
+	public function doFoo(): void
+	{
+		doFoo();
+	}
+
+}