middleman-toc 0.0.2 → 0.0.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: d92d0afc67a827ff2b546a0330868ad1d29eee94
-  data.tar.gz: d1103d95ecc62e2af21f8b5460d7747a0f0c6602
+  metadata.gz: 9878fe65c1884c356621be680c01b083115a5c36
+  data.tar.gz: bc806aa5c08d4f29cfbc8ab318e4935e388bcb29
 SHA512:
-  metadata.gz: 65fcce00a3c64d0cc071f7e3e9dbacdfc455ca0dc2b70cad3ba33cfd1b5262b8e659519c2a047c8fdda8091f5e905fdf8eca80f737062e2d32b0460b60ba001b
-  data.tar.gz: 652196367bf93e1274e5a8ddaa82c3fb1d6fa7665b1894df4bde3503a03d47dc747a6194b724856e51079838d692d8d9b217a7c6276c72c4076432c8a1a6fdab
+  metadata.gz: 3ce628078149e15537da2e668693c394a919f0b8bfb42332ca27af6a219422c3779b0b17e37feb67820c42ca25bedf9edda07e8e2ede676515295ee6e4da8c99
+  data.tar.gz: b50206b8fa190abaafe5f93d7e3962b2837fbd4824461b4d8b3f64effa4a33fa8cac062df2fd8c55fda674a38fa9a539f175f951c4611e732b2b5fe0d8283632

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    middleman-toc (0.0.1)
+    middleman-toc (0.0.2)
       titleize
 
 GEM

data/lib/middleman_toc.rb

@@ -1,182 +1,41 @@
 require 'middleman'
+require 'yaml'
 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 Page
-    extend Forwardable
-    include Indent
-
-    def_delegators :@children, :empty?
-
-    attr_reader :level, :path, :page, :children, :active
-
-    def initialize(level, path, page)
-      @level = level
-      @path = path
-      @page = page
-      @children = []
-    end
-
-    def <<(child)
-      children << child
-    end
-
-    def activate(active)
-      children.each { |child| child.activate(active) }
-      @active = active == path
-    end
-
-    def render
-      if level == 1
-        render_children
-      else
-        html = title
-        html = link("/#{path}.html", html) if File.file?(filename)
-        html = [html, render_children].join("\n") unless children.empty?
-        item(html)
+require 'middleman_toc/toc'
+require 'middleman_toc/validator'
+
+module MiddlemanToc
+  class << self
+    def instance(sitemap)
+      @instance ||= Toc.new(pages(sitemap)).tap do |toc|
+        Validator.new(toc.pages, toc.root).validate!
       end
     end
 
