jekyll-toc 0.14.0 → 0.15.0.rc

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: dc8236ac8c5ff74ef8f7f23fc8b2b2fedbf94cb238a2c20783256d4ca8523909
-  data.tar.gz: 8b92259b9e2f5345b58ff472a7232121e18fbac6986bda5938c53ff79bc7c501
+  metadata.gz: 3d791df4c69353cee2810d445dc565746e9d4ed2f7f738e205f6ee2fef19d369
+  data.tar.gz: '084bc15ad6fe3fb08b2ad83e979e08d93ffb988adbccc6c7981479cd210d9de4'
 SHA512:
-  metadata.gz: 70be39d4763e0ca77a39d1ee77e9a743a2bec709181e0ef75214c767ca2605d342ff2f245eec5aa0ac80fc28b78f58eb82c064687023aeedb4411785b5f5dca1
-  data.tar.gz: 18d1a1d16869dfbbaec20805470ea5e260e5daa2d252f2a751c479ba3457425f2f0b2b36c8794b29bc61f1637466524448d7acf3201d570b545d29e982e11df6
+  metadata.gz: 44021a6c5bf17fa105b698571d43715aa381297b47355f4f439179063f695318f8071a8c1120318682c9eb25c17d7067fcacfdfc0ea5ce62995428f3e2f3649f
+  data.tar.gz: 69af07e31563443aa18492717b820aa3d274cc2e1cbb520a9b1489b87c72492ef3611fb96a25403565ea9e809161cffb2809aaead154b047984dac67da268bcb

data/.github/workflows/ci.yml

@@ -1,16 +1,20 @@
 name: CI
-on: [push]
+on: [push, pull_request]
 jobs:
   build:
     strategy:
       matrix:
         ruby: [2.4, 2.5, 2.6, 2.7]
         gemfile:
-        - gemfiles/jekyll_4.0.gemfile
-        - gemfiles/jekyll_3.8.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

data/.github/workflows/coverage.yml

@@ -1,5 +1,5 @@
 name: Coverage
-on: [push]
+on: [push, pull_request]
 jobs:
   build:
     strategy:

data/.github/workflows/rubocop.yml

@@ -1,5 +1,5 @@
 name: RuboCop
-on: [push]
+on: [push, pull_request]
 jobs:
   build:
     strategy:

data/Appraisals

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

data/README.md

