jekyll-toc 0.1.0 → 0.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: d5182d04d94e419e33025caaa66a64d016d1db78
-  data.tar.gz: 131cf0a03478c80523fc94bca791dc4e1e0424a8
+  metadata.gz: 5f0601165123bc065a76d355ae7fff00c7143c59
+  data.tar.gz: a6debb0a1f9999f1714a0db81993dade1f514cc0
 SHA512:
-  metadata.gz: 267d7551a141b3007950892e24d618a869a48af010c9d912cd62d940e21d439a0f3df2fa1f78c67c9a0a353f7a7e975da9fdcdc484058e5f4f6651e1076233d7
-  data.tar.gz: c399807b95bf22b474184677296a973c1909cc89a322e0b416b11797f4ec09a0d9321e3cec4b3e9fe3959fe297c287ff5e6be2640c86f8a514cc5d92ba1c7301
+  metadata.gz: aadfda21dacca72d16ef4ac3577f18bd00753d6c21dd2e74f1cf63f70afb559760bb43d23770a00aece77f671320090dc1b33ba27da8d8764b9bc877e54e1bed
+  data.tar.gz: 2eaf6f22f02f2b9444540f4cd3484224c1e37319233fc7a44b3d4d0e7004a3e5fdf80434322654b98986da64c492ab1045d6f69335a4f772b27ff256b453cbe8

data/.travis.yml

@@ -7,3 +7,6 @@ gemfile:
   - gemfiles/jekyll_3.1.gemfile
   - gemfiles/jekyll_3.gemfile
   - gemfiles/jekyll_2.gemfile
+addons:
+  code_climate:
+    repo_token: 6b81e393ea6ad38560386f650ea2fb0e57a7beb5e20f8c8364fabee30d5bff07

data/CHANGELOG.md

