Make split platform independend

Author: jaapio

src/DocBlock/DescriptionFactory.php

@@ -146,7 +146,7 @@ private function lex(string $contents): array
      */
     private function removeSuperfluousStartingWhitespace(string $contents): string
     {
-        $lines = explode("\n", $contents);
+        $lines = Utils::pregSplit("/\r\n?|\n/", $contents);
 
         // if there is only one line then we don't have lines with superfluous whitespace and
         // can use the contents as-is

tests/integration/InterpretingDocBlocksTest.php

@@ -79,7 +79,14 @@ public function testInterpretingASimpleDocBlock(): void
         $this->assertInstanceOf(DocBlock::class, $docblock);
         $this->assertSame('This is an example of a summary.', $summary);
         $this->assertInstanceOf(Description::class, $description);
-        $this->assertSame($descriptionText, $description->render());
+        $this->assertSame(
+            str_replace(
+                PHP_EOL,
+                "\n",
+            $descriptionText
+            ),
+            $description->render()
+        );
         $this->assertEmpty($docblock->getTags());
     }
 
@@ -124,6 +131,9 @@ public function testDescriptionsCanEscapeAtSignsAndClosingBraces(): void
         include(__DIR__ . '/../../examples/playing-with-descriptions/02-escaping.php');
 
         $this->assertSame(
+            str_replace(
+                PHP_EOL,
+                "\n",
             <<<'DESCRIPTION'
 You can escape the @-sign by surrounding it with braces, for example: @. And escape a closing brace within an
 inline tag by adding an opening brace in front of it like this: }.
@@ -135,7 +145,7 @@ public function testDescriptionsCanEscapeAtSignsAndClosingBraces(): void
 
 Do note that an {@internal inline tag that has an opening brace ({) does not break out}.
 DESCRIPTION
-            ,
+            ),
             $foundDescription
         );
     }

tests/unit/DocBlock/DescriptionFactoryTest.php

@@ -20,6 +20,8 @@
 use phpDocumentor\Reflection\Types\Context;
 use PHPUnit\Framework\TestCase;
 
+use function str_replace;
+
 /**
  * @coversDefaultClass \phpDocumentor\Reflection\DocBlock\DescriptionFactory
  * @covers ::<private>
@@ -192,7 +194,7 @@ public function testIfSuperfluousStartingSpacesAreRemoved(): void
 
         $description = $factory->create($descriptionText, new Context(''));
 
-        $this->assertSame($expectedDescription, $description->render());
+        $this->assertSame(str_replace(PHP_EOL, "\n", $expectedDescription), $description->render());
     }
 
     /**

tests/unit/DocBlock/SerializerTest.php

@@ -63,7 +63,7 @@ public function testReconstructsADocCommentFromADocBlock(): void
             ]
         );
 
-        $this->assertSame($expected, $fixture->getDocComment($docBlock));
+        $this->assertSameString($expected, $fixture->getDocComment($docBlock));
     }
 
     /**
@@ -98,7 +98,7 @@ public function testAddPrefixToDocBlock(): void
             ]
         );
 
-        $this->assertSame($expected, $fixture->getDocComment($docBlock));
+        $this->assertSameString($expected, $fixture->getDocComment($docBlock));
     }
 
     /**
@@ -133,7 +133,7 @@ public function testAddPrefixToDocBlockExceptFirstLine(): void
             ]
         );
 
-        $this->assertSame($expected, $fixture->getDocComment($docBlock));
+        $this->assertSameString($expected, $fixture->getDocComment($docBlock));
     }
 
     /**
@@ -174,7 +174,7 @@ public function testWordwrapsAroundTheGivenAmountOfCharacters(): void
             ]
         );
 
-        $this->assertSame($expected, $fixture->getDocComment($docBlock));
+        $this->assertSameString($expected, $fixture->getDocComment($docBlock));
     }
 
     /**
@@ -198,9 +198,16 @@ public function testNoExtraSpacesAfterTagRemoval(): void
         $genericTag = new DocBlock\Tags\Generic('unknown-tag');
 
         $docBlock = new DocBlock('', null, [$genericTag]);
-        $this->assertSame($expected, $fixture->getDocComment($docBlock));
+        $this->assertSameString($expected, $fixture->getDocComment($docBlock));
 
         $docBlock->removeTag($genericTag);
-        $this->assertSame($expectedAfterRemove, $fixture->getDocComment($docBlock));
+        $this->assertSameString($expectedAfterRemove, $fixture->getDocComment($docBlock));
+    }
+
+    public function assertSameString(string $expected, string $actual): void
+    {
+        $expected = str_replace(PHP_EOL, "\n", $expected);
+
+        self::assertSame($expected, $actual);
     }
 }

tests/unit/DocBlockFactoryTest.php

@@ -134,7 +134,7 @@ public function testSummaryAndDescriptionAreSeparated(string $given, string $sum
         $docblock = $fixture->create($given);
 
         $this->assertSame($summary, $docblock->getSummary());
-        $this->assertEquals(new Description($description), $docblock->getDescription());
+        $this->assertEquals(new Description(str_replace(PHP_EOL, "\n", $description)), $docblock->getDescription());
     }
 
     /**
@@ -159,12 +159,7 @@ public function testDescriptionsRetainFormatting(): void
  */
 DOCBLOCK;
 
-        $description = <<<DESCRIPTION
-This is a multiline Description
-that contains a code block.
-
-    See here: a CodeBlock
-DESCRIPTION;
+        $description = "This is a multiline Description\nthat contains a code block.\n\n    See here: a CodeBlock";
 
         $docblock = $fixture->create($given);
 
@@ -180,14 +175,9 @@ public function testDescriptionsRetainFormatting(): void
      */
     public function testTagsAreInterpretedUsingFactory(): void
     {
-        $tagString = <<<TAG
-@author Mike van Riel <[email protected]> This is with
-  multiline description.
-TAG;
-
         $tag        = m::mock(Tag::class);
         $tagFactory = m::mock(TagFactory::class);
-        $tagFactory->shouldReceive('create')->with($tagString, m::type(Context::class))->andReturn($tag);
+        $tagFactory->shouldReceive('create')->with(m::any(), m::type(Context::class))->andReturn($tag);
 
         $fixture = new DocBlockFactory(new DescriptionFactory($tagFactory), $tagFactory);