Add comment parser tests

Author: SerafimArts

src/Parser/Comment/CommentParserInterface.php

@@ -24,8 +24,8 @@ interface CommentParserInterface
      *      DOC);
      *
      * // The $result contains:
-     * // 7 => 'Example line 1'
-     * // 28 => '@tag1 type Description of tag1'
+     * // - Segment{ offset: 7, text: 'Example line 1' }
+     * // - Segment{ offset: 28, text: '@tag1 type Description of tag1' }
      * ```
      *
      * @return iterable<array-key, Segment>

tests/Unit/CommentParserTest.php

@@ -0,0 +1,157 @@
+<?php
+
+declare(strict_types=1);
+
+namespace TypeLang\PHPDoc\Tests\Unit;
+
+use PHPUnit\Framework\Attributes\DataProvider;
+use PHPUnit\Framework\Attributes\Group;
+use TypeLang\PHPDoc\Parser\Comment\CommentParserInterface;
+use TypeLang\PHPDoc\Parser\Comment\LexerAwareCommentParser;
+
+#[Group('unit'), Group('type-lang/phpdoc')]
+final class CommentParserTest extends TestCase
+{
+    public static function parserDataProvider(): iterable
+    {
+        yield LexerAwareCommentParser::class => [
+            new LexerAwareCommentParser(),
+        ];
+    }
+
+    public static function delimiterDataProvider(): array
+    {
+        return [
+            'LF' => ["\n"],
+            'CRLF' => ["\r\n"],
+        ];
+    }
+
+    public static function parserWithVariantDelimitersDataProvider(): iterable
+    {
+        foreach (self::parserDataProvider() as $parserName => [$provider]) {
+            foreach (self::delimiterDataProvider() as $delimiterName => [$delimiter]) {
+                yield $parserName . ' + ' . $delimiterName => [$provider, $delimiter];
+            }
+        }
+    }
+
+    private function convertLineDelimiter(string $docblock, string $delimiter = "\r\n"): string
+    {
+        return \implode($delimiter, \explode("\n", $docblock));
+    }
+
+    private function parseAsArray(CommentParserInterface $parser, string $docblock, string $delimiter = "\n"): array
+    {
+        if ($delimiter !== "\n") {
+            $docblock = $this->convertLineDelimiter($docblock, $delimiter);
+        }
+
+        $result = [];
+
+        foreach ($parser->parse($docblock) as $segment) {
+            $result[$segment->offset] = $segment->text;
+        }
+
+        return $result;
+    }
+
+    #[DataProvider('parserWithVariantDelimitersDataProvider')]
+    public function testWrappedComment(CommentParserInterface $parser, string $delimiter): void
+    {
+        $docBlock = <<<'PHP'
+            /**
+             * Line 1
+             * Line 2
+             */
+            PHP;
+
+        self::assertSame(match($delimiter) {
+            "\n" => [7 => "Line 1$delimiter", 17 => "Line 2$delimiter"],
+            "\r\n" => [8 => "Line 1$delimiter", 19 => "Line 2$delimiter"],
+        }, $this->parseAsArray($parser, $docBlock, $delimiter));
+    }
+
+    #[DataProvider('parserWithVariantDelimitersDataProvider')]
+    public function testIncompleteEndingWrappedComment(CommentParserInterface $parser, string $delimiter): void
+    {
+        $docBlock = <<<'PHP'
+            /**
+             * Line 1
+             *
+             * Line 3
+            PHP;
+
+        self::assertSame(match($delimiter) {
+            "\n" => [7 => "Line 1$delimiter", 20 => "Line 3"],
+            "\r\n" => [8 => "Line 1$delimiter", 23 => "Line 3"],
+        }, $this->parseAsArray($parser, $docBlock, $delimiter));
+    }
+
+    #[DataProvider('parserWithVariantDelimitersDataProvider')]
+    public function testIncompleteStartingWrappedComment(CommentParserInterface $parser, string $delimiter): void
+    {
+        $docBlock = <<<'PHP'
+             * Line 1
+             *
+             * Line 3
+             */
+            PHP;
+
+        self::assertSame(
+            expected: [0 => $this->convertLineDelimiter($docBlock, $delimiter)],
+            actual: $this->parseAsArray($parser, $docBlock, $delimiter),
+        );
+    }
+
+    #[DataProvider('parserWithVariantDelimitersDataProvider')]
+    public function testExtraNonWhitespaceCharsBeforeWrappedComment(CommentParserInterface $parser, string $delimiter): void
+    {
+        $docBlock = <<<'PHP'
+            Some unrecognized chars
+            /**
+             * Line 1
+             *
+             * Line 3
+             */
+            PHP;
+
+        self::assertSame(
+            expected: [0 => $this->convertLineDelimiter($docBlock, $delimiter)],
+            actual: $this->parseAsArray($parser, $docBlock, $delimiter),
+        );
+    }
+
+    #[DataProvider('parserWithVariantDelimitersDataProvider')]
+    public function testExtraWhitespaceCharsBeforeWrappedComment(CommentParserInterface $parser, string $delimiter): void
+    {
+        $docBlock = <<<PHP
+            \u{0020}\u{000A}
+            /**
+             * Line 1
+             * Line 2
+             */
+            PHP;
+
+        self::assertSame(match($delimiter) {
+            "\n" => [10 => "Line 1$delimiter", 20 => "Line 2$delimiter"],
+            "\r\n" => [13 => "Line 1$delimiter", 24 => "Line 2$delimiter"],
+        }, $this->parseAsArray($parser, $docBlock, $delimiter));
+    }
+
+    #[DataProvider('parserWithVariantDelimitersDataProvider')]
+    public function testNonWrappedComment(CommentParserInterface $parser, string $delimiter): void
+    {
+        $docBlock = <<<'PHP'
+            Example some
+            @phpdoc test
+            any test
+            @return void Description
+            PHP;
+
+        self::assertSame(
+            expected: [0 => $this->convertLineDelimiter($docBlock, $delimiter)],
+            actual: $this->parseAsArray($parser, $docBlock, $delimiter),
+        );
+    }
+}