jekyll-toc-helpers 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 61ac4d47460a4674accaee642a67c84f6a838ea8
+  data.tar.gz: c6f7900b4a03f102c09fc46a74b3645d3d9b94d4
+SHA512:
+  metadata.gz: 286867923fca5b53ee62a95f6a044a6b4229c33d5c57760346a2c5264bc93d5993a322c981a56af9f15d3a5331ec3544591561202e474082bd224c380fecebf8
+  data.tar.gz: ec9a78b4fc65a414e33e6d4491fb66aed8e950b67811ad22a4e18b3013f5b3cecef69a70caff16e0eb104deb6c5c59499da5a8faab607ed17bc1f48a3a366204

data/.gitignore

@@ -0,0 +1,18 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp
+spec/fixtures/_site

data/.travis.yml

@@ -0,0 +1,6 @@
+language: ruby
+rvm:
+  - 2.1
+  - 2.0
+  - 1.9.3
+script: "script/cibuild"

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in jekyll-alt-urls.gemspec
+gemspec

data/Rakefile

@@ -0,0 +1,6 @@
+require 'bundler/gem_tasks'
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new(:spec)
+
+task default: :spec

data/jekyll-toc-helpers.gemspec

@@ -0,0 +1,25 @@
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+
+Gem::Specification.new do |spec|
+  spec.name          = 'jekyll-toc-helpers'
+  spec.version       = '0.1.0'
+  spec.authors       = ['Garen Torikian']
+  spec.email         = ['gjtorikian@gmail.com']
+  spec.summary       = 'Some helper tags for generating TOCs.'
+  spec.description   = ''
+  spec.homepage      = 'https://github.com/gjtorikian/jekyll-toc-helpers'
+  spec.license       = 'MIT'
+
+  spec.files         = `git ls-files`.split($/)
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test)/})
+  spec.require_paths = ['lib']
+
+  spec.add_runtime_dependency 'jekyll', '~> 2.0'
+
+  spec.add_development_dependency 'bundler', '~> 1.3'
+  spec.add_development_dependency 'nokogiri', '~> 1.6'
+  spec.add_development_dependency 'rake'
+  spec.add_development_dependency 'rspec'
+end

data/lib/jekyll-toc-helpers.rb

@@ -0,0 +1,92 @@
+module Jekyll
+  module TOCHelper
+    def check_existing_content(context, prefix, id)
+      context.registers[:site].data["#{prefix}_#{id}"]
+    end
+
+    def construct_datafile(context, keys)
+      datafile = context.registers[:site].data
+
+      while path = keys.shift
+        datafile = datafile[path]
+      end
+
+      datafile
+    end
+  end
+
+  class TOCTag < Liquid::Tag
+    include TOCHelper
+
+    def initialize(tag_name, text, tokens)
+      super
+      keys = text.strip.split('.')
+      keys.shift(2) # this is just site.data
+      @keys = keys
+      @id = keys.join('.')
+    end
+
+    def render(context)
+      existing_content = check_existing_content(context, 'toc', @id)
+      return existing_content unless existing_content.nil?
+
+      list = []
+      datafile = construct_datafile(context, @keys)
+
+      datafile.each do |line|
+        if line.is_a? Hash
+          line.each_pair do |parent, children|
+            list << "- [#{parent}](#{Utils.slugify parent})"
+            children.each do |subsection|
+              list << "  - [#{subsection}](#{Utils.slugify subsection})"
+            end
+          end
+        else
+          list << "- [#{line}](#{Utils.slugify line})"
+        end
+      end
+
+      context.registers[:site].data["toc_#{@id}"] = list.join("\n")
+      context.registers[:site].data["toc_#{@id}"]
+    end
+  end
+
+  class NextPrevTag < Liquid::Tag
+    include TOCHelper
+
+    def initialize(tag_name, text, tokens)
+      super
+      keys = text.strip.split('.')
+      keys.shift(2) # this is just site.data
+      @keys = keys
+      @id = keys.join('.')
+    end
+
+    def render(context)
+      existing_content = check_existing_content(context, 'next_prev', @id)
+      return existing_content unless existing_content.nil?
+
+      list = []
+      datafile = construct_datafile(context, @keys)
+
+      datafile.each do |line|
+        if line.is_a? Hash
+          line.each_pair do |parent, children|
+            list << parent
+            children.each do |subsection|
+              list << subsection
+            end
+          end
+        else
+          list << line
+        end
+      end
+
+      context.registers[:site].data["next_prev_#{@id}"] = list.join('|')
+      context.registers[:site].data["next_prev_#{@id}"]
+    end
+  end
+end
+
+Liquid::Template.register_tag('toc', Jekyll::TOCTag)
+Liquid::Template.register_tag('next_prev', Jekyll::NextPrevTag)

