jekyll-toc 0.11.0 → 0.12.0.rc1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: afa3ea6b7c656558ab8ac87171d113867f0c720a5917d4a057b7754c0f2b1516
-  data.tar.gz: 5309a5224a0e925d3993024736821e29d2605fc74c003e9e412ab0af9a26c869
+  metadata.gz: be220b1646e71d971f92efb0d26f1dc8774a503d8607d8762b54f9402e1606fa
+  data.tar.gz: 79701301568dc4bedf7a7658ccc7dd618b16018e7befecea758f7298044187ed
 SHA512:
-  metadata.gz: 0a51b5ea083c92d3cf6842f4d4ab5ec41c8da3425ec8f64c1938933f2e43514eaebd9731a59742bac191990e47318bd72104b92cf8611a97d3858d21c390db74
-  data.tar.gz: 34b863397e58393a41d567a412a84676ac125fa5ad3465a509114ad0b965f3d440ef3a730f81d96313b6f76beb3c8529a610702ca667489fa012fd4dfd76125d
+  metadata.gz: 5248660f0d76d3afbee5d9e4316f63896a44766326c73ad7feeff23ca977bd147722a457ee21b2022048cc6cc1b93837048f48de5518bce71bfc71cf6e647308
+  data.tar.gz: a6e2f104e4334909dbe70fdbca80123b644965f3c2599c55a09575461f5f9e769a5274ae3627b78cde91203daa9f65c98168d868322f2335386f5d0aacafc77c

data/.rubocop.yml

@@ -20,4 +20,3 @@ Metrics/ClassLength:
 
 Style/FileName:
   Enabled: false
-

data/README.md

