Merge pull request #95 from nikophil/refacto/no-extend-from-lib

refacto: don't extend from parser

Author: weaverryan

src/Directive/RstClassDirective.php

@@ -2,13 +2,41 @@
 
 namespace SymfonyDocsBuilder\Directive;
 
+use Doctrine\RST\Directives\SubDirective;
 use Doctrine\RST\HTML\Directives\ClassDirective;
+use Doctrine\RST\Nodes\Node;
+use Doctrine\RST\Parser;
 
 /**
  * Allows you to add custom classes to the next directive.
  */
-class RstClassDirective extends ClassDirective
+class RstClassDirective extends SubDirective
 {
+    private $classDirective;
+
+    public function __construct(ClassDirective $classDirective)
+    {
+        $this->classDirective = $classDirective;
+    }
+
+    /**
+     * @param string[] $options
+     */
+    public function processSub(
+        Parser $parser,
+        ?Node $document,
+        string $variable,
+        string $data,
+        array $options
+    ): ?Node {
+        return $this->classDirective->processSub($parser, $document, $variable, $data, $options);
+    }
+
+    public function appliesToNonBlockContent(): bool
+    {
+        return $this->classDirective->appliesToNonBlockContent();
+    }
+
     public function getName() : string
     {
         return 'rst-class';

src/KernelFactory.php

@@ -12,6 +12,7 @@
 namespace SymfonyDocsBuilder;
 
 use Doctrine\RST\Configuration as RSTParserConfiguration;
+use Doctrine\RST\HTML\Directives\ClassDirective;
 use Doctrine\RST\Kernel;
 use SymfonyDocsBuilder\CI\UrlChecker;
 use SymfonyDocsBuilder\Directive as SymfonyDirectives;
@@ -82,7 +83,7 @@ private static function getDirectives(): array
             new SymfonyDirectives\IndexDirective(),
             new SymfonyDirectives\RoleDirective(),
             new SymfonyDirectives\NoteDirective(),
-            new SymfonyDirectives\RstClassDirective(),
+            new SymfonyDirectives\RstClassDirective(new ClassDirective()),
             new SymfonyDirectives\SeeAlsoDirective(),
             new SymfonyDirectives\SidebarDirective(),
             new SymfonyDirectives\TipDirective(),

src/Renderers/CodeNodeRenderer.php

@@ -15,7 +15,6 @@
 use Doctrine\RST\Renderers\NodeRenderer;
 use Doctrine\RST\Templates\TemplateRenderer;
 use Highlight\Highlighter;
-use function Symfony\Component\String\u;
 
 class CodeNodeRenderer implements NodeRenderer
 {

src/Renderers/SpanNodeRenderer.php

@@ -14,35 +14,34 @@
 use Doctrine\RST\Environment;
 use Doctrine\RST\HTML\Renderers\SpanNodeRenderer as BaseSpanNodeRenderer;
 use Doctrine\RST\Nodes\SpanNode;
-use Doctrine\RST\Templates\TemplateRenderer;
+use Doctrine\RST\References\ResolvedReference;
+use Doctrine\RST\Renderers\SpanNodeRenderer as AbstractSpanNodeRenderer;
 use SymfonyDocsBuilder\CI\UrlChecker;
 use function Symfony\Component\String\u;
 
-class SpanNodeRenderer extends BaseSpanNodeRenderer
+class SpanNodeRenderer extends AbstractSpanNodeRenderer
 {
-    /** @var TemplateRenderer */
-    private $templateRenderer;
+    /** @var BaseSpanNodeRenderer */
+    private $decoratedSpanNodeRenderer;
     /** @var UrlChecker|null */
     private $urlChecker;
 
     public function __construct(
         Environment $environment,
         SpanNode $span,
-        TemplateRenderer $templateRenderer,
+        BaseSpanNodeRenderer $decoratedSpanNodeRenderer,
         ?UrlChecker $urlChecker = null
     ) {
-        parent::__construct($environment, $span, $templateRenderer);
+        parent::__construct($environment, $span);
 
-        $this->templateRenderer = $templateRenderer;
+        $this->decoratedSpanNodeRenderer = $decoratedSpanNodeRenderer;
         $this->urlChecker = $urlChecker;
     }
 
-    /**
-     * @param mixed[] $attributes
-     */
+    /** @inheritDoc */
     public function link(?string $url, string $title, array $attributes = []): string
     {
-        $url = (string) $url;
+        $url = (string)$url;
 
         if (
             $this->urlChecker &&
@@ -53,18 +52,25 @@ public function link(?string $url, string $title, array $attributes = []): strin
         }
 
         if (!$this->isSafeUrl($url)) {
-            $attributes['rel'] = 'external noopener noreferrer';
-            $attributes['target'] = '_blank';
+            $attributes = $this->addAttributesForUnsafeUrl($attributes);
         }
 
-        return $this->templateRenderer->render(
-            'link.html.twig',
-            [
-                'url' => $this->environment->generateUrl($url),
-                'title' => $title,
-                'attributes' => $attributes,
-            ]
-        );
+        return $this->decoratedSpanNodeRenderer->link($url, $title, $attributes);
+    }
+
+    public function reference(ResolvedReference $reference, array $value): string
+    {
+        if (!$this->isSafeUrl($reference->getUrl())) {
+            $reference = new ResolvedReference(
+                $reference->getFile(),
+                $reference->getTitle(),
+                $reference->getUrl(),
+                $reference->getTitles(),
+                $this->addAttributesForUnsafeUrl($reference->getAttributes())
+            );
+        }
+
+        return $this->decoratedSpanNodeRenderer->reference($reference, $value);
     }
 
     public function literal(string $text): string
@@ -78,7 +84,32 @@ public function literal(string $text): string
             $text = str_replace('\\', '<wbr>\\', $text);
         }
 
-        return $this->templateRenderer->render('literal.html.twig', ['text' => $text]);
+        return $this->decoratedSpanNodeRenderer->literal($text);
+    }
+
+    public function emphasis(string $text): string
+    {
+        return $this->decoratedSpanNodeRenderer->emphasis($text);
+    }
+
+    public function strongEmphasis(string $text): string
+    {
+        return $this->decoratedSpanNodeRenderer->strongEmphasis($text);
+    }
+
+    public function nbsp(): string
+    {
+        return $this->decoratedSpanNodeRenderer->nbsp();
+    }
+
+    public function br(): string
+    {
+        return $this->decoratedSpanNodeRenderer->br();
+    }
+
+    public function escape(string $span): string
+    {
+        return $this->decoratedSpanNodeRenderer->escape($span);
     }
 
     private function isExternalUrl($url): bool
@@ -101,4 +132,12 @@ private function isSafeUrl(string $url): bool
 
         return $isSymfonyUrl || $isRelativeUrl;
     }
+
+    private function addAttributesForUnsafeUrl(array $attributes): array
+    {
+        return array_merge(
+            $attributes,
+            ['rel' => 'external noopener noreferrer', 'target' => '_blank']
+        );
+    }
 }

src/SymfonyHTMLFormat.php

@@ -18,6 +18,7 @@
 use Doctrine\RST\Renderers\NodeRendererFactory;
 use Doctrine\RST\Templates\TemplateRenderer;
 use SymfonyDocsBuilder\CI\UrlChecker;
+use Doctrine\RST\HTML\Renderers\SpanNodeRenderer as BaseSpanNodeRenderer;
 
 /**
  * Class SymfonyHTMLFormat.
@@ -67,7 +68,7 @@ function (SpanNode $node) {
                 return new Renderers\SpanNodeRenderer(
                     $node->getEnvironment(),
                     $node,
-                    $this->templateRenderer,
+                    new BaseSpanNodeRenderer($node->getEnvironment(), $node, $this->templateRenderer),
                     $this->urlChecker
                 );
             }