Merge pull request #63 from weaverryan/fix/duplicate-id-in-titles

nikophil · web-flow · commit 026d1a3336a3 · 2021-03-10T19:50:52.000+01:00
Fix/duplicate id in titles
diff --git a/.gitignore b/.gitignore
@@ -4,3 +4,4 @@
 /var/
 /docs.phar
 /.env
+/.phpunit.result.cache
diff --git a/src/Generator/HtmlForPdfGenerator.php b/src/Generator/HtmlForPdfGenerator.php
@@ -139,10 +139,10 @@ static function ($matches) use ($uid) {
         );
     }
 
-    private function cleanupContent($content)
+    private function cleanupContent(string $content): string
     {
         // remove internal anchors
-        $content = preg_replace('#<a class="headerlink"([^>]+)>¶</a>#', '', $content);
+        $content = preg_replace('#<a class="headerlink"([^>]+)>(.*)</a>#', '$2', $content);
 
         // convert links to footnote
         $content = preg_replace_callback(
diff --git a/src/Generator/JsonGenerator.php b/src/Generator/JsonGenerator.php
@@ -20,6 +20,7 @@
 use Symfony\Component\DomCrawler\Crawler;
 use Symfony\Component\Filesystem\Filesystem;
 use SymfonyDocsBuilder\BuildContext;
+use function Symfony\Component\String\u;
 
 class JsonGenerator
 {
diff --git a/src/Templates/default/html/section-begin.html.twig b/src/Templates/default/html/section-begin.html.twig
@@ -0,0 +1 @@
+<div class="section">
diff --git a/tests/IntegrationTest.php b/tests/IntegrationTest.php
@@ -95,7 +95,7 @@ public function testIntegration(string $folder)
                 str_replace(" \n", "\n", $indenter->indent($crawler->filter('body')->html())),
                 str_replace(" \n", "\n", $indenter->indent($jsonData['body']))
             );
-            $this->assertSame($crawler->filter('h1')->first()->text(), $jsonData['title'].'¶');
+            $this->assertSame($crawler->filter('h1')->first()->text(), $jsonData['title']);
         }
     }
 
diff --git a/tests/fixtures/expected/build-pdf/book.html b/tests/fixtures/expected/build-pdf/book.html
@@ -3,36 +3,27 @@
 <body>
 <div id="book-index">
     <div class="section">
-        <h1 id="book-index-book"><a class="headerlink" href="#book" title="Permalink to this headline">Book</a></h1>
+        <h1 id="book-index-book">Book</h1>
         <img src="_images/symfony-logo.png">
         <p>Here is a link to the <a href="#index" class="reference internal">main index</a></p>
         <div class="toctree-wrapper compound">
             <ul>
                 <li><a href="https://symfony.com/doc/4.0/book/first-page.html#first-page">First page</a></li>
                 <li><a href="https://symfony.com/doc/4.0/book/second-page.html#second-page">Second page</a></li>
-
             </ul>
         </div>
     </div>
 
 </div>
 <div id="book-first-page">
     <div class="section">
-        <h1 id="book-first-page-first-page">
-            <a class="headerlink" href="#first-page" title="Permalink to this headline">First page</a>
-        </h1>
-
+        <h1 id="book-first-page-first-page">First page</h1>
     </div>
-
 </div>
 <div id="book-second-page">
     <div class="section">
-        <h1 id="book-second-page-second-page">
-            <a class="headerlink" href="#second-page" title="Permalink to this headline">Second page</a>
-        </h1>
-
+        <h1 id="book-second-page-second-page">Second page</h1>
     </div>
-
 </div>
 </body>
-</html>
+</html>
diff --git a/tests/fixtures/expected/main/datetime.html b/tests/fixtures/expected/main/datetime.html
diff --git a/tests/fixtures/expected/main/form/form_type.html b/tests/fixtures/expected/main/form/form_type.html
@@ -4,8 +4,10 @@
     <meta charset="utf-8" />
 </head>
 <body>
-<div class="section" id="formtype-documentation">
-    <h1>FormType Documentation<a class="headerlink" href="#formtype-documentation" title="Permalink to this headline">¶</a></h1>
+<div class="section">
+    <h1 id="formtype-documentation">
+        <a class="headerlink" href="#formtype-documentation" title="Permalink to this headline">FormType Documentation</a>
+    </h1>
 <span id="internal-reference"></span>
 <img src="../_images/symfony-logo.png" />
 </div>
