middleman-toc 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: f854b8ef57495ea5b094ed90d3b4e509e0978c21
+  data.tar.gz: fc7e54f5ded46ca96834fae5b8c969caf283689d
+SHA512:
+  metadata.gz: 908ae6a3625b281fd30f68dab7b49ac61b6c555f460e034bcaed39282248d0506e793873cddc2ce2b9116030f9a6bf5fa460e221f632df4e7d5298986e3d0a3e
+  data.tar.gz: 295f8764e0986ab0309231b77b882e4668e9e5eccfb1447b3f1ed10eb5feff9cc8eafe135352978e4aca12bd27c0e8eec6195de884688f9638dc076baadf9ee1

data/Gemfile

@@ -0,0 +1,9 @@
+source 'https://rubygems.org'
+
+gemspec
+gem 'middleman'
+
+group :test do
+  gem 'rspec'
+  gem 'mocha'
+end

data/Gemfile.lock

@@ -0,0 +1,140 @@
+PATH
+  remote: .
+  specs:
+    middleman-toc (0.0.1)
+      titleize
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    activesupport (4.1.8)
+      i18n (~> 0.6, >= 0.6.9)
+      json (~> 1.7, >= 1.7.7)
+      minitest (~> 5.1)
+      thread_safe (~> 0.1)
+      tzinfo (~> 1.1)
+    celluloid (0.16.0)
+      timers (~> 4.0.0)
+    chunky_png (1.3.3)
+    coffee-script (2.3.0)
+      coffee-script-source
+      execjs
+    coffee-script-source (1.8.0)
+    compass (1.0.1)
+      chunky_png (~> 1.2)
+      compass-core (~> 1.0.1)
+      compass-import-once (~> 1.0.5)
+      rb-fsevent (>= 0.9.3)
+      rb-inotify (>= 0.9)
+      sass (>= 3.3.13, < 3.5)
+    compass-core (1.0.1)
+      multi_json (~> 1.0)
+      sass (>= 3.3.0, < 3.5)
+    compass-import-once (1.0.5)
+      sass (>= 3.2, < 3.5)
+    diff-lcs (1.2.5)
+    erubis (2.7.0)
+    execjs (2.2.2)
+    ffi (1.9.6)
+    haml (4.0.6)
+      tilt
+    hike (1.2.3)
+    hitimes (1.2.2)
+    hooks (0.4.0)
+      uber (~> 0.0.4)
+    i18n (0.6.11)
+    json (1.8.2)
+    kramdown (1.5.0)
+    listen (2.8.5)
+      celluloid (>= 0.15.2)
+      rb-fsevent (>= 0.9.3)
+      rb-inotify (>= 0.9)
+    metaclass (0.0.4)
+    middleman (3.3.7)
+      coffee-script (~> 2.2)
+      compass (>= 1.0.0, < 2.0.0)
+      compass-import-once (= 1.0.5)
+      execjs (~> 2.0)
+      haml (>= 4.0.5)
+      kramdown (~> 1.2)
+      middleman-core (= 3.3.7)
+      middleman-sprockets (>= 3.1.2)
+      sass (>= 3.4.0, < 4.0)
+      uglifier (~> 2.5)
+    middleman-core (3.3.7)
+      activesupport (~> 4.1.0)
+      bundler (~> 1.1)
+      erubis
+      hooks (~> 0.3)
+      i18n (~> 0.6.9)
+      listen (>= 2.7.9, < 3.0)
+      padrino-helpers (~> 0.12.3)
+      rack (>= 1.4.5, < 2.0)
+      rack-test (~> 0.6.2)
+      thor (>= 0.15.2, < 2.0)
+      tilt (~> 1.4.1, < 2.0)
+    middleman-sprockets (3.4.1)
+      middleman-core (>= 3.3)
+      sprockets (~> 2.12.1)
+      sprockets-helpers (~> 1.1.0)
+      sprockets-sass (~> 1.3.0)
+    minitest (5.5.1)
+    mocha (1.1.0)
+      metaclass (~> 0.0.1)
+    multi_json (1.10.1)
+    padrino-helpers (0.12.4)
+      i18n (~> 0.6, >= 0.6.7)
+      padrino-support (= 0.12.4)
+      tilt (~> 1.4.1)
+    padrino-support (0.12.4)
+      activesupport (>= 3.1)
+    rack (1.6.0)
+    rack-test (0.6.2)
+      rack (>= 1.0)
+    rb-fsevent (0.9.4)
+    rb-inotify (0.9.5)
+      ffi (>= 0.5.0)
+    rspec (3.1.0)
+      rspec-core (~> 3.1.0)
+      rspec-expectations (~> 3.1.0)
+      rspec-mocks (~> 3.1.0)
+    rspec-core (3.1.7)
+      rspec-support (~> 3.1.0)
+    rspec-expectations (3.1.2)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.1.0)
+    rspec-mocks (3.1.3)
+      rspec-support (~> 3.1.0)
+    rspec-support (3.1.2)
+    sass (3.4.9)
+    sprockets (2.12.3)
+      hike (~> 1.2)
+      multi_json (~> 1.0)
+      rack (~> 1.0)
+      tilt (~> 1.1, != 1.3.0)
+    sprockets-helpers (1.1.0)
+      sprockets (~> 2.0)
+    sprockets-sass (1.3.1)
+      sprockets (~> 2.0)
+      tilt (~> 1.1)
+    thor (0.19.1)
+    thread_safe (0.3.4)
+    tilt (1.4.1)
+    timers (4.0.1)
+      hitimes
+    titleize (1.3.0)
+    tzinfo (1.2.2)
+      thread_safe (~> 0.1)
+    uber (0.0.12)
+    uglifier (2.6.1)
+      execjs (>= 0.3.0)
+      json (>= 1.8.0)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  middleman
+  middleman-toc!
+  mocha
+  rspec