@@ -1,7 +1,7 @@
 # jekyll-toc
 
 ![CI](https://github.com/toshimaru/jekyll-toc/workflows/CI/badge.svg)
-[![Gem Version](https://badge.fury.io/rb/jekyll-toc.svg)](http://badge.fury.io/rb/jekyll-toc)
+[![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
 
@@ -146,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: ''
@@ -245,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.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.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/lib/table_of_contents/configuration.rb

@@ -4,12 +4,13 @@ module Jekyll
   module TableOfContents
     # jekyll-toc configuration class
     class Configuration
-      attr_reader :toc_levels, :no_toc_class, :no_toc_section_class,
+      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/parser.rb

@@ -19,7 +19,7 @@ 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
@@ -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

data/lib/table_of_contents/version.rb

@@ -2,6 +2,6 @@
 
 module Jekyll
   module TableOfContents
-    VERSION = '0.14.0'
+    VERSION = '0.15.0.rc'
   end
 end

data/test/parser/test_ordered_list.rb

@@ -0,0 +1,76 @@
+# frozen_string_literal: true
+
+require 'test_helper'
+
+class TestOrderedList < Minitest::Test
+  include TestHelpers
+
+  def test_default_configuration
+    configuration = Jekyll::TableOfContents::Configuration.new({})
+
+    assert_equal configuration.ordered_list, false
+  end
+
+  def test_disabled_ordered_list
+    configuration = Jekyll::TableOfContents::Configuration.new('ordered_list' => false)
+
+    assert_equal configuration.ordered_list, false
+  end
+
+  def test_enabled_ordered_list
+    configuration = Jekyll::TableOfContents::Configuration.new('ordered_list' => true)
+
+    assert_equal configuration.ordered_list, true
+  end
+
+  def test_basic_ordered_list_top_heading
+    parse_with_ordered_list
+    html = @parser.toc
+
+    assert_match(/^<ol class="section-nav">/, html)
+  end
+
+  def test_ordered_list_sub_headings
+    parse_with_ordered_list
+    html = @parser.toc
+
+    assert_match(/<ol>\n<li class="toc-entry/, html)
+  end
+
+  def test_ordered_list_top_heading_with_classes
+    parse_with_ordered_list_and_classes
+    html = @parser.toc
+
+    assert_match(/^<ol class="top-list-class">/, html)
+  end
+
+  def test_ordered_list_sub_headings_with_classes
+    parse_with_ordered_list_and_classes
+    html = @parser.toc
+
+    assert_match(/<ol class="sublist-class">/, html)
+  end
+
+  def test_ordered_list_subheadings_with_classes_nested_structure
+    parse_with_ordered_list_and_classes
+    html = @parser.toc
+
+    occurrences = html.scan(/<ol class="sublist-class">/).count
+
+    assert_equal occurrences, 5
+  end
+
+  private
+
+  def parse_with_ordered_list
+    read_html_and_create_parser('ordered_list' => true)
+  end
+
+  def parse_with_ordered_list_and_classes
+    read_html_and_create_parser(
+      'ordered_list' => true,
+      'list_class' => 'top-list-class',
+      'sublist_class' => 'sublist-class'
+    )
+  end
+end

data/test/test_configuration.rb

@@ -3,10 +3,11 @@
 require 'test_helper'
 
 class TestConfiguration < Minitest::Test
-  def test_default_conf1guration
+  def test_default_configuration
     configuration = Jekyll::TableOfContents::Configuration.new({})
 
     assert_equal configuration.toc_levels, 1..6
+    assert_equal configuration.ordered_list, false
     assert_equal configuration.no_toc_section_class, 'no_toc_section'
     assert_equal configuration.list_class, 'section-nav'
     assert_equal configuration.sublist_class, ''
@@ -18,6 +19,7 @@ class TestConfiguration < Minitest::Test
     configuration = Jekyll::TableOfContents::Configuration.new('TypeError!')
 
     assert_equal configuration.toc_levels, 1..6
+    assert_equal configuration.ordered_list, false
     assert_equal configuration.no_toc_section_class, 'no_toc_section'
     assert_equal configuration.list_class, 'section-nav'
     assert_equal configuration.sublist_class, ''

data/test/test_helper.rb

@@ -20,7 +20,7 @@ SIMPLE_HTML = <<~HTML
 HTML
 
 module TestHelpers
-  def read_html_and_create_parser
-    @parser = Jekyll::TableOfContents::Parser.new(SIMPLE_HTML)
+  def read_html_and_create_parser(options = {})
+    @parser = Jekyll::TableOfContents::Parser.new(SIMPLE_HTML, options)
   end
 end

metadata

@@ -1,15 +1,15 @@
 --- !ruby/object:Gem::Specification
 name: jekyll-toc
 version: !ruby/object:Gem::Version
-  version: 0.14.0
+  version: 0.15.0.rc
 platform: ruby
 authors:
 - toshimaru
 - torbjoernk
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2020-05-05 00:00:00.000000000 Z
+date: 2020-10-13 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: jekyll
@@ -58,7 +58,9 @@ files:
 - README.md
 - Rakefile
 - gemfiles/jekyll_3.8.gemfile
+- gemfiles/jekyll_3.9.gemfile
 - gemfiles/jekyll_4.0.gemfile
+- gemfiles/jekyll_4.1.gemfile
 - jekyll-toc.gemspec
 - lib/jekyll-toc.rb
 - lib/table_of_contents/configuration.rb
@@ -67,6 +69,7 @@ files:
 - lib/table_of_contents/version.rb
 - test/parser/test_inject_anchors_filter.rb
 - test/parser/test_invalid_options.rb
+- test/parser/test_ordered_list.rb
 - test/parser/test_toc_filter.rb
 - test/parser/test_toc_only_filter.rb
 - test/parser/test_various_toc_html.rb
@@ -79,7 +82,7 @@ homepage: https://github.com/toshimaru/jekyll-toc
 licenses:
 - MIT
 metadata: {}
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -90,17 +93,18 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '2.4'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ">="
+  - - ">"
     - !ruby/object:Gem::Version
-      version: '0'
+      version: 1.3.1
 requirements: []
-rubygems_version: 3.1.2
-signing_key: 
+rubygems_version: 3.1.4
+signing_key:
 specification_version: 4
 summary: Jekyll Table of Contents plugin
 test_files:
 - test/parser/test_inject_anchors_filter.rb
 - test/parser/test_invalid_options.rb
+- test/parser/test_ordered_list.rb
 - test/parser/test_toc_filter.rb
 - test/parser/test_toc_only_filter.rb
 - test/parser/test_various_toc_html.rb