diff --git a/tests/fixtures/expected/main/index.html b/tests/fixtures/expected/main/index.html
@@ -4,8 +4,10 @@
     <meta charset="utf-8" />
 </head>
 <body>
-<div class="section" id="some-test-docs">
-    <h1>Some Test Docs!<a class="headerlink" href="#some-test-docs" title="Permalink to this headline">¶</a></h1>
+<div class="section">
+    <h1 id="some-test-docs">
+        <a class="headerlink" href="#some-test-docs" title="Permalink to this headline">Some Test Docs!</a>
+    </h1>
     <img src="_images/symfony-logo.png" />
     <div class="toctree-wrapper compound">
         <ul>
@@ -21,10 +23,12 @@ <h1>Some Test Docs!<a class="headerlink" href="#some-test-docs" title="Permalink
         </ul>
     </div>
 <span id="reference-forms-type-date-format"></span>
-<div class="section" id="a-header">
-    <h2>A header<a class="headerlink" href="#a-header" title="Permalink to this headline">¶</a></h2>
+<div class="section">
+    <h2 id="a-header">
+        <a class="headerlink" href="#a-header" title="Permalink to this headline">A header</a>
+    </h2>
     <p>Some info...</p>
 </div>
 </div>
 </body>
-</html>
+</html>
diff --git a/tests/fixtures/expected/ref-reference/index.html b/tests/fixtures/expected/ref-reference/index.html
@@ -4,7 +4,7 @@
     <meta charset="utf-8" />
 </head>
 <body>
-<div class="section" >
+<div class="section">
     <h1 id="a-test-for-reference">
         <a class="headerlink" href="#a-test-for-reference" title="Permalink to this headline">A test for reference</a>
     </h1>
diff --git a/tests/fixtures/source/main/datetime.rst b/tests/fixtures/source/main/datetime.rst
@@ -54,8 +54,7 @@ Date widget!
 
 .. note::
 
-    Sometimes we add notes. But not too often because they interrupt
-    the flow.
+    Sometimes we add notes. But not too often because they interrupt the flow.
     :ref:`internal-reference`
 
 .. include:: /_includes/date_widget.rst.inc
diff --git a/tests/fixtures/source/toctree/directory/another_file.rst b/tests/fixtures/source/toctree/directory/another_file.rst
@@ -1,2 +1,8 @@
 Another file
 ============
+
+Some text.
+
+.. _some_reference:
+
+And more text.

Original file line number	Diff line number	Diff line change
`@@ -139,10 +139,10 @@ static function ($matches) use ($uid) {`
`139`	`139`	`);`
`140`	`140`	`}`
`141`	`141`
`142`		`- private function cleanupContent($content)`
	`142`	`+ private function cleanupContent(string $content): string`
`143`	`143`	`{`
`144`	`144`	`// remove internal anchors`
`145`		`- $content = preg_replace('#<a class="headerlink"([^>]+)>¶</a>#', '', $content);`
	`145`	`+ $content = preg_replace('#<a class="headerlink"([^>]+)>(.*)</a>#', '$2', $content);`
`146`	`146`
`147`	`147`	`// convert links to footnote`
`148`	`148`	`$content = preg_replace_callback(`
Original file line number	Diff line number	Diff line change
`@@ -20,6 +20,7 @@`
`20`	`20`	`use Symfony\Component\DomCrawler\Crawler;`
`21`	`21`	`use Symfony\Component\Filesystem\Filesystem;`
`22`	`22`	`use SymfonyDocsBuilder\BuildContext;`
	`23`	`+use function Symfony\Component\String\u;`
`23`	`24`
`24`	`25`	`class JsonGenerator`
`25`	`26`	`{`
Original file line number	Diff line number	Diff line change
`@@ -95,7 +95,7 @@ public function testIntegration(string $folder)`
`95`	`95`	`str_replace(" \n", "\n", $indenter->indent($crawler->filter('body')->html())),`
`96`	`96`	`str_replace(" \n", "\n", $indenter->indent($jsonData['body']))`
`97`	`97`	`);`
`98`		`- $this->assertSame($crawler->filter('h1')->first()->text(), $jsonData['title'].'¶');`
	`98`	`+ $this->assertSame($crawler->filter('h1')->first()->text(), $jsonData['title']);`
`99`	`99`	`}`
`100`	`100`	`}`
`101`	`101`