Merge pull request #546 from phpDocumentor/bugfix/code-with_underscore

[BUGFIX] Make underscores work as first sign in a code role

Author: jaapio

Makefile

@@ -15,6 +15,10 @@ fix-code-style:
 .PHONY: static-code-analysis
 static-code-analysis: vendor phpstan psalm test-architecture ## Runs a static code analysis with phpstan/phpstan and vimeo/psalm
 
+.PHONY: phpstan-baseline
+phpstan-baseline:
+	$(PHP_BIN) -d memory_limit=1024M vendor/bin/phpstan --configuration=phpstan.neon --generate-baseline
+
 .PHONY: phpstan
 phpstan:
 	$(PHP_BIN) -d memory_limit=1024M vendor/bin/phpstan --configuration=phpstan.neon

packages/guides-restructured-text/src/RestructuredText/Parser/InlineLexer.php

@@ -21,11 +21,8 @@ final class InlineLexer extends AbstractLexer
     public const WORD = 1;
     public const UNDERSCORE = 2;
     public const ANONYMOUS_END = 3;
-    public const PHRASE_ANONYMOUS_END = 4;
     public const LITERAL = 5;
     public const BACKTICK = 6;
-    public const NAMED_REFERENCE_END = 7;
-    public const INTERNAL_REFERENCE_START = 8;
     public const EMBEDED_URL_START = 9;
     public const EMBEDED_URL_END = 10;
     public const NAMED_REFERENCE = 11;
@@ -63,14 +60,11 @@ protected function getCatchablePatterns(): array
             '[a-z0-9-]+_{2}', //Inline href.
             '[a-z0-9-]+_{1}(?=[\s\.+]|$)', //Inline href.
             '``.+?``(?!`)',
-            '`__',
-            '`_',
-            '`~',
+            '_{2}',
+            '_',
             '<',
             '>',
-            '_`',
             '`',
-            '_{2}',
             ':',
             '|',
             '\\*\\*',
@@ -160,18 +154,9 @@ protected function getType(string &$value)
             case '_':
                 return self::UNDERSCORE;
 
-            case '`_':
-                return self::NAMED_REFERENCE_END;
-
-            case '_`':
-                return self::INTERNAL_REFERENCE_START;
-
             case '__':
                 return self::ANONYMOUS_END;
 
-            case '`__':
-                return self::PHRASE_ANONYMOUS_END;
-
             case ':':
                 return self::COLON;
 

packages/guides-restructured-text/src/RestructuredText/Parser/Productions/InlineRules/AnonymousPhraseRule.php

