jekyll-toc 0.12.1 → 0.15.0.rc

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 79d1409209555ff59be7d83d30b1576ca4ae792835a934fa2618e9efb13c0a61
-  data.tar.gz: 1008538004cb196a363fca3748988f1156d21e6ff72b30505d4a4f20ad0c1600
+  metadata.gz: 3d791df4c69353cee2810d445dc565746e9d4ed2f7f738e205f6ee2fef19d369
+  data.tar.gz: '084bc15ad6fe3fb08b2ad83e979e08d93ffb988adbccc6c7981479cd210d9de4'
 SHA512:
-  metadata.gz: 4a4f68a3f04691f78bfe05f8a5b3e5e59f0b75b26e43cdb199ba8a5aa08192c397fd7bc2ffbbf458d5923b136369d986dac1f1a6556ef6c820faa95365873a8e
-  data.tar.gz: 83ad420d0a58ca60ef99635b1ed13b85e2f17f7a638c35724f22c0f6b628121cf73c25ae4a9d6e2c65d909dcae72355220c3465471bd3f14d858f9af5c143764
+  metadata.gz: 44021a6c5bf17fa105b698571d43715aa381297b47355f4f439179063f695318f8071a8c1120318682c9eb25c17d7067fcacfdfc0ea5ce62995428f3e2f3649f
+  data.tar.gz: 69af07e31563443aa18492717b820aa3d274cc2e1cbb520a9b1489b87c72492ef3611fb96a25403565ea9e809161cffb2809aaead154b047984dac67da268bcb

data/.github/workflows/ci.yml

@@ -0,0 +1,32 @@
+name: CI
+on: [push, pull_request]
+jobs:
+  build:
+    strategy:
+      matrix:
+        ruby: [2.4, 2.5, 2.6, 2.7]
+        gemfile:
+          - gemfiles/jekyll_3.8.gemfile
+          - gemfiles/jekyll_3.9.gemfile
+          - gemfiles/jekyll_4.0.gemfile
+          - gemfiles/jekyll_4.1.gemfile
+        exclude:
+        - ruby: 2.4
+          gemfile: gemfiles/jekyll_4.0.gemfile
+        - ruby: 2.4
+          gemfile: gemfiles/jekyll_4.1.gemfile
+    env:
+      BUNDLE_GEMFILE: ${{ matrix.gemfile }}
+    runs-on: ubuntu-latest
+    steps:
+    - uses: actions/checkout@v2
+    - name: Set up Ruby ${{ matrix.ruby }}
+      uses: eregon/use-ruby-action@master
+      with:
+        ruby-version: ${{ matrix.ruby }}
+    - name: bundle install
+      run: |
+        gem install bundler
+        bundle install --jobs 4 --retry 3
+    - name: Run Test
+      run: bundle exec rake

data/.github/workflows/coverage.yml

@@ -0,0 +1,22 @@
+name: Coverage
+on: [push, pull_request]
+jobs:
+  build:
+    strategy:
+      matrix:
+        ruby: [2.6]
+    runs-on: ubuntu-latest
+    name: coverage
+    steps:
+      - uses: actions/checkout@v2
+      - name: Set up Ruby ${{ matrix.ruby }}
+        uses: eregon/use-ruby-action@master
+        with:
+          ruby-version: ${{ matrix.ruby }}
+      - name: bundle install
+        run: bundle install --jobs 4 --retry 3
+      - uses: paambaati/codeclimate-action@v2.4.0
+        env:
+          CC_TEST_REPORTER_ID: 6b81e393ea6ad38560386f650ea2fb0e57a7beb5e20f8c8364fabee30d5bff07
+        with:
+          coverageCommand: bundle exec rake

data/.github/workflows/rubocop.yml

