jekyll-toc 0.8.0.beta2 → 0.8.0.rc1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: b22b1a38ade3692df275b45f909d15c6c08c86a9
-  data.tar.gz: 10c79cce93cbdfe9c1f563b89357aa4b22f5e95c
+SHA256:
+  metadata.gz: ff793cf0c346ce007f527e7441cad059b4ee01d05cf5ff632c163c75031af6f7
+  data.tar.gz: 000f6cddbd70c9b906caed9182bbefca8ca2127afc9568cebd7fcb5ef636e9f1
 SHA512:
-  metadata.gz: 4cf2f7ece01ba18e9c3df914974f395e1f9133da89380e73bf5cad9d82e20b2dcdd81b6f813854cc0dead5af0f79e72924f200b8cf5fc66bc48023b56859ecb5
-  data.tar.gz: 2bf2aa4519199fd01957562b769f14fe22ff0586d5a44c61a8e33180716508b1274967ffe37766e7d1fb63ec47876b82cd1b36d2d64d7b46a69358315fd0c783
+  metadata.gz: 065f6561458207ea00a1512fc78499a77e753c807d9a8fa17b4a2a47b0c89e31eae4f8ff7f4a6a3cf69a85dcd5700dda0fd7e46d34395dd480fb390da6978cc9
+  data.tar.gz: 2e54f2d06c29eb9afcab58d5f960007e45c6955f42fdee6642ba18055dfd46016b42f7df70d9dffcbc7d763f71f969b00bc5c8342a292be2539b79145b7fb1c3

data/README.md

