Intro of WARNING (3), better header handling.

Author: SpacePossum

src/Differ.php

@@ -111,7 +111,7 @@ public function diffToArray($from, $to, LongestCommonSubsequenceCalculator $lcs
         if ($this->detectUnmatchedLineEndings($fromMatches, $toMatches)) {
             $diff[] = [
                 '#Warning: Strings contain different line endings!',
-                0
+                3
             ];
         }
 

src/Output/DiffOnlyOutputBuilder.php

@@ -28,14 +28,22 @@ public function __construct(string $header = "--- Original\n+++ New\n")
     public function getDiff(array $diff): string
     {
         $buffer = \fopen('php://memory', 'r+b');
-        \fwrite($buffer, $this->header);
+
+        if ('' !== $this->header) {
+            \fwrite($buffer, $this->header);
+            if ("\n" !== \substr($this->header, -1, 1)) {
+                \fwrite($buffer, "\n");
+            }
+        }
 
         foreach ($diff as $diffEntry) {
             if ($diffEntry[1] === 1 /* ADDED */) {
                 \fwrite($buffer, '+' . $diffEntry[0] . "\n");
             } elseif ($diffEntry[1] === 2 /* REMOVED */) {
                 \fwrite($buffer, '-' . $diffEntry[0] . "\n");
-            }
+            } elseif ($diffEntry[1] === 3 /* WARNING */) {
+                \fwrite($buffer, ' ' . $diffEntry[0] . "\n");
+            } // else { /* Not changed (old) 0 */
         }
 
         $diff = \stream_get_contents($buffer, -1, 0);

src/Output/UnifiedDiffOutputBuilder.php

@@ -40,7 +40,13 @@ public function getDiff(array $diff): string
             }
         }
 
-        $buffer = $this->header;
+        $buffer = '';
+        if ('' !== $this->header) {
+            $buffer = $this->header;
+            if ("\n" !== \substr($this->header, -1, 1)) {
+                $buffer .= "\n";
+            }
+        }
 
         if (!isset($old[$start])) {
             $buffer = $this->getDiffBufferElementNew($diff, $buffer, $start);
@@ -88,7 +94,7 @@ private function getDiffBufferElement(array $diff, string $buffer, int $diffInde
             $buffer .= '+' . $diff[$diffIndex][0] . "\n";
         } elseif ($diff[$diffIndex][1] === 2 /* REMOVED */) {
             $buffer .= '-' . $diff[$diffIndex][0] . "\n";
-        } else {
+        } else { /* Not changed (OLD) 0 or Warning 3 */
             $buffer .= ' ' . $diff[$diffIndex][0] . "\n";
         }
 

tests/DifferTest.php

@@ -30,6 +30,7 @@
  */
 final class DifferTest extends TestCase
 {
+    const WARNING = 3;
     const REMOVED = 2;
     const ADDED   = 1;
     const OLD     = 0;
@@ -61,7 +62,7 @@ public function testArrayRepresentationOfDiffCanBeRenderedUsingTimeEfficientLcsI
      * @param string $to
      * @dataProvider textProvider
      */
-    public function testTextRepresentationOfDiffCanBeRenderedUsingTimeEfficientLcsImplementation($expected, $from, $to)
+    public function testTextRepresentationOfDiffCanBeRenderedUsingTimeEfficientLcsImplementation(string $expected, string $from, string $to)
     {
         $this->assertSame($expected, $this->differ->diff($from, $to, new TimeEfficientLongestCommonSubsequenceCalculator));
     }
@@ -88,16 +89,53 @@ public function testTextRepresentationOfDiffCanBeRenderedUsingMemoryEfficientLcs
         $this->assertSame($expected, $this->differ->diff($from, $to, new MemoryEfficientLongestCommonSubsequenceCalculator));
     }
 
-    public function testCustomHeaderCanBeUsed()
+    /**
+     * @param string $expected
+     * @param string $from
+     * @param string $to
+     * @param string $header
+     * @dataProvider headerProvider
+     */
+    public function testCustomHeaderCanBeUsed(string $expected, string $from, string $to, string $header)
     {
-        $differ = new Differ(new UnifiedDiffOutputBuilder('CUSTOM HEADER'));
+        $differ = new Differ(new UnifiedDiffOutputBuilder($header));
 
         $this->assertSame(
-            "CUSTOM HEADER@@ @@\n-a\n+b\n",
-            $differ->diff('a', 'b')
+            $expected,
+            $differ->diff($from, $to)
         );
     }
 
+    public function headerProvider()
+    {
+        return [
+            [
+                "CUSTOM HEADER\n@@ @@\n-a\n+b\n",
+                'a',
+                'b',
+                'CUSTOM HEADER'
+            ],
+            [
+                "CUSTOM HEADER\n@@ @@\n-a\n+b\n",
+                'a',
+                'b',
+                "CUSTOM HEADER\n"
+            ],
+            [
+                "CUSTOM HEADER\n\n@@ @@\n-a\n+b\n",
+                'a',
+                'b',
+                "CUSTOM HEADER\n\n"
+            ],
+            [
+                "@@ @@\n-a\n+b\n",
+                'a',
+                'b',
+                ''
+            ],
+        ];
+    }
+
     public function testTypesOtherThanArrayAndStringCanBePassed()
     {
         $this->assertSame(
@@ -245,7 +283,7 @@ public function arrayProvider(): array
                 [
                     [
                         '#Warning: Strings contain different line endings!',
-                        self::OLD,
+                        self::WARNING,
                     ],
                     [
                         '<?php',
@@ -363,25 +401,49 @@ public function diffProvider(): array
      * @param string $expected
      * @param string $from
      * @param string $to
+     * @param string $header
      * @dataProvider textForNoNonDiffLinesProvider
      */
-    public function testDiffDoNotShowNonDiffLines(string $expected, string $from, string $to)
+    public function testDiffDoNotShowNonDiffLines(string $expected, string $from, string $to, string $header = '')
     {
-        $differ = new Differ(new DiffOnlyOutputBuilder(''));
+        $differ = new Differ(new DiffOnlyOutputBuilder($header));
+
         $this->assertSame($expected, $differ->diff($from, $to));
     }
 
     public function textForNoNonDiffLinesProvider(): array
     {
         return [
             [
-                '', 'a', 'a'
+                ' #Warning: Strings contain different line endings!
+-A
++B
+',
+                "A\r\n",
+                "B\n",
+            ],
+            [
+                '',
+                'a',
+                'a'
             ],
             [
                 "-A\n+C\n",
                 "A\n\n\nB",
                 "C\n\n\nB",
             ],
+            [
+                "header\n",
+                'a',
+                'a',
+                'header'
+            ],
+            [
+                "header\n",
+                'a',
+                'a',
+                "header\n"
+            ],
         ];
     }