jekyll-toc 0.7.0.alpha1 → 0.7.0.beta1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 216b7cc996afe5cf11876349eecb8911442b7eb510e709606056f68854a3191a
-  data.tar.gz: f34f11a6aabc56e42d388d1407cdda508423091f899ca9104028e8843dc80e3b
+  metadata.gz: 2b7578981ba66427ed37a31d9705ad0e174d5646d31f5cd028fbe28038249a83
+  data.tar.gz: 63cfa7ca781467175dea8072975b41416fc556e2e4fa3c0f77f741ff0746c401
 SHA512:
-  metadata.gz: 20b72524b5aa6101bc15e26dc6ba483b2ab39af9e660c4d01346752546fa585daf5967e06986bcaaf4c22ee84db2560958348dbe8fdbd88e8d0e808eb87d732d
-  data.tar.gz: 58a5bc0982197f7118e249957bb465aa849dae8b42f1e6ded5f9c7425f16a49ede11814da24379cf5c88059bc27be988182de25a29e771d3296801cbcce29226
+  metadata.gz: 639bb631c1370b4c0f01f5769fa79048f883603d9582441d2c7d214e89bd2e578d6c174b72c48d5d1acaf52e496fe59332c8b6626eb4b1786c1ee6934bcce542
+  data.tar.gz: 120b7f1bafb23b34c99149d4db56418644e9918b436a9753ecf07ac5cabb19a3410eac999785277cc38bf6e3a88de2bc84efbac4e3162485250d460affcc5d92

data/README.md

@@ -103,6 +103,16 @@ It looks like the image below.
 
 ## Customization
 
+### Skip TOC(`no_toc`)
+
+The heding is ignored in the toc when you add `no_toc` to the class.
+
+```html
+<h1>h1</h1>
+<h1 class="no_toc">This heding is ignored in the toc</h1>
+<h2>h2</h2>
+```
+
 ### TOC level
 
 The toc levels can be configured on `_config.yml`.

data/lib/jekyll-toc.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'nokogiri'
 require 'table_of_contents/parser'
 
@@ -33,7 +35,7 @@ module Jekyll
     end
 
     def toc_config
-      @context.registers[:site].config["toc"] || {}
+      @context.registers[:site].config['toc'] || {}
     end
   end
 end

data/lib/table_of_contents/parser.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Jekyll
   module TableOfContents
     # Parse html contents and generate table of contents
@@ -5,14 +7,14 @@ module Jekyll
       PUNCTUATION_REGEXP = /[^\p{Word}\- ]/u
 
       DEFAULT_CONFIG = {
-        "min_level" => 1,
-        "max_level" => 6,
-      }
+        'min_level' => 1,
+        'max_level' => 6
+      }.freeze
 
       def initialize(html, options = {})
         @doc = Nokogiri::HTML::DocumentFragment.parse(html)
         options = generate_option_hash(options)
-        @toc_levels = options["min_level"]..options["max_level"]
+        @toc_levels = options['min_level']..options['max_level']
         @entries = parse_content
       end
 
@@ -41,11 +43,11 @@ module Jekyll
         headers = Hash.new(0)
 
         # TODO: Use kramdown auto ids
-        @doc.css(toc_headings).each do |node|
+        @doc.css(toc_headings).reject { |n| n.classes.include?('no_toc') }.each do |node|
           text = node.text
           id = text.downcase
           id.gsub!(PUNCTUATION_REGEXP, '') # remove punctuation
-          id.gsub!(' ', '-') # replace spaces with dash
+          id.tr!(' ', '-') # replace spaces with dash
 
           uniq = headers[id] > 0 ? "-#{headers[id]}" : ''
           headers[id] += 1
@@ -57,7 +59,6 @@ module Jekyll
             uniq: uniq,
             text: text,
             node_name: node.name,
-            no_toc: node.attribute('class') && node.attribute('class').value.include?('no_toc'),
             content_node: header_content,
             h_num: node.name.delete('h').to_i
           }
@@ -69,14 +70,12 @@ module Jekyll
       # Returns the list items for entries
       def build_toc_list(entries, last_ul_used: false)
         i = 0
-        toc_list = ''
+        toc_list = ''.dup
         min_h_num = entries.map { |e| e[:h_num] }.min
 
         while i < entries.count
           entry = entries[i]
