page-toc-filter 0.0.1 → 0.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 86b76a41f01bb806ec13216e76bd748af27c77b2
-  data.tar.gz: ce2f03b1fec1676acc1ca6728d3618e47906c2f0
+  metadata.gz: 45b7f9c69ba970ee849f37ba30d5662db658f14e
+  data.tar.gz: 2aad334c79bcf252995ff8812e883a80a179eb80
 SHA512:
-  metadata.gz: 192a85e15ead4dfb0646a2626bf1a4cf947691d9a992877c3343c626a289c73bcd41c3c501e79310c17c72f7a93eb75aefcb609cf31e32f3a11d59944c89234e
-  data.tar.gz: f748bdb2e314294e80ee052ff83860851e448529fbd63cf6c43e83f7e9cd33655c2bebdf461eafff3667721634108c054129c7965bed2933f1f067e615fdb742
+  metadata.gz: cb85a7bf92d8685f888665064538183ff073273894cc4e46110825e596209a0e98f8df14af89d5b6544fda0bdece7b7f3f775b9ffa0ef1ac204f17b8820e38e1
+  data.tar.gz: '092d37bfcdad2bd1de98db1dcdec337dce79fc05bf26068e549c754a6365f2c64b1fcbc67cdea015ee511db227b7d819a5c93bda72da5254d3c981d0d88e68a1'

data/README.md

@@ -1,5 +1,7 @@
 # PageTocFilter
 
+Inserts a table of contents on a page via the [`HTML::Pipeline`](https://github.com/jch/html-pipeline). 
+
 ## Installation
 
 Add this line to your application's Gemfile:
@@ -34,6 +36,8 @@ pipeline = HTML::Pipeline.new([
 ])
 ```
 
+Then, on your page, enter the text `{:toc}` to have it replaced by a table of contents.
+
 By default, only `h2` headings will be converted into a table of contents. You can change this with the optional `toc_levels` setting, which should be a comma-separated string of heading levels. For example:
 
 ``` ruby

data/lib/page-toc-filter.rb

@@ -14,15 +14,41 @@ class PageTocFilter < HTML::Pipeline::Filter
   end
 
   def page_toc_filter(doc)
-    toc = ''
-    levels = context[:toc_levels] || 'h2'
+    levels = doc.search(context[:toc_levels] || 'h2')
+    return '' if levels.empty?
+
+    toc = %(<ul id="markdown-toc">\n)
+    last_level = nil
+    depth = 1
+
+    levels.each do |node|
+      current_level = node.name.match(/h(\d)/)[1]
 
-    doc.search(levels).each do |node|
       text = node.text
       id = node.child['id']
-      toc << %(<li><a href="##{id}" id="markdown-toc-#{id}">#{text}</a></li>\n)
+
+      link = %(<a href="##{id}" id="markdown-toc-#{id}">#{text}</a>)
+
+      if last_level.nil?
+        toc << %(<li>#{link})
+      elsif current_level == last_level
+        toc << %(</li>\n<li>#{link})
+      elsif current_level > last_level
+        depth += 1
+        toc << %(\n<ul><li>#{link})
+      elsif current_level < last_level
+        depth -= 1
+        toc << %(</li></ul>\n<li>#{link})
+      end
+
+      last_level = current_level
+    end
+
+    if depth < 0
+      raise ArgumentError, 'Your headings are not in sequential order. It seems that a lower heading level (like an h4) is being defined before a higher heading level (like an h1).'
     end
-    toc = %(<ul id="markdown-toc">\n#{toc}</ul>) unless toc.empty?
+
+    toc << %(</li>\n</ul>) * depth
     toc
   end
 end

data/page-toc-filter.gemspec

@@ -3,7 +3,7 @@ $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
 
 Gem::Specification.new do |spec|
   spec.name          = 'page-toc-filter'
-  spec.version       = '0.0.1'
+  spec.version       = '0.1.0'
   spec.authors       = ['Garen Torikian']
   spec.email         = ['gjtorikian@gmail.com']
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: page-toc-filter
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.1.0
 platform: ruby
 authors:
 - Garen Torikian
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2015-11-20 00:00:00.000000000 Z
+date: 2017-04-16 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: html-pipeline
@@ -115,7 +115,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.4.5.1
+rubygems_version: 2.6.8
 signing_key: 
 specification_version: 4
 summary: Generates a table of contents for a single page, via HTML::Pipeline.