data/README.md

@@ -0,0 +1,3 @@
+# Middleman Table of Contents
+
+Render a table of contents. See http://ruby-for-beginners.rubymonstas.org

data/lib/middleman_toc.rb

@@ -0,0 +1,183 @@
+require 'middleman'
+require 'middleman_toc/extension'
+require 'forwardable'
+
+class MiddlemanToc
+  module Indent
+    def indent(string)
+      string.split("\n").map { |line| "#{'  ' * (level)}#{line}" }.join("\n")
+    end
+  end
+
+  class Paths < Struct.new(:sitemap)
+    def prev(path)
+      path = paths[index(path) - 1]
+      "#{path.sub('.', '')}.html" if path
+    end
+
+    def next(path)
+      path = paths[index(path) + 1]
+      "#{path.sub('.', '')}.html" if path
+    end
+
+    def select(dir)
+      paths.select { |path| path =~ %r(#{dir}/) }.reject { |path| path =~ %r(#{dir}/.+/) }
+    end
+
+    def paths
+      @paths ||= begin
+        paths = sitemap.resources.map(&:path)
+        paths = paths.select { |path| path =~ /.html$/ }
+        paths = paths.map { |path| "./#{path.sub(/.html$/, '')}" }
+        paths = paths + paths.map { |path| ::File.dirname(path) } - ['.']
+        paths.sort.unshift('./index').uniq
+      end
+    end
+
+    def index(path)
+      paths.index("./#{path.sub('.html', '')}")
+    end
+  end
+
+  class Tree
+    extend Forwardable
+    include Indent
+
+    def_delegators :@children, :empty?
+    attr_reader :level, :path, :children, :active
+
+    def initialize(level, path)
+      @level = level
+      @path = path
+      @children = []
+    end
+
+    def <<(child)
+      children << child
+    end
+
+    def activate(active)
+      children.each { |child| child.activate(active) }
+      @active = level == 1 || active == path || children.any?(&:active?)
+    end
+
+    def render
+      "<ul#{' class="active"' if active}>\n#{indent(children.map(&:render).join("\n"))}\n</ul>"
+    end
+  end
+
+  class Page < Struct.new(:level, :page, :path, :directory?)
+    include Indent
+
+    attr_reader :active, :active
+
+    def activate(active)
+      @active = active == path
+    end
+
+    def render
+      html = title
+      html = link("/#{path}.html", html) if File.file?(filename)
+      html = item(html)
+      html
+    end
+
+    def link(href, content)
+      %(<a href="#{href}">#{content}</a>)
+    end
+
+    def item(content)
+      %(<li#{%( class="#{classes}") if classes}>#{content}</li>)
+    end
+
+    def active?
+      # current == path
+      @active
+    end
+
+    def classes
+      classes = []
+      classes << 'active' if active?
+      classes << 'directory' if directory?
+      classes.join(' ')
+    end
+
+    def title
+      title = page_title if page
+      title || path_title
+    end
+
+    def page_title
+      if page.data.title
+        page.data.title
+      else
+        html = page.render(layout: false, no_images: true)
+        matches = html.match(/<h.+>(.*?)<\/h1>/)
+        matches[1] if matches
+      end
+    end
+
+    def path_title
+      path.sub(/[\d]{2}-/, '').titleize
+    end
+
+    def filename
+      "source/#{path}.md"
+    end
+  end
+
+  class Link < Struct.new(:href, :content, :options)
+    def render
+      %(<a href="#{href}" class="#{options[:class]}">#{content}</a>)
+    end
+  end
+
+  attr_reader :sitemap, :paths, :tree
+
+  def initialize(sitemap)
+    @sitemap = sitemap
+    @paths = Paths.new(sitemap)
+    @tree = build('.')
+  end
+
+  def render(current_path)
+    tree.activate(current_path.sub('.html', ''))
+    tree.render
+  end
+
+  def prev(current_path)
+    page = page_for(current_path)
+    href = paths.prev(page.path)
+    Link.new(href, 'Previous', class: 'prev').render if href
+  end
+
+  def next(current_path)
+    page = page_for(current_path)
+    href = paths.next(page.path)
+    Link.new(href, 'Next', class: 'next').render if href
+  end
+
+  private
+
+    def build(dir, level = 1)
+      tree = Tree.new(level, dir.sub('./', ''))
+      paths.select(dir).each do |path|
+        child = build(path, level + 1)
+        path = path.sub('./', '')
+        page = page_for("#{path}.html")
+        tree.children << Page.new(level, page, path, !child.empty?)
+        tree << child unless child.empty?
+      end
+      tree
+    end
+
+    def page_for(path)
+      sitemap.find_resource_by_path(path)
+    end
+
+    def title_for(path)
+      File.read(path)
+    end
+end
+
+Middleman::Extensions.register(:toc, MiddlemanToc::Extension)

data/lib/middleman_toc/extension.rb

@@ -0,0 +1,10 @@
+require 'middleman_toc/helpers'
+
+class MiddlemanToc
+  class Extension < ::Middleman::Extension
+    # option :ignore, ['sitemap.xml', 'robots.txt'], 'Ignored files and directories.'
+    # option :titles, { 'index.md' => 'Home' }, 'Default link titles.'
+
+    self.defined_helpers = [Helpers]
+  end
+end

data/lib/middleman_toc/helpers.rb

@@ -0,0 +1,19 @@
+class MiddlemanToc
+  module Helpers
+    def _toc
+      @_toc ||= MiddlemanToc.new(sitemap)
+    end
+
+    def toc
+      _toc.render(current_page.path)
+    end
+
+    def prev_page
+      _toc.prev(current_page.path)
+    end
+
+    def next_page
+      _toc.next(current_page.path)
+    end
+  end
+end

data/lib/middleman_toc/version.rb

@@ -0,0 +1,3 @@
+class MiddlemanToc
+  VERSION = "0.0.1"
+end

data/spec/spec_helper.rb

@@ -0,0 +1,7 @@
+require 'middleman-toc'
+require 'middleman-core/configuration'
+
+RSpec.configure do |c|
+  c.expect_with :rspec
+  c.mock_with :mocha
+end

data/spec/toc_spec.rb

@@ -0,0 +1,47 @@
+require 'spec_helper'
+
+describe Middleman::Toc do
+  let(:titles)  { ['Title 1', 'Title 2', 'Title 2-1', 'Title 2-2', 'Book'] }
+  let(:paths)   { %w(1.html 2.html 2/2-1.html 2/2-2.html index.html) }
+  let(:pages)   { paths.map { |path| stub(path: path) } }
+  let(:sitemap) { stub(resources: pages) }
+  let(:toc)     { Middleman::Toc.new(sitemap) }
+
+  subject { toc.render }
+
+  before do
+    pages.map do |page|
+      sitemap.stubs(:find_resource_by_path).with(page.path).returns(page)
+      page.stubs(:data).returns(stub(title: nil))
+      File.stubs(:file?).with("source/#{page.path.sub('html', 'md')}").returns(page.path != '2.html')
+    end
+  end
+
+  describe 'with a directory that has an equivalent file' do
+  end
+
+  describe 'with page data title attribute set' do
+    before do
+      pages.map.with_index do |resource, ix|
+        resource.stubs(:data).returns(stub(title: "Data: #{titles[ix]}"))
+      end
+    end
+
+    it 'uses the page data title attribute' do
+      expect(subject).to include('<a href="1.html">Data: Title 1</a>')
+    end
+  end
+
+  describe 'with page data title attribute not set' do
+    before do
+      pages.map.with_index do |resource, ix|
+        resource.stubs(:render).returns("<h1>Html: #{titles[ix]}</h1>")
+      end
+    end
+
+    it 'renders and parses the page for a <h1> tag' do
+      puts subject
+      expect(subject).to include('<a href="1.html">Html: Title 1</a>')
+    end
+  end
+end

metadata

@@ -0,0 +1,66 @@
+--- !ruby/object:Gem::Specification
+name: middleman-toc
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Sven Fuchs
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-01-16 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: titleize
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: 
+email: me@svenfuchs.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- Gemfile
+- Gemfile.lock
+- README.md
+- lib/middleman_toc.rb
+- lib/middleman_toc/extension.rb
+- lib/middleman_toc/helpers.rb
+- lib/middleman_toc/version.rb
+- spec/spec_helper.rb
+- spec/toc_spec.rb
+homepage: https://github.com/svenfuchs/middleman-toc
+licenses: []
+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: "[none]"
+rubygems_version: 2.2.2
+signing_key: 
+specification_version: 4
+summary: Middleman Table of Contents
+test_files: []
+has_rdoc: