Merge pull request #296 from phpDocumentor/fix/287-line-endings

Improve line-endings for windows.

Author: jaapio

examples/03-reconstituting-a-docblock.php

@@ -20,7 +20,7 @@
 $docblock = $factory->create($docComment);
 
 // Create the serializer that will reconstitute the DocBlock back to its original form.
-$serializer = new Serializer();
+$serializer = new Serializer(0, '', true, null, null, PHP_EOL);
 
 // Reconstitution is performed by the `getDocComment()` method.
 $reconstitutedDocComment = $serializer->getDocComment($docblock);

examples/04-adding-your-own-tag.php

@@ -126,5 +126,5 @@ public function __toString(): string
 
 // As an experiment: let's reconstitute the DocBlock and observe that because we added a __toString() method
 // to the tag class that we can now also see it.
-$serializer              = new Serializer();
+$serializer              = new Serializer(0, '',true, null, null, PHP_EOL);
 $reconstitutedDocComment = $serializer->getDocComment($docblock);

src/DocBlock/DescriptionFactory.php

@@ -17,7 +17,6 @@
 use phpDocumentor\Reflection\Utils;
 
 use function count;
-use function explode;
 use function implode;
 use function ltrim;
 use function min;
@@ -146,7 +145,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

src/DocBlock/Serializer.php

@@ -42,6 +42,8 @@ class Serializer
 
     /** @var Formatter A custom tag formatter. */
     protected $tagFormatter;
+    /** @var string */
+    private $lineEnding;
 
     /**
      * Create a Serializer instance.
@@ -51,19 +53,22 @@ class Serializer
      * @param bool      $indentFirstLine Whether to indent the first line.
      * @param int|null  $lineLength      The max length of a line or NULL to disable line wrapping.
      * @param Formatter $tagFormatter    A custom tag formatter, defaults to PassthroughFormatter.
+     * @param string    $lineEnding      Line ending used in the output, by default \n is used.
      */
     public function __construct(
         int $indent = 0,
         string $indentString = ' ',
         bool $indentFirstLine = true,
         ?int $lineLength = null,
-        ?Formatter $tagFormatter = null
+        ?Formatter $tagFormatter = null,
+        string $lineEnding = "\n"
     ) {
         $this->indent              = $indent;
         $this->indentString        = $indentString;
         $this->isFirstLineIndented = $indentFirstLine;
         $this->lineLength          = $lineLength;
         $this->tagFormatter        = $tagFormatter ?: new PassthroughFormatter();
+        $this->lineEnding = $lineEnding;
     }
 
     /**
@@ -96,7 +101,7 @@ public function getDocComment(DocBlock $docblock): string
 
         $comment = $this->addTagBlock($docblock, $wrapLength, $indent, $comment);
 
-        return $comment . $indent . ' */';
+        return str_replace("\n", $this->lineEnding, $comment . $indent . ' */');
     }
 
     private function removeTrailingSpaces(string $indent, string $text): string

src/DocBlock/Tag.php

@@ -21,7 +21,6 @@ public function getName(): string;
 
     /**
      * @return Tag|mixed Class that implements Tag
-     *
      * @phpstan-return ?Tag
      */
     public static function create(string $body);

src/DocBlock/Tags/Method.php

@@ -59,7 +59,6 @@ final class Method extends BaseTag implements Factory\StaticMethod
 
     /**
      * @param array<int, array<string, Type|string>> $arguments
-     *
      * @phpstan-param array<int, array{name: string, type: Type}|string> $arguments
      */
     public function __construct(
@@ -186,7 +185,6 @@ public function getMethodName(): string
 
     /**
      * @return array<int, array<string, Type|string>>
-     *
      * @phpstan-return array<int, array{name: string, type: Type}>
      */
     public function getArguments(): array
@@ -239,10 +237,9 @@ public function __toString(): string
 
     /**
      * @param mixed[][]|string[] $arguments
+     * @phpstan-param array<int, array{name: string, type: Type}|string> $arguments
      *
      * @return mixed[][]
-     *
-     * @phpstan-param array<int, array{name: string, type: Type}|string> $arguments
      * @phpstan-return array<int, array{name: string, type: Type}>
      */
     private function filterArguments(array $arguments = []): array

src/Utils.php

@@ -14,8 +14,8 @@
 namespace phpDocumentor\Reflection;
 
 use phpDocumentor\Reflection\Exception\PcreException;
-
 use Webmozart\Assert\Assert;
+
 use function preg_last_error;
 use function preg_split as php_preg_split;
 

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,10 @@
 use phpDocumentor\Reflection\Types\Context;
 use PHPUnit\Framework\TestCase;
 
+use function str_replace;
+
+use const PHP_EOL;
+
 /**
  * @coversDefaultClass \phpDocumentor\Reflection\DocBlock\DescriptionFactory
  * @covers ::<private>
@@ -192,7 +196,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

@@ -17,6 +17,10 @@
 use phpDocumentor\Reflection\DocBlock;
 use PHPUnit\Framework\TestCase;
 
+use function str_replace;
+
+use const PHP_EOL;
+
 /**
  * @coversDefaultClass \phpDocumentor\Reflection\DocBlock\Serializer
  * @covers ::<private>
@@ -63,7 +67,7 @@ public function testReconstructsADocCommentFromADocBlock(): void
             ]
         );
 
-        $this->assertSame($expected, $fixture->getDocComment($docBlock));
+        $this->assertSameString($expected, $fixture->getDocComment($docBlock));
     }
 
     /**
@@ -98,7 +102,7 @@ public function testAddPrefixToDocBlock(): void
             ]
         );
 
-        $this->assertSame($expected, $fixture->getDocComment($docBlock));
+        $this->assertSameString($expected, $fixture->getDocComment($docBlock));
     }
 
     /**
@@ -133,7 +137,7 @@ public function testAddPrefixToDocBlockExceptFirstLine(): void
             ]
         );
 
-        $this->assertSame($expected, $fixture->getDocComment($docBlock));
+        $this->assertSameString($expected, $fixture->getDocComment($docBlock));
     }
 
     /**
@@ -174,7 +178,7 @@ public function testWordwrapsAroundTheGivenAmountOfCharacters(): void
             ]
         );
 
-        $this->assertSame($expected, $fixture->getDocComment($docBlock));
+        $this->assertSameString($expected, $fixture->getDocComment($docBlock));
     }
 
     /**
@@ -198,9 +202,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);
     }
 }