@@ -12,6 +12,7 @@
   - [1. Basic Usage](#1-basic-usage)
   - [2. Advanced Usage](#2-advanced-usage)
 - [Generated HTML](#generated-html)
+- [Default Configuration](#default-configuration)
 - [Customization](#customization)
   - [Skip TOC](#skip-toc)
   - [Skip TOC Section](#skip-toc-section)
@@ -112,6 +113,19 @@ jekyll-toc generates an unordered list. The HTML output is as follows.
 
 ![screenshot](https://user-images.githubusercontent.com/803398/28401295-0dcfb7ca-6d54-11e7-892b-2f2e6ca755a7.png)s
 
+## Default Configuration 
+
+```yml
+toc:
+  min_level: 1
+  max_level: 6
+  no_toc_section_class: no_toc_section
+  list_class: section-nav
+  sublist_class: ''
+  item_class: toc-entry
+  item_prefix: toc-
+```
+
 ## Customization
 
 ### Skip TOC

data/lib/jekyll-toc.rb

@@ -1,6 +1,7 @@
 # frozen_string_literal: true
 
 require 'nokogiri'
+require 'table_of_contents/configuration'
 require 'table_of_contents/parser'
 
 module Jekyll

data/lib/table_of_contents/configuration.rb

@@ -0,0 +1,39 @@
+# frozen_string_literal: true
+
+module Jekyll
+  module TableOfContents
+    # jekyll-toc configuration class
+    class Configuration
+      attr_accessor :toc_levels, :no_toc_section_class, :list_class, :sublist_class, :item_class, :item_prefix
+
+      DEFAULT_CONFIG = {
+        'min_level' => 1,
+        'max_level' => 6,
+        'no_toc_section_class' => 'no_toc_section',
+        'list_class' => 'section-nav',
+        'sublist_class' => '',
+        'item_class' => 'toc-entry',
+        'item_prefix' => 'toc-'
+      }.freeze
+
+      def initialize(options)
+        options = generate_option_hash(options)
+
+        @toc_levels = options['min_level']..options['max_level']
+        @no_toc_section_class = options['no_toc_section_class']
+        @list_class = options['list_class']
+        @sublist_class = options['sublist_class']
+        @item_class = options['item_class']
+        @item_prefix = options['item_prefix']
+      end
+
+      private
+
+      def generate_option_hash(options)
+        DEFAULT_CONFIG.merge(options)
+      rescue TypeError
+        DEFAULT_CONFIG
+      end
+    end
+  end
+end

data/lib/table_of_contents/parser.rb

@@ -7,25 +7,9 @@ module Jekyll
       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,
-        'list_class' => 'section-nav',
-        'sublist_class' => '',
-        'item_class' => 'toc-entry',
-        'item_prefix' => 'toc-'
-      }.freeze
-
       def initialize(html, options = {})
         @doc = Nokogiri::HTML::DocumentFragment.parse(html)
-        options = generate_option_hash(options)
-        @toc_levels = options['min_level']..options['max_level']
-        @no_toc_section_class = options['no_toc_section_class']
-        @list_class = options['list_class']
-        @sublist_class = options['sublist_class']
-        @item_class = options['item_class']
-        @item_prefix = options['item_prefix']
+        @configuration = Configuration.new(options)
         @entries = parse_content
       end
 
@@ -34,7 +18,7 @@ module Jekyll
       end
 
       def build_toc
-        %(<ul class="#{@list_class}">\n#{build_toc_list(@entries)}</ul>)
+        %(<ul class="#{@configuration.list_class}">\n#{build_toc_list(@entries)}</ul>)
       end
 
       def inject_anchors_into_html
@@ -86,7 +70,7 @@ module Jekyll
           entry = entries[i]
           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="#{@item_class} #{@item_prefix}#{entry[:node_name]}"><a href="##{entry[:id]}">#{entry[:text]}</a>)
+            toc_list << %(<li class="#{@configuration.item_class} #{@configuration.item_prefix}#{entry[:node_name]}"><a href="##{entry[:id]}">#{entry[:text]}</a>)
             # If the next entry should be indented in the list, generate a sublist
             next_i = i + 1
             if next_i < entries.count && entries[next_i][:h_num] > min_h_num
@@ -120,29 +104,23 @@ module Jekyll
       end
 
       def toc_headings
-        @toc_levels.map { |level| "h#{level}" }.join(',')
+        @configuration.toc_levels.map { |level| "h#{level}" }.join(',')
       end
 
       def toc_headings_in_no_toc_section
-        if @no_toc_section_class.is_a? Array
-          @no_toc_section_class.map { |cls| toc_headings_within(cls) }.join(',')
+        if @configuration.no_toc_section_class.is_a? Array
+          @configuration.no_toc_section_class.map { |cls| toc_headings_within(cls) }.join(',')
         else
-          toc_headings_within(@no_toc_section_class)
+          toc_headings_within(@configuration.no_toc_section_class)
         end
       end
 
       def toc_headings_within(class_name)
-        @toc_levels.map { |level| ".#{class_name} h#{level}" }.join(',')
-      end
-
-      def generate_option_hash(options)
-        DEFAULT_CONFIG.merge(options)
-      rescue TypeError
-        DEFAULT_CONFIG
+        @configuration.toc_levels.map { |level| ".#{class_name} h#{level}" }.join(',')
       end
 
       def ul_attributes
-        @ul_attributes ||= @sublist_class.empty? ? '' : %( class="#{@sublist_class}")
+        @ul_attributes ||= @configuration.sublist_class.empty? ? '' : %( class="#{@configuration.sublist_class}")
       end
     end
   end

data/lib/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module JekyllToc
-  VERSION = '0.11.0'
+  VERSION = '0.12.0.rc1'
 end

data/test/test_configuration.rb

@@ -0,0 +1,27 @@
+# frozen_string_literal: true
+
+require 'test_helper'
+
+class TestConfiguration < Minitest::Test
+  def test_default_conf1guration
+    configuration = Jekyll::TableOfContents::Configuration.new({})
+
+    assert_equal configuration.toc_levels, 1..6
+    assert_equal configuration.no_toc_section_class, 'no_toc_section'
+    assert_equal configuration.list_class, 'section-nav'
+    assert_equal configuration.sublist_class, ''
+    assert_equal configuration.item_class, 'toc-entry'
+    assert_equal configuration.item_prefix, 'toc-'
+  end
+
+  def test_type_error
+    configuration = Jekyll::TableOfContents::Configuration.new('TypeError!')
+
+    assert_equal configuration.toc_levels, 1..6
+    assert_equal configuration.no_toc_section_class, 'no_toc_section'
+    assert_equal configuration.list_class, 'section-nav'
+    assert_equal configuration.sublist_class, ''
+    assert_equal configuration.item_class, 'toc-entry'
+    assert_equal configuration.item_prefix, 'toc-'
+  end
+end

data/test/test_jekyll-toc.rb

@@ -5,11 +5,11 @@ require 'test_helper'
 class TestTableOfContentsFilter < Minitest::Test
   include Jekyll::TableOfContentsFilter
 
-  DUMMY_HTML = "<div>Dummy HTML Content</div>"
-  
+  DUMMY_HTML = '<div>Dummy HTML Content</div>'
+
   def setup
     stubbed_context = Struct.new(:registers)
-    @context = stubbed_context.new(page: "xxx")
+    @context = stubbed_context.new(page: 'xxx')
     @context
   end
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: jekyll-toc
 version: !ruby/object:Gem::Version
-  version: 0.11.0
+  version: 0.12.0.rc1
 platform: ruby
 authors:
 - toshimaru
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-03-24 00:00:00.000000000 Z
+date: 2019-03-29 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: nokogiri
@@ -157,6 +157,7 @@ files:
 - gemfiles/jekyll_3.8.gemfile
 - jekyll-toc.gemspec
 - lib/jekyll-toc.rb
+- lib/table_of_contents/configuration.rb
 - lib/table_of_contents/parser.rb
 - lib/version.rb
 - test/parser/test_inject_anchors_filter.rb
@@ -164,6 +165,7 @@ files:
 - test/parser/test_toc_filter.rb
 - test/parser/test_toc_only_filter.rb
 - test/parser/test_various_toc_html.rb
+- test/test_configuration.rb
 - test/test_helper.rb
 - test/test_jekyll-toc.rb
 - test/test_kramdown_list.rb
@@ -182,9 +184,9 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '2.3'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ">="
+  - - ">"
     - !ruby/object:Gem::Version
-      version: '0'
+      version: 1.3.1
 requirements: []
 rubygems_version: 3.0.3
 signing_key: 
@@ -196,6 +198,7 @@ test_files:
 - test/parser/test_toc_filter.rb
 - test/parser/test_toc_only_filter.rb
 - test/parser/test_various_toc_html.rb
+- test/test_configuration.rb
 - test/test_helper.rb
 - test/test_jekyll-toc.rb
 - test/test_kramdown_list.rb