@@ -0,0 +1,19 @@
+name: RuboCop
+on: [push, pull_request]
+jobs:
+  build:
+    strategy:
+      matrix:
+        ruby: [2.6]
+    runs-on: ubuntu-latest
+    name: rubocop
+    steps:
+      - uses: actions/checkout@v2
+      - name: Set up Ruby ${{ matrix.ruby }}
+        uses: eregon/use-ruby-action@master
+        with:
+          ruby-version: ${{ matrix.ruby }}
+      - name: bundle install
+        run: bundle install --jobs 4 --retry 3
+      - name: Run RuboCop
+        run: bundle exec rubocop

data/.rubocop.yml

@@ -1,22 +1,39 @@
 AllCops:
-  TargetRubyVersion: 2.3
+  TargetRubyVersion: 2.4
   Exclude:
-    - '*.gemspec'
-    - 'gemfiles/*'
+    - "*.gemspec"
+    - "gemfiles/*"
+    - "vendor/**/*"
     - Rakefile
     - Gemfile
 
-Metrics/LineLength: 
-  Enabled: false
-
 Metrics/MethodLength:
   Enabled: false
-
 Metrics/AbcSize:
   Enabled: false
-
 Metrics/ClassLength:
   Enabled: false
 
-Style/FileName:
+Naming/FileName:
+  Enabled: false
+
+Layout/LineLength:
+  Enabled: false
+Layout/SpaceAroundMethodCallOperator:
+  Enabled: true
+
+Lint/RaiseException:
+  Enabled: true
+Lint/StructNewOverride:
+  Enabled: true
+
+Style/WordArray:
   Enabled: false
+Style/HashEachMethods:
+  Enabled: true
+Style/HashTransformKeys:
+  Enabled: true
+Style/HashTransformValues:
+  Enabled: true
+Style/ExponentialNotation:
+  Enabled: true

data/Appraisals

@@ -1,13 +1,9 @@
 # frozen_string_literal: true
 
-appraise 'jekyll-3.8' do
-  gem 'jekyll', '3.8'
-end
-
-appraise 'jekyll-3.7' do
-  gem 'jekyll', '3.7'
-end
+SUPPORTED_VERSIONS = %w[3.8 3.9 4.0 4.1].freeze
 
-appraise 'jekyll-3.6' do
-  gem 'jekyll', '3.6'
+SUPPORTED_VERSIONS.each do |version|
+  appraise "jekyll-#{version}" do
+    gem 'jekyll', version
+  end
 end

data/Gemfile

@@ -1,3 +1,11 @@
 source 'https://rubygems.org'
 
 gemspec
+
+gem 'appraisal'
+gem 'minitest-reporters'
+gem 'minitest'
+gem 'pry'
+gem 'rake'
+gem 'rubocop', '~> 0.81'
+gem 'simplecov', '~> 0.17.1'

data/LICENSE.md

@@ -1,6 +1,6 @@
 The MIT License (MIT)
 
-Copyright (c) 2019 Toshimaru
+Copyright (c) 2020 Toshimaru
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

data/README.md

@@ -1,7 +1,7 @@
 # jekyll-toc
 
