feat: Assure Gitlab reports have integer line properties

Ref: phpstan/phpstan-src#616

Author: williamdes

src/Error.php

@@ -10,7 +10,7 @@ class Error
     protected $message;
     /** @var string|null */
     protected $file;
-    /** @var int */
+    /** @var int|null */
     protected $line;
     /** @var int */
     protected $severity;
@@ -29,7 +29,7 @@ class Error
     public function __construct(
         string $message,
         ?string $file,
-        int $line,
+        ?int $line,
         int $severity = Error::LEVEL_ERROR,
         ?string $tip = null
     ) {
@@ -50,7 +50,7 @@ public function getFile(): ?string
         return $this->file;
     }
 
-    public function getLine(): int
+    public function getLine(): ?int
     {
         return $this->line;
     }

src/ErrorFormatter/GitlabErrorFormatter.php

@@ -3,7 +3,7 @@
 declare(strict_types = 1);
 
 /*
- * (c) Copyright (c) 2016-2020 Ondřej Mirtes <[email protected]>
+ * (c) Copyright (c) 2016-2021 Ondřej Mirtes <[email protected]>
  *
  * This source file is subject to the MIT license.
  *
@@ -72,7 +72,7 @@ public function formatErrors(AnalysisResult $analysisResult, Output $output): in
                 'location' => [
                     'path' => $this->relativePathHelper->getRelativePath($file),
                     'lines' => [
-                        'begin' => $fileSpecificError->getLine(),
+                        'begin' => $fileSpecificError->getLine() ?? 0,
                     ],
                 ],
             ];

tests/ErrorFormatter/GitlabFormatterTest.php

@@ -3,7 +3,7 @@
 declare(strict_types = 1);
 
 /*
- * (c) Copyright (c) 2016-2020 Ondřej Mirtes <[email protected]>
+ * (c) Copyright (c) 2016-2021 Ondřej Mirtes <[email protected]>
  *
  * This source file is subject to the MIT license.
  *
@@ -134,6 +134,69 @@ public function dataFormatterOutputProvider(): iterable
     }
 ]',
         ];
+		yield [
+			'Multiple file errors, including error with line=null',
+			1,
+			5,
+			0,
+			'[
+    {
+        "description": "Bar\nBar2",
+        "fingerprint": "034b4afbfb347494c14e396ed8327692f58be4cd27e8aff5f19f4194934db7c9",
+        "severity": "major",
+        "location": {
+            "path": "with space/and unicode 😃/project/folder with unicode 😃/file name with \"spaces\" and unicode 😃.php",
+            "lines": {
+                "begin": 2
+            }
+        }
+    },
+    {
+        "description": "Foo",
+        "fingerprint": "e82b7e1f1d4255352b19ecefa9116a12f129c7edb4351cf2319285eccdb1565e",
+        "severity": "major",
+        "location": {
+            "path": "with space/and unicode 😃/project/folder with unicode 😃/file name with \"spaces\" and unicode 😃.php",
+            "lines": {
+                "begin": 4
+            }
+        }
+    },
+    {
+        "description": "Bar\nBar2",
+        "fingerprint": "52d22d9e64bd6c6257b7a0d170ed8c99482043aeedd68c52bac081a80da9800a",
+        "severity": "major",
+        "location": {
+            "path": "with space/and unicode \ud83d\ude03/project/foo.php",
+            "lines": {
+                "begin": 0
+            }
+        }
+    },
+    {
+        "description": "Foo",
+        "fingerprint": "93c79740ed8c6fbaac2087e54d6f6f67fc0918e3ff77840530f32e19857ef63c",
+        "severity": "major",
+        "location": {
+            "path": "with space/and unicode \ud83d\ude03/project/foo.php",
+            "lines": {
+                "begin": 1
+            }
+        }
+    },
+    {
+        "description": "Bar\nBar2",
+        "fingerprint": "829f6c782152fdac840b39208c5b519d18e51bff2c601b6197812fffb8bcd9ed",
+        "severity": "major",
+        "location": {
+            "path": "with space/and unicode \ud83d\ude03/project/foo.php",
+            "lines": {
+                "begin": 5
+            }
+        }
+    }
+]',
+		];
 
         yield [
             'Multiple generic errors',

tests/ErrorFormatterTestCase.php

@@ -3,7 +3,7 @@
 declare(strict_types = 1);
 
 /*
- * (c) Copyright (c) 2016-2020 Ondřej Mirtes <[email protected]>
+ * (c) Copyright (c) 2016-2021 Ondřej Mirtes <[email protected]>
  *
  * This source file is subject to the MIT license.
  *
@@ -98,7 +98,7 @@ protected function getOutputContent(): string
 
     protected function getAnalysisResult(int $numFileErrors, int $numGenericErrors, int $numWarnings = 0): AnalysisResult
     {
-        if ($numFileErrors > 4 || $numFileErrors < 0 || $numGenericErrors > 2 || $numGenericErrors < 0) {
+        if ($numFileErrors > 5 || $numFileErrors < 0 || $numGenericErrors > 2 || $numGenericErrors < 0) {
             throw new \Exception('Test case error');
         }
 
@@ -108,6 +108,7 @@ protected function getAnalysisResult(int $numFileErrors, int $numGenericErrors,
             new Error('Foo', self::DIRECTORY_PATH . '/foo.php', 1),
             new Error("Bar\nBar2", self::DIRECTORY_PATH . '/foo.php', 5),
             new Error("Bar\nBar2", self::DIRECTORY_PATH . '/folder with unicode 😃/file name with "spaces" and unicode 😃.php', 2),
+            new Error("Bar\nBar2", self::DIRECTORY_PATH . '/foo.php', null),
             ],
             0,
             $numFileErrors