@@ -5,17 +5,18 @@
 [![Code Climate](https://codeclimate.com/github/toshimaru/jekyll-toc/badges/gpa.svg)](https://codeclimate.com/github/toshimaru/jekyll-toc)
 [![Test Coverage](https://api.codeclimate.com/v1/badges/cd56b207f327603662a1/test_coverage)](https://codeclimate.com/github/toshimaru/jekyll-toc/test_coverage)
 
-# Table of Contents
+## Table of Contents
 
 - [Installation](#installation)
 - [Usage](#usage)
 - [Generated HTML](#generated-html)
 - [Customization](#customization)
   - [Skip TOC](#skip-toc)
+  - [Skip TOC Section](#skip-toc-section)
   - [TOC levels](#toc-levels)
   - [CSS Styling](#css-styling)
 
-# Installation
+## Installation
 
 Add jekyll-toc plugin in your site's `Gemfile`, and run `bundle install`.
 
@@ -40,14 +41,14 @@ toc: true
 ---
 ```
 
-# Usage
+## Usage
 
 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
+### 1. Basic Usage
 
-### `toc` filter
+#### `toc` filter
 
 Add the `toc` filter to your site's `{{ content }}` (e.g. `_layouts/post.html`).
 
@@ -57,17 +58,17 @@ Add the `toc` filter to your site's `{{ content }}` (e.g. `_layouts/post.html`).
 
 This filter places the TOC directly above the content.
 
-## 2. Advanced Usage
+### 2. Advanced Usage
 
 If you'd like separated TOC and content, you can use `toc_only` and `inject_anchors` filters.
 
-### `toc_only` filter
+#### `toc_only` filter
 
 Generates the TOC itself as described [below](#generated-table-of-contents-html).
 Mostly useful in cases where the TOC should _not_ be placed immediately
 above the content but at some other place of the page, i.e. an aside.
 
-### `inject_anchors` filter
+#### `inject_anchors` filter
 
 Injects HTML anchors into the content without actually outputing the
 TOC itself. They are of the form:
@@ -81,7 +82,7 @@ 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 HTML
+### Generated HTML
 
 ![screenshot](https://user-images.githubusercontent.com/803398/28401295-0dcfb7ca-6d54-11e7-892b-2f2e6ca755a7.png)
 
@@ -109,42 +110,30 @@ jekyll-toc generates an unordered list. The HTML output is as follows.
 </ul>
 ```
 
-## Customization
+### Customization
 
-### Skip TOC
+#### Skip TOC
 
-The heding is ignored in the toc when you add `no_toc` to the class.
+The heading 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>
+<h1 class="no_toc">This heading is ignored in the toc</h1>
 <h2>h2</h2>
 ```
 
-### TOC levels
-
-The toc levels can be configured on `_config.yml`.
-
-```yml
-toc:
-  min_level: 2 # default: 1
-  max_level: 5 # default: 6
-```
-
-The default level range is `<h1>` to `<h6>`.
-
-### Ignore within
+#### Skip TOC Section
 
 It can be configured to ignore elements within a selector:
 
 ```yml
 toc:
-  ignore_within: .exclude
+  no_toc_section_class: no_toc_within # default: no_toc_section
 ```
 
 ```html
 <h1>h1</h1>
-<div class="exclude">
+<div class="no_toc_within">
   <h2>h2</h2>
   <h3>h3</h3>
 </div>
@@ -153,21 +142,33 @@ toc:
 
 Which would result in only the `<h1>` & `<h4>` within the example being included in the TOC.
 
-### CSS Styling
+#### TOC levels
+
+The toc levels can be configured on `_config.yml`.
+
+```yml
+toc:
+  min_level: 2 # default: 1
+  max_level: 5 # default: 6
+```
+
+The default level range is `<h1>` to `<h6>`.
+
+#### CSS Styling
 
 The toc can be modified with CSS. The sample CSS is the following.
 
 ```css
 .section-nav {
-  background-color: #FFF;
+  background-color: #fff;
   margin: 5px 0;
   padding: 10px 30px;
-  border: 1px solid #E8E8E8;
+  border: 1px solid #e8e8e8;
   border-radius: 3px;
 }
 ```
 
-![screen shot](https://user-images.githubusercontent.com/803398/28401455-0ba60868-6d55-11e7-8159-0ae7591aee66.png)
+![screenshot](https://user-images.githubusercontent.com/803398/28401455-0ba60868-6d55-11e7-8159-0ae7591aee66.png)
 
 Each TOC `li` entry has two CSS classes for further styling.
 The general `toc-entry` is applied to all `li` elements in the `ul.section-nav`.

data/lib/table_of_contents/parser.rb

@@ -4,9 +4,11 @@ module Jekyll
   module TableOfContents
     # Parse html contents and generate table of contents
     class Parser
+      NO_TOC_CLASS_NAME = 'no_toc'
       PUNCTUATION_REGEXP = /[^\p{Word}\- ]/u
 
       DEFAULT_CONFIG = {
+        'no_toc_section_class' => 'no_toc_section',
         'min_level' => 1,
         'max_level' => 6
       }.freeze
@@ -14,11 +16,15 @@ module Jekyll
       def initialize(html, options = {})
         @doc = Nokogiri::HTML::DocumentFragment.parse(html)
         options = generate_option_hash(options)
-        @toc_levels = options["min_level"]..options["max_level"]
-        @ignore_within = options["ignore_within"]
+        @toc_levels = options['min_level']..options['max_level']
+        @no_toc_section_class = options['no_toc_section_class']
         @entries = parse_content
       end
 
+      def toc
+        build_toc + inject_anchors_into_html
+      end
+
       def build_toc
         %(<ul class="section-nav">\n#{build_toc_list(@entries)}</ul>)
       end
@@ -31,38 +37,26 @@ module Jekyll
         @doc.inner_html
       end
 
-      def toc
-        build_toc + inject_anchors_into_html
-      end
-
       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)
 
-        if @ignore_within
-          @doc.css(@ignore_within).remove
-        end
-
-        # TODO: Use kramdown auto ids
-        @doc.css(toc_headings).reject { |n| n.classes.include?('no_toc') }.each do |node|
+        (@doc.css(toc_headings) - @doc.css(toc_headings_in_no_toc_section))
+          .reject { |n| n.classes.include?(NO_TOC_CLASS_NAME) }
+          .inject([]) do |entries, node|
           text = node.text
-          id = if node.attribute('id')
-            node.attribute('id')
-          else
-            text
-              .downcase
-              .gsub(PUNCTUATION_REGEXP, '') # remove punctuation
-              .tr(' ', '-') # replace spaces with dash
-          end
+          id = node.attribute('id') || text
+               .downcase
+               .gsub(PUNCTUATION_REGEXP, '') # remove punctuation
+               .tr(' ', '-') # replace spaces with dash
 
           uniq = headers[id] > 0 ? "-#{headers[id]}" : ''
           headers[id] += 1
           header_content = node.children.first
-          next unless header_content
+          next entries unless header_content
 
           entries << {
             id: id,
@@ -73,8 +67,6 @@ module Jekyll
             h_num: node.name.delete('h').to_i
           }
         end
-
-        entries
       end
 
       # Returns the list items for entries
@@ -117,6 +109,7 @@ module Jekyll
       def get_nest_entries(entries, min_h_num)
         entries.inject([]) do |nest_entries, entry|
           break nest_entries if entry[:h_num] == min_h_num
+
           nest_entries << entry
         end
       end
@@ -125,6 +118,10 @@ module Jekyll
         @toc_levels.map { |level| "h#{level}" }.join(',')
       end
 
+      def toc_headings_in_no_toc_section
+        @toc_levels.map { |level| ".#{@no_toc_section_class} h#{level}" }.join(',')
+      end
+
       def generate_option_hash(options)
         DEFAULT_CONFIG.merge(options)
       rescue TypeError

data/lib/version.rb

@@ -1,3 +1,3 @@
 module JekyllToc
-  VERSION = '0.8.0.beta2'.freeze
+  VERSION = '0.8.0.rc1'.freeze
 end

data/test/test_various_toc_html.rb

@@ -86,7 +86,7 @@ class TestVariousTocHtml < Minitest::Test
   end
 
   def test_nested_toc_with_min_and_max
-    parser = Jekyll::TableOfContents::Parser.new(TEST_HTML_1, { "min_level" => 2, "max_level" => 5 })
+    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">
@@ -248,7 +248,44 @@ class TestVariousTocHtml < Minitest::Test
     assert_equal(expected, actual)
   end
 
-TEST_HTML_IGNORE = <<-HTML
+  TEST_HTML_IGNORE = <<-HTML
+<h1>h1</h1>
+<div class="no_toc_section">
+<h2>h2</h2>
+</div>
+<h3>h3</h3>
+<h6>h6</h6>
+  HTML
+
+  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">
+<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
+    actual = doc.css('ul.section-nav').to_s
+    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_includes(html, '<h2>h2</h2>')
+  end
+
+  TEST_HTML_IGNORE_2 = <<-HTML
 <h1>h1</h1>
 <div class="exclude">
 <h2>h2</h2>
@@ -256,13 +293,13 @@ TEST_HTML_IGNORE = <<-HTML
 <h3>h3</h3>
 <div class="exclude">
 <h4>h4</h4>
-<h4>h5</h4>
+<h5>h5</h5>
 </div>
 <h6>h6</h6>
-HTML
+  HTML
 
-  def test_nested_toc_with_ignore_within_option
-    parser = Jekyll::TableOfContents::Parser.new(TEST_HTML_IGNORE, { "ignore_within" => '.exclude'})
+  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">
@@ -280,8 +317,15 @@ HTML
 </ul>
     HTML
     actual = doc.css('ul.section-nav').to_s
-
     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_includes(html, '<h2>h2</h2>')
+    assert_includes(html, '<h4>h4</h4>')
+    assert_includes(html, '<h5>h5</h5>')
   end
 
   TEST_EXPLICIT_ID = <<-HTML
@@ -291,7 +335,7 @@ HTML
   HTML
 
   def test_toc_with_explicit_id
-    parser = Jekyll::TableOfContents::Parser.new(TEST_EXPLICIT_ID, { "ignore_within" => '.exclude'})
+    parser = Jekyll::TableOfContents::Parser.new(TEST_EXPLICIT_ID)
     doc = Nokogiri::HTML(parser.toc)
     expected = <<-HTML
 <ul class="section-nav">
@@ -300,7 +344,12 @@ HTML
 <li class="toc-entry toc-h1"><a href="#third">h3</a></li>
 </ul>
     HTML
+    actual = doc.css('ul.section-nav').to_s
+    assert_equal(expected, actual)
 
-    assert_equal(expected, doc.css('ul.section-nav').to_s)
+    html = parser.inject_anchors_into_html
+    assert_includes(html, %(<a id="h1" class="anchor" href="#h1" aria-hidden="true">))
+    assert_includes(html, %(<a id="second" class="anchor" href="#second" aria-hidden="true">))
+    assert_includes(html, %(<a id="third" class="anchor" href="#third" aria-hidden="true">))
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: jekyll-toc
 version: !ruby/object:Gem::Version
-  version: 0.8.0.beta2
+  version: 0.8.0.rc1
 platform: ruby
 authors:
 - toshimaru
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-10-10 00:00:00.000000000 Z
+date: 2018-10-16 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: nokogiri
@@ -158,7 +158,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: 1.3.1
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.5.2.3
+rubygems_version: 2.7.6
 signing_key: 
 specification_version: 4
 summary: Jekyll Table of Contents plugin