toshimaru · N7K4 · Jan 8, 2020 · Jan 8, 2020 · Jan 8, 2020 · Jan 8, 2020
diff --git a/README.md b/README.md
@@ -103,6 +103,14 @@ They are of the form:
 This is only useful when the TOC itself should be placed at some other
 location with the `toc_only` filter.
 
+## Testing
+
+To run the tests you `rake`. First install gem packages local and run `rake test`.
+
+```shell
+rake test
+```
+
 ## Generated HTML
 
 jekyll-toc generates an unordered list. The HTML output is as follows.

diff --git a/lib/table_of_contents/parser.rb b/lib/table_of_contents/parser.rb
@@ -1,9 +1,15 @@
 # frozen_string_literal: true
 
+require 'erb'
+
+# Jekyll Modul, the root of everything
 module Jekyll
+  # Module to wrap the classes for TOC creation
   module TableOfContents
     # Parse html contents and generate table of contents
     class Parser
+      include ERB::Util
+
       PUNCTUATION_REGEXP = /[^\p{Word}\- ]/u
 
       def initialize(html, options = {})
@@ -17,13 +23,24 @@ def toc
       end
 
       def build_toc
-        %(<ul class="#{@configuration.list_class}">\n#{build_toc_list(@entries)}</ul>)
+        %(<ul id="toc" class="#{@configuration.list_class}">\n#{build_toc_list(@entries)}</ul>)
       end
 
       def inject_anchors_into_html
         @entries.each do |entry|
-          entry[:header_content].add_previous_sibling(
-            %(<a class="anchor" href="##{entry[:id]}" aria-hidden="true"><span class="octicon octicon-link"></span></a>)
+          # Add id to h-element
+          entry[:header_parent].set_attribute('id', "#{entry[:id]}.to_s")
+
+          # Add link icon after text
+          entry[:header_content].add_next_sibling(
+            %(<a class="anchor" href="##{entry[:id]}" aria-hidden="true">&nbsp;&#128279;</a>)
+          )
+
+          # Add link 'nav to toc'
+          arr_to_top = [2, 3]
+          next unless arr_to_top.include?(entry[:h_num])
+          entry[:header_content].add_next_sibling(
+            %(<span style="float: right"><a class="anchor_to_top" href="#toc" aria-hidden="true">&#x21A5;</a></span>)
           )
         end
 
@@ -45,6 +62,7 @@ def parse_content
                .downcase
                .gsub(PUNCTUATION_REGEXP, '') # remove punctuation
                .tr(' ', '-') # replace spaces with dash
+          id = url_encode(id)
 
           suffix_num = headers[id]
           headers[id] += 1
@@ -53,6 +71,7 @@ def parse_content
             id: suffix_num.zero? ? id : "#{id}-#{suffix_num}",
             text: CGI.escapeHTML(text),
             node_name: node.name,
+            header_parent: node,
             header_content: node.children.first,
             h_num: node.name.delete('h').to_i
           }

diff --git a/test/parser/test_inject_anchors_filter.rb b/test/parser/test_inject_anchors_filter.rb
@@ -12,7 +12,7 @@ def setup
   def test_injects_anchors_into_content
     html = @parser.inject_anchors_into_html
 
-    assert_match(%r{<a class="anchor" href="#simple-h1" aria-hidden="true"><span.*span></a>Simple H1}, html)
+    assert_match(%r{<a class="anchor" href="#simple-h1" aria-hidden="true">.+</a>}, html)
   end
 
   def test_does_not_inject_toc

diff --git a/test/parser/test_option_error.rb b/test/parser/test_option_error.rb
@@ -5,7 +5,7 @@
 class TestOptionError < Minitest::Test
   BASE_HTML = '<h1>h1</h1>'
   EXPECTED_HTML = <<~HTML
-    <ul class="section-nav">
+    <ul id="toc" class="section-nav">
     <li class="toc-entry toc-h1"><a href="#h1">h1</a></li>
     </ul>
   HTML
@@ -30,7 +30,7 @@ def test_option_is_string
     expected = EXPECTED_HTML
     assert_equal(expected, doc.css('ul.section-nav').to_s)
   end
-
+ 
   def test_option_is_array
     parser = Jekyll::TableOfContents::Parser.new(BASE_HTML, [])
     doc = Nokogiri::HTML(parser.toc)

diff --git a/test/parser/test_toc_filter.rb b/test/parser/test_toc_filter.rb
@@ -12,7 +12,7 @@ def setup
   def test_injects_anchors
     html = @parser.toc
 
-    assert_match(%r{<a class="anchor" href="#simple-h1" aria-hidden="true"><span.*span></a>Simple H1}, html)
+    assert_match(%r{<a class="anchor" href="#simple-h1" aria-hidden="true">.+</a>}, html)
   end
 
   def test_nested_toc
@@ -31,6 +31,6 @@ def test_nested_toc
   def test_injects_toc_container
     html = @parser.toc
 
-    assert_match(/<ul class="section-nav">/, html)
+    assert_match(/<ul id=\"toc\" class="section-nav">/, html)
   end
 end
diff --git a/test/parser/test_toc_only_filter.rb b/test/parser/test_toc_only_filter.rb
@@ -12,7 +12,7 @@ def setup
   def test_injects_toc_container
     html = @parser.build_toc
 
-    assert_match(/<ul class="section-nav">/, html)
+    assert_match(/<ul id=\"toc\" class="section-nav">/, html)
   end
 
   def test_does_not_return_content

diff --git a/test/parser/test_various_toc_html.rb b/test/parser/test_various_toc_html.rb
@@ -66,7 +66,7 @@ def test_nested_toc
     parser = Jekyll::TableOfContents::Parser.new(TEST_HTML_1)
     doc = Nokogiri::HTML(parser.toc)
     expected = <<~HTML
-      <ul class="section-nav">
+      <ul id="toc" class="section-nav">
       <li class="toc-entry toc-h1">
       <a href="#h1">h1</a>
       <ul>
@@ -89,7 +89,7 @@ def test_nested_toc_with_min_and_max
     parser = Jekyll::TableOfContents::Parser.new(TEST_HTML_1, 'min_level' => 2, 'max_level' => 5)
     doc = Nokogiri::HTML(parser.toc)
     expected = <<~HTML
-      <ul class="section-nav">
+      <ul id="toc" class="section-nav">
       <li class="toc-entry toc-h3"><a href="#h3">h3</a></li>
       </ul>
     HTML
@@ -102,7 +102,7 @@ def test_complex_nested_toc
     parser = Jekyll::TableOfContents::Parser.new(TEST_HTML_2)
     doc = Nokogiri::HTML(parser.toc)
     expected = <<~HTML
-      <ul class="section-nav">
+      <ul id="toc" class="section-nav">
       <li class="toc-entry toc-h1">
       <a href="#h1">h1</a>
       <ul>
@@ -126,7 +126,7 @@ def test_decremental_headings1
     parser = Jekyll::TableOfContents::Parser.new(TEST_HTML_3)
     doc = Nokogiri::HTML(parser.toc)
     expected = <<~HTML
-      <ul class="section-nav">
+      <ul id="toc" class="section-nav">
       <li class="toc-entry toc-h6"><a href="#h6">h6</a></li>
       <li class="toc-entry toc-h5"><a href="#h5">h5</a></li>
       <li class="toc-entry toc-h4"><a href="#h4">h4</a></li>
@@ -144,7 +144,7 @@ def test_decremental_headings2
     parser = Jekyll::TableOfContents::Parser.new(TEST_HTML_4)
     doc = Nokogiri::HTML(parser.toc)
     expected = <<~HTML
-      <ul class="section-nav">
+      <ul id="toc" class="section-nav">
       <li class="toc-entry toc-h1">
       <a href="#h1">h1</a>
       <ul>
@@ -172,7 +172,7 @@ def test_no_toc
     parser = Jekyll::TableOfContents::Parser.new(NO_TOC_HTML)
     doc = Nokogiri::HTML(parser.toc)
     expected = <<~HTML
-      <ul class="section-nav">
+      <ul id="toc" class="section-nav">
       <li class="toc-entry toc-h1">
       <a href="#h1">h1</a>
       <ul>
@@ -200,7 +200,7 @@ def test_japanese_toc
     parser = Jekyll::TableOfContents::Parser.new(JAPANESE_HEADINGS_HTML)
     doc = Nokogiri::HTML(parser.toc)
     expected = <<~HTML
-      <ul class="section-nav">
+      <ul id="toc" class="section-nav">
       <li class="toc-entry toc-h1">
       <a href="#%E3%81%82">あ</a>
       <ul>
@@ -223,7 +223,7 @@ def test_angle_bracket
     parser = Jekyll::TableOfContents::Parser.new(ANGLE_BRACKET_HTML)
     doc = Nokogiri::HTML(parser.toc)
     expected = <<~HTML
-      <ul class="section-nav">
+      <ul id="toc" class="section-nav">
       <li class="toc-entry toc-h1"><a href="#h1">h1</a></li>
       <li class="toc-entry toc-h1"><a href="#base-href">&lt;base href&gt;</a></li>
       <li class="toc-entry toc-h1"><a href="#--">&amp; &lt; &gt;</a></li>
@@ -238,7 +238,7 @@ def test_tags_inside_heading
     parser = Jekyll::TableOfContents::Parser.new(TAGS_INSIDE_HEADINGS_HTML)
     doc = Nokogiri::HTML(parser.toc)
     expected = <<~HTML
-      <ul class="section-nav">
+      <ul id="toc" class="section-nav">
       <li class="toc-entry toc-h2"><a href="#h2">h2</a></li>
       <li class="toc-entry toc-h2"><a href="#h2-1">h2</a></li>
       </ul>
@@ -261,7 +261,7 @@ def test_nested_toc_with_no_toc_section_class
     parser = Jekyll::TableOfContents::Parser.new(TEST_HTML_IGNORE)
     doc = Nokogiri::HTML(parser.toc)
     expected = <<~HTML
-      <ul class="section-nav">
+      <ul id="toc" class="section-nav">
       <li class="toc-entry toc-h1">
       <a href="#h1">h1</a>
       <ul>
@@ -279,9 +279,9 @@ def test_nested_toc_with_no_toc_section_class
     assert_equal(expected, actual)
 
     html = parser.inject_anchors_into_html
-    assert_match(%r{<h1>.+</h1>}m, html)
-    assert_match(%r{<h3>.+</h3>}m, html)
-    assert_match(%r{<h6>.+</h6>}m, html)
+    assert_match(%r{<h1 id=".+">.+</h1>}m, html)
+    assert_match(%r{<h3 id=".+">.+</h3>}m, html)
+    assert_match(%r{<h6 id=".+">.+</h6>}m, html)
     assert_includes(html, '<h2>h2</h2>')
   end
 
@@ -302,7 +302,7 @@ def test_nested_toc_with_no_toc_section_class_option
     parser = Jekyll::TableOfContents::Parser.new(TEST_HTML_IGNORE_2, 'no_toc_section_class' => 'exclude')
     doc = Nokogiri::HTML(parser.toc)
     expected = <<~HTML
-      <ul class="section-nav">
+      <ul id="toc" class="section-nav">
       <li class="toc-entry toc-h1">
       <a href="#h1">h1</a>
       <ul>
@@ -320,9 +320,9 @@ def test_nested_toc_with_no_toc_section_class_option
     assert_equal(expected, actual)
 
     html = parser.inject_anchors_into_html
-    assert_match(%r{<h1>.+</h1>}m, html)
-    assert_match(%r{<h3>.+</h3>}m, html)
-    assert_match(%r{<h6>.+</h6>}m, html)
+    assert_match(%r{<h1 id=".+">.+</h1>}m, html)
+    assert_match(%r{<h3 id=".+">.+</h3>}m, html)
+    assert_match(%r{<h6 id=".+">.+</h6>}m, html)
     assert_includes(html, '<h2>h2</h2>')
     assert_includes(html, '<h4>h4</h4>')
     assert_includes(html, '<h5>h5</h5>')
@@ -345,7 +345,7 @@ def test_multiple_no_toc_section_classes
     parser = Jekyll::TableOfContents::Parser.new(TEST_HTML_IGNORE_3, 'no_toc_section_class' => ['no_toc_section', 'exclude'])
     doc = Nokogiri::HTML(parser.toc)
     expected = <<~HTML
-      <ul class="section-nav">
+      <ul id="toc" class="section-nav">
       <li class="toc-entry toc-h1">
       <a href="#h1">h1</a>
       <ul>
@@ -363,9 +363,9 @@ def test_multiple_no_toc_section_classes
     assert_equal(expected, actual)
 
     html = parser.inject_anchors_into_html
-    assert_match(%r{<h1>.+</h1>}m, html)
-    assert_match(%r{<h3>.+</h3>}m, html)
-    assert_match(%r{<h6>.+</h6>}m, html)
+    assert_match(%r{<h1 id=".+">.+</h1>}m, html)
+    assert_match(%r{<h3 id=".+">.+</h3>}m, html)
+    assert_match(%r{<h6 id=".+">.+</h6>}m, html)
     assert_includes(html, '<h2>h2</h2>')
     assert_includes(html, '<h4>h4</h4>')
     assert_includes(html, '<h5>h5</h5>')
@@ -381,7 +381,7 @@ def test_toc_with_explicit_id
     parser = Jekyll::TableOfContents::Parser.new(TEST_EXPLICIT_ID)
     doc = Nokogiri::HTML(parser.toc)
     expected = <<~HTML
-      <ul class="section-nav">
+      <ul id="toc" class="section-nav">
       <li class="toc-entry toc-h1"><a href="#h1">h1</a></li>
       <li class="toc-entry toc-h1"><a href="#second">h2</a></li>
       <li class="toc-entry toc-h1"><a href="#third">h3</a></li>
@@ -406,7 +406,7 @@ def test_anchor_is_uniq
     parser = Jekyll::TableOfContents::Parser.new(TEST_UNIQ_ID)
     doc = Nokogiri::HTML(parser.toc)
     expected = <<~HTML
-      <ul class="section-nav">
+      <ul id="toc" class="section-nav">
       <li class="toc-entry toc-h1"><a href="#h1">h1</a></li>
       <li class="toc-entry toc-h1"><a href="#h1-1">h1</a></li>
       <li class="toc-entry toc-h1"><a href="#h1-2">h1</a></li>
@@ -423,7 +423,7 @@ def test_custom_css_classes
     )
     doc = Nokogiri::HTML(parser.toc)
     expected = <<~HTML
-      <ul class="custom-list">
+      <ul id="toc" class="custom-list">
       <li class="custom-item custom-prefix-h1">
       <a href="#h1">h1</a>
       <ul class="custom-sublist">

diff --git a/test/test_jekyll-toc.rb b/test/test_jekyll-toc.rb
@@ -24,7 +24,7 @@ def test_toc
 
   def test_toc_only2
     @context = enable_toc_context
-    assert_equal "<ul class=\"section-nav\">\n</ul>", toc_only(DUMMY_HTML)
+    assert_equal "<ul id=\"toc\" class=\"section-nav\">\n</ul>", toc_only(DUMMY_HTML)
   end
 
   def test_inject_anchors2
@@ -34,7 +34,7 @@ def test_inject_anchors2
 
   def test_toc2
     @context = enable_toc_context
-    assert_equal "<ul class=\"section-nav\">\n</ul>#{DUMMY_HTML}", toc(DUMMY_HTML)
+    assert_equal "<ul id=\"toc\" class=\"section-nav\">\n</ul>#{DUMMY_HTML}", toc(DUMMY_HTML)
   end
 
   private

diff --git a/test/test_toc_tag.rb b/test/test_toc_tag.rb
@@ -17,7 +17,7 @@ def test_toc_tag
       site: @stubbed_context1.new({ 'toc' => nil })
     )
     tag = Jekyll::TocTag.parse('toc_tag', '', Tokenizer.new(''), ParseContext.new)
-    assert_equal tag.render(context), "<ul class=\"section-nav\">\n<li class=\"toc-entry toc-h1\"><a href=\"#test\">test</a></li>\n</ul>"
+    assert_equal tag.render(context), "<ul id=\"toc\" class=\"section-nav\">\n<li class=\"toc-entry toc-h1\"><a href=\"#test\">test</a></li>\n</ul>"
   end
 
   def test_toc_tag_returns_empty_string