jekyll-toc 0.3.0 → 0.4.0.rc

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 53c57e9121410deaeb8ae17baa0aba66d09884ff
-  data.tar.gz: 64fa560a6fb7008f52fad57889e0e5d00fbfe739
+  metadata.gz: 14addb9f45e2c59684378d0a893225af44329358
+  data.tar.gz: 61974f038bb809635bb874991aa9d962a1759a48
 SHA512:
-  metadata.gz: 13220d95cfcea4503fcbb1fee8b91395ed5b4623206f8f9a7258f0c888526484cef6a21131263526f7041a66ad826ac9165ae1c01f86b04cd6d490886f890eb8
-  data.tar.gz: d92865dc291732d1eded8cb67420488786d9b0385b2216a8e523c6a0cbac699d21cccfc1d8f395dc1f1f540ac9893c7065b5b435feaa5b52271870e9cb7b8401
+  metadata.gz: ea6df1586db53071164ffa49bd6ef5e9cec024d690aa890838c222853e83de86e817fdd4c916618d4c50604ca3f61f3c253917cb015acb51f45787254d31e8fc
+  data.tar.gz: 4c5b95c5d20a28f7bacdc1effaa717d6e9466fa555c449e7e53b80882c9bd7daf17ae715fb51b79b6abb3983e9ad4cee9075e6c2bf48bb37af12950f1ba98955

data/.travis.yml

@@ -7,6 +7,7 @@ rvm:
   - 2.4.1
 # gemfile is generated by appraisal
 gemfile:
+  - gemfiles/jekyll_3.6.gemfile
   - gemfiles/jekyll_3.5.gemfile
   - gemfiles/jekyll_3.4.gemfile
   - gemfiles/jekyll_3.3.gemfile

data/Appraisals

@@ -1,3 +1,7 @@
+appraise "jekyll-3.6" do
+  gem "jekyll", "3.6"
+end
+
 appraise "jekyll-3.5" do
   gem "jekyll", "3.5.1"
 end
@@ -21,7 +25,3 @@ end
 appraise "jekyll-3" do
   gem "jekyll", "3.0.3"
 end
-
-appraise "jekyll-2" do
-  gem "jekyll", "2.5.3"
-end

data/README.md

@@ -8,20 +8,20 @@
 
 # Installation
 
-Add jekyll-toc plugin in your site's `Gemfile`.
+Add jekyll-toc plugin in your site's `Gemfile`, and run `bundle install`.
 
 ```ruby
 gem 'jekyll-toc'
 ```
 
-And add the jekyll-toc to your site's `_config.yml`.
+Add jekyll-toc to the `gems:` section in your site's `_config.yml`.
 
 ```yml
 gems:
   - jekyll-toc
 ```
 
-Set `toc: true` in your posts.
+Set `toc: true` in posts for which you want the TOC to appear.
 
 ```yml
 ---
@@ -33,15 +33,14 @@ toc: true
 
 # Usage
 
-There are three Liquid filters available now, which all should be applied
-to some HTML content, e.g. the Liquid variable `content` available in
-Jekyll's templates.
+There are three Liquid filters, which can be applied to HTML content,
+e.g. the Liquid variable `content` available in Jekyll's templates.
 
 ## 1. Basic Usage
 
 ### `toc` filter
 
-Add `toc` filter to your site's `{{ content }}` (e.g. `_layouts/post.html`).
+Add the `toc` filter to your site's `{{ content }}` (e.g. `_layouts/post.html`).
 
 ```liquid
 {{ content | toc }}
@@ -73,9 +72,9 @@ TOC itself. 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.
 
-## Generated Table of Contents HTML
+## Generated HTML
 
