Skip to content

Commit 9e8c89f

Browse files
weaverryanweaverryan
authored
Merge pull request #80 from weaverryan/missing-line-break-anchor
[WIP] Fix missing line break with anchors
2 parents 9b9d026 + 107fe8b commit 9e8c89f

40 files changed

+87
-486
lines changed

‎src/Templates/default/html/paragraph.html.twig

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
{% set text = paragraphNode.value.render()|trim %}
2+
3+
{%- if text %}
4+
<p{% if paragraphNode.classes %} class="{{ paragraphNode.classesString }}"{% endif %}>{{ text|raw }}</p>
5+
{% endif %}

‎tests/AbstractIntegrationTest.php

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@
77
use Symfony\Component\Filesystem\Filesystem;
88
use SymfonyDocsBuilder\BuildConfig;
99

10-
class AbstractIntegrationTest extends TestCase
10+
abstract class AbstractIntegrationTest extends TestCase
1111
{
1212
protected function createBuildConfig(string $sourceDir): BuildConfig
1313
{

‎tests/IntegrationTest.php

Lines changed: 10 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -96,14 +96,16 @@ public function testParseUnitBlock(string $blockName)
9696

9797
$sourceFile = sprintf('%s/fixtures/source/blocks/%s.rst', __DIR__, $blockName);
9898

99-
$document = $parser->parseFile($sourceFile)->renderDocument();
99+
$actualHtml = $parser->parseFile($sourceFile)->renderDocument();
100+
$expectedHtml = file_get_contents(sprintf('%s/fixtures/expected/blocks/%s.html', __DIR__, $blockName));
100101

102+
$actualCrawler = new Crawler($actualHtml);
103+
$expectedCrawler = new Crawler($expectedHtml);
101104
$indenter = $this->createIndenter();
102105

103-
$expectedFile = sprintf('%s/fixtures/expected/blocks/%s.html', __DIR__, $blockName);
104106
$this->assertSame(
105-
str_replace(" \n", "\n", $indenter->indent(file_get_contents($expectedFile))),
106-
str_replace(" \n", "\n", $indenter->indent($document))
107+
$indenter->indent(trim($expectedCrawler->filter('body')->html())),
108+
$indenter->indent(trim($actualCrawler->filter('body')->html()))
107109
);
108110
}
109111

@@ -197,6 +199,10 @@ public function parserUnitBlockProvider()
197199
'blockName' => 'references/php-method',
198200
];
199201

202+
yield 'reference-and-code' => [
203+
'blockName' => 'references/reference-and-code',
204+
];
205+
200206
yield 'code-block-php' => [
201207
'blockName' => 'code-blocks/php',
202208
];

‎tests/fixtures/expected/blocks/code-blocks/bash.html

Lines changed: 1 addition & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -1,19 +1,7 @@
1-
<!DOCTYPE html>
2-
<html>
3-
<head>
4-
<meta charset="utf-8" />
5-
6-
7-
</head>
8-
9-
<body>
10-
<div translate="no" class="notranslate codeblock codeblock-loc-1 codeblock-bash">
1+
<div translate="no" class="notranslate codeblock codeblock-loc-1 codeblock-bash">
112
<div class="codeblock-scroll">
123
<pre class="codeblock-lines">1</pre>
134
<pre class="codeblock-code"><code>git <span class="hljs-built_in">clone</span> git@github.com:symfony/symfony.git
145
</code></pre>
156
</div>
167
</div>
17-
18-
</body>
19-
</html>

‎tests/fixtures/expected/blocks/code-blocks/html-php.html

Lines changed: 1 addition & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -1,13 +1,4 @@
1-
<!DOCTYPE html>
2-
<html>
3-
<head>
4-
<meta charset="utf-8" />
5-
6-
7-
</head>
8-
9-
<body>
10-
<div translate="no" class="notranslate codeblock codeblock-loc-2 codeblock-html+php codeblock-html">
1+
<div translate="no" class="notranslate codeblock codeblock-loc-2 codeblock-html+php codeblock-html">
112
<div class="codeblock-scroll">
123
<pre class="codeblock-lines">1
134
2
@@ -35,7 +26,3 @@
3526
<span class="hljs-tag">&lt;/<span class="hljs-name">html</span>&gt;</span>
3627
</code></pre>
3728
</div>
38-
</div>
39-
40-
</body>
41-
</html>

‎tests/fixtures/expected/blocks/code-blocks/html-twig.html

Lines changed: 1 addition & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -1,13 +1,4 @@
1-
<!DOCTYPE html>
2-
<html>
3-
<head>
4-
<meta charset="utf-8" />
5-
6-
7-
</head>
8-
9-
<body>
10-
<div translate="no" class="notranslate codeblock codeblock-loc-1 codeblock-html+twig codeblock-twig">
1+
<div translate="no" class="notranslate codeblock codeblock-loc-1 codeblock-html+twig codeblock-twig">
112
<div class="codeblock-scroll">
123
<pre class="codeblock-lines">1
134
2</pre>
@@ -16,6 +7,3 @@
167
</span></code></pre>
178
</div>
189
</div>
19-
20-
</body>
21-
</html>

