Extract span parser from spannode

Nodes should be value objects without any dependencies. The spannode still had a dependency.
phpDocumentor · Apr 6, 2022 · ee7f168 · ee7f168
1 parent 5327beb
commit ee7f168
Show file tree

Hide file tree

Showing 24 changed files with 154 additions and 102 deletions.
diff --git a/incubator/guides-markdown/src/Markdown/Parsers/Paragraph.php b/incubator/guides-markdown/src/Markdown/Parsers/Paragraph.php
@@ -21,7 +21,7 @@ final class Paragraph extends AbstractBlock
      */
     public function parse(MarkupLanguageParser $parser, NodeWalker $walker): Nodes\Node
     {
-        $context = new ParagraphNode(SpanNode::create($parser, ''));
+        $context = new ParagraphNode(new SpanNode('', []));
 
         while ($event = $walker->next()) {
             $node = $event->getNode();

diff --git a/.../guides-restructured-text/src/RestructuredText/Directives/AbstractAdmonitionDirective.php b/.../guides-restructured-text/src/RestructuredText/Directives/AbstractAdmonitionDirective.php
@@ -14,9 +14,9 @@
 namespace phpDocumentor\Guides\RestructuredText\Directives;
 
 use phpDocumentor\Guides\Nodes\Node;
-use phpDocumentor\Guides\Nodes\SpanNode;
 use phpDocumentor\Guides\RestructuredText\MarkupLanguageParser;
 use phpDocumentor\Guides\RestructuredText\Nodes\AdmonitionNode;
+use phpDocumentor\Guides\RestructuredText\Span\SpanParser;
 
 abstract class AbstractAdmonitionDirective extends SubDirective
 {
@@ -25,11 +25,13 @@ abstract class AbstractAdmonitionDirective extends SubDirective
 
     /** @var string */
     private $text;
+    private SpanParser $spanParser;
 
-    public function __construct(string $name, string $text)
+    public function __construct(string $name, string $text, SpanParser $spanParser)
     {
         $this->name = $name;
         $this->text = $text;
+        $this->spanParser = $spanParser;
     }
 
     final public function processSub(
@@ -42,7 +44,7 @@ final public function processSub(
         return (new AdmonitionNode(
             $this->name,
             $this->text,
-            $document ?? SpanNode::create($parser, $data)
+            $document ?? $this->spanParser->parse($data, $parser->getEnvironment())
         ))->withOptions($options);
     }
 

diff --git a/incubator/guides-restructured-text/src/RestructuredText/Directives/AdmonitionDirective.php b/incubator/guides-restructured-text/src/RestructuredText/Directives/AdmonitionDirective.php
@@ -13,10 +13,12 @@
 
 namespace phpDocumentor\Guides\RestructuredText\Directives;
 
+use phpDocumentor\Guides\RestructuredText\Span\SpanParser;
+
 class AdmonitionDirective extends AbstractAdmonitionDirective
 {
-    public function __construct()
+    public function __construct(SpanParser $spanParser)
     {
-        parent::__construct('admonition', 'Admonition');
+        parent::__construct('admonition', 'Admonition', $spanParser);
     }
 }
diff --git a/incubator/guides-restructured-text/src/RestructuredText/Directives/BestPracticeDirective.php b/incubator/guides-restructured-text/src/RestructuredText/Directives/BestPracticeDirective.php
@@ -13,10 +13,12 @@
 
 namespace phpDocumentor\Guides\RestructuredText\Directives;
 
+use phpDocumentor\Guides\RestructuredText\Span\SpanParser;
+
 class BestPracticeDirective extends AbstractAdmonitionDirective
 {
-    public function __construct()
+    public function __construct(SpanParser $spanParser)
     {
-        parent::__construct('best-practice', 'Best Practice');
+        parent::__construct('best-practice', 'Best Practice', $spanParser);
     }
 }
diff --git a/incubator/guides-restructured-text/src/RestructuredText/Directives/CautionDirective.php b/incubator/guides-restructured-text/src/RestructuredText/Directives/CautionDirective.php
@@ -13,10 +13,12 @@
 
 namespace phpDocumentor\Guides\RestructuredText\Directives;
 
+use phpDocumentor\Guides\RestructuredText\Span\SpanParser;
+
 class CautionDirective extends AbstractAdmonitionDirective
 {
-    public function __construct()
+    public function __construct(SpanParser $spanParser)
     {
-        parent::__construct('caution', 'Caution');
+        parent::__construct('caution', 'Caution', $spanParser);
     }
 }
diff --git a/incubator/guides-restructured-text/src/RestructuredText/Directives/HintDirective.php b/incubator/guides-restructured-text/src/RestructuredText/Directives/HintDirective.php
@@ -13,10 +13,12 @@
 
 namespace phpDocumentor\Guides\RestructuredText\Directives;
 
+use phpDocumentor\Guides\RestructuredText\Span\SpanParser;
+
 class HintDirective extends AbstractAdmonitionDirective
 {
-    public function __construct()
+    public function __construct(SpanParser $spanParser)
     {
-        parent::__construct('hint', 'Hint');
+        parent::__construct('hint', 'Hint', $spanParser);
     }
 }
diff --git a/incubator/guides-restructured-text/src/RestructuredText/Directives/ImportantDirective.php b/incubator/guides-restructured-text/src/RestructuredText/Directives/ImportantDirective.php
@@ -13,10 +13,12 @@
 
 namespace phpDocumentor\Guides\RestructuredText\Directives;
 
+use phpDocumentor\Guides\RestructuredText\Span\SpanParser;
+
 class ImportantDirective extends AbstractAdmonitionDirective
 {
-    public function __construct()
+    public function __construct(SpanParser $spanParser)
     {
-        parent::__construct('important', 'Important');
+        parent::__construct('important', 'Important', $spanParser);
     }
 }
diff --git a/incubator/guides-restructured-text/src/RestructuredText/Directives/NoteDirective.php b/incubator/guides-restructured-text/src/RestructuredText/Directives/NoteDirective.php
@@ -13,10 +13,12 @@
 
 namespace phpDocumentor\Guides\RestructuredText\Directives;
 
+use phpDocumentor\Guides\RestructuredText\Span\SpanParser;
+
 class NoteDirective extends AbstractAdmonitionDirective
 {
-    public function __construct()
+    public function __construct(SpanParser $spanParser)
     {
-        parent::__construct('note', 'Note');
+        parent::__construct('note', 'Note', $spanParser);
     }
 }
diff --git a/incubator/guides-restructured-text/src/RestructuredText/Directives/Replace.php b/incubator/guides-restructured-text/src/RestructuredText/Directives/Replace.php
@@ -5,8 +5,8 @@
 namespace phpDocumentor\Guides\RestructuredText\Directives;
 
 use phpDocumentor\Guides\Nodes\Node;
-use phpDocumentor\Guides\Nodes\SpanNode;
 use phpDocumentor\Guides\RestructuredText\MarkupLanguageParser;
+use phpDocumentor\Guides\RestructuredText\Span\SpanParser;
 
 /**
  * The Replace directive will set the variables for the spans
@@ -15,6 +15,13 @@
  */
 class Replace extends Directive
 {
+    private SpanParser $spanParser;
+
+    public function __construct(SpanParser $spanParser)
+    {
+        $this->spanParser = $spanParser;
+    }
+
     public function getName(): string
     {
         return 'replace';
@@ -29,6 +36,6 @@ public function processNode(
         string $data,
         array $options
     ): Node {
-        return SpanNode::create($parser, $data);
+        return $this->spanParser->parse($data, $parser->getEnvironment());
     }
 }
diff --git a/incubator/guides-restructured-text/src/RestructuredText/Directives/SeeAlsoDirective.php b/incubator/guides-restructured-text/src/RestructuredText/Directives/SeeAlsoDirective.php
@@ -13,10 +13,12 @@
 
 namespace phpDocumentor\Guides\RestructuredText\Directives;
 
+use phpDocumentor\Guides\RestructuredText\Span\SpanParser;
+
 class SeeAlsoDirective extends AbstractAdmonitionDirective
 {
-    public function __construct()
+    public function __construct(SpanParser $spanParser)
     {
-        parent::__construct('seealso', 'See also');
+        parent::__construct('seealso', 'See also', $spanParser);
     }
 }
diff --git a/incubator/guides-restructured-text/src/RestructuredText/Directives/TipDirective.php b/incubator/guides-restructured-text/src/RestructuredText/Directives/TipDirective.php
@@ -13,10 +13,12 @@
 
 namespace phpDocumentor\Guides\RestructuredText\Directives;
 
+use phpDocumentor\Guides\RestructuredText\Span\SpanParser;
+
 class TipDirective extends AbstractAdmonitionDirective
 {
-    public function __construct()
+    public function __construct(SpanParser $spanParser)
     {
-        parent::__construct('tip', 'Tip');
+        parent::__construct('tip', 'Tip', $spanParser);
     }
 }
diff --git a/incubator/guides-restructured-text/src/RestructuredText/Directives/WarningDirective.php b/incubator/guides-restructured-text/src/RestructuredText/Directives/WarningDirective.php
@@ -13,10 +13,12 @@
 
 namespace phpDocumentor\Guides\RestructuredText\Directives;
 
+use phpDocumentor\Guides\RestructuredText\Span\SpanParser;
+
 class WarningDirective extends AbstractAdmonitionDirective
 {
-    public function __construct()
+    public function __construct(SpanParser $spanParser)
     {
-        parent::__construct('warning', 'Warning');
+        parent::__construct('warning', 'Warning', $spanParser);
     }
 }
diff --git a/incubator/guides-restructured-text/src/RestructuredText/Parser/LineDataParser.php b/incubator/guides-restructured-text/src/RestructuredText/Parser/LineDataParser.php
@@ -8,8 +8,8 @@
 use phpDocumentor\Guides\Nodes\DefinitionLists\DefinitionListTerm;
 use phpDocumentor\Guides\Nodes\Links\Link;
 use phpDocumentor\Guides\Nodes\Lists\ListItem;
-use phpDocumentor\Guides\Nodes\SpanNode;
 use phpDocumentor\Guides\RestructuredText\MarkupLanguageParser;
+use phpDocumentor\Guides\RestructuredText\Span\SpanParser;
 
 use function array_map;
 use function count;
@@ -23,10 +23,12 @@ class LineDataParser
 {
     /** @var MarkupLanguageParser */
     private $parser;
+    private SpanParser $spanParser;
 
-    public function __construct(MarkupLanguageParser $parser)
+    public function __construct(MarkupLanguageParser $parser, SpanParser $spanParser)
     {
         $this->parser = $parser;
+        $this->spanParser = $spanParser;
     }
 
     public function parseLink(string $line): ?Link
@@ -167,21 +169,24 @@ public function parseDefinitionList(array $lines): DefinitionList
 
                 $classifiers = array_map(
                     function (string $classifier) {
-                        return SpanNode::create($this->parser, $classifier);
+                        return $this->spanParser->parse($classifier, $this->parser->getEnvironment());
                     },
                     array_map('trim', $parts)
                 );
 
                 $definitionListTerm = [
-                    'term' => SpanNode::create($this->parser, $term),
+                    'term' => $this->spanParser->parse($term, $this->parser->getEnvironment()),
                     'classifiers' => $classifiers,
                     'definitions' => [],
                 ];
 
                 // last line
             } elseif ($definitionListTerm !== null && trim($line) === '' && count($lines) - 1 === $key) {
                 if ($currentDefinition !== null) {
-                    $definitionListTerm['definitions'][] = SpanNode::create($this->parser, $currentDefinition);
+                    $definitionListTerm['definitions'][] = $this->spanParser->parse(
+                        $currentDefinition,
+                        $this->parser->getEnvironment()
+                    );
 
                     $currentDefinition = null;
                 }
@@ -194,7 +199,10 @@ function (string $classifier) {
 
                 // empty line, start of a new definition for the current term
             } elseif ($currentDefinition !== null && $definitionListTerm !== null && trim($line) === '') {
-                $definitionListTerm['definitions'][] = SpanNode::create($this->parser, $currentDefinition);
+                $definitionListTerm['definitions'][] = $this->spanParser->parse(
+                    $currentDefinition,
+                    $this->parser->getEnvironment()
+                );
 
                 $currentDefinition = null;
             }

diff --git a/incubator/guides-restructured-text/src/RestructuredText/Parser/Productions/DocumentRule.php b/incubator/guides-restructured-text/src/RestructuredText/Parser/Productions/DocumentRule.php
@@ -14,6 +14,7 @@
 use phpDocumentor\Guides\RestructuredText\Parser\DocumentParser;
 use phpDocumentor\Guides\RestructuredText\Parser\LineDataParser;
 use phpDocumentor\Guides\RestructuredText\Parser\LinesIterator;
+use phpDocumentor\Guides\RestructuredText\Span\SpanParser;
 
 use function array_search;
 
@@ -35,14 +36,15 @@ public function __construct(
     ) {
         $this->documentParser = $documentParser;
 
-        $lineDataParser = new LineDataParser($parser);
+        $spanParser = new SpanParser();
+        $lineDataParser = new LineDataParser($parser, $spanParser);
 
         $literalBlockRule = new LiteralBlockRule();
 
         // TODO: Somehow move this into the top of the instantiation chain so that you can configure which rules
         //       to use when consuming this library
         $this->productions = [
-            new TitleRule($parser, $documentParser),
+            new TitleRule($parser, $documentParser, $spanParser),
             new TransitionRule(), // Transition rule must follow Title rule
             new LinkRule($lineDataParser, $parser),
             $literalBlockRule,
@@ -54,7 +56,7 @@ public function __construct(
             new TableRule($parser),
 
             // For now: ParagraphRule must be last as it is the rule that applies if none other applies.
-            new ParagraphRule($parser, $documentParser),
+            new ParagraphRule($parser, $documentParser, $spanParser),
         ];
     }
 

diff --git a/incubator/guides-restructured-text/src/RestructuredText/Parser/Productions/ParagraphRule.php b/incubator/guides-restructured-text/src/RestructuredText/Parser/Productions/ParagraphRule.php
@@ -15,11 +15,11 @@
 
 use phpDocumentor\Guides\Nodes\Node;
 use phpDocumentor\Guides\Nodes\ParagraphNode;
-use phpDocumentor\Guides\Nodes\SpanNode;
 use phpDocumentor\Guides\RestructuredText\MarkupLanguageParser;
 use phpDocumentor\Guides\RestructuredText\Parser\Buffer;
 use phpDocumentor\Guides\RestructuredText\Parser\DocumentParser;
 use phpDocumentor\Guides\RestructuredText\Parser\LinesIterator;
+use phpDocumentor\Guides\RestructuredText\Span\SpanParser;
 
 use function array_pop;
 use function implode;
@@ -36,11 +36,13 @@ final class ParagraphRule implements Rule
 
     /** @var DocumentParser */
     private $documentParser;
+    private SpanParser $spanParser;
 
-    public function __construct(MarkupLanguageParser $parser, DocumentParser $documentParser)
+    public function __construct(MarkupLanguageParser $parser, DocumentParser $documentParser, SpanParser $spanParser)
     {
         $this->parser = $parser;
         $this->documentParser = $documentParser;
+        $this->spanParser = $spanParser;
     }
 
     public function applies(DocumentParser $documentParser): bool
@@ -91,7 +93,7 @@ public function apply(LinesIterator $documentIterator, ?Node $on = null): ?Node
             return null;
         }
 
-        return new ParagraphNode(SpanNode::create($this->parser, $lines));
+        return new ParagraphNode($this->spanParser->parse($lines, $this->parser->getEnvironment()));
     }
 
     private function isWhiteline(string $line): bool

diff --git a/incubator/guides-restructured-text/src/RestructuredText/Parser/Productions/TableRule.php b/incubator/guides-restructured-text/src/RestructuredText/Parser/Productions/TableRule.php
@@ -21,6 +21,7 @@
 use phpDocumentor\Guides\RestructuredText\Parser\LineDataParser;
 use phpDocumentor\Guides\RestructuredText\Parser\LinesIterator;
 use phpDocumentor\Guides\RestructuredText\Parser\TableParser;
+use phpDocumentor\Guides\RestructuredText\Span\SpanParser;
 
 use function trim;
 
@@ -41,7 +42,7 @@ final class TableRule implements Rule
     public function __construct(MarkupLanguageParser $parser)
     {
         $this->parser = $parser;
-        $this->lineChecker = new LineChecker(new LineDataParser($parser));
+        $this->lineChecker = new LineChecker(new LineDataParser($parser, new SpanParser()));
         $this->tableParser = new TableParser();
     }