Merge pull request #79 from weaverryan/figure-test-case

weaverryan · web-flow · commit 7cd65bf94cd5 · 2021-03-22T20:42:45.000-04:00
Adding a failing test case for bad figure behavior
diff --git a/composer.json b/composer.json
@@ -16,7 +16,7 @@
     "require": {
         "ext-json": "*",
         "ext-curl": "*",
-        "doctrine/rst-parser": "0.3.x-dev",
+        "doctrine/rst-parser": "0.4.x-dev",
         "scrivo/highlight.php": "^9.12.0",
         "symfony/filesystem": "^5.2",
         "symfony/finder": "^5.2",
diff --git a/composer.lock b/composer.lock
diff --git a/src/Directive/AbstractAdmonitionDirective.php b/src/Directive/AbstractAdmonitionDirective.php
@@ -29,6 +29,10 @@ public function __construct(string $name, string $text)
 
     final public function processSub(Parser $parser, ?Node $document, string $variable, string $data, array $options): ?Node
     {
+        if (null === $document) {
+            throw new \RuntimeException('Content expected, none found.');
+        }
+
         $wrapperDiv = $parser->renderTemplate(
             'directives/admonition.html.twig',
             [
diff --git a/tests/IntegrationTest.php b/tests/IntegrationTest.php
@@ -103,8 +103,13 @@ public function testParseUnitBlock(string $blockName)
         $expectedCrawler = new Crawler($expectedHtml);
         $indenter = $this->createIndenter();
 
+        $expected = trim($expectedCrawler->filter('body')->html());
+        // you can add notes to a test file via <!-- REMOVE the notes here -->
+        // we remove them here for comparing
+        $expected = preg_replace('/<\!\-\- REMOVE(.)+\-\->/', '', $expected);
+
         $this->assertSame(
-            $indenter->indent(trim($expectedCrawler->filter('body')->html())),
+            $indenter->indent($expected),
             $indenter->indent(trim($actualCrawler->filter('body')->html()))
         );
     }
@@ -123,6 +128,10 @@ public function parserUnitBlockProvider()
             'blockName' => 'nodes/list',
         ];
 
+        yield 'figure' => [
+            'blockName' => 'nodes/figure',
+        ];
+
         yield 'caution' => [
             'blockName' => 'directives/caution',
         ];
diff --git a/tests/fixtures/expected/blocks/nodes/figure.html b/tests/fixtures/expected/blocks/nodes/figure.html
@@ -0,0 +1,22 @@
+<!DOCTYPE html>
+<html>
+<head>
+    <meta charset="utf-8" />
+</head>
+<body>
+
+<figure>
+    <!-- REMOVE: src is empty just because the test doesn't utilize the full stack, with CopyImagesListener -->
+    <img src="" alt="Symfony Logo" width="200px" />
+</figure>
+<p>I am a paragraph AFTER the figure. I should not be included as the
+caption for the above figure.</p>
+
+<figure>
+    <img src="" />
+
+    <figcaption><p>But I am a caption <em>for</em> the figure above.</p></figcaption>
+</figure>
+
+</body>
+</html>
diff --git a/tests/fixtures/expected/toctree/index.html b/tests/fixtures/expected/toctree/index.html
@@ -12,8 +12,8 @@ <h1 id="toctree"><a class="headerlink" href="#toctree" title="Permalink to this
 <div class="toctree-wrapper"><ul class="toctree toctree-level-1 toctree-length-1"><li><a href="file.html">Title</a><ul class="toctree toctree-level-2 toctree-length-1"><li><a href="file.html#sub-title">Sub title</a></li></ul></li></ul></div>
 <div class="toctree-wrapper"><ul class="toctree toctree-level-1 toctree-length-1"><li><a href="file.html">Title</a></li></ul></div>
 <div class="toctree-wrapper"><ul class="toctree toctree-level-1 toctree-length-1"><li><a href="directory/another_file.html">Another file</a></li></ul></div>
-<div class="toctree-wrapper"><ul class="toctree toctree-level-1 toctree-length-3"><li><a href="index.html#toctree">Toctree</a></li><li><a href="directory/another_file.html">Another file</a></li><li><a href="file.html">Title</a><ul class="toctree toctree-level-2 toctree-length-1"><li><a href="file.html#sub-title">Sub title</a></li></ul></li></ul></div>
-<div class="toctree-wrapper"><ul class="toctree toctree-level-1 toctree-length-3"><li><a href="file.html">Title</a><ul class="toctree toctree-level-2 toctree-length-1"><li><a href="file.html#sub-title">Sub title</a></li></ul></li><li><a href="index.html#toctree">Toctree</a></li><li><a href="directory/another_file.html">Another file</a></li></ul></div>
+<div class="toctree-wrapper"><ul class="toctree toctree-level-1 toctree-length-2"><li><a href="directory/another_file.html">Another file</a></li><li><a href="file.html">Title</a><ul class="toctree toctree-level-2 toctree-length-1"><li><a href="file.html#sub-title">Sub title</a></li></ul></li></ul></div>
+<div class="toctree-wrapper"><ul class="toctree toctree-level-1 toctree-length-2"><li><a href="file.html">Title</a><ul class="toctree toctree-level-2 toctree-length-1"><li><a href="file.html#sub-title">Sub title</a></li></ul></li><li><a href="directory/another_file.html">Another file</a></li></ul></div>
 
 </div>
 
diff --git a/tests/fixtures/source/blocks/nodes/figure.rst b/tests/fixtures/source/blocks/nodes/figure.rst
@@ -0,0 +1,10 @@
+.. figure:: images/logo.png
+   :alt: Symfony Logo
+   :width: 200px
+
+I am a paragraph AFTER the figure. I should not be included as the
+caption for the above figure.
+
+.. figure:: images/logo.png
+
+    But I am a caption *for* the figure above.

Original file line number	Diff line number	Diff line change
`@@ -29,6 +29,10 @@ public function __construct(string $name, string $text)`
`29`	`29`
`30`	`30`	`final public function processSub(Parser $parser, ?Node $document, string $variable, string $data, array $options): ?Node`
`31`	`31`	`{`
	`32`	`+ if (null === $document) {`
	`33`	`+ throw new \RuntimeException('Content expected, none found.');`
	`34`	`+ }`
	`35`	`+`
`32`	`36`	`$wrapperDiv = $parser->renderTemplate(`
`33`	`37`	`'directives/admonition.html.twig',`
`34`	`38`	`[`