@@ -0,0 +1 @@
+Changelog is maintained under [Github Releases](https://github.com/toshimaru/jekyll-toc/releases).

data/README.md

@@ -4,8 +4,9 @@
 [![Gem Version](https://badge.fury.io/rb/jekyll-toc.svg)](http://badge.fury.io/rb/jekyll-toc)
 [![Dependency Status](https://gemnasium.com/toshimaru/jekyll-toc.svg)](https://gemnasium.com/toshimaru/jekyll-toc)
 [![Code Climate](https://codeclimate.com/github/toshimaru/jekyll-toc/badges/gpa.svg)](https://codeclimate.com/github/toshimaru/jekyll-toc)
+[![Test Coverage](https://codeclimate.com/github/toshimaru/jekyll-toc/badges/coverage.svg)](https://codeclimate.com/github/toshimaru/jekyll-toc/coverage)
 
-# Usage
+# Installation
 
 Add jekyll-toc plugin in your site's `Gemfile`.
 
@@ -30,39 +31,47 @@ toc: true
 ---
 ```
 
+# Usage
+
 There are three Liquid filters available now, which all should be applied
 to some HTML content, e.g. the Liquid variable `content` available in
 Jekyll's templates.
 
-1. `toc_only`  
-   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.
-
-2. `inject_anchors`  
-   Injects HTML anchors into the content without actually outputing the
-   TOC itself.
-   They are of the form:
-   
-   ```html
-   <a id="heading11" class="anchor" href="#heading1-1" aria-hidden="true">
-     <span class="octicon octicon-link"></span>
-   </a>
-   ```
-   
-   This is only useful when the TOC itself should be placed at some other
-   location with the `toc_only` filter.
-
-3. `toc`  
-  This is the concatenation of the two above, where the TOC is placed
-  directly above the content.
-  
-  Add `toc` filter to your site's `{{ content }}` (e.g. `_layouts/post.html`).
-
-  ```
-  {{ content | toc }}
-  ```
+## Basic Usage
+
+### `toc` filter
+
+Add `toc` filter to your site's `{{ content }}` (e.g. `_layouts/post.html`).
+
+```
+{{ content | toc }}
+```
+
+This filter places the TOC directly above the content.
+
+## Advanced Usage
 
+If you'd like separated TOC and content, you can use `toc_only` and `inject_anchors` filters.
+
+### `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
+
+Injects HTML anchors into the content without actually outputing the
+TOC itself. They are of the form:
+
+```html
+<a id="heading11" class="anchor" href="#heading1-1" aria-hidden="true">
+  <span class="octicon octicon-link"></span>
+</a>
+```
+
+This is only useful when the TOC itself should be placed at some other
+location with the `toc_only` filter.
 
 ## Generated Table of Contents HTML
 
@@ -122,4 +131,3 @@ all other links:
   display: none;
 }
 ```
-

data/jekyll-toc.gemspec

@@ -17,8 +17,9 @@ Gem::Specification.new do |spec|
 
   spec.add_runtime_dependency "nokogiri", "~> 1.6"
 
-  spec.add_development_dependency "appraisal"
   spec.add_development_dependency 'minitest', "~> 5.0"
+  spec.add_development_dependency "appraisal"
+  spec.add_development_dependency "codeclimate-test-reporter"
   spec.add_development_dependency "jekyll", "~> 2.0"
   spec.add_development_dependency "rake"
 end

data/lib/jekyll-toc.rb

@@ -1,90 +1,30 @@
 require 'nokogiri'
+require 'table_of_contents/parser'
 
 module Jekyll
-  module TableOfContents
-    PUNCTUATION_REGEXP = RUBY_VERSION > '1.9' ? /[^\p{Word}\- ]/u : /[^\w\- ]/
-
-    class Parser
-      attr_reader :doc
-
-      def initialize(html)
-        @doc = Nokogiri::HTML::DocumentFragment.parse(html)
-        @entries = parse_content
-      end
-
-      def build_toc
-        toc = %Q{<ul class="section-nav">\n}
-
-        @entries.each do |entry|
-          toc << %Q{<li class="toc-entry toc-#{entry[:node_name]}"><a href="##{entry[:id]}#{entry[:uniq]}">#{entry[:text]}</a></li>\n}
-        end
-
-        toc << '</ul>'
-      end
-
-      def inject_anchors_into_html
-        @entries.each do |entry|
-          entry[:content_node].add_previous_sibling(%Q{<a id="#{entry[:id]}#{entry[:uniq]}" class="anchor" href="##{entry[:id]}#{entry[:uniq]}" aria-hidden="true"><span class="octicon octicon-link"></span></a>})
-        end
-
-        @doc.inner_html
-      end
-
-      def toc
-        build_toc + inject_anchors_into_html
-      end
-
-      # parse logic is from html-pipeline toc_filter
-      # https://github.com/jch/html-pipeline/blob/v1.1.0/lib/html/pipeline/toc_filter.rb
-      private
-      def parse_content
-        entries = []
-        headers = Hash.new(0)
-
-        @doc.css('h1, h2, h3, h4, h5, h6').each do |node|
-          text = node.text
-          id = text.downcase
-          id.gsub!(PUNCTUATION_REGEXP, '') # remove punctuation
-          id.gsub!(' ', '-') # replace spaces with dash
-
-          uniq = (headers[id] > 0) ? "-#{headers[id]}" : ''
-          headers[id] += 1
-          if header_content = node.children.first
-            entries << {
-                id: id,
-                uniq: uniq,
-                text: text,
-                node_name: node.name,
-                content_node: header_content
-            }
-          end
-        end
-
-        entries
-      end
-    end
-  end
-
   module TableOfContentsFilter
     def toc_only(html)
-      page = @context.registers[:page]
       return html unless page['toc']
 
-      Jekyll::TableOfContents::Parser.new(html).build_toc
+      ::Jekyll::TableOfContents::Parser.new(html).build_toc
     end
 
     def inject_anchors(html)
-      page = @context.registers[:page]
       return html unless page['toc']
 
-      Jekyll::TableOfContents::Parser.new(html).inject_anchors_into_html
+      ::Jekyll::TableOfContents::Parser.new(html).inject_anchors_into_html
     end
 
     def toc(html)
-      page = @context.registers[:page]
       return html unless page['toc']
 
-      Jekyll::TableOfContents::Parser.new(html).toc
+      ::Jekyll::TableOfContents::Parser.new(html).toc
+    end
+
+    private
+
+    def page
+      @context.registers[:page]
     end
   end
 end

data/lib/table_of_contents/parser.rb

@@ -0,0 +1,66 @@
+module Jekyll
+  module TableOfContents
+    class Parser
+      PUNCTUATION_REGEXP = RUBY_VERSION > '1.9' ? /[^\p{Word}\- ]/u : /[^\w\- ]/
+
+      attr_reader :doc
+
+      def initialize(html)
+        @doc = Nokogiri::HTML::DocumentFragment.parse(html)
+        @entries = parse_content
+      end
+
+      def build_toc
+        toc = %Q{<ul class="section-nav">\n}
+
+        @entries.each do |entry|
+          toc << %Q{<li class="toc-entry toc-#{entry[:node_name]}"><a href="##{entry[:id]}#{entry[:uniq]}">#{entry[:text]}</a></li>\n}
+        end
+
+        toc << '</ul>'
+      end
+
+      def inject_anchors_into_html
+        @entries.each do |entry|
+          entry[:content_node].add_previous_sibling(%Q{<a id="#{entry[:id]}#{entry[:uniq]}" class="anchor" href="##{entry[:id]}#{entry[:uniq]}" aria-hidden="true"><span class="octicon octicon-link"></span></a>})
+        end
+
+        @doc.inner_html
+      end
+
+      def toc
+        build_toc + inject_anchors_into_html
+      end
+
+      # parse logic is from html-pipeline toc_filter
+      # https://github.com/jch/html-pipeline/blob/v1.1.0/lib/html/pipeline/toc_filter.rb
+      private
+
+      def parse_content
+        entries = []
+        headers = Hash.new(0)
+
+        @doc.css('h1, h2, h3, h4, h5, h6').each do |node|
+          text = node.text
+          id = text.downcase
+          id.gsub!(PUNCTUATION_REGEXP, '') # remove punctuation
+          id.gsub!(' ', '-') # replace spaces with dash
+
+          uniq = (headers[id] > 0) ? "-#{headers[id]}" : ''
+          headers[id] += 1
+          if header_content = node.children.first
+            entries << {
+                id: id,
+                uniq: uniq,
+                text: text,
+                node_name: node.name,
+                content_node: header_content
+            }
+          end
+        end
+
+        entries
+      end
+    end
+  end
+end

data/lib/version.rb

@@ -1,3 +1,3 @@
 module JekyllToc
-  VERSION = '0.1.0'
+  VERSION = '0.1.1'
 end

data/test/test_helper.rb

@@ -1,3 +1,6 @@
+require "codeclimate-test-reporter"
+CodeClimate::TestReporter.start
+
 require 'jekyll'
 require 'minitest/autorun'
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: jekyll-toc
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.1
 platform: ruby
 authors:
 - Toshimaru
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-03-23 00:00:00.000000000 Z
+date: 2016-04-17 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: nokogiri
@@ -25,6 +25,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '1.6'
+- !ruby/object:Gem::Dependency
+  name: minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
 - !ruby/object:Gem::Dependency
   name: appraisal
   requirement: !ruby/object:Gem::Requirement
@@ -40,19 +54,19 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: minitest
+  name: codeclimate-test-reporter
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '5.0'
+        version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '5.0'
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: jekyll
   requirement: !ruby/object:Gem::Requirement
@@ -90,6 +104,7 @@ files:
 - ".gitignore"
 - ".travis.yml"
 - Appraisals
+- CHANGELOG.md
 - Gemfile
 - LICENSE.md
 - README.md
@@ -99,6 +114,7 @@ files:
 - gemfiles/jekyll_3.gemfile
 - jekyll-toc.gemspec
 - lib/jekyll-toc.rb
+- lib/table_of_contents/parser.rb
 - lib/version.rb
 - test/test_helper.rb
 - test/test_inject_anchors_filter.rb
@@ -124,7 +140,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.4.5
+rubygems_version: 2.4.5.1
 signing_key: 
 specification_version: 4
 summary: Jekyll Table of Contents plugin