jekyll-toc 0.4.0 → 0.5.0.rc

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 4ee3560e2836d7f495f8fe64f4c69edaf6e49c20
-  data.tar.gz: cd52bc52d78d47eb963c8e6f9161e0398f478ca7
+  metadata.gz: 0353251fa1c46baa96730df912c764c123c9f2bd
+  data.tar.gz: 855171e677a52e8547d066589206328623b6fffd
 SHA512:
-  metadata.gz: bebc90760a20a6d048930811d15e5fb8c9f0913a6dcc15493a898671ea904e7a3cc604f837b9c8308b6f584f8f9d9db443565fad1adf27ca7e3e76dbd0f91193
-  data.tar.gz: 56db9b9ef09e981f8eb91c7e2587ca7756492dd3500238726e3174078253da5159b88c6f54aa6f356a43f7cf88cbe8d14e9ce749087c4f39f5a05d574912c743
+  metadata.gz: b527d0826b5b28d783514d10e4323bcfa2f99b1b9e1595fb1124e59bc11e5cc97f250ca31d673c99d9e82bd0bb539c3f3e47ab07e997ff8ea36283513f6b4072
+  data.tar.gz: 978a80e1a914ad9141449dc4bb5c51dbe377b09cf8732be42c8a576e8c5c08ecdd6f718e12fd8e6323b395e12c469767e0d1db41eb7cfe41f227c63b90e60af2

data/lib/jekyll-toc.rb

@@ -2,31 +2,41 @@ require 'nokogiri'
 require 'table_of_contents/parser'
 
 module Jekyll
+  class TocTag < Liquid::Tag
+    def render(context)
+      return unless context.registers[:page]['toc'] == true
+      content_html = context.registers[:page].content
+      ::Jekyll::TableOfContents::Parser.new(content_html).build_toc
+    end
+  end
+
   module TableOfContentsFilter
     def toc_only(html)
-      return html unless page['toc']
-
-      ::Jekyll::TableOfContents::Parser.new(html).build_toc
+      return html unless toc_enabled?
+      ::Jekyll::TableOfContents::Parser.new(html, toc_config).build_toc
     end
 
     def inject_anchors(html)
-      return html unless page['toc']
-
-      ::Jekyll::TableOfContents::Parser.new(html).inject_anchors_into_html
+      return html unless toc_enabled?
+      ::Jekyll::TableOfContents::Parser.new(html, toc_config).inject_anchors_into_html
     end
 
     def toc(html)
-      return html unless page['toc']
-
-      ::Jekyll::TableOfContents::Parser.new(html).toc
+      return html unless toc_enabled?
+      ::Jekyll::TableOfContents::Parser.new(html, toc_config).toc
     end
 
     private
 
-    def page
-      @context.registers[:page]
+    def toc_enabled?
+      @context.registers[:page]['toc'] == true
+    end
+
+    def toc_config
+      @context.registers[:site].config["toc"]
     end
   end
 end
 
 Liquid::Template.register_filter(Jekyll::TableOfContentsFilter)
+# Liquid::Template.register_tag('toc', Jekyll::TocTag) # will be enabled at v1.0

data/lib/table_of_contents/parser.rb

@@ -4,8 +4,15 @@ module Jekyll
     class Parser
       PUNCTUATION_REGEXP = /[^\p{Word}\- ]/u
 
-      def initialize(html)
+      DEFAULT_CONFIG = {
+        "min_level" => 1,
+        "max_level" => 6,
+      }
+
+      def initialize(html, options = {})
         @doc = Nokogiri::HTML::DocumentFragment.parse(html)
+        options = DEFAULT_CONFIG.merge(options)
+        @toc_levels = options["min_level"]..options["max_level"]
         @entries = parse_content
       end
 
@@ -33,7 +40,8 @@ module Jekyll
         entries = []
         headers = Hash.new(0)
 
-        @doc.css('h1, h2, h3, h4, h5, h6').each do |node|
+        # TODO: Use kramdown auto ids
+        @doc.css(toc_headings).each do |node|
           text = node.text
           id = text.downcase
           id.gsub!(PUNCTUATION_REGEXP, '') # remove punctuation
@@ -104,6 +112,10 @@ module Jekyll
           nest_entries << entry
         end
       end
+
+      def toc_headings
+        @toc_levels.map { |level| "h#{level}" }.join(",")
+      end
     end
   end
 end

data/lib/version.rb

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

data/test/test_kramdown_list.rb

@@ -1,6 +1,23 @@
 require 'test_helper'
 
 class TestKramdownList < Minitest::Test
+  # NOTE: kramdown automatically injects `id` attribute
+  # TODO: test Japanese heading
+  def test_kramdown_heading
+    text = <<-MARKDOWN
+# h1
+
+## h2
+    MARKDOWN
+    expected = <<-HTML
+<h1 id="h1">h1</h1>
+
+<h2 id=\"h2\">h2</h2>
+    HTML
+
+    assert_equal(expected, Kramdown::Document.new(text).to_html)
+  end
+
   def test_kramdown_list_1
     text = <<-MARKDOWN
 * level-1
@@ -72,12 +89,15 @@ class TestKramdownList < Minitest::Test
 * level-1
     MARKDOWN
     expected = <<-HTML
+<pre><code>  * level-4
+* level-3   * level-2 * level-1
+</code></pre>
     HTML
 
     assert_equal(expected, Kramdown::Document.new(text).to_html)
   end
 
-  def test_kramdown_list_3
+  def test_kramdown_list_4
     text = <<-MARKDOWN
 * level-1
       * level-4
@@ -101,7 +121,7 @@ class TestKramdownList < Minitest::Test
     assert_equal(expected, Kramdown::Document.new(text).to_html)
   end
 
-    def test_kramdown_list_3
+    def test_kramdown_list_5
       text = <<-MARKDOWN
 * level-1
     * level-3

data/test/test_various_toc_html.rb

@@ -53,6 +53,18 @@ class TestVariousTocHtml < Minitest::Test
     assert_equal(expected, doc.css('ul.section-nav').to_s)
   end
 
+  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">
+<li class="toc-entry toc-h3"><a href="#h3">h3</a></li>
+</ul>
+    HTML
+
+    assert_equal(expected, doc.css('ul.section-nav').to_s)
+  end
+
   def test_complex_nested_toc
     parser = Jekyll::TableOfContents::Parser.new(TEST_HTML_2)
     doc = Nokogiri::HTML(parser.toc)
@@ -76,7 +88,7 @@ class TestVariousTocHtml < Minitest::Test
     assert_equal(expected, doc.css('ul.section-nav').to_s)
   end
 
-  def test_decremental_headings
+  def test_decremental_headings1
     parser = Jekyll::TableOfContents::Parser.new(TEST_HTML_3)
     doc = Nokogiri::HTML(parser.toc)
     expected = <<-HTML
@@ -94,7 +106,7 @@ class TestVariousTocHtml < Minitest::Test
   end
 
 
-  def test_decremental_headings
+  def test_decremental_headings2
     parser = Jekyll::TableOfContents::Parser.new(TEST_HTML_4)
     doc = Nokogiri::HTML(parser.toc)
     expected = <<-HTML

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: jekyll-toc
 version: !ruby/object:Gem::Version
-  version: 0.4.0
+  version: 0.5.0.rc
 platform: ruby
 authors:
 - toshimaru
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-10-21 00:00:00.000000000 Z
+date: 2017-11-25 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: nokogiri
@@ -154,12 +154,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.6.13
+rubygems_version: 2.6.11
 signing_key: 
 specification_version: 4
 summary: Jekyll Table of Contents plugin