Merge pull request #251 from alphagov/fix-single-page-nav-ul

Fix missing `<ul>` in single page navigation
alphagov · Jul 29, 2021 · f563c3e · f563c3e
2 parents 8375d93 + 4fd4a60
commit f563c3e
Show file tree

Hide file tree

Showing 2 changed files with 20 additions and 8 deletions.
diff --git a/lib/govuk_tech_docs/table_of_contents/helpers.rb b/lib/govuk_tech_docs/table_of_contents/helpers.rb
@@ -8,14 +8,11 @@ module GovukTechDocs
   module TableOfContents
     module Helpers
       def single_page_table_of_contents(html, url: "", max_level: nil)
-        headings = HeadingsBuilder.new(html, url).headings
-
-        if headings.none? { |heading| heading.size == 1 }
-          raise "No H1 tag found. You have to at least add one H1 heading to the page: " + url
-        end
+        output = "<ul>\n"
+        output += list_items_from_headings(html, url: url, max_level: max_level)
+        output += "</ul>\n"
 
-        tree = HeadingTreeBuilder.new(headings).tree
-        HeadingTreeRenderer.new(tree, max_level: max_level).html
+        output
       end
 
       def multi_page_table_of_contents(resources, current_page, config, current_page_html = nil)
@@ -28,6 +25,17 @@ def multi_page_table_of_contents(resources, current_page, config, current_page_h
         render_page_tree(resources, current_page, config, current_page_html)
       end
 
+      def list_items_from_headings(html, url: "", max_level: nil)
+        headings = HeadingsBuilder.new(html, url).headings
+
+        if headings.none? { |heading| heading.size == 1 }
+          raise "No H1 tag found. You have to at least add one H1 heading to the page: " + url
+        end
+
+        tree = HeadingTreeBuilder.new(headings).tree
+        HeadingTreeRenderer.new(tree, max_level: max_level).html
+      end
+
       def render_page_tree(resources, current_page, config, current_page_html)
         # Sort by weight frontmatter
         resources = resources
@@ -69,7 +77,7 @@ def render_page_tree(resources, current_page, config, current_page_html)
             output += "</li>\n"
           else
             output +=
-              single_page_table_of_contents(
+              list_items_from_headings(
                 content,
                 url: resource.url,
                 max_level: config[:tech_docs][:max_toc_heading_level],

diff --git a/spec/table_of_contents/helpers_spec.rb b/spec/table_of_contents/helpers_spec.rb
@@ -18,6 +18,7 @@ class Subject
       }
 
       expected_single_page_table_of_contents = %{
+<ul>
   <li>
     <a href="#fruit"><span>Fruit</span></a>
   </li>
@@ -29,6 +30,7 @@ class Subject
       </li>
     </ul>
   </li>
+</ul>
       }
 
       expect(subject.single_page_table_of_contents(html).strip).to eq(expected_single_page_table_of_contents.strip)
@@ -45,6 +47,7 @@ class Subject
       }
 
       expected_single_page_table_of_contents = %{
+<ul>
   <li>
     <a href="#fruit"><span>Fruit</span></a>
     <ul>
@@ -65,6 +68,7 @@ class Subject
   <li>
     <a href="#bread"><span>Bread</span></a>
   </li>
+</ul>
       }
 
       expect(subject.single_page_table_of_contents(html).strip).to eq(expected_single_page_table_of_contents.strip)