data/script/bootstrap

@@ -0,0 +1,3 @@
+#! /bin/bash
+
+bundle install

data/script/cibuild

@@ -0,0 +1,4 @@
+#! /bin/bash
+
+script/bootstrap > /dev/null 2>&1
+bundle exec rake spec

data/spec/fixtures/_config.yml

@@ -0,0 +1,11 @@
+collections:
+  source:
+    output: true
+
+defaults:
+  -
+    scope:
+      path: ""
+      type: "source"
+    values:
+      layout: "layout"

data/spec/fixtures/_data/toc.yml

@@ -0,0 +1,5 @@
+- One File
+- Two File:
+  - One Subfile
+  - Two Subfile
+- Three File

data/spec/fixtures/_layouts/layout.html

@@ -0,0 +1,23 @@
+{% capture flat_links %}{% next_prev site.data.toc %}{% endcapture %}
+{% assign flat_links = flat_links | split: '|' %}
+
+<div class="pager">
+  <ul>
+    {% for title in flat_links %}
+    {% if title == page.title %}
+    {% unless forloop.first %}
+    <li class="left"><a href="source/{{ prev | slugify }}">&lt; Previous</a></li>
+    {% endunless %}
+
+    {% unless forloop.last %}
+    <li class="right"><a href="source/{{ flat_links[forloop.index] | slugify }}">Next &gt;</a></li>
+    {% endunless %}
+
+    {% break %}
+    {% endif %}
+    {% assign prev = title %}
+    {% endfor %}
+  </ul>
+</div>
+
+{{ content }}

data/spec/fixtures/_source/file1.md

@@ -0,0 +1,3 @@
+---
+title: One File
+---

data/spec/fixtures/_source/file2.md

@@ -0,0 +1,3 @@
+---
+title: Two File
+---

data/spec/fixtures/_source/file3.md

@@ -0,0 +1,3 @@
+---
+title: Three File
+---

data/spec/fixtures/_source/index.md

@@ -0,0 +1,5 @@
+---
+title: The Index
+---
+
+{% toc site.data.toc %}

data/spec/fixtures/_source/subfile1.md

@@ -0,0 +1,3 @@
+---
+title: One Subfile
+---

data/spec/fixtures/_source/subfile2.md

@@ -0,0 +1,3 @@
+---
+title: Two Subfile
+---

data/spec/jekyll-toc-helpers/prev_next_spec.rb

@@ -0,0 +1,28 @@
+require 'spec_helper'
+require 'nokogiri'
+
+describe('PrevNext') do
+  let(:file1)        { destination_file('source/file1.html') }
+  let(:file2)        { destination_file('source/file2.html') }
+  let(:subfile1)     { destination_file('source/subfile1.html') }
+  let(:subfile2)     { destination_file('source/subfile2.html') }
+  let(:file3)        { destination_file('source/file3.html') }
+
+  it 'writes the default frontmatter using a variable' do
+    file1_doc = Nokogiri::HTML(file1)
+    expect(0).to equal(file1_doc.css('.left').size)
+    expect(1).to equal(file1_doc.css('.right').size)
+    expect('source/two-file').to eq(file1_doc.css('.right a').attr('href').text)
+
+    file2_doc = Nokogiri::HTML(file2)
+    expect(1).to equal(file2_doc.css('.left').size)
+    expect(1).to equal(file2_doc.css('.right').size)
+    expect('source/one-file').to eq(file2_doc.css('.left a').attr('href').text)
+    expect('source/one-subfile').to eq(file2_doc.css('.right a').attr('href').text)
+
+    file3_doc = Nokogiri::HTML(file3)
+    expect(1).to equal(file3_doc.css('.left').size)
+    expect(0).to equal(file3_doc.css('.right').size)
+    expect('source/two-subfile').to eq(file3_doc.css('.left a').attr('href').text)
+  end
+end

