Overriding FigureDirective to fix lack of support for figclass

Author: weaverryan

src/Directive/FigureDirective.php

@@ -10,29 +10,50 @@
 namespace SymfonyDocsBuilder\Directive;
 
 use Doctrine\RST\Directives\SubDirective;
-use Doctrine\RST\Nodes\FigureNode;
 use Doctrine\RST\Nodes\Node;
 use Doctrine\RST\Parser;
 
+/**
+ * Overridden to handle "figclass" properly.
+ */
 class FigureDirective extends SubDirective
 {
     public function getName(): string
     {
         return 'figure';
     }
 
-    final public function processSub(Parser $parser, ?Node $document, string $variable, string $data, array $options): ?Node
-    {
-        $wrapperDiv = $parser->renderTemplate(
-            'directives/figure.html.twig',
-            [
-                'custom_css_classes' => $options['class'] ?? '',
-                'alt' => $options['alt'] ?? '',
-                'height' => $options['height'] ?? null,
-                'width' => $options['width'] ?? null,
-            ]
+    /**
+     * @param string[] $options
+     */
+    public function processSub(
+        Parser $parser,
+        ?Node $document,
+        string $variable,
+        string $data,
+        array $options
+    ): ?Node {
+        $environment = $parser->getEnvironment();
+
+        $url = $environment->relativeUrl($data);
+
+        if ($url === null) {
+            throw new \Exception(sprintf('Could not get relative url for %s', $data));
+        }
+
+        $nodeFactory = $parser->getNodeFactory();
+
+        $figClass = $options['figclass'] ?? null;
+        unset($options['figclass']);
+
+        $figureNode = $parser->getNodeFactory()->createFigureNode(
+            $nodeFactory->createImageNode($url, $options),
+            $document
         );
+        if ($figClass) {
+            $figureNode->setClasses(explode(' ', $figClass));
+        }
 
-        return $parser->getNodeFactory()->createWrapperNode($document, $wrapperDiv, '</div>');
+        return $figureNode;
     }
 }

src/Templates/default/html/directives/figure.html.twig

@@ -0,0 +1,17 @@
+{% apply spaceless %}
+<figure
+    {% if figureNode.classes is not empty %}
+    class="{{ figureNode.classes ? figureNode.classesString : '' }}"
+    {% endif %}
+>
+    {{ figureNode.image.render()|raw }}
+
+    {% if figureNode.document %}
+        {% set caption = figureNode.document.render()|trim %}
+
+        {% if caption %}
+            <figcaption>{{ caption|raw }}</figcaption>
+        {% endif %}
+    {% endif %}
+</figure>
+{% endapply %}

src/Templates/default/html/figure.html.twig

@@ -17,8 +17,7 @@
 </div>
 
 <p>And RST figures use a different syntax to define their custom CSS classes:</p>
-<div class="with-browser foo">
-    <figure>
-        <img src="" alt="/" align="center" figclass="with-browser foo">
-    </figure>
-</div>
+
+<figure class="with-browser foo">
+    <img src="" alt="/" align="center">
+</figure>