Merge pull request #545 from phpDocumentor/bugfix/reference-errors

[BUGFIX] Prevent false positives for named references
phpDocumentor · Aug 19, 2023 · f26fd3f · f26fd3f
2 parents fedf6a5 + 10d3529
commit f26fd3f
Show file tree

Hide file tree

Showing 2 changed files with 58 additions and 1 deletion.
diff --git a/packages/guides-restructured-text/src/RestructuredText/Parser/InlineLexer.php b/packages/guides-restructured-text/src/RestructuredText/Parser/InlineLexer.php
@@ -130,7 +130,7 @@ protected function getType(string &$value)
             return self::ANONYMOUSE_REFERENCE;
         }
 
-        if (preg_match('/[a-z0-9-]+_{1}/i', $value)) {
+        if (preg_match('/[a-z0-9-]+_{1}(?=\s|$)/i', $value)) {
             return self::NAMED_REFERENCE;
         }
 

diff --git a/packages/guides-restructured-text/tests/unit/Parser/InlineLexerTest.php b/packages/guides-restructured-text/tests/unit/Parser/InlineLexerTest.php
@@ -0,0 +1,57 @@
+<?php
+
+declare(strict_types=1);
+
+namespace phpDocumentor\Guides\RestructuredText\Parser;
+
+use PHPUnit\Framework\Attributes\DataProvider;
+use PHPUnit\Framework\TestCase;
+
+use function PHPUnit\Framework\assertEquals;
+
+class InlineLexerTest extends TestCase
+{
+    /** @param int[] $result */
+    #[DataProvider('inlineLexerProvider')]
+    public function testLexer(string $input, array $result): void
+    {
+        $lexer = new InlineLexer();
+        $lexer->setInput($input);
+        $lexer->moveNext();
+        $lexer->moveNext();
+        foreach ($result as $tokenType) {
+            assertEquals($tokenType, $lexer->token?->type);
+        }
+    }
+
+    /** @return array<string, array<string | int[]>> */
+    public static function inlineLexerProvider(): array
+    {
+        return [
+            'Backtick' => [
+                '`',
+                [InlineLexer::BACKTICK],
+            ],
+            'Normal Url' => [
+                'http://www.test.com',
+                [InlineLexer::HYPERLINK],
+            ],
+            'HTTPS Url' => [
+                'https://www.test.com',
+                [InlineLexer::HYPERLINK],
+            ],
+            'String with underscore' => [
+                'EXT:css_styled_content/static/v6.2',
+                [InlineLexer::WORD],
+            ],
+            'Named Reference' => [
+                'css_',
+                [InlineLexer::NAMED_REFERENCE],
+            ],
+            'Named Reference in sentence' => [
+                'css_ and something',
+                [InlineLexer::NAMED_REFERENCE],
+            ],
+        ];
+    }
+}