data/spec/jekyll-toc-helpers/toc_spec.rb

@@ -0,0 +1,22 @@
+require 'spec_helper'
+
+describe('TOC') do
+  let(:index)        { destination_file('source/index.html') }
+
+  it 'writes the TOC out when asked' do
+    toc = <<-eos
+<ul>
+  <li><a href="one-file">One File</a></li>
+  <li><a href="two-file">Two File</a>
+    <ul>
+      <li><a href="one-subfile">One Subfile</a></li>
+      <li><a href="two-subfile">Two Subfile</a></li>
+    </ul>
+  </li>
+  <li><a href="three-file">Three File</a></li>
+</ul>
+eos
+
+    expect(index).to match(toc)
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,53 @@
+require 'jekyll'
+require 'yaml'
+require File.expand_path('lib/jekyll-toc-helpers.rb')
+
+RSpec.configure do |config|
+
+  config.run_all_when_everything_filtered = true
+  config.filter_run :focus
+  config.order = 'random'
+
+  config.expect_with :rspec do |c|
+    c.syntax = :expect
+  end
+
+  config.before(:each) do
+    Jekyll.logger.log_level = :error
+
+    @fixtures_path = Pathname.new(__FILE__).parent.join('fixtures')
+    @dest        = @fixtures_path.join('_site')
+    @config_src  = @fixtures_path.join('_config.yml')
+    @posts_src   = @fixtures_path.join('_posts')
+    @layouts_src = @fixtures_path.join('_layouts')
+    @plugins_src = @fixtures_path.join('_plugins')
+
+    @site = Jekyll::Site.new(Jekyll.configuration(
+      'source'      => @fixtures_path.to_s,
+      'destination' => @dest.to_s,
+      'plugins'     => @plugins_src.to_s,
+      'collections' => {
+        'source' => { 'output' => true }
+      }
+    ))
+
+    @dest.rmtree if @dest.exist?
+    @site.process
+  end
+
+  # config.after(:each) do
+  #   @dest.rmtree if @dest.exist?
+  # end
+
+  def setup_doc(doc_filename)
+    @site.collections['source'].docs.find { |d| d.relative_path.match(doc_filename) }
+  end
+
+  def destination_file_exists?(file)
+    File.exist?(File.join(@dest.to_s, file))
+  end
+
+  def destination_file(file)
+    File.read(File.join(@dest.to_s, file))
+  end
+end

metadata

@@ -0,0 +1,135 @@
+--- !ruby/object:Gem::Specification
+name: jekyll-toc-helpers
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Garen Torikian
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-12-29 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: jekyll
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.3'
+- !ruby/object:Gem::Dependency
+  name: nokogiri
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.6'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.6'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: ''
+email:
+- gjtorikian@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".travis.yml"
+- Gemfile
+- README.md
+- Rakefile
+- jekyll-toc-helpers.gemspec
+- lib/jekyll-toc-helpers.rb
+- script/bootstrap
+- script/cibuild
+- spec/fixtures/_config.yml
+- spec/fixtures/_data/toc.yml
+- spec/fixtures/_layouts/layout.html
+- spec/fixtures/_source/file1.md
+- spec/fixtures/_source/file2.md
+- spec/fixtures/_source/file3.md
+- spec/fixtures/_source/index.md
+- spec/fixtures/_source/subfile1.md
+- spec/fixtures/_source/subfile2.md
+- spec/jekyll-toc-helpers/prev_next_spec.rb
+- spec/jekyll-toc-helpers/toc_spec.rb
+- spec/spec_helper.rb
+homepage: https://github.com/gjtorikian/jekyll-toc-helpers
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.2.2
+signing_key: 
+specification_version: 4
+summary: Some helper tags for generating TOCs.
+test_files: []