Support windows line endings (#2)

Author: janedbal

src/InlineIgnoreInliner.php

@@ -4,7 +4,10 @@
 
 use function explode;
 use function implode;
+use function rtrim;
 use function str_contains;
+use function strlen;
+use function substr;
 
 final class InlineIgnoreInliner
 {
@@ -33,17 +36,17 @@ public function inlineErrors(
 
                 [$trueFilePath] = explode(' (in context of class', $filePath, 2); // solve trait "filepath" in format "src/App/MyTrait.php (in context of class App\Clazz)"
 
-                $fileContent = $this->io->readFile($trueFilePath);
-                $lines = explode("\n", $fileContent);
+                $lines = $this->io->readFile($trueFilePath);
 
-                $lineContent = $lines[$line - 1];
+                $lineContent = rtrim($lines[$line - 1]);
+                $lineEnding = substr($lines[$line - 1], strlen($lineContent));
 
                 $append = str_contains($lineContent, '// @phpstan-ignore ')
                     ? ', ' . $identifier
                     : ' // @phpstan-ignore ' . $identifier;
 
-                $lines[$line - 1] .= $append;
-                $this->io->writeFile($trueFilePath, implode("\n", $lines));
+                $lines[$line - 1] = $lineContent . $append . $lineEnding;
+                $this->io->writeFile($trueFilePath, implode('', $lines));
             }
         }
     }

src/Io.php

@@ -2,7 +2,7 @@
 
 namespace ShipMonk\PHPStan\Errors;
 
-use function file_get_contents;
+use function file;
 use function file_put_contents;
 use function stream_get_contents;
 use const STDIN;
@@ -29,17 +29,18 @@ public function readInput(): string
     }
 
     /**
+     * @return list<string>
      * @throws FailureException
      */
-    public function readFile(string $filePath): string
+    public function readFile(string $filePath): array
     {
-        $contents = file_get_contents($filePath);
+        $lines = file($filePath);
 
-        if ($contents === false) {
+        if ($lines === false) {
             throw new FailureException('Could not read file ' . $filePath);
         }
 
-        return $contents;
+        return $lines;
     }
 
     /**

tests/InlineIgnoreInlinerTest.php

@@ -2,22 +2,30 @@
 
 namespace ShipMonk\PHPStan\Errors;
 
+use PHPUnit\Framework\Attributes\DataProvider;
 use PHPUnit\Framework\TestCase;
+use function file;
 use function file_get_contents;
 use function file_put_contents;
 use function json_decode;
+use function str_replace;
 use function sys_get_temp_dir;
 use function uniqid;
 
 class InlineIgnoreInlinerTest extends TestCase
 {
 
-    public function testInlineErrors(): void
+    #[DataProvider('lineEndingProvider')]
+    public function testInlineErrors(string $lineEnding): void
     {
         $tmpFilePath = sys_get_temp_dir() . '/' . uniqid('ignore', true) . '.php';
-        $testedFileContents = file_get_contents(__DIR__ . '/data/test.php');
-        self::assertNotFalse($testedFileContents);
-        self::assertNotFalse(file_put_contents($tmpFilePath, $testedFileContents));
+        $tmpExpectedPath = sys_get_temp_dir() . '/' . uniqid('ignore-expected', true) . '.php';
+
+        $testContent = $this->getTestFileContent('test.php', $lineEnding);
+        $expectedContent = $this->getTestFileContent('test.fixed.php', $lineEnding);
+
+        self::assertNotFalse(file_put_contents($tmpFilePath, $testContent));
+        self::assertNotFalse(file_put_contents($tmpExpectedPath, $expectedContent));
 
         $ioMock = $this->createMock(Io::class);
         $ioMock->expects(self::exactly(2))
@@ -27,8 +35,8 @@ public function testInlineErrors(): void
             });
         $ioMock->expects(self::exactly(2))
             ->method('readFile')
-            ->willReturnCallback(static function (string $filePath) use ($tmpFilePath): string|false {
-                return file_get_contents($tmpFilePath);
+            ->willReturnCallback(static function (string $filePath) use ($tmpFilePath): array|false {
+                return file($tmpFilePath);
             });
 
         $testJson = file_get_contents(__DIR__ . '/data/errors.json');
@@ -37,7 +45,26 @@ public function testInlineErrors(): void
         $inliner = new InlineIgnoreInliner($ioMock);
         $inliner->inlineErrors($testData);
 
-        self::assertFileEquals(__DIR__ . '/data/test.fixed.php', $tmpFilePath);
+        self::assertFileEquals($tmpExpectedPath, $tmpFilePath);
+    }
+
+    private function getTestFileContent(string $filename, string $lineEnding): string
+    {
+        $content = file_get_contents(__DIR__ . '/data/' . $filename);
+        self::assertNotFalse($content);
+
+        return str_replace("\n", $lineEnding, $content);
+    }
+
+    /**
+     * @return array<string, array{string}>
+     */
+    public static function lineEndingProvider(): array
+    {
+        return [
+            'Unix line endings' => ["\n"],
+            'Windows line endings' => ["\r\n"],
+        ];
     }
 
 }