jekyll-toc 0.12.0.rc1 → 0.12.0.rc2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: be220b1646e71d971f92efb0d26f1dc8774a503d8607d8762b54f9402e1606fa
-  data.tar.gz: 79701301568dc4bedf7a7658ccc7dd618b16018e7befecea758f7298044187ed
+  metadata.gz: 6912be740161a70021da9fdcfffcc86c1102b47ca0331fb83dd82ac6c3d9ff3a
+  data.tar.gz: b643b75ca33642f66054b52de2d3bc94ef6280277ac1afe91afbc5d0b9096f09
 SHA512:
-  metadata.gz: 5248660f0d76d3afbee5d9e4316f63896a44766326c73ad7feeff23ca977bd147722a457ee21b2022048cc6cc1b93837048f48de5518bce71bfc71cf6e647308
-  data.tar.gz: a6e2f104e4334909dbe70fdbca80123b644965f3c2599c55a09575461f5f9e769a5274ae3627b78cde91203daa9f65c98168d868322f2335386f5d0aacafc77c
+  metadata.gz: 26e96485ad84ea72849fde58ff33ced713b3ea962f56dc9ed09caf4ee85c2abff1566994126e0c9cb3f4d56f1d2e7b4638b26ae6e90c0cf9c56405f1b765ef2f
+  data.tar.gz: 714d5b7e4973f32d08e2a8689240ee3f372ca6bb7e983122ffca009db47bf175d8df8e3e21cd6c4a74b225ede5e480c2fe48fbec1cb030a2a3dcee10d04c423a

data/README.md

@@ -65,19 +65,34 @@ This filter places the TOC directly above the content.
 
 If you'd like separated TOC and content, you can use `toc_only` and `inject_anchors` filters.
 
-#### `toc_only` filter
+#### ~~`toc_only` filter~~
+
+⚠️ Please use `{% toc %}` instead of `{{ contents | toc_only }}`.
 
 Generates the TOC itself as described [below](#generated-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.
 
+#### toc tag
+
+```html
+<div>
+  <div id="table-of-contents">
+    {% toc %}
+  </div>
+  <div id="markdown-content">
+    {{ content }}
+  </div>
+</div>
+```
+
 #### `inject_anchors` filter
 
 Injects HTML anchors into the content without actually outputting the TOC itself.
 They are of the form:
 
 ```html
-<a id="heading11" class="anchor" href="#heading1-1" aria-hidden="true">
+<a class="anchor" href="#heading1-1" aria-hidden="true">
   <span class="octicon octicon-link"></span>
 </a>
 ```

data/lib/jekyll-toc.rb

@@ -5,18 +5,21 @@ require 'table_of_contents/configuration'
 require 'table_of_contents/parser'
 
 module Jekyll
-  # class TocTag < Liquid::Tag
-  #   def render(context)
-  #     return unless context.registers[:page]['toc']
-  #
-  #     content_html = context.registers[:page].content
-  #     ::Jekyll::TableOfContents::Parser.new(content_html).build_toc
-  #   end
-  # end
+  # toc tag for Jekyll
+  class TocTag < Liquid::Tag
+    def render(context)
+      return '' unless context.registers[:page]['toc']
+
+      content_html = context.registers[:page].content
+      ::Jekyll::TableOfContents::Parser.new(content_html).build_toc
+    end
+  end
 
   # Jekyll Table of Contents filter plugin
   module TableOfContentsFilter
     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 `{{ contents | toc_only }}`.'
       return '' unless toc_enabled?
 
       ::Jekyll::TableOfContents::Parser.new(html, toc_config).build_toc
@@ -47,4 +50,4 @@ module Jekyll
 end
 
 Liquid::Template.register_filter(Jekyll::TableOfContentsFilter)
-# Liquid::Template.register_tag('toc', Jekyll::TocTag) # will be enabled at v1.0
+Liquid::Template.register_tag('toc', Jekyll::TocTag) # will be enabled at v1.0

data/lib/version.rb

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

data/test/test_jekyll-toc.rb

@@ -8,9 +8,7 @@ class TestTableOfContentsFilter < Minitest::Test
   DUMMY_HTML = '<div>Dummy HTML Content</div>'
 
   def setup
-    stubbed_context = Struct.new(:registers)
-    @context = stubbed_context.new(page: 'xxx')
-    @context
+    @context = Struct.new(:registers).new(page: { "toc" => false })
   end
 
   def test_toc_only

data/test/test_toc_tag.rb

@@ -0,0 +1,24 @@
+# frozen_string_literal: true
+
+require 'test_helper'
+
+class TestTableOfContentsTag < Minitest::Test
+  include Liquid
+
+  def setup
+    @stubbed_context  = Struct.new(:registers)
+    @stubbed_context2 = Struct.new(:toc, :content)
+  end
+
+  def test_toc_tag
+    context = @stubbed_context.new(page: @stubbed_context2.new({ 'toc' => false }, '<h1>test</h1>'))
+    tag = Jekyll::TocTag.parse('toc_tag', '', Tokenizer.new(''), ParseContext.new)
+    assert_equal tag.render(context), "<ul class=\"section-nav\">\n<li class=\"toc-entry toc-h1\"><a href=\"#test\">test</a></li>\n</ul>"
+  end
+
+  def test_toc_tag_returns_empty_string
+    context = @stubbed_context.new(page: { 'toc' => false })
+    tag = Jekyll::TocTag.parse('toc_tag', '', Tokenizer.new(''), ParseContext.new)
+    assert_empty tag.render(context)
+  end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: jekyll-toc
 version: !ruby/object:Gem::Version
-  version: 0.12.0.rc1
+  version: 0.12.0.rc2
 platform: ruby
 authors:
 - toshimaru
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-03-29 00:00:00.000000000 Z
+date: 2019-03-30 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: nokogiri
@@ -169,6 +169,7 @@ files:
 - test/test_helper.rb
 - test/test_jekyll-toc.rb
 - test/test_kramdown_list.rb
+- test/test_toc_tag.rb
 homepage: https://github.com/toshimaru/jekyll-toc
 licenses:
 - MIT
@@ -202,3 +203,4 @@ test_files:
 - test/test_helper.rb
 - test/test_jekyll-toc.rb
 - test/test_kramdown_list.rb
+- test/test_toc_tag.rb