-jekyll-toc generates Unordered List. The final output is as follows.
+jekyll-toc generates an unordered list. The final output is as follows.
 
 **Heads-up**: As of v0.3, nested toc has been supported. If you update jekyll-toc from 0.2 to 0.3, please check [upgrade guide](https://github.com/toshimaru/jekyll-toc/wiki/0.3-Upgrade-Guide)
 

data/gemfiles/{jekyll_2.gemfile → jekyll_3.6.gemfile}

@@ -2,6 +2,6 @@
 
 source "https://rubygems.org"
 
-gem "jekyll", "2.5.3"
+gem "jekyll", "3.6"
 
 gemspec :path => "../"

data/lib/table_of_contents/parser.rb

@@ -12,16 +12,7 @@ module Jekyll
       end
 
       def build_toc
-        toc = %(<ul class="section-nav">\n)
-
-        min_h_num = 6
-        @entries.each do |entry|
-          h_num = entry[:node_name].delete('h').to_i
-          min_h_num = [min_h_num, h_num].min
-        end
-        toc << build_lis(@entries, min_h_num)
-
-        toc << '</ul>'
+        %(<ul class="section-nav">\n#{build_toc_list(@entries)}</ul>)
       end
 
       def inject_anchors_into_html
@@ -60,7 +51,8 @@ module Jekyll
             uniq: uniq,
             text: text,
             node_name: node.name,
-            content_node: header_content
+            content_node: header_content,
+            h_num: node.name.delete('h').to_i
           }
         end
 
@@ -68,55 +60,47 @@ module Jekyll
       end
 
       # Returns the list items for entries
-      def build_lis(entries, min_h_num)
-        lis = ''
+      def build_toc_list(entries)
         i = 0
-        while i < entries.length
+        toc_list = ''
+        min_h_num = entries.map { |e| e[:h_num] }.min
+
+        while i < entries.count
           entry = entries[i]
-          curr_h_num = entry[:node_name].delete('h').to_i
-          if curr_h_num == min_h_num
+          if entry[:h_num] == min_h_num
             # If the current entry should not be indented in the list, add the entry to the list
-            lis << %(<li class="toc-entry toc-#{entry[:node_name]}"><a href="##{entry[:id]}#{entry[:uniq]}">#{entry[:text]}</a>)
+            toc_list << %(<li class="toc-entry toc-#{entry[:node_name]}"><a href="##{entry[:id]}#{entry[:uniq]}">#{entry[:text]}</a>)
             # If the next entry should be indented in the list, generate a sublist
-            if i + 1 < entries.length
+            if i + 1 < entries.count
               next_entry = entries[i + 1]
-              next_h_num = next_entry[:node_name].delete('h').to_i
-              if next_h_num > min_h_num
-                lis << %(\n)
-                lis << %(<ul>\n)
-                nest_entries = get_nest_entries(entries[i + 1, entries.length], min_h_num)
-                lis << build_lis(nest_entries, min_h_num + 1)
-                lis << %(</ul>\n)
-                i += nest_entries.length
+              if next_entry[:h_num] > min_h_num
+                nest_entries = get_nest_entries(entries[i + 1, entries.count], min_h_num)
+                toc_list << %(\n<ul>\n#{build_toc_list(nest_entries)}</ul>\n)
+                i += nest_entries.count
               end
             end
             # Add the closing tag for the current entry in the list
-            lis << %(</li>\n)
-          elsif curr_h_num > min_h_num
+            toc_list << %(</li>\n)
+          elsif entry[:h_num] > min_h_num
             # If the current entry should be indented in the list, generate a sublist
-            lis << %(<ul>\n)
-            nest_entries = get_nest_entries(entries[i, entries.length], min_h_num)
-            lis << build_lis(nest_entries, min_h_num + 1)
-            lis << %(</ul>\n)
-            i += nest_entries.length - 1
+            nest_entries = get_nest_entries(entries[i, entries.count], min_h_num)
+            toc_list << %(<ul>\n#{build_toc_list(nest_entries)}</ul>\n)
+            i += nest_entries.count - 1
           end
           i += 1
         end
-        lis
+
+        toc_list
       end
 
       # Returns the entries in a nested list
       # The nested list starts at the first entry in entries (inclusive)
       # The nested list ends at the first entry in entries with depth min_h_num or greater (exclusive)
       def get_nest_entries(entries, min_h_num)
-        nest_entries = []
-        (0..(entries.length - 1)).each do |i|
-          nest_entry = entries[i]
-          nest_h_num = nest_entry[:node_name].delete('h').to_i
-          break unless nest_h_num > min_h_num
-          nest_entries.push(nest_entry)
+        entries.inject([]) do |nest_entries, entry|
+          break nest_entries if entry[:h_num] == min_h_num
+          nest_entries << entry
         end
-        nest_entries
       end
     end
   end

data/lib/version.rb

@@ -1,3 +1,3 @@
 module JekyllToc
-  VERSION = '0.3.0'.freeze
+  VERSION = '0.4.0.rc'.freeze
 end

data/test/test_helper.rb

@@ -5,18 +5,17 @@ require 'minitest/autorun'
 require 'jekyll'
 require 'jekyll-toc'
 
-SIMPLE_HTML = <<-HTML
-<h1>Simple H1</h1>
-<h2>Simple H2</h2>
-<h3>Simple H3</h3>
-<h4>Simple H4</h4>
-<h5>Simple H5</h5>
-<h6>Simple H6</h6>
+SIMPLE_HTML = <<-HTML.freeze
+  <h1>Simple H1</h1>
+  <h2>Simple H2</h2>
+  <h3>Simple H3</h3>
+  <h4>Simple H4</h4>
+  <h5>Simple H5</h5>
+  <h6>Simple H6</h6>
 HTML
 
 module TestHelpers
   def read_html_and_create_parser
     @parser = Jekyll::TableOfContents::Parser.new(SIMPLE_HTML)
-    assert_match(/Simple H1/, @parser.doc.inner_html)
   end
 end

data/test/test_various_toc_html.rb

@@ -0,0 +1,96 @@
+require 'test_helper'
+
+class TestVariousTocHtml < Minitest::Test
+  TEST_HTML_1 = <<-HTML
+<h1>h1</h1>
+<h3>h3</h3>
+<h6>h6</h6>
+  HTML
+
+  TEST_HTML_2 = <<-HTML
+<h1>h1</h1>
+<h3>h3</h3>
+<h2>h2</h2>
+<h6>h6</h6>
+  HTML
+
+  TEST_HTML_3 = <<-HTML
+<h6>h6</h6>
+<h5>h5</h5>
+<h4>h4</h4>
+<h3>h3</h3>
+<h2>h2</h2>
+<h1>h1</h1>
+  HTML
+
+  def test_nested_toc
+    @parser = Jekyll::TableOfContents::Parser.new(TEST_HTML_1)
+    doc = Nokogiri::HTML(@parser.toc)
+    assert_equal(doc.css('ul.section-nav').to_s, <<-HTML
+<ul class="section-nav">
+<li class="toc-entry toc-h1">
+<a href="#h1">h1</a>
+<ul>
+<li class="toc-entry toc-h3">
+<a href="#h3">h3</a>
+<ul>
+<li class="toc-entry toc-h6"><a href="#h6">h6</a></li>
+</ul>
+</li>
+</ul>
+</li>
+</ul>
+    HTML
+    )
+  end
+
+  def test_complex_nested_toc
+    @parser = Jekyll::TableOfContents::Parser.new(TEST_HTML_2)
+    doc = Nokogiri::HTML(@parser.toc)
+    assert_equal(doc.css('ul.section-nav').to_s, <<-HTML
+<ul class="section-nav">
+<li class="toc-entry toc-h1">
+<a href="#h1">h1</a>
+<ul>
+<ul>
+<li class="toc-entry toc-h3"><a href="#h3">h3</a></li>
+</ul>
+<li class="toc-entry toc-h2">
+<a href="#h2">h2</a>
+<ul>
+<li class="toc-entry toc-h6"><a href="#h6">h6</a></li>
+</ul>
+</li>
+</ul>
+</li>
+</ul>
+    HTML
+    )
+  end
+
+  def test_decremental_headings
+    @parser = Jekyll::TableOfContents::Parser.new(TEST_HTML_3)
+    doc = Nokogiri::HTML(@parser.toc)
+    assert_equal(doc.css('ul.section-nav').to_s, <<-HTML
+<ul class="section-nav">
+<ul>
+<ul>
+<ul>
+<ul>
+<ul>
+<li class="toc-entry toc-h6"><a href="#h6">h6</a></li>
+</ul>
+<li class="toc-entry toc-h5"><a href="#h5">h5</a></li>
+</ul>
+<li class="toc-entry toc-h4"><a href="#h4">h4</a></li>
+</ul>
+<li class="toc-entry toc-h3"><a href="#h3">h3</a></li>
+</ul>
+<li class="toc-entry toc-h2"><a href="#h2">h2</a></li>
+</ul>
+<li class="toc-entry toc-h1"><a href="#h1">h1</a></li>
+</ul>
+    HTML
+    )
+  end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: jekyll-toc
 version: !ruby/object:Gem::Version
-  version: 0.3.0
+  version: 0.4.0.rc
 platform: ruby
 authors:
 - toshimaru
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-07-20 00:00:00.000000000 Z
+date: 2017-10-03 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: nokogiri
@@ -123,12 +123,12 @@ files:
 - LICENSE.md
 - README.md
 - Rakefile
-- gemfiles/jekyll_2.gemfile
 - gemfiles/jekyll_3.1.gemfile
 - gemfiles/jekyll_3.2.gemfile
 - gemfiles/jekyll_3.3.gemfile
 - gemfiles/jekyll_3.4.gemfile
 - gemfiles/jekyll_3.5.gemfile
+- gemfiles/jekyll_3.6.gemfile
 - gemfiles/jekyll_3.gemfile
 - jekyll-toc.gemspec
 - lib/jekyll-toc.rb
@@ -138,6 +138,7 @@ files:
 - test/test_inject_anchors_filter.rb
 - test/test_toc_filter.rb
 - test/test_toc_only_filter.rb
+- test/test_various_toc_html.rb
 homepage: https://github.com/toshimaru/jekyll-toc
 licenses:
 - MIT
@@ -156,12 +157,12 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: 2.1.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ">="
+  - - ">"
     - !ruby/object:Gem::Version
-      version: '0'
+      version: 1.3.1
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.5.2
+rubygems_version: 2.6.13
 signing_key: 
 specification_version: 4
 summary: Jekyll Table of Contents plugin
@@ -170,3 +171,4 @@ test_files:
 - test/test_inject_anchors_filter.rb
 - test/test_toc_filter.rb
 - test/test_toc_only_filter.rb
+- test/test_various_toc_html.rb