Introduce LocalIgnoresProcessor

phpstan · Apr 20, 2024 · d026655 · d026655
1 parent 38e2c96
commit d026655
Show file tree

Hide file tree

Showing 6 changed files with 178 additions and 63 deletions.
diff --git a/conf/config.neon b/conf/config.neon
@@ -485,6 +485,9 @@ services:
 			parser: @defaultAnalysisParser
 			reportUnmatchedIgnoredErrors: %reportUnmatchedIgnoredErrors%
 
+	-
+		class: PHPStan\Analyser\LocalIgnoresProcessor
+
 	-
 		class: PHPStan\Analyser\RuleErrorTransformer
 

diff --git a/src/Analyser/FileAnalyser.php b/src/Analyser/FileAnalyser.php
@@ -15,15 +15,13 @@
 use PHPStan\Parser\Parser;
 use PHPStan\Parser\ParserErrorsException;
 use PHPStan\Rules\Registry as RuleRegistry;
-use function array_key_exists;
 use function array_keys;
 use function array_merge;
 use function array_unique;
 use function array_values;
 use function count;
 use function error_reporting;
 use function get_class;
-use function is_array;
 use function is_dir;
 use function is_file;
 use function restore_error_handler;
@@ -43,6 +41,7 @@ public function __construct(
 		private Parser $parser,
 		private DependencyResolver $dependencyResolver,
 		private RuleErrorTransformer $ruleErrorTransformer,
+		private LocalIgnoresProcessor $localIgnoresProcessor,
 		private bool $reportUnmatchedIgnoredErrors,
 	)
 	{
@@ -176,69 +175,20 @@ public function analyseFile(
 					$scope,
 					$nodeCallback,
 				);
-				foreach ($temporaryFileErrors as $tmpFileError) {
-					$line = $tmpFileError->getLine();
-					if (
-						$line !== null
-						&& $tmpFileError->canBeIgnored()
-						&& array_key_exists($tmpFileError->getFile(), $linesToIgnore)
-						&& array_key_exists($line, $linesToIgnore[$tmpFileError->getFile()])
-					) {
-						$identifiers = $linesToIgnore[$tmpFileError->getFile()][$line];
-						if ($identifiers === null) {
-							$locallyIgnoredErrors[] = $tmpFileError;
-							unset($unmatchedLineIgnores[$tmpFileError->getFile()][$line]);
-							continue;
-						}
-
-						if ($tmpFileError->getIdentifier() === null) {
-							$fileErrors[] = $tmpFileError;
-							continue;
-						}
-
-						foreach ($identifiers as $i => $ignoredIdentifier) {
-							if ($ignoredIdentifier !== $tmpFileError->getIdentifier()) {
-								continue;
-							}
-
-							unset($identifiers[$i]);
 
-							if (count($identifiers) > 0) {
-								$linesToIgnore[$tmpFileError->getFile()][$line] = array_values($identifiers);
-							} else {
-								unset($linesToIgnore[$tmpFileError->getFile()][$line]);
-							}
-
-							if (
-								array_key_exists($tmpFileError->getFile(), $unmatchedLineIgnores)
-								&& array_key_exists($line, $unmatchedLineIgnores[$tmpFileError->getFile()])
-							) {
-								$unmatchedIgnoredIdentifiers = $unmatchedLineIgnores[$tmpFileError->getFile()][$line];
-								if (is_array($unmatchedIgnoredIdentifiers)) {
-									foreach ($unmatchedIgnoredIdentifiers as $j => $unmatchedIgnoredIdentifier) {
-										if ($ignoredIdentifier !== $unmatchedIgnoredIdentifier) {
-											continue;
-										}
-
-										unset($unmatchedIgnoredIdentifiers[$j]);
-
-										if (count($unmatchedIgnoredIdentifiers) > 0) {
-											$unmatchedLineIgnores[$tmpFileError->getFile()][$line] = array_values($unmatchedIgnoredIdentifiers);
-										} else {
-											unset($unmatchedLineIgnores[$tmpFileError->getFile()][$line]);
-										}
-										break;
-									}
-								}
-							}
-
-							$locallyIgnoredErrors[] = $tmpFileError;
-							continue 2;
-						}
-					}
-
-					$fileErrors[] = $tmpFileError;
+				$localIgnoresProcessorResult = $this->localIgnoresProcessor->process(
+					$temporaryFileErrors,
+					$linesToIgnore,
+					$unmatchedLineIgnores,
+				);
+				foreach ($localIgnoresProcessorResult->getFileErrors() as $fileError) {
+					$fileErrors[] = $fileError;
+				}
+				foreach ($localIgnoresProcessorResult->getLocallyIgnoredErrors() as $locallyIgnoredError) {
+					$locallyIgnoredErrors[] = $locallyIgnoredError;
 				}
+				$linesToIgnore = $localIgnoresProcessorResult->getLinesToIgnore();
+				$unmatchedLineIgnores = $localIgnoresProcessorResult->getUnmatchedLineIgnores();
 
 				if ($this->reportUnmatchedIgnoredErrors) {
 					foreach ($unmatchedLineIgnores as $ignoredFile => $lines) {

diff --git a/src/Analyser/LocalIgnoresProcessor.php b/src/Analyser/LocalIgnoresProcessor.php
@@ -0,0 +1,101 @@
+<?php declare(strict_types = 1);
+
+namespace PHPStan\Analyser;
+
+use function array_key_exists;
+use function array_values;
+use function count;
+use function is_array;
+
+/**
+ * @phpstan-import-type LinesToIgnore from FileAnalyserResult
+ */
+class LocalIgnoresProcessor
+{
+
+	/**
+	 * @param list<Error> $temporaryFileErrors
+	 * @param LinesToIgnore $linesToIgnore
+	 * @param LinesToIgnore $unmatchedLineIgnores
+	 */
+	public function process(
+		array $temporaryFileErrors,
+		array $linesToIgnore,
+		array $unmatchedLineIgnores,
+	): LocalIgnoresProcessorResult
+	{
+		$fileErrors = [];
+		$locallyIgnoredErrors = [];
+		foreach ($temporaryFileErrors as $tmpFileError) {
+			$line = $tmpFileError->getLine();
+			if (
+				$line !== null
+				&& $tmpFileError->canBeIgnored()
+				&& array_key_exists($tmpFileError->getFile(), $linesToIgnore)
+				&& array_key_exists($line, $linesToIgnore[$tmpFileError->getFile()])
+			) {
+				$identifiers = $linesToIgnore[$tmpFileError->getFile()][$line];
+				if ($identifiers === null) {
+					$locallyIgnoredErrors[] = $tmpFileError;
+					unset($unmatchedLineIgnores[$tmpFileError->getFile()][$line]);
+					continue;
+				}
+
+				if ($tmpFileError->getIdentifier() === null) {
+					$fileErrors[] = $tmpFileError;
+					continue;
+				}
+
+				foreach ($identifiers as $i => $ignoredIdentifier) {
+					if ($ignoredIdentifier !== $tmpFileError->getIdentifier()) {
+						continue;
+					}
+
+					unset($identifiers[$i]);
+
+					if (count($identifiers) > 0) {
+						$linesToIgnore[$tmpFileError->getFile()][$line] = array_values($identifiers);
+					} else {
+						unset($linesToIgnore[$tmpFileError->getFile()][$line]);
+					}
+
+					if (
+						array_key_exists($tmpFileError->getFile(), $unmatchedLineIgnores)
+						&& array_key_exists($line, $unmatchedLineIgnores[$tmpFileError->getFile()])
+					) {
+						$unmatchedIgnoredIdentifiers = $unmatchedLineIgnores[$tmpFileError->getFile()][$line];
+						if (is_array($unmatchedIgnoredIdentifiers)) {
+							foreach ($unmatchedIgnoredIdentifiers as $j => $unmatchedIgnoredIdentifier) {
+								if ($ignoredIdentifier !== $unmatchedIgnoredIdentifier) {
+									continue;
+								}
+
+								unset($unmatchedIgnoredIdentifiers[$j]);
+
+								if (count($unmatchedIgnoredIdentifiers) > 0) {
+									$unmatchedLineIgnores[$tmpFileError->getFile()][$line] = array_values($unmatchedIgnoredIdentifiers);
+								} else {
+									unset($unmatchedLineIgnores[$tmpFileError->getFile()][$line]);
+								}
+								break;
+							}
+						}
+					}
+
+					$locallyIgnoredErrors[] = $tmpFileError;
+					continue 2;
+				}
+			}
+
+			$fileErrors[] = $tmpFileError;
+		}
+
+		return new LocalIgnoresProcessorResult(
+			$fileErrors,
+			$locallyIgnoredErrors,
+			$linesToIgnore,
+			$unmatchedLineIgnores,
+		);
+	}
+
+}
diff --git a/src/Analyser/LocalIgnoresProcessorResult.php b/src/Analyser/LocalIgnoresProcessorResult.php
@@ -0,0 +1,58 @@
+<?php declare(strict_types = 1);
+
+namespace PHPStan\Analyser;
+
+/**
+ * @phpstan-import-type LinesToIgnore from FileAnalyserResult
+ */
+class LocalIgnoresProcessorResult
+{
+
+	/**
+	 * @param list<Error> $fileErrors
+	 * @param list<Error> $locallyIgnoredErrors
+	 * @param LinesToIgnore $linesToIgnore
+	 * @param LinesToIgnore $unmatchedLineIgnores
+	 */
+	public function __construct(
+		private array $fileErrors,
+		private array $locallyIgnoredErrors,
+		private array $linesToIgnore,
+		private array $unmatchedLineIgnores,
+	)
+	{
+	}
+
+	/**
+	 * @return list<Error>
+	 */
+	public function getFileErrors(): array
+	{
+		return $this->fileErrors;
+	}
+
+	/**
+	 * @return list<Error>
+	 */
+	public function getLocallyIgnoredErrors(): array
+	{
+		return $this->locallyIgnoredErrors;
+	}
+
+	/**
+	 * @return LinesToIgnore
+	 */
+	public function getLinesToIgnore(): array
+	{
+		return $this->linesToIgnore;
+	}
+
+	/**
+	 * @return LinesToIgnore
+	 */
+	public function getUnmatchedLineIgnores(): array
+	{
+		return $this->unmatchedLineIgnores;
+	}
+
+}
diff --git a/src/Testing/RuleTestCase.php b/src/Testing/RuleTestCase.php
@@ -7,6 +7,7 @@
 use PHPStan\Analyser\AnalyserResultFinalizer;
 use PHPStan\Analyser\Error;
 use PHPStan\Analyser\FileAnalyser;
+use PHPStan\Analyser\LocalIgnoresProcessor;
 use PHPStan\Analyser\NodeScopeResolver;
 use PHPStan\Analyser\RuleErrorTransformer;
 use PHPStan\Analyser\TypeSpecifier;
@@ -110,6 +111,7 @@ private function getAnalyser(): Analyser
 				$this->getParser(),
 				self::getContainer()->getByType(DependencyResolver::class),
 				new RuleErrorTransformer(),
+				new LocalIgnoresProcessor(),
 				true,
 			);
 			$this->analyser = new Analyser(

diff --git a/tests/PHPStan/Analyser/AnalyserTest.php b/tests/PHPStan/Analyser/AnalyserTest.php
@@ -715,6 +715,7 @@ private function createAnalyser(bool $reportUnmatchedIgnoredErrors, bool $enable
 			),
 			new DependencyResolver($fileHelper, $reflectionProvider, new ExportedNodeResolver($fileTypeMapper, new ExprPrinter(new Printer())), $fileTypeMapper),
 			new RuleErrorTransformer(),
+			new LocalIgnoresProcessor(),
 			$reportUnmatchedIgnoredErrors,
 		);