‎tests/fixtures/expected/blocks/code-blocks/html.html

Lines changed: 1 addition & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -1,19 +1,6 @@
1-
<!DOCTYPE html>
2-
<html>
3-
<head>
4-
<meta charset="utf-8" />
5-
6-
7-
</head>
8-
9-
<body>
10-
<div translate="no" class="notranslate codeblock codeblock-loc-1 codeblock-html">
1+
<div translate="no" class="notranslate codeblock codeblock-loc-1 codeblock-html">
112
<div class="codeblock-scroll">
123
<pre class="codeblock-lines">1</pre>
134
<pre class="codeblock-code"><code><span class="hljs-comment">&lt;!-- some code --&gt;</span>
145
</code></pre>
156
</div>
16-
</div>
17-
18-
</body>
19-
</html>

‎tests/fixtures/expected/blocks/code-blocks/ini.html

Lines changed: 1 addition & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -1,19 +1,7 @@
1-
<!DOCTYPE html>
2-
<html>
3-
<head>
4-
<meta charset="utf-8" />
5-
6-
7-
</head>
8-
9-
<body>
10-
<div translate="no" class="notranslate codeblock codeblock-loc-1 codeblock-ini">
1+
<div translate="no" class="notranslate codeblock codeblock-loc-1 codeblock-ini">
112
<div class="codeblock-scroll">
123
<pre class="codeblock-lines">1</pre>
134
<pre class="codeblock-code"><code><span class="hljs-attr">fetch</span> = +refs/notes/*:refs/notes/*
145
</code></pre>
156
</div>
167
</div>
17-
18-
</body>
19-
</html>

‎tests/fixtures/expected/blocks/code-blocks/php-annotations.html

Lines changed: 1 addition & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -1,13 +1,4 @@
1-
<!DOCTYPE html>
2-
<html>
3-
<head>
4-
<meta charset="utf-8" />
5-
6-
7-
</head>
8-
9-
<body>
10-
<div translate="no" class="notranslate codeblock codeblock-loc-2 codeblock-php-annotations codeblock-php">
1+
<div translate="no" class="notranslate codeblock codeblock-loc-2 codeblock-php-annotations codeblock-php">
112
<div class="codeblock-scroll">
123
<pre class="codeblock-lines">1
134
2
@@ -40,6 +31,3 @@
4031
</code></pre>
4132
</div>
4233
</div>
43-
44-
</body>
45-
</html>

‎tests/fixtures/expected/blocks/code-blocks/php.html

Lines changed: 1 addition & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -1,13 +1,4 @@
1-
<!DOCTYPE html>
2-
<html>
3-
<head>
4-
<meta charset="utf-8" />
5-
6-
7-
</head>
8-
9-
<body>
10-
<div translate="no" class="notranslate codeblock codeblock-loc-1 codeblock-php">
1+
<div translate="no" class="notranslate codeblock codeblock-loc-1 codeblock-php">
112
<div class="codeblock-scroll">
123
<pre class="codeblock-lines">1
134
2
@@ -26,6 +17,3 @@
2617
</code></pre>
2718
</div>
2819
</div>
29-
30-
</body>
31-
</html>

‎tests/fixtures/expected/blocks/code-blocks/terminal.html

Lines changed: 3 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -1,20 +1,11 @@
1-
<!DOCTYPE html>
2-
<html>
3-
<head>
4-
<meta charset="utf-8" />
5-
6-
7-
</head>
8-
9-
<body>
10-
<div translate="no" class="notranslate codeblock codeblock-loc-1 codeblock-terminal codeblock-bash">
1+
<div translate="no" class="notranslate codeblock codeblock-loc-1 codeblock-terminal codeblock-bash">
112
<div class="codeblock-scroll">
123
<pre class="codeblock-lines">1</pre>
13-
<pre class="codeblock-code"><code>git <span class="hljs-built_in">clone</span> git@github.com:symfony/symfony.git
4+
<pre class="codeblock-code"><code>git <span
5+
class="hljs-built_in">clone</span> git@github.com:symfony/symfony.git
146
</code></pre>
157
</div>
168
</div>
17-
189
<div translate="no" class="notranslate codeblock codeblock-loc-1 codeblock-terminal codeblock-bash">
1910
<div class="codeblock-scroll">
2011
<pre class="codeblock-lines">1
@@ -43,6 +34,3 @@
4334
</pre>
4435
</div>
4536
</div>
46-
47-
</body>
48-
</html>

‎tests/fixtures/expected/blocks/code-blocks/text.html

Lines changed: 1 addition & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -1,19 +1,7 @@
1-
<!DOCTYPE html>
2-
<html>
3-
<head>
4-
<meta charset="utf-8" />
5-
6-
7-
</head>
8-
9-
<body>
10-
<div translate="no" class="notranslate codeblock codeblock-loc-1 codeblock-text">
1+
<div translate="no" class="notranslate codeblock codeblock-loc-1 codeblock-text">
112
<div class="codeblock-scroll">
123
<pre class="codeblock-lines">1</pre>
134
<pre class="codeblock-code"><code>some text
145
</code></pre>
156
</div>
167
</div>
17-
18-
</body>
19-
</html>

‎tests/fixtures/expected/blocks/code-blocks/twig.html

Lines changed: 1 addition & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -1,19 +1,7 @@
1-
<!DOCTYPE html>
2-
<html>
3-
<head>
4-
<meta charset="utf-8" />
5-
6-
7-
</head>
8-
9-
<body>
10-
<div translate="no" class="notranslate codeblock codeblock-loc-1 codeblock-twig">
1+
<div translate="no" class="notranslate codeblock codeblock-loc-1 codeblock-twig">
112
<div class="codeblock-scroll">
123
<pre class="codeblock-lines">1</pre>
134
<pre class="codeblock-code"><code><span class="hljs-comment">{# some code #}</span><span class="xml">
145
</span></code></pre>
156
</div>
167
</div>
17-
18-
</body>
19-
</html>

‎tests/fixtures/expected/blocks/code-blocks/xml.html

Lines changed: 1 addition & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -1,19 +1,7 @@
1-
<!DOCTYPE html>
2-
<html>
3-
<head>
4-
<meta charset="utf-8" />
5-
6-
7-
</head>
8-
9-
<body>
10-
<div translate="no" class="notranslate codeblock codeblock-loc-1 codeblock-xml">
1+
<div translate="no" class="notranslate codeblock codeblock-loc-1 codeblock-xml">
112
<div class="codeblock-scroll">
123
<pre class="codeblock-lines">1</pre>
134
<pre class="codeblock-code"><code><span class="hljs-comment">&lt;!-- some code --&gt;</span>
145
</code></pre>
156
</div>
167
</div>
17-
18-
</body>
19-
</html>

‎tests/fixtures/expected/blocks/code-blocks/yaml.html

Lines changed: 1 addition & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -1,19 +1,7 @@
1-
<!DOCTYPE html>
2-
<html>
3-
<head>
4-
<meta charset="utf-8" />
5-
6-
7-
</head>
8-
9-
<body>
10-
<div translate="no" class="notranslate codeblock codeblock-loc-1 codeblock-yaml">
1+
<div translate="no" class="notranslate codeblock codeblock-loc-1 codeblock-yaml">
112
<div class="codeblock-scroll">
123
<pre class="codeblock-lines">1</pre>
134
<pre class="codeblock-code"><code><span class="hljs-comment"># some code</span>
145
</code></pre>
156
</div>
167
</div>
17-
18-
</body>
19-
</html>

‎tests/fixtures/expected/blocks/directives/admonition.html

Lines changed: 1 addition & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -1,17 +1,5 @@
1-
<!DOCTYPE html>
2-
<html>
3-
<head>
4-
<meta charset="utf-8" />
5-
6-
7-
</head>
8-
9-
<body>
10-
<div class="admonition admonition-default screencast_class">
1+
<div class="admonition admonition-default screencast_class">
112
<p class="admonition-title">
123
Screencast
134
</p><p>Do you prefer video tutorials? Check out the the screencasts.</p>
145
</div>
15-
16-
</body>
17-
</html>

‎tests/fixtures/expected/blocks/directives/best-practice.html

Lines changed: 1 addition & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -1,17 +1,5 @@
1-
<!DOCTYPE html>
2-
<html>
3-
<head>
4-
<meta charset="utf-8" />
5-
6-
7-
</head>
8-
9-
<body>
10-
<div class="admonition admonition-best-practice ">
1+
<div class="admonition admonition-best-practice ">
112
<p class="admonition-title">
123
Best Practice
134
</p><p>Use the bcrypt encoder for hashing your users' passwords.</p>
145
</div>
15-
16-
</body>
17-
</html>

‎tests/fixtures/expected/blocks/directives/caution.html

Lines changed: 1 addition & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -1,18 +1,6 @@
1-
<!DOCTYPE html>
2-
<html>
3-
<head>
4-
<meta charset="utf-8" />
5-
6-
7-
</head>
8-
9-
<body>
10-
<div class="admonition admonition-caution ">
1+
<div class="admonition admonition-caution ">
112
<p class="admonition-title">
123
<svg xmlns="http://www.w3.org/2000/svg" fill="none" width="24" height="24" viewBox="0 0 24 24" stroke="currentColor"><path stroke-linecap="round" stroke-linejoin="round" stroke-width="2" d="M12 8v4m0 4h.01M21 12a9 9 0 11-18 0 9 9 0 0118 0z" /></svg>
134
Caution
145
</p><p>Using too many sidebars or caution directives can be distracting!</p>
156
</div>
16-
17-
</body>
18-
</html>

0 commit comments

Comments
 (0)