-    def render_children
-      %(<ul#{%( class="active") if active?}>\n#{indent(children.map(&:render).join("\n"))}\n</ul>)
-    end
-
-    def link(href, content)
-      %(<a href="#{href}">#{content}</a>)
-    end
-
-    def item(content)
-      %(<li#{%( class="#{classes}") unless classes.empty?}>#{content}</li>)
-    end
-
-    def classes
-      classes = []
-      classes << 'active' if active?
-      classes << 'directory' if directory?
-      classes << 'expanded' if active? && !children.empty? || expanded?
-      classes.join(' ')
-    end
-
-    def directory?
-      !children.empty?
-    end
-
-    def active?
-      @active
+    def toc(sitemap, path)
+      rendering { instance(sitemap).toc(path) } # .tap { |html| puts html }
     end
 
-    def expanded?
-      level == 1 || children.any?(&:active?)
+    def prev_page(sitemap, path)
+      rendering { instance(sitemap).prev_page(path) }
     end
 
-    def title
-      title = page_title if page
-      title || path_title
+    def next_page(sitemap, path)
+      rendering { instance(sitemap).next_page(path) }
     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
+    def pages(sitemap)
+      sitemap.resources.inject({}) do |pages, page|
+        pages.merge(page.path.gsub(%r((^|\/)[\d]+\-), '').sub('.html', '\1') => page)
       end
     end
 
-    def path_title
-      File.basename(path).sub(/[\d]{2}-/, '').titleize
+    def rendering
+      return if @rendering
+      @rendering = true
+      yield.tap { @rendering = false }
     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(path, level = 1)
-      path = path.sub('./', '')
-      page = Page.new(level, path, page_for("#{path}.html"))
-      paths.select(path).each { |path| page.children << build(path, level + 1) }
-      page
-    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/builder.rb

@@ -0,0 +1,28 @@
+require 'middleman_toc/node'
+require 'middleman_toc/title'
+
+module MiddlemanToc
+  class Builder < Struct.new(:manifest, :pages)
+    def build
+      Node.new(0, nil, nil, nodes(manifest))
+    end
+
+    private
+
+      def nodes(data, parents = [])
+        data.inject([]) do |pages, data|
+          pages << node(data['path'], data['children'], parents)
+        end
+      end
+
+      def node(path, children, parents)
+        path = parents + [path]
+        children = nodes(children, path) if children
+        Node.new(path.size, path.join('/'), title_for(path.join('/')), children)
+      end
+
+      def title_for(path)
+        Title.new(path, pages[path]).title
+      end
+    end
+end

data/lib/middleman_toc/extension.rb

@@ -1,10 +1,16 @@
 require 'middleman_toc/helpers'
 
-class MiddlemanToc
+module 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]
+
+    def manipulate_resource_list(resources)
+      resources.each do |resource|
+        resource.destination_path.gsub!(/(^|\/)[\d]+\-/, '\1')
+      end
+    end
   end
 end

data/lib/middleman_toc/helpers.rb

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

data/lib/middleman_toc/node.rb

@@ -0,0 +1,45 @@
+require 'middleman_toc/renderer'
+
+module MiddlemanToc
+  class Node < Struct.new(:level, :path, :title, :children)
+    attr_reader :active
+
+    def find(path)
+      flatten.detect { |node| node.path == path }
+    end
+
+    def flatten
+      [self, children.map(&:flatten)].flatten
+    end
+
+    def activate(path)
+      @active = path == self.path
+      children.each { |child| child.activate(path) }
+    end
+
+    def render
+      Renderer.new(self).render
+    end
+
+    def children
+      super || []
+    end
+
+    def root?
+      level == 0
+    end
+
+    def directory?
+      children.any?
+    end
+
+    def active?
+      @active
+    end
+
+    def expanded?
+      directory? && active? || children.any?(&:active?)
+    end
+  end
+end
+

data/lib/middleman_toc/renderer.rb

@@ -0,0 +1,38 @@
+require 'middleman_toc/tag'
+
+module MiddlemanToc
+  class Renderer < Struct.new(:node)
+    def render
+      if node.root?
+        children
+      else
+        html = node.title
+        html = link("/#{node.path}.html", html)
+        html = [html, children].join("\n") if node.directory?
+        item(html)
+      end
+    end
+
+    private
+
+      def children
+        Tag.new(:ul, node.children.map(&:render)).render
+      end
+
+      def link(href, content)
+        Tag.new(:a, content, href: href).render
+      end
+
+      def item(content)
+        Tag.new(:li, content, class: classes).render
+      end
+
+      def classes
+        %w(active directory expanded).select { |name| node.send(:"#{name}?") }
+      end
+
+      def indent(string)
+        string.split("\n").map { |line| "  #{line}" }.join("\n")
+      end
+    end
+end

data/lib/middleman_toc/tag.rb

@@ -0,0 +1,24 @@
+module MiddlemanToc
+  class Tag < Struct.new(:name, :content, :attrs)
+    class Attr < Struct.new(:key, :value)
+    end
+
+    def render
+      "<#{name} #{attrs}".strip + ">\n#{indent(content)}\n</#{name}>"
+    end
+
+    private
+
+      def attrs
+        Array(super).map { |key, value| attr(key, value) }.compact.join(' ')
+      end
+
+      def attr(key, value)
+        %(#{key}="#{Array(value).join(' ')}") unless value.nil? || value.empty?
+      end
+
+      def indent(lines)
+        Array(lines).join("\n").split("\n").map { |line| "  #{line}" }.join("\n")
+      end
+  end
+end

data/lib/middleman_toc/title.rb

@@ -0,0 +1,25 @@
+module MiddlemanToc
+  class Title < Struct.new(:path, :page)
+    def title
+      from_data || from_html || from_path
+    end
+
+    private
+
+      def from_data
+        page.data.title if page
+      end
+
+      def from_html
+        html.match(/<h.+>(.*?)<\/h1>/) && $1
+      end
+
+      def html
+        page ? page.render(layout: false, no_images: true) : ''
+      end
+
+      def from_path
+        File.basename(path).sub(/[\d]{2}-/, '').titleize if path
+      end
+  end
+end

data/lib/middleman_toc/toc.rb

@@ -0,0 +1,51 @@
+require 'middleman_toc/builder'
+
+module MiddlemanToc
+  class Toc < Struct.new(:pages)
+    attr_reader :root
+
+    def initialize(*)
+      super
+      @root = Builder.new(manifest, pages).build
+    end
+
+    def toc(path)
+      root.activate(normalize_path(path))
+      root.render
+    end
+
+    def prev_page(path)
+      node = root.find(normalize_path(path)).try(:prev)
+      Tag.new(:a, node.path, 'Previous', class: 'prev').render if node
+    end
+
+    def next_page(path)
+      node = root.find(normalize_path(path)).try(:next)
+      Tag.new(:a, node.path, 'Next', class: 'next').render if node
+    end
+
+    def normalize_path(path)
+      path.sub('.html', '')
+    end
+
+    def manifest
+      raise 'Could not load data/toc.yml' unless File.exists?('data/toc.yml')
+      normalize_nodes(YAML.load_file('data/toc.yml'))
+    end
+
+    def normalize_nodes(nodes)
+      Array(nodes).map do |node|
+        case node
+        when Array
+          normalize_nodes(node)
+        when String
+          { 'path' => node }
+        when Hash
+          node.merge('children' => normalize_nodes(node['children']))
+        else
+          node
+        end
+      end
+    end
+  end
+end

data/lib/middleman_toc/validator.rb

@@ -0,0 +1,50 @@
+require 'thor/shell/color'
+
+module MiddlemanToc
+  class Validator < Struct.new(:pages, :node)
+    INDENT = '   '
+
+    def validate!
+      hrefs.each do |href|
+        missing_page(href) unless exists?(href)
+      end
+    end
+
+    private
+
+      def missing_page(href)
+        puts [INDENT, warn("Link to local page is missing in the table of contents: #{href}")].join
+      end
+
+      def exists?(href)
+        paths.include?(href)
+      end
+
+      def warn(message)
+        "#{ansi('warning', :red, :bold)}: #{message}"
+      end
+
+      def ansi(string, *attrs)
+        Thor::Shell::Color.new.set_color('warning', *attrs)
+      end
+
+      def hrefs
+        pages.map { |path, page| hrefs_from(page) }.flatten
+      end
+
+      def paths
+        pages.keys
+      end
+
+      def hrefs_from(page)
+        html = render(page) || ''
+        html.scan(%r(<a.+href="/([^"]+)")).flatten.map do |href|
+          href.sub('.html', '')
+        end
+      end
+
+      def render(page)
+        page.render(layout: false, no_images: true)
+      end
+  end
+end

data/lib/middleman_toc/version.rb

@@ -1,3 +1,3 @@
-class MiddlemanToc
-  VERSION = "0.0.2"
+module MiddlemanToc
+  VERSION = "0.0.3"
 end

data/middleman-toc.gemspec

@@ -0,0 +1,19 @@
+# encoding: utf-8
+
+$:.unshift File.expand_path('../lib', __FILE__)
+require 'middleman_toc/version'
+
+Gem::Specification.new do |s|
+  s.name         = "middleman-toc"
+  s.version      = MiddlemanToc::VERSION
+  s.authors      = ["Sven Fuchs"]
+  s.email        = "me@svenfuchs.com"
+  s.homepage     = "https://github.com/svenfuchs/middleman-toc"
+  s.summary      = "Middleman Table of Contents"
+  s.files        = Dir['{lib/**/*,spec/**/*,[A-Z]*}']
+  s.platform     = Gem::Platform::RUBY
+  s.require_path = 'lib'
+  s.rubyforge_project = '[none]'
+
+  s.add_dependency 'titleize'
+end

data/spec/spec_helper.rb

@@ -1,5 +1,5 @@
-require 'middleman-toc'
-require 'middleman-core/configuration'
+require 'middleman_toc'
+# require 'middleman-core/configuration'
 
 RSpec.configure do |c|
   c.expect_with :rspec

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: middleman-toc
 version: !ruby/object:Gem::Version
-  version: 0.0.2
+  version: 0.0.3
 platform: ruby
 authors:
 - Sven Fuchs
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-01-16 00:00:00.000000000 Z
+date: 2015-05-10 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: titleize
@@ -34,14 +34,18 @@ files:
 - Gemfile.lock
 - README.md
 - lib/middleman_toc.rb
+- lib/middleman_toc/builder.rb
 - lib/middleman_toc/extension.rb
 - lib/middleman_toc/helpers.rb
-- lib/middleman_toc/link.rb
-- lib/middleman_toc/page.rb
-- lib/middleman_toc/paths.rb
+- lib/middleman_toc/node.rb
+- lib/middleman_toc/renderer.rb
+- lib/middleman_toc/tag.rb
+- lib/middleman_toc/title.rb
+- lib/middleman_toc/toc.rb
+- lib/middleman_toc/validator.rb
 - lib/middleman_toc/version.rb
+- middleman-toc.gemspec
 - spec/spec_helper.rb
-- spec/toc_spec.rb
 homepage: https://github.com/svenfuchs/middleman-toc
 licenses: []
 metadata: {}
@@ -61,9 +65,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: "[none]"
-rubygems_version: 2.2.2
+rubygems_version: 2.4.5
 signing_key: 
 specification_version: 4
 summary: Middleman Table of Contents
 test_files: []
-has_rdoc: 

data/lib/middleman_toc/link.rb

@@ -1,7 +0,0 @@
-class MiddlemanToc
-  class Link < Struct.new(:href, :content, :options)
-    def render
-      %(<a href="#{href}" class="#{options[:class]}">#{content}</a>)
-    end
-  end
-end

data/lib/middleman_toc/page.rb

@@ -1,95 +0,0 @@
-class MiddlemanToc
-  class Page
-    extend Forwardable
-
-    def_delegators :@children, :empty?
-
-    attr_reader :level, :path, :page, :children, :active
-
-    def initialize(level, path, page)
-      @level = level
-      @path = path
-      @page = page
-      @children = []
-    end
-
-    def <<(child)
-      children << child
-    end
-
-    def activate(active)
-      children.each { |child| child.activate(active) }
-      @active = active == path
-    end
-
-    def render
-      if level == 1
-        render_children
-      else
-        html = title
-        html = link("/#{path}.html", html) if File.file?(filename)
-        html = [html, render_children].join("\n") unless children.empty?
-        item(html)
-      end
-    end
-
-    def render_children
-      %(<ul#{%( class="active") if active?}>\n#{indent(children.map(&:render).join("\n"))}\n</ul>)
-    end
-
-    def link(href, content)
-      %(<a href="#{href}">#{content}</a>)
-    end
-
-    def item(content)
-      %(<li#{%( class="#{classes}") unless classes.empty?}>#{content}</li>)
-    end
-
-    def classes
-      classes = []
-      classes << 'active' if active?
-      classes << 'directory' if directory?
-      classes << 'expanded' if active? && !children.empty? || expanded?
-      classes.join(' ')
-    end
-
-    def directory?
-      !children.empty?
-    end
-
-    def active?
-      @active
-    end
-
-    def expanded?
-      level == 1 || children.any?(&:active?)
-    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
-      File.basename(path).sub(/[\d]{2}-/, '').titleize
-    end
-
-    def filename
-      "source/#{path}.md"
-    end
-
-    def indent(string)
-      string.split("\n").map { |line| "#{'  ' * (level)}#{line}" }.join("\n")
-    end
-  end
-end

data/lib/middleman_toc/paths.rb

@@ -1,31 +0,0 @@
-class MiddlemanToc
-  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
-end

data/spec/toc_spec.rb

@@ -1,47 +0,0 @@
-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