Preserve same fingerprint after issue moved to another line

Author: Antanas Strumila

src/Report/Gitlab.php

@@ -11,6 +11,7 @@
 
 use PHP_CodeSniffer\Files\File;
 use PHP_CodeSniffer\Reports\Report;
+use SplFileObject;
 
 use function md5;
 use function rtrim;
@@ -28,13 +29,18 @@ public function generateFileReport($report, File $phpcsFile, $showSources = fals
         $hasOutput = false;
 
         foreach ($report['messages'] as $line => $lineErrors) {
+            $file = new SplFileObject($phpcsFile->getFilename());
             foreach ($lineErrors as $column => $colErrors) {
                 foreach ($colErrors as $error) {
                     $issue = [
                         'type' => 'issue',
                         'categories' => ['Style'],
                         'check_name' => $error['source'],
-                        'fingerprint' => md5($report['filename'] . $error['message'] . $line . $column),
+                        'fingerprint' => md5(
+                            $report['filename']
+                            . $error["source"]
+                            . $this->getRelevantSource($file, $line - 1)
+                        ),
                         'severity' => $error['type'] === 'ERROR' ? 'major' : 'minor',
                         'description' => str_replace(["\n", "\r", "\t"], ['\n', '\r', '\t'], $error['message']),
                         'location' => [
@@ -68,4 +74,18 @@ public function generate(
     ) {
         echo '[' . rtrim($cachedData, ',') . ']' . PHP_EOL;
     }
+
+    private function getRelevantSource(SplFileObject $file, int $line): string
+    {
+        if (!$file->eof()) {
+            $file->seek($line);
+            $contents = $file->current();
+
+            if (false !== $contents) {
+                return preg_replace('/\s+/', '', $contents);
+            }
+        }
+
+        return '';
+    }
 }

tests/Fixtures/MixedViolations.php

@@ -47,6 +47,6 @@ public function getReportData(): array
 
     public function getExpectedOutput(): string
     {
-        return '{"type":"issue","categories":["Style"],"check_name":"PSR12.Functions.ReturnTypeDeclaration.SpaceBeforeReturnType","fingerprint":"766bf1f7eff186fd667447bfb0291078","severity":"major","description":"There must be a single space between the colon and type in a return type declaration","location":{"path":"tests/Report/GitlabTest.php","lines":{"begin":23,"end":23}}},{"type":"issue","categories":["Style"],"check_name":"Generic.Files.LineLength.TooLong","fingerprint":"517eda4b85a33cd09fc933259f873191","severity":"minor","description":"Line exceeds 120 characters; contains 124 characters","location":{"path":"tests/Report/GitlabTest.php","lines":{"begin":34,"end":34}}},';
+        return '{"type":"issue","categories":["Style"],"check_name":"PSR12.Functions.ReturnTypeDeclaration.SpaceBeforeReturnType","fingerprint":"0f7fd875e9d8ce4260a335195f184ae8","severity":"major","description":"There must be a single space between the colon and type in a return type declaration","location":{"path":"tests/Report/GitlabTest.php","lines":{"begin":23,"end":23}}},{"type":"issue","categories":["Style"],"check_name":"Generic.Files.LineLength.TooLong","fingerprint":"ba24219048019211e5a36d99b23a0428","severity":"minor","description":"Line exceeds 120 characters; contains 124 characters","location":{"path":"tests/Report/GitlabTest.php","lines":{"begin":34,"end":34}}},';
     }
 }

tests/Fixtures/SingleViolation.php

@@ -36,6 +36,6 @@ public function getReportData(): array
 
     public function getExpectedOutput(): string
     {
-        return '{"type":"issue","categories":["Style"],"check_name":"PSR12.Files.FileHeader.SpacingInsideBlock","fingerprint":"21f4cd5b7d88d9eb67402be5d56caa8b","severity":"major","description":"Header blocks must not contain blank lines","location":{"path":"src/Report/Gitlab.php","lines":{"begin":18,"end":18}}},';
+        return '{"type":"issue","categories":["Style"],"check_name":"PSR12.Files.FileHeader.SpacingInsideBlock","fingerprint":"b032bdbf36024c6287172cef1f54a6fd","severity":"major","description":"Header blocks must not contain blank lines","location":{"path":"src/Report/Gitlab.php","lines":{"begin":18,"end":18}}},';
     }
 }

tests/Report/GitlabTest.php

@@ -67,8 +67,11 @@ public function testGenerateFileReport(string $class): void
     {
         $fixture = new $class();
         self::assertInstanceOf(ReportFixture::class, $fixture);
+        $fixtureReflection = new \ReflectionClass($class);
+        $phpcsFile = $this->createMock(File::class);
+        $phpcsFile->method('getFilename')->willReturn($fixtureReflection->getFileName());
 
         $this->expectOutputString($fixture->getExpectedOutput());
-        $this->report->generateFileReport($fixture->getReportData(), $this->createMock(File::class));
+        $this->report->generateFileReport($fixture->getReportData(), $phpcsFile);
     }
 }