[FEATURE] Make DocumentParserContext Available in Text Roles

linawolf · linawolf · commit bde5c01e2ce9 · 2023-08-12T09:25:54.000Z
TextRoles might also need the DocumentParserContext
diff --git a/packages/guides-restructured-text/src/RestructuredText/Parser/Productions/InlineRules/TextRoleRule.php b/packages/guides-restructured-text/src/RestructuredText/Parser/Productions/InlineRules/TextRoleRule.php
@@ -58,7 +58,7 @@ public function apply(DocumentParserContext $documentParserContext, InlineLexer
                         $fullRole = ($domain ? $domain . ':' : '') . $role;
                         $lexer->moveNext();
 
-                        return $textRole->processNode($documentParserContext->getContext(), $fullRole, $part, $rawPart);
+                        return $textRole->processNode($documentParserContext, $fullRole, $part, $rawPart);
                     }
 
                     $inText = true;
diff --git a/packages/guides-restructured-text/src/RestructuredText/TextRoles/AbbreviationTextRole.php b/packages/guides-restructured-text/src/RestructuredText/TextRoles/AbbreviationTextRole.php
@@ -6,7 +6,7 @@
 
 use phpDocumentor\Guides\Nodes\Inline\AbbreviationInlineNode;
 use phpDocumentor\Guides\Nodes\Inline\InlineNode;
-use phpDocumentor\Guides\ParserContext;
+use phpDocumentor\Guides\RestructuredText\Parser\DocumentParserContext;
 use Psr\Log\LoggerInterface;
 
 use function preg_match;
