[TASK] Allow whitepace parsing to be stopped at EOL

src/Parsing/ParserState.php

@@ -201,12 +201,16 @@ public function parseCharacter(bool $isForIdentifier): ?string
      * This method may change the state of the object by advancing the internal position;
      * it does not simply 'get' a value.
      */
-    public function consumeWhiteSpace(array &$comments = []): string
+    public function consumeWhiteSpace(array &$comments = [], bool $stopAfterLineFeed = false): string
     {
         $consumed = '';
         do {
             while (preg_match('/\\s/isSu', $this->peek()) === 1) {
-                $consumed .= $this->consume(1);
+                $characterComsumed = $this->consume(1);
+                $consumed .= $characterComsumed;
+                if ($stopAfterLineFeed && $characterComsumed === "\n") {
+                    break 2;
+                }
             }
             if ($this->parserSettings->usesLenientParsing()) {
                 try {

tests/Unit/Parsing/ParserStateTest.php

@@ -303,4 +303,67 @@ public function consumeWhiteSpaceStopsAtNonWhitespace(string $nonWhitespace, str
 
         self::assertTrue($subject->comes($nonWhitespace));
     }
+
+    /**
+     * @return array<non-empty-string, array{0: string}>
+     */
+    public static function providePossibleWhitespaceWithoutLineFeedPossiblyIncludingComments(): array
+    {
+        return [
+            'nothing' => [''],
+            'space' => [' '],
+            'tab' => ["\t"],
+            'carriage return' => ["\r"], // inclusion of this is debatable, but Mac line endings are not generally seen
+            'two spaces' => ['  '],
+            'comment' => ['/* Time for bed */'],
+            'comment with spacing around' => [' /* I am so tired */ '],
+        ];
+    }
+
+    /**
+     * @return DataProvider<non-empty-string, array{0: string, 1: string}>
+     */
+    public function providePossibleWhitespaceWithoutLineFeedPossiblyIncludingCommentsAndTheSameAgain(): DataProvider
+    {
+        return DataProvider::cross(
+            self::providePossibleWhitespaceWithoutLineFeedPossiblyIncludingComments(),
+            self::providePossibleWhitespaceWithoutLineFeedPossiblyIncludingComments()
+        );
+    }
+
+    /**
+     * @test
+     *
+     * @dataProvider providePossibleWhitespaceWithoutLineFeedPossiblyIncludingCommentsAndTheSameAgain
+     */
+    public function consumeWhiteSpaceStopsAfterLineFeedWhenRequested(string $firstLine, string $secondLine): void
+    {
+        $subject = new ParserState($firstLine . "\n" . $secondLine, Settings::create());
+
+        $comments = [];
+        $subject->consumeWhiteSpace($comments, true);
+
+        if ($secondLine === '') {
+            self::assertTrue($subject->isEnd());
+        } else {
+            self::assertTrue($subject->comes($secondLine));
+        }
+    }
+
+    /**
+     * @test
+     *
+     * @dataProvider providePossibleWhitespaceWithoutLineFeedPossiblyIncludingCommentsAndTheSameAgain
+     */
+    public function consumeWhiteSpaceDoesNotStopAfterLineFeedWhenNotRequested(
+        string $firstLine,
+        string $secondLine
+    ): void {
+        $subject = new ParserState($firstLine . "\n" . $secondLine, Settings::create());
+
+        $comments = [];
+        $subject->consumeWhiteSpace($comments, false);
+
+        self::assertTrue($subject->isEnd());
+    }
 }