@@ -33,7 +33,14 @@ public function apply(BlockContext $blockContext, InlineLexer $lexer): HyperLink
         $lexer->moveNext();
         while ($lexer->token !== null) {
             switch ($lexer->token->type) {
-                case InlineLexer::PHRASE_ANONYMOUS_END:
+                case InlineLexer::BACKTICK:
+                    $lexer->moveNext();
+                    if ($lexer->token?->type !== InlineLexer::ANONYMOUS_END) {
+                        $this->rollback($lexer, $initialPosition ?? 0);
+
+                        return null;
+                    }
+
                     $lexer->moveNext();
 
                     return $this->createAnonymousReference($blockContext, $text, $embeddedUrl);

packages/guides-restructured-text/src/RestructuredText/Parser/Productions/InlineRules/InternalReferenceRule.php

@@ -12,13 +12,20 @@ class InternalReferenceRule extends ReferenceRule
 {
     public function applies(InlineLexer $lexer): bool
     {
-        return $lexer->token?->type === InlineLexer::INTERNAL_REFERENCE_START;
+        return $lexer->token?->type === InlineLexer::UNDERSCORE;
     }
 
     public function apply(BlockContext $blockContext, InlineLexer $lexer): InlineNode|null
     {
         $text = '';
         $initialPosition = $lexer->token?->position;
+        $lexer->moveNext();
+        if ($lexer->token?->type !== InlineLexer::BACKTICK) {
+            $this->rollback($lexer, $initialPosition ?? 0);
+
+            return null;
+        }
+
         $lexer->moveNext();
         while ($lexer->token !== null) {
             switch ($lexer->token->type) {

packages/guides-restructured-text/src/RestructuredText/Parser/Productions/InlineRules/NamedPhraseRule.php

@@ -33,7 +33,14 @@ public function apply(BlockContext $blockContext, InlineLexer $lexer): InlineNod
         $lexer->moveNext();
         while ($lexer->token !== null) {
             switch ($lexer->token->type) {
-                case InlineLexer::NAMED_REFERENCE_END:
+                case InlineLexer::BACKTICK:
+                    $lexer->moveNext();
+                    if ($lexer->token?->type !== InlineLexer::UNDERSCORE) {
+                        $this->rollback($lexer, $initialPosition ?? 0);
+
+                        return null;
+                    }
+
                     $lexer->moveNext();
                     if ($text === '') {
                         $text = $embeddedUrl ?? '';

packages/guides-restructured-text/src/RestructuredText/Parser/Productions/InlineRules/ReferenceRule.php

@@ -40,7 +40,7 @@ protected function parseEmbeddedUrl(InlineLexer $lexer): string|null
         while ($lexer->moveNext()) {
             $token = $lexer->token;
             switch ($token->type) {
-                case InlineLexer::NAMED_REFERENCE_END:
+                case InlineLexer::BACKTICK:
                     //We did not find the expected SpanLexer::EMBEDED_URL_END
                     $this->rollback($lexer, $startPosition);
 

phpstan-baseline.neon

@@ -0,0 +1,16 @@
+parameters:
+	ignoreErrors:
+		-
+			message: "#^Using nullsafe property access on non\\-nullable type Doctrine\\\\Common\\\\Lexer\\\\Token\\<int, string\\>\\. Use \\-\\> instead\\.$#"
+			count: 1
+			path: packages/guides-restructured-text/src/RestructuredText/Parser/Productions/InlineRules/AnonymousPhraseRule.php
+
+		-
+			message: "#^Unreachable statement \\- code above always terminates\\.$#"
+			count: 1
+			path: packages/guides-restructured-text/src/RestructuredText/Parser/Productions/InlineRules/InternalReferenceRule.php
+
+		-
+			message: "#^Using nullsafe property access on non\\-nullable type Doctrine\\\\Common\\\\Lexer\\\\Token\\<int, string\\>\\. Use \\-\\> instead\\.$#"
+			count: 1
+			path: packages/guides-restructured-text/src/RestructuredText/Parser/Productions/InlineRules/NamedPhraseRule.php

phpstan.neon

@@ -1,3 +1,5 @@
+includes:
+	- phpstan-baseline.neon
 parameters:
   level: max
   inferPrivatePropertyTypeFromConstructor: true

tests/Integration/tests/code-with underscore/expected/index.html

@@ -0,0 +1,19 @@
+<!DOCTYPE html>
+<html lang="en">
+<head>
+    <title>Title</title>
+
+</head>
+<body>
+    <div class="section" id="title">
+    <h1>Title</h1>
+
+            <p>Folder <code>_assets</code> contains symlinks to <code>Resources/Public</code></p>
+            <p>Folder <code>_assets</code> contains symlinks to <code>Resources/Public</code></p>
+            <p>Folder <code>\_assets</code> contains symlinks to <code>Resources/Public</code></p>
+            <p>Folder <code>_assets</code> contains symlinks to <code>Resources/Public</code></p>
+            <p>Some <code>_.htaccess</code> and <code>_web.config</code>.</p>
+    </div>
+
+</body>
+</html>

tests/Integration/tests/code-with underscore/input/skip

@@ -8,3 +8,5 @@ Folder :code:`_assets` contains symlinks to :code:`Resources/Public`
 Folder :code:`\_assets` contains symlinks to :code:`Resources/Public`
 
 Folder ``_assets`` contains symlinks to `Resources/Public`
+
+Some `_.htaccess` and `_web.config`.