-

Author: javiereguiluz

src/Generator/JsonGenerator.php

@@ -111,9 +111,9 @@ private function generateToc(MetaEntry $metaEntry, Crawler $crawler): array
 
             // this tocTree stores items sequentially (h2, h2, h3, h3, h2, h3, etc.)
             $flatTocTree[] = [
-                'level' => 'h2' === $heading->tagName ? 2 : 3,
+                'level' => 'h2' === $heading->tagName ? 1 : 2,
                 'url' => sprintf('%s#%s', $metaEntry->getUrl(), $headerId),
-                'page' => u($metaEntry->getUrl())->beforeLast('.html'),
+                'page' => u($metaEntry->getUrl())->beforeLast('.html')->toString(),
                 'fragment' => $headerId,
                 'title' => $heading->textContent,
                 'children' => [],
@@ -123,7 +123,7 @@ private function generateToc(MetaEntry $metaEntry, Crawler $crawler): array
         // this tocTree stores items nested by level (h2, h2[h3, h3], h2[h3], etc.)
         $nestedTocTree = [];
         foreach ($flatTocTree as $tocItem) {
-            if (2 === $tocItem['level']) {
+            if (1 === $tocItem['level']) {
                 $nestedTocTree[] = $tocItem;
             } else {
                 $nestedTocTree[\count($nestedTocTree) - 1]['children'][] = $tocItem;

tests/JsonIntegrationTest.php

@@ -10,9 +10,19 @@
 namespace SymfonyDocsBuilder\Tests;
 
 use SymfonyDocsBuilder\DocBuilder;
+use SymfonyDocsBuilder\Renderers\TitleNodeRenderer;
 
 class JsonIntegrationTest extends AbstractIntegrationTest
 {
+    public function setUp(): void
+    {
+        $reflection = new \ReflectionClass(TitleNodeRenderer::class);
+        $property = $reflection->getProperty('idUsagesCountByFilename');
+        $property->setAccessible(true);
+
+        $property->setValue([]);
+    }
+
     /**
      * @dataProvider getJsonTests
      */
@@ -26,7 +36,7 @@ public function testJsonGeneration(string $filename, array $expectedData)
         $actualFileData = $fJsons[$filename];
         foreach ($expectedData as $key => $expectedKeyData) {
             $this->assertArrayHasKey($key, $actualFileData, sprintf('Missing key "%s" in file "%s"', $key, $filename));
-            $this->assertSame($expectedData[$key], $actualFileData[$key], sprintf('Invalid data for key "%s" in file "%s"', $key, $filename));
+            $this->assertSame($expectedKeyData, $actualFileData[$key], sprintf('Invalid data for key "%s" in file "%s"', $key, $filename));
         }
     }
 
@@ -76,9 +86,53 @@ public function getJsonTests()
                 'title' => 'Design',
                 'toc_options' => [
                     'maxDepth' => 2,
-                    'numVisibleItems' => 3,
+                    'numVisibleItems' => 5,
                     'size' => 'md'
                 ],
+                'toc' => [
+                    [
+                        'level' => 1,
+                        'url' => 'design.html#section-1',
+                        'page' => 'design',
+                        'fragment' => 'section-1',
+                        'title' => 'Section 1',
+                        'children' => [
+                            [
+                                'level' => 2,
+                                'url' => 'design.html#some-subsection',
+                                'page' => 'design',
+                                'fragment' => 'some-subsection',
+                                'title' => 'Some subsection',
+                                'children' => [],
+                            ],
+                            [
+                                'level' => 2,
+                                'url' => 'design.html#some-subsection-1',
+                                'page' => 'design',
+                                'fragment' => 'some-subsection-1',
+                                'title' => 'Some subsection',
+                                'children' => [],
+                            ],
+                        ],
+                    ],
+                    [
+                        'level' => 1,
+                        'url' => 'design.html#section-2',
+                        'page' => 'design',
+                        'fragment' => 'section-2',
+                        'title' => 'Section 2',
+                        'children' => [
+                            [
+                                'level' => 2,
+                                'url' => 'design.html#some-subsection-2',
+                                'page' => 'design',
+                                'fragment' => 'some-subsection-2',
+                                'title' => 'Some subsection',
+                                'children' => [],
+                            ],
+                        ],
+                    ],
+                ],
             ],
         ];
 

tests/fixtures/source/json/design.rst

@@ -11,18 +11,30 @@ The toctree below should affects the next/prev. The
 first entry is effectively ignored, as it was already
 included by the toctree in index.rst (which is parsed first).
 
-Subsection 1
-~~~~~~~~~~~~
+Some subsection
+~~~~~~~~~~~~~~~
 
 This is a subsection of the first section. That's all.
 
+Some subsection
+~~~~~~~~~~~~~~~
+
+This sub-section uses the same title as before to test that the tool
+never generated two or more headings with the same ID.
+
 Section 2
 ---------
 
 However, crud (which is ALSO included in the toctree in index.rst),
 WILL be read here, as the "crud" in index.rst has not been read
 yet (design comes first). Also, design/sub-page WILL be considered.
 
+Some subsection
+~~~~~~~~~~~~~~~
+
+This sub-section also uses the same title as in the previous section
+to test that the tool never generated two or more headings with the same ID.
+
 .. toctree::
     :maxdepth: 1