-[![Build Status](https://travis-ci.org/toshimaru/jekyll-toc.svg?branch=master)](https://travis-ci.org/toshimaru/jekyll-toc)
-[![Gem Version](https://badge.fury.io/rb/jekyll-toc.svg)](http://badge.fury.io/rb/jekyll-toc)
+![CI](https://github.com/toshimaru/jekyll-toc/workflows/CI/badge.svg)
+[![Gem Version](https://badge.fury.io/rb/jekyll-toc.svg)](https://badge.fury.io/rb/jekyll-toc)
 [![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)
 
@@ -19,6 +19,7 @@
   - [Skip TOC Section](#skip-toc-section)
   - [CSS Styling](#css-styling)
   - [Custom CSS Class](#custom-css-class)
+  - [Using Unordered/Ordered lists](#using-unorderedordered-lists)
 
 ## Installation
 
@@ -64,11 +65,9 @@ This filter places the TOC directly above the content.
 
 ### 2. Advanced Usage
 
-If you'd like separated TOC and content, you can use `toc_only` and `inject_anchors` filters.
+If you'd like separated TOC and content, you can use `{% toc %}` tag (or `toc_only` filter) and `inject_anchors` filter.
 
-#### ~~`toc_only` filter~~ `toc` tag
-
-⚠️ Please use `{% toc %}` instead of `{{ content | toc_only }}`.
+#### `{% toc %}` tag
 
 Generates the TOC itself as described [below](#generated-html).
 Mostly useful in cases where the TOC should _not_ be placed immediately
@@ -85,9 +84,20 @@ above the content but at some other place of the page, i.e. an aside.
 </div>
 ```
 
-#### Current Limitation
+:warning: **`{% toc %}` Tag Limitation**
+
+`{% toc %}` can be available only in [Jekyll Posts](https://jekyllrb.com/docs/step-by-step/08-blogging/) and [Jekyll Collections](https://jekyllrb.com/docs/collections/). If you'd like to use `{% toc %}` except posts or collections, please use `toc_only` filter as described below.
 
-**`{% toc %}` can be available only in [Jekyll Posts](https://jekyllrb.com/docs/step-by-step/08-blogging/) and [Jekyll Collections](https://jekyllrb.com/docs/collections/). If any concern or issue, please report it on [issue](https://github.com/toshimaru/jekyll-toc/issues/new).**
+```html
+<div>
+  <div id="table-of-contents">
+    {{ content | toc_only }}
+  </div>
+  <div id="markdown-content">
+    {{ content | inject_anchors }}
+  </div>
+</div>
+```
 
 #### `inject_anchors` filter
 
@@ -137,6 +147,7 @@ jekyll-toc generates an unordered list. The HTML output is as follows.
 toc:
   min_level: 1
   max_level: 6
+  ordered_list: false
   no_toc_section_class: no_toc_section
   list_class: section-nav
   sublist_class: ''
@@ -236,3 +247,39 @@ toc:
   # Default is "toc-":
   item_prefix: item-
 ```
+
+### Using Unordered/Ordered lists
+
+By default the table of contents will be generated as an unordered list via `<ul></ul>` tags. This can be configured to use ordered lists instead `<ol></ol>`.
+This can be configured in `_config.yml`:
+
+```yml
+toc:
+  ordered_list: true # default is false
+```
+
+In order to change the list type, use the [list-style-type](https://developer.mozilla.org/en-US/docs/Web/CSS/list-style-type) css property.
+Add a class to the `sublist_class` configuration to append it to the `ol` tags so that you can add the `list-style-type` property.
+
+Example
+
+```yml
+toc:
+  ordered_list: true
+  list_class: my-list-class
+  sublist_class: my-sublist-class
+```
+
+```css
+.my-list-class {
+  list-style-type: upper-alpha;
+}
+
+.my-sublist-class: {
+  list-style-type: lower-alpha;
+}
+```
+
+This will produce:
+
+![screenshot](https://user-images.githubusercontent.com/7675276/85813980-a0ea5a80-b719-11ea-9458-ccf9b86a778b.png)

data/gemfiles/jekyll_3.8.gemfile

@@ -2,6 +2,13 @@
 
 source "https://rubygems.org"
 
+gem "appraisal"
+gem "minitest-reporters"
+gem "minitest"
+gem "pry"
+gem "rake"
+gem "rubocop", "~> 0.81"
+gem "simplecov", "~> 0.17.1"
 gem "jekyll", "3.8"
 
 gemspec path: "../"

data/gemfiles/jekyll_3.9.gemfile

@@ -0,0 +1,14 @@
+# This file was generated by Appraisal
+
+source "https://rubygems.org"
+
+gem "appraisal"
+gem "minitest-reporters"
+gem "minitest"
+gem "pry"
+gem "rake"
+gem "rubocop", "~> 0.81"
+gem "simplecov", "~> 0.17.1"
+gem "jekyll", "3.9"
+
+gemspec path: "../"

data/gemfiles/jekyll_4.0.gemfile

@@ -0,0 +1,14 @@
+# This file was generated by Appraisal
+
+source "https://rubygems.org"
+
+gem "appraisal"
+gem "minitest-reporters"
+gem "minitest"
+gem "pry"
+gem "rake"
+gem "rubocop", "~> 0.81"
+gem "simplecov", "~> 0.17.1"
+gem "jekyll", "4.0"
+
+gemspec path: "../"

data/gemfiles/jekyll_4.1.gemfile

@@ -0,0 +1,14 @@
+# This file was generated by Appraisal
+
+source "https://rubygems.org"
+
+gem "appraisal"
+gem "minitest-reporters"
+gem "minitest"
+gem "pry"
+gem "rake"
+gem "rubocop", "~> 0.81"
+gem "simplecov", "~> 0.17.1"
+gem "jekyll", "4.1"
+
+gemspec path: "../"

data/jekyll-toc.gemspec

@@ -1,12 +1,14 @@
+# frozen_string_literal: true
+
 lib = File.expand_path('../lib', __FILE__)
 $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
-require 'version'
+require 'table_of_contents/version'
 
 Gem::Specification.new do |spec|
   spec.name          = 'jekyll-toc'
-  spec.version       = JekyllToc::VERSION
+  spec.version       = Jekyll::TableOfContents::VERSION
   spec.summary       = 'Jekyll Table of Contents plugin'
-  spec.description   = 'A liquid filter plugin for Jekyll which generates a table of contents.'
+  spec.description   = 'Jekyll (Ruby static website generator) plugin which generates a table of contents.'
   spec.authors       = %w(toshimaru torbjoernk)
   spec.email         = 'me@toshimaru.net'
   spec.files         = `git ls-files -z`.split("\x0")
@@ -15,16 +17,8 @@ Gem::Specification.new do |spec|
   spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
   spec.require_paths = ['lib']
 
-  spec.required_ruby_version = '>= 2.3'
-
-  spec.add_runtime_dependency 'nokogiri', '~> 1.9'
+  spec.required_ruby_version = '>= 2.4'
 
-  spec.add_development_dependency 'appraisal'
-  spec.add_development_dependency 'jekyll', '>= 3.5'
-  spec.add_development_dependency 'minitest', '~> 5.11'
-  spec.add_development_dependency 'minitest-reporters'
-  spec.add_development_dependency 'pry'
-  spec.add_development_dependency 'rake'
-  spec.add_development_dependency 'rubocop'
-  spec.add_development_dependency 'simplecov'
+  spec.add_dependency 'jekyll', '>= 3.8'
+  spec.add_dependency 'nokogiri', '~> 1.10'
 end

data/lib/jekyll-toc.rb

@@ -20,8 +20,6 @@ module Jekyll
   module TableOfContentsFilter
     # Deprecated method. Removed in v1.0.
     def toc_only(html)
-      Jekyll.logger.warn 'Deprecation: toc_only filter is deprecated and will be remove in jekyll-toc v1.0.',
-                         'Use `{% toc %}` instead of `{{ content | toc_only }}`.'
       return '' unless toc_enabled?
 
       TableOfContents::Parser.new(html, toc_config).build_toc

data/lib/table_of_contents/configuration.rb

@@ -4,12 +4,13 @@ module Jekyll
   module TableOfContents
     # jekyll-toc configuration class
     class Configuration
-      attr_accessor :toc_levels, :no_toc_class, :no_toc_section_class,
-                    :list_class, :sublist_class, :item_class, :item_prefix
+      attr_reader :toc_levels, :no_toc_class, :ordered_list, :no_toc_section_class,
+                  :list_class, :sublist_class, :item_class, :item_prefix
 
       DEFAULT_CONFIG = {
         'min_level' => 1,
         'max_level' => 6,
+        'ordered_list' => false,
         'no_toc_section_class' => 'no_toc_section',
         'list_class' => 'section-nav',
         'sublist_class' => '',
@@ -21,6 +22,7 @@ module Jekyll
         options = generate_option_hash(options)
 
         @toc_levels = options['min_level']..options['max_level']
+        @ordered_list = options['ordered_list']
         @no_toc_class = 'no_toc'
         @no_toc_section_class = options['no_toc_section_class']
         @list_class = options['list_class']

data/lib/table_of_contents/helper.rb

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+
+module Jekyll
+  module TableOfContents
+    # helper methods for Parser
+    module Helper
+      PUNCTUATION_REGEXP = /[^\p{Word}\- ]/u.freeze
+
+      def generate_toc_id(text)
+        text = text.downcase
+                   .gsub(PUNCTUATION_REGEXP, '') # remove punctuation
+                   .tr(' ', '-') # replace spaces with dash
+        CGI.escape(text)
+      end
+    end
+  end
+end

data/lib/table_of_contents/parser.rb

@@ -1,10 +1,12 @@
 # frozen_string_literal: true
 
+require 'table_of_contents/helper'
+
 module Jekyll
   module TableOfContents
     # Parse html contents and generate table of contents
     class Parser
-      PUNCTUATION_REGEXP = /[^\p{Word}\- ]/u
+      include ::Jekyll::TableOfContents::Helper
 
       def initialize(html, options = {})
         @doc = Nokogiri::HTML::DocumentFragment.parse(html)
@@ -17,11 +19,12 @@ module Jekyll
       end
 
       def build_toc
-        %(<ul class="#{@configuration.list_class}">\n#{build_toc_list(@entries)}</ul>)
+        %(<#{list_tag} class="#{@configuration.list_class}">\n#{build_toc_list(@entries)}</#{list_tag}>)
       end
 
       def inject_anchors_into_html
         @entries.each do |entry|
+          # NOTE: `entry[:id]` is automatically URL encoded by Nokogiri
           entry[:header_content].add_previous_sibling(
             %(<a class="anchor" href="##{entry[:id]}" aria-hidden="true"><span class="octicon octicon-link"></span></a>)
           )
@@ -41,10 +44,7 @@ module Jekyll
           .reject { |n| n.classes.include?(@configuration.no_toc_class) }
           .inject([]) do |entries, node|
           text = node.text
-          id = node.attribute('id') || text
-               .downcase
-               .gsub(PUNCTUATION_REGEXP, '') # remove punctuation
-               .tr(' ', '-') # replace spaces with dash
+          id = node.attribute('id') || generate_toc_id(text)
 
           suffix_num = headers[id]
           headers[id] += 1
@@ -74,7 +74,7 @@ module Jekyll
             next_i = i + 1
             if next_i < entries.count && entries[next_i][:h_num] > min_h_num
               nest_entries = get_nest_entries(entries[next_i, entries.count], min_h_num)
-              toc_list << %(\n<ul#{ul_attributes}>\n#{build_toc_list(nest_entries)}</ul>\n)
+              toc_list << %(\n<#{list_tag}#{ul_attributes}>\n#{build_toc_list(nest_entries)}</#{list_tag}>\n)
               i += nest_entries.count
             end
             # Add the closing tag for the current entry in the list
@@ -107,7 +107,7 @@ module Jekyll
       end
 
       def toc_headings_in_no_toc_section
-        if @configuration.no_toc_section_class.is_a? Array
+        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(@configuration.no_toc_section_class)
@@ -121,6 +121,10 @@ module Jekyll
       def ul_attributes
         @ul_attributes ||= @configuration.sublist_class.empty? ? '' : %( class="#{@configuration.sublist_class}")
       end
+
+      def list_tag
+        @list_tag ||= @configuration.ordered_list ? 'ol' : 'ul'
+      end
     end
   end
 end