@@ -34,7 +34,7 @@ public function getAliases(): array
 
     /** @return AbbreviationInlineNode */
     public function processNode(
-        ParserContext $parserContext,
+        DocumentParserContext $documentParserContext,
         string $role,
         string $content,
         string $rawContent,
@@ -45,7 +45,7 @@ public function processNode(
 
         $this->logger->warning(
             'Abbreviation has no definition. Usage: :abbreviation:`term (some term definition)`',
-            $parserContext->getLoggerInformation(),
+            $documentParserContext->getContext()->getLoggerInformation(),
         );
 
         return new AbbreviationInlineNode($content, '');
diff --git a/packages/guides-restructured-text/src/RestructuredText/TextRoles/AbstractReferenceTextRole.php b/packages/guides-restructured-text/src/RestructuredText/TextRoles/AbstractReferenceTextRole.php
@@ -5,7 +5,7 @@
 namespace phpDocumentor\Guides\RestructuredText\TextRoles;
 
 use phpDocumentor\Guides\Nodes\Inline\AbstractLinkInlineNode;
-use phpDocumentor\Guides\ParserContext;
+use phpDocumentor\Guides\RestructuredText\Parser\DocumentParserContext;
 use phpDocumentor\Guides\RestructuredText\Parser\InlineLexer;
 use Psr\Log\LoggerInterface;
 
@@ -25,7 +25,7 @@ public function __construct(
     }
 
     public function processNode(
-        ParserContext $parserContext,
+        DocumentParserContext $documentParserContext,
         string $role,
         string $content,
         string $rawContent,
@@ -58,7 +58,7 @@ public function processNode(
                                 'Reference contains unexpected content after closing `>`: "%s"',
                                 $content,
                             ),
-                            $parserContext->getLoggerInformation(),
+                            $documentParserContext->getContext()->getLoggerInformation(),
                         );
                     }
 
diff --git a/packages/guides-restructured-text/src/RestructuredText/TextRoles/GenericTextRole.php b/packages/guides-restructured-text/src/RestructuredText/TextRoles/GenericTextRole.php
@@ -5,7 +5,7 @@
 namespace phpDocumentor\Guides\RestructuredText\TextRoles;
 
 use phpDocumentor\Guides\Nodes\Inline\GenericTextRoleInlineNode;
-use phpDocumentor\Guides\ParserContext;
+use phpDocumentor\Guides\RestructuredText\Parser\DocumentParserContext;
 
 class GenericTextRole implements TextRole
 {
@@ -23,7 +23,7 @@ public function getAliases(): array
     }
 
     public function processNode(
-        ParserContext $parserContext,
+        DocumentParserContext $documentParserContext,
         string $role,
         string $content,
         string $rawContent,
diff --git a/packages/guides-restructured-text/src/RestructuredText/TextRoles/LiteralTextRole.php b/packages/guides-restructured-text/src/RestructuredText/TextRoles/LiteralTextRole.php
@@ -5,7 +5,7 @@
 namespace phpDocumentor\Guides\RestructuredText\TextRoles;
 
 use phpDocumentor\Guides\Nodes\Inline\GenericTextRoleInlineNode;
-use phpDocumentor\Guides\ParserContext;
+use phpDocumentor\Guides\RestructuredText\Parser\DocumentParserContext;
 
 class LiteralTextRole implements TextRole
 {
@@ -23,7 +23,7 @@ public function getAliases(): array
     }
 
     public function processNode(
-        ParserContext $parserContext,
+        DocumentParserContext $documentParserContext,
         string $role,
         string $content,
         string $rawContent,
diff --git a/packages/guides-restructured-text/src/RestructuredText/TextRoles/MathTextRole.php b/packages/guides-restructured-text/src/RestructuredText/TextRoles/MathTextRole.php
@@ -5,7 +5,7 @@
 namespace phpDocumentor\Guides\RestructuredText\TextRoles;
 
 use phpDocumentor\Guides\Nodes\Inline\GenericTextRoleInlineNode;
-use phpDocumentor\Guides\ParserContext;
+use phpDocumentor\Guides\RestructuredText\Parser\DocumentParserContext;
 
 class MathTextRole implements TextRole
 {
@@ -23,7 +23,7 @@ public function getAliases(): array
     }
 
     public function processNode(
-        ParserContext $parserContext,
+        DocumentParserContext $documentParserContext,
         string $role,
         string $content,
         string $rawContent,
diff --git a/packages/guides-restructured-text/src/RestructuredText/TextRoles/TextRole.php b/packages/guides-restructured-text/src/RestructuredText/TextRoles/TextRole.php
@@ -5,7 +5,7 @@
 namespace phpDocumentor\Guides\RestructuredText\TextRoles;
 
 use phpDocumentor\Guides\Nodes\Inline\InlineNode;
-use phpDocumentor\Guides\ParserContext;
+use phpDocumentor\Guides\RestructuredText\Parser\DocumentParserContext;
 
 interface TextRole
 {
@@ -19,7 +19,7 @@ public function getAliases(): array;
      * @param string $rawContent the raw content, including backslash escapes
      */
     public function processNode(
-        ParserContext $parserContext,
+        DocumentParserContext $documentParserContext,
         string $role,
         string $content,
         string $rawContent,
diff --git a/packages/guides-restructured-text/tests/unit/Parser/Productions/InlineRules/TextRoleRuleTest.php b/packages/guides-restructured-text/tests/unit/Parser/Productions/InlineRules/TextRoleRuleTest.php
@@ -6,7 +6,6 @@
 
 use Generator;
 use phpDocumentor\Guides\Nodes\Inline\InlineNode;
-use phpDocumentor\Guides\ParserContext;
 use phpDocumentor\Guides\RestructuredText\Parser\DocumentParserContext;
 use phpDocumentor\Guides\RestructuredText\Parser\InlineLexer;
 use phpDocumentor\Guides\RestructuredText\Parser\Productions\InlineRules\TextRoleRule;
@@ -65,7 +64,7 @@ public function getAliases(): array
                 return [];
             }
 
-            public function processNode(ParserContext $parserContext, string $role, string $content, string $rawContent): InlineNode
+            public function processNode(DocumentParserContext $documentParserContext, string $role, string $content, string $rawContent): InlineNode
             {
                 return new class ($role, $content, $rawContent) extends InlineNode {
                     public function __construct(
diff --git a/packages/guides-restructured-text/tests/unit/TextRoles/DocReferenceTextRoleTest.php b/packages/guides-restructured-text/tests/unit/TextRoles/DocReferenceTextRoleTest.php
@@ -6,7 +6,7 @@
 
 use Monolog\Logger;
 use phpDocumentor\Guides\Nodes\Inline\DocReferenceNode;
-use phpDocumentor\Guides\ParserContext;
+use phpDocumentor\Guides\RestructuredText\Parser\DocumentParserContext;
 use PHPUnit\Framework\Attributes\DataProvider;
 use PHPUnit\Framework\MockObject\MockObject;
 use PHPUnit\Framework\TestCase;
@@ -15,12 +15,12 @@ class DocReferenceTextRoleTest extends TestCase
 {
     private Logger $logger;
     private DocReferenceTextRole $docReferenceTextRole;
-    private ParserContext&MockObject $parserContext;
+    private DocumentParserContext&MockObject $documentParserContext;
 
     public function setUp(): void
     {
         $this->logger = new Logger('test');
-        $this->parserContext = $this->createMock(ParserContext::class);
+        $this->documentParserContext = $this->createMock(DocumentParserContext::class);
         $this->docReferenceTextRole = new DocReferenceTextRole($this->logger);
     }
 
@@ -30,7 +30,7 @@ public function testDocReferenceIsParsedIntoDocReferenceNode(
         string $url,
         string|null $text = null,
     ): void {
-        $result = $this->docReferenceTextRole->processNode($this->parserContext, 'doc', $span, $span);
+        $result = $this->docReferenceTextRole->processNode($this->documentParserContext, 'doc', $span, $span);
 
         self::assertInstanceOf(DocReferenceNode::class, $result);
         self::assertEquals($url, $result->getTargetReference(), 'DocumentLinks are different');
diff --git a/packages/guides-restructured-text/tests/unit/TextRoles/ReferenceTextRoleTest.php b/packages/guides-restructured-text/tests/unit/TextRoles/ReferenceTextRoleTest.php
@@ -6,7 +6,7 @@
 
 use Monolog\Logger;
 use phpDocumentor\Guides\Nodes\Inline\ReferenceNode;
-use phpDocumentor\Guides\ParserContext;
+use phpDocumentor\Guides\RestructuredText\Parser\DocumentParserContext;
 use PHPUnit\Framework\Attributes\DataProvider;
 use PHPUnit\Framework\MockObject\MockObject;
 use PHPUnit\Framework\TestCase;
@@ -15,12 +15,12 @@ class ReferenceTextRoleTest extends TestCase
 {
     private Logger $logger;
     private ReferenceTextRole $referenceTextRole;
-    private ParserContext&MockObject $parserContext;
+    private DocumentParserContext&MockObject $documentParserContext;
 
     public function setUp(): void
     {
         $this->logger = new Logger('test');
-        $this->parserContext = $this->createMock(ParserContext::class);
+        $this->documentParserContext = $this->createMock(DocumentParserContext::class);
         $this->referenceTextRole = new ReferenceTextRole($this->logger);
     }
 
@@ -30,7 +30,7 @@ public function testReferenceIsParsedIntoRefReferenceNode(
         string $url,
         string|null $text = null,
     ): void {
-        $result = $this->referenceTextRole->processNode($this->parserContext, 'doc', $span, $span);
+        $result = $this->referenceTextRole->processNode($this->documentParserContext, 'doc', $span, $span);
 
         self::assertInstanceOf(ReferenceNode::class, $result);
         self::assertEquals($url, $result->getTargetReference(), 'ReferenceNames are different');

Original file line number	Diff line number	Diff line change
`@@ -58,7 +58,7 @@ public function apply(DocumentParserContext $documentParserContext, InlineLexer`
`58`	`58`	`$fullRole = ($domain ? $domain . ':' : '') . $role;`
`59`	`59`	`$lexer->moveNext();`
`60`	`60`
`61`		`- return $textRole->processNode($documentParserContext->getContext(), $fullRole, $part, $rawPart);`
	`61`	`+ return $textRole->processNode($documentParserContext, $fullRole, $part, $rawPart);`
`62`	`62`	`}`
`63`	`63`
`64`	`64`	`$inText = true;`
Original file line number	Diff line number	Diff line change
`@@ -5,7 +5,7 @@`
`5`	`5`	`namespace phpDocumentor\Guides\RestructuredText\TextRoles;`
`6`	`6`
`7`	`7`	`use phpDocumentor\Guides\Nodes\Inline\GenericTextRoleInlineNode;`
`8`		`-use phpDocumentor\Guides\ParserContext;`
	`8`	`+use phpDocumentor\Guides\RestructuredText\Parser\DocumentParserContext;`
`9`	`9`
`10`	`10`	`class GenericTextRole implements TextRole`
`11`	`11`	`{`
`@@ -23,7 +23,7 @@ public function getAliases(): array`
`23`	`23`	`}`
`24`	`24`
`25`	`25`	`public function processNode(`
`26`		`- ParserContext $parserContext,`
	`26`	`+ DocumentParserContext $documentParserContext,`
`27`	`27`	`string $role,`
`28`	`28`	`string $content,`
`29`	`29`	`string $rawContent,`
Original file line number	Diff line number	Diff line change
`@@ -6,7 +6,6 @@`
`6`	`6`
`7`	`7`	`use Generator;`
`8`	`8`	`use phpDocumentor\Guides\Nodes\Inline\InlineNode;`
`9`		`-use phpDocumentor\Guides\ParserContext;`
`10`	`9`	`use phpDocumentor\Guides\RestructuredText\Parser\DocumentParserContext;`
`11`	`10`	`use phpDocumentor\Guides\RestructuredText\Parser\InlineLexer;`
`12`	`11`	`use phpDocumentor\Guides\RestructuredText\Parser\Productions\InlineRules\TextRoleRule;`
`@@ -65,7 +64,7 @@ public function getAliases(): array`
`65`	`64`	`return [];`
`66`	`65`	`}`
`67`	`66`
`68`		`- public function processNode(ParserContext $parserContext, string $role, string $content, string $rawContent): InlineNode`
	`67`	`+ public function processNode(DocumentParserContext $documentParserContext, string $role, string $content, string $rawContent): InlineNode`
`69`	`68`	`{`
`70`	`69`	`return new class ($role, $content, $rawContent) extends InlineNode {`
`71`	`70`	`public function __construct(`