-          if entry[:no_toc]
-            # Do nothing / skip entry
-          elsif entry[: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
             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

data/lib/version.rb

@@ -1,3 +1,3 @@
 module JekyllToc
-  VERSION = '0.7.0.alpha1'.freeze
+  VERSION = '0.7.0.beta1'.freeze
 end

data/test/test_helper.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'simplecov'
 SimpleCov.start
 
@@ -12,7 +14,6 @@ SIMPLE_HTML = <<-HTML.freeze
   <h4>Simple H4</h4>
   <h5>Simple H5</h5>
   <h6>Simple H6</h6>
-  <h1 class="no_toc">No-toc H1</h1>
 HTML
 
 module TestHelpers

data/test/test_inject_anchors_filter.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'test_helper'
 
 class TestInjectAnchorsFilter < Minitest::Test

data/test/test_kramdown_list.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'test_helper'
 
 class TestKramdownList < Minitest::Test

data/test/test_option_error.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'test_helper'
 
 class TestOptionError < Minitest::Test

data/test/test_toc_filter.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'test_helper'
 
 class TestTOCFilter < Minitest::Test

data/test/test_toc_only_filter.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'test_helper'
 
 class TestTOCOnlyFilter < Minitest::Test

data/test/test_various_toc_html.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'test_helper'
 
 class TestVariousTocHtml < Minitest::Test
@@ -31,6 +33,17 @@ class TestVariousTocHtml < Minitest::Test
 <h5>h5</h5>
   HTML
 
+  NO_TOC_HTML = <<-HTML
+<h1>h1</h1>
+<h1 class="no_toc">no_toc h1</h1>
+<h2>h2</h2>
+<h2 class="no_toc">no_toc h2</h2>
+<h3>h3</h3>
+<h3 class="no_toc">no_toc h3</h3>
+<h4>h4</h4>
+<h4 class="no_toc">no_toc h4</h4>
+  HTML
+
   def test_nested_toc
     parser = Jekyll::TableOfContents::Parser.new(TEST_HTML_1)
     doc = Nokogiri::HTML(parser.toc)
@@ -49,8 +62,9 @@ class TestVariousTocHtml < Minitest::Test
 </li>
 </ul>
     HTML
+    actual = doc.css('ul.section-nav').to_s
 
-    assert_equal(expected, doc.css('ul.section-nav').to_s)
+    assert_equal(expected, actual)
   end
 
   def test_nested_toc_with_min_and_max
@@ -61,8 +75,9 @@ class TestVariousTocHtml < Minitest::Test
 <li class="toc-entry toc-h3"><a href="#h3">h3</a></li>
 </ul>
     HTML
+    actual = doc.css('ul.section-nav').to_s
 
-    assert_equal(expected, doc.css('ul.section-nav').to_s)
+    assert_equal(expected, actual)
   end
 
   def test_complex_nested_toc
@@ -84,8 +99,9 @@ class TestVariousTocHtml < Minitest::Test
 </li>
 </ul>
     HTML
+    actual = doc.css('ul.section-nav').to_s
 
-    assert_equal(expected, doc.css('ul.section-nav').to_s)
+    assert_equal(expected, actual)
   end
 
   def test_decremental_headings1
@@ -101,11 +117,11 @@ class TestVariousTocHtml < Minitest::Test
 <li class="toc-entry toc-h1"><a href="#h1">h1</a></li>
 </ul>
     HTML
+    actual = doc.css('ul.section-nav').to_s
 
-    assert_equal(expected, doc.css('ul.section-nav').to_s)
+    assert_equal(expected, actual)
   end
 
-
   def test_decremental_headings2
     parser = Jekyll::TableOfContents::Parser.new(TEST_HTML_4)
     doc = Nokogiri::HTML(parser.toc)
@@ -133,4 +149,32 @@ class TestVariousTocHtml < Minitest::Test
 
     assert_equal(expected, doc.css('ul.section-nav').to_s)
   end
+
+  def test_no_toc
+    parser = Jekyll::TableOfContents::Parser.new(NO_TOC_HTML)
+    doc = Nokogiri::HTML(parser.toc)
+    expected = <<-HTML
+<ul class="section-nav">
+<li class="toc-entry toc-h1">
+<a href="#h1">h1</a>
+<ul>
+<li class="toc-entry toc-h2">
+<a href="#h2">h2</a>
+<ul>
+<li class="toc-entry toc-h3">
+<a href="#h3">h3</a>
+<ul>
+<li class="toc-entry toc-h4"><a href="#h4">h4</a></li>
+</ul>
+</li>
+</ul>
+</li>
+</ul>
+</li>
+</ul>
+    HTML
+    actual = doc.css('ul.section-nav').to_s
+
+    assert_equal(expected, actual)
+  end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: jekyll-toc
 version: !ruby/object:Gem::Version
-  version: 0.7.0.alpha1
+  version: 0.7.0.beta1
 platform: ruby
 authors:
 - toshimaru
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-09-20 00:00:00.000000000 Z
+date: 2018-09-29 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: nokogiri