jekyll-toc 0.2.1 → 0.3.0.pre1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 491e3fec762e5cd84506a21a98e0a19c4e2018b5
-  data.tar.gz: ff448ad90aada2e391cbcae847f65d7c28306e9d
+  metadata.gz: bd7a5a0373a967ef42103de10288c8da0db20f0b
+  data.tar.gz: 84427b7348a6db378b8bc27b1b938797f2b6f84f
 SHA512:
-  metadata.gz: 92b25158017d448d0dc8db8ee76b030946f3fc19e4d5e807951fca33daef99d8a693a11d056355755e3ef5edca326c5274275a98e193974efbaad62205c221a4
-  data.tar.gz: 972a128dd4054041d1b6bcd6ffe2f6990a5eced0b6f3176861d99b06e8df030a4089cb7e4567b1a9b2478a98182e8433f25f743f2740a8a66df4a46dc29d0fc3
+  metadata.gz: d4d5644477eebaca659eed0cfcced2d07e4771a26f02d4ed2056c90dc2ff3d51314464671b9504ac35346f67bb238794fd6eb87f30599a1cdf7912b8d12114e8
+  data.tar.gz: f68deeb9b77fb14381924694ca12da5003f85b95bd9e4f3debe43d03b9925e95506d75f58107fbb09f559f07142758203a7c8b5b5d26145bcd954235abdd19f6

data/.travis.yml

@@ -5,8 +5,9 @@ rvm:
   - 2.2
   - 2.3.1
   - 2.4.0
-# Put this in your .travis.yml
+# gemfile is generated by appraisal
 gemfile:
+  - gemfiles/jekyll_3.4.gemfile
   - gemfiles/jekyll_3.3.gemfile
   - gemfiles/jekyll_3.2.gemfile
   - gemfiles/jekyll_3.1.gemfile

data/README.md

@@ -37,19 +37,19 @@ 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.
 
-## Basic Usage
+## 1. Basic Usage
 
 ### `toc` filter
 
 Add `toc` filter to your site's `{{ content }}` (e.g. `_layouts/post.html`).
 
-```
+```liquid
 {{ content | toc }}
 ```
 
 This filter places the TOC directly above the content.
 
-## Advanced Usage
+## 2. Advanced Usage
 
 If you'd like separated TOC and content, you can use `toc_only` and `inject_anchors` filters.
 

data/lib/table_of_contents/parser.rb

@@ -1,7 +1,8 @@
 module Jekyll
   module TableOfContents
+    # Parse html contents and generate table of contents
     class Parser
-      PUNCTUATION_REGEXP = RUBY_VERSION > '1.9' ? /[^\p{Word}\- ]/u : /[^\w\- ]/
+      PUNCTUATION_REGEXP = /[^\p{Word}\- ]/u
 
       attr_reader :doc
 
@@ -11,18 +12,21 @@ module Jekyll
       end
 
       def build_toc
-        toc = %Q{<ul class="section-nav">\n}
+        toc = %(<ul class="section-nav">\n)
 
+        min_h_num = 6
         @entries.each do |entry|
-          toc << %Q{<li class="toc-entry toc-#{entry[:node_name]}"><a href="##{entry[:id]}#{entry[:uniq]}">#{entry[:text]}</a></li>\n}
+          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>'
       end
 
       def inject_anchors_into_html
         @entries.each do |entry|
-          entry[:content_node].add_previous_sibling(%Q{<a id="#{entry[:id]}#{entry[:uniq]}" class="anchor" href="##{entry[:id]}#{entry[:uniq]}" aria-hidden="true"><span class="octicon octicon-link"></span></a>})
+          entry[:content_node].add_previous_sibling(%(<a id="#{entry[:id]}#{entry[:uniq]}" class="anchor" href="##{entry[:id]}#{entry[:uniq]}" aria-hidden="true"><span class="octicon octicon-link"></span></a>))
         end
 
         @doc.inner_html
@@ -32,10 +36,10 @@ module Jekyll
         build_toc + inject_anchors_into_html
       end
 
-      # parse logic is from html-pipeline toc_filter
-      # https://github.com/jch/html-pipeline/blob/v1.1.0/lib/html/pipeline/toc_filter.rb
       private
 
+      # parse logic is from html-pipeline toc_filter
+      # https://github.com/jch/html-pipeline/blob/v1.1.0/lib/html/pipeline/toc_filter.rb
       def parse_content
         entries = []
         headers = Hash.new(0)
@@ -46,21 +50,74 @@ module Jekyll
           id.gsub!(PUNCTUATION_REGEXP, '') # remove punctuation
           id.gsub!(' ', '-') # replace spaces with dash
 
-          uniq = (headers[id] > 0) ? "-#{headers[id]}" : ''
+          uniq = headers[id] > 0 ? "-#{headers[id]}" : ''
           headers[id] += 1
-          if header_content = node.children.first
-            entries << {
-                id: id,
-                uniq: uniq,
-                text: text,
-                node_name: node.name,
-                content_node: header_content
-            }
-          end
+          header_content = node.children.first
+          next unless header_content
+
+          entries << {
+            id: id,
+            uniq: uniq,
+            text: text,
+            node_name: node.name,
+            content_node: header_content
+          }
         end
 
         entries
       end
+
+      # Returns the list items for entries
+      def build_lis(entries, min_h_num)
+        lis = ''
+        i = 0
+        while i < entries.length
+          entry = entries[i]
+          curr_h_num = entry[:node_name].delete('h').to_i
+          if curr_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>)
+            # If the next entry should be indented in the list, generate a sublist
+            if i + 1 < entries.length
+              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
+              end
+            end
+            # Add the closing tag for the current entry in the list
+            lis << %(</li>\n)
+          elsif curr_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
+          end
+          i += 1
+        end
+        lis
+      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)
+        end
+        nest_entries
+      end
     end
   end
 end

data/lib/version.rb

@@ -1,3 +1,3 @@
 module JekyllToc
-  VERSION = '0.2.1'
+  VERSION = '0.3.0.pre1'
 end

data/test/test_helper.rb

@@ -4,14 +4,14 @@ SimpleCov.start
 require 'jekyll'
 require 'minitest/autorun'
 
-SIMPLE_HTML = <<EOL
+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>
-EOL
+HTML
 
 module TestHelpers
   def read_html_and_create_parser

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: jekyll-toc
 version: !ruby/object:Gem::Version
-  version: 0.2.1
+  version: 0.3.0.pre1
 platform: ruby
 authors:
 - Toshimaru
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-03-28 00:00:00.000000000 Z
+date: 2017-04-11 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: nokogiri
@@ -138,9 +138,9 @@ 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