gollum-descendant_tree 0.0.1

data/.gitignore

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

data/.rspec

@@ -0,0 +1 @@
+--colour

data/Gemfile

@@ -0,0 +1,6 @@
+source 'https://rubygems.org'
+
+gem "titleize", "~> 1.3.0"
+
+# Specify your gem's dependencies in gollum-descendant_tree.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2013 Aaron Froehlich
+
+MIT License
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,33 @@
+# Gollum::DescendantTree
+
+DescendantTree adds a helper function, similar to Gollum's Table of Contents (TOC), which adds an unordered list of links to all descendants of the current page.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'gollum-descendant_tree'
+
+And then execute:
+
+    $ bundle install
+
+Or install it yourself as:
+
+    $ gem install gollum-descendant_tree
+
+## Usage
+
+Simply add `[[_TREE_]]` to any page of your wiki to add an unordered list of descendants to the page. If you're using custom css, you can target `ul.tree` for styling the list.
+
+## Automated Tests
+
+    $ bundle exec rspec spec
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request

data/Rakefile

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

data/gollum-descendant_tree.gemspec

@@ -0,0 +1,26 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'gollum/descendant_tree/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "gollum-descendant_tree"
+  spec.version       = Gollum::DescendantTree::VERSION
+  spec.authors       = ["Aaron Froehlich"]
+  spec.email         = ["aaron@singlebrook.com"]
+  spec.description   = %q{Provides a tag that can be used in gollum to output descedants of the current page}
+  spec.summary       = %q{Descendant Tree is similar to Gollum's _TOC_ tag, except that it outputs an unordered list of all descendants of the current page, as determined by the page paths.}
+  spec.homepage      = "https://github.com/singlebrook/gollum-descendant_tree"
+  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|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.3"
+  spec.add_development_dependency "rake"
+  spec.add_development_dependency 'rspec', '~> 2.13'
+  spec.add_dependency "gollum", "~> 2.4.0"
+  spec.add_dependency "titleize", "~> 1.3"
+end

data/lib/gollum-descendant_tree.rb

@@ -0,0 +1,4 @@
+require "gollum/descendant_tree/version"
+require "gollum/markup"
+require "gollum/descendant_tree/tree_builder"
+require "gollum/descendant_tree/tree_renderer"

data/lib/gollum/descendant_tree/tree_builder.rb

@@ -0,0 +1,53 @@
+module Gollum
+  module DescendantTree
+    class TreeBuilder
+
+      def initialize (wiki, name)
+        @wiki = wiki
+        @name = name
+        @current_nest_index = 0
+      end
+
+      def tree
+        current_page_name = get_current_page_name
+        page_descendants = []
+        previous_page = ''
+        @wiki.pages.each do |page|
+          if (page.url_path.include?(current_page_name))
+            page_descendants << {
+              title: page.title,
+              url_path: page.url_path,
+              nest_index: get_current_index(page, previous_page)
+            }
+            previous_page = page
+          end
+          
+        end
+        page_descendants
+      end
+
+      private
+      
+      def get_current_index(current, previous)
+        return 0 if previous == ''
+        current_path_array = get_path_array(current)
+        previous_path_array = get_path_array(previous)
+        i = -1
+        previous_path_array.reverse_each do |node|
+          next if current_path_array.include?(node)
+          i += 1
+        end
+        @current_nest_index -= i
+      end
+
+      def get_current_page_name
+        @name.split('.').first
+      end
+
+      def get_path_array(page)
+        return page.url_path.split('/')
+      end
+
+    end  
+  end
+end

data/lib/gollum/descendant_tree/tree_renderer.rb

@@ -0,0 +1,38 @@
+require 'titleize'
+
+module Gollum
+  module DescendantTree
+    class TreeRenderer
+
+      def initialize
+        @previous_nest_index = 0
+      end
+
+      def render(tree)
+        output = "<ul class='tree'>\n"
+        tree.each do |page|
+          output += nest_for(page) if page[:nest_index] != 0
+          output += "<li><a href='/#{page[:url_path]}'>#{page[:title].titleize}</a>"
+        end
+        output += "</ul></li>\n"
+        output += "</ul>\n"
+        output
+      end
+
+      private
+
+      def nest_for(page)
+        output = ''
+        if page[:nest_index] == @previous_nest_index
+          output += "</li>\n"
+        elsif page[:nest_index] > @previous_nest_index
+          output += "<ul>\n"
+        else
+          output += "</li></ul>\n" * (@previous_nest_index - page[:nest_index])
+        end
+        @previous_nest_index = page[:nest_index]
+        output
+      end
+    end  
+  end
+end

data/lib/gollum/descendant_tree/version.rb

@@ -0,0 +1,5 @@
+module Gollum
+  module DescendantTree
+    VERSION = "0.0.1"
+  end
+end

data/lib/gollum/markup.rb

@@ -0,0 +1,19 @@
+module Gollum
+  class Markup
+
+    def render_with_descendant_tree (no_follow = false, encoding = nil)
+      data = render_without_descendant_tree(no_follow, encoding)
+      tree_builder = Gollum::DescendantTree::TreeBuilder.new(@wiki, @name)
+      tree = tree_builder.tree
+      tree_renderer = Gollum::DescendantTree::TreeRenderer.new
+      #[[_TREE_]] is already rendered from Markup.render
+      data.gsub(rendered_tree_link, tree_renderer.render(tree))
+    end
+    alias_method :render_without_descendant_tree, :render
+    alias_method :render, :render_with_descendant_tree
+
+    def rendered_tree_link 
+      '<a class="internal absent" href="/_TREE_">_TREE_</a>'
+    end
+  end
+end

data/spec/gollum/descendant_tree/markup_spec.rb

@@ -0,0 +1,6 @@
+require 'spec_helper'
+
+describe Gollum::Markup do
+  subject { Gollum::Markup }
+  #it { should alias_from(:render).to(:render_with_descendant_tree) }
+end

data/spec/gollum/descendant_tree/tree_builder_spec.rb

@@ -0,0 +1,24 @@
+require 'spec_helper'
+
+describe Gollum::DescendantTree::TreeBuilder do
+
+  it "returns the correct tree" do
+    wiki = double
+    wiki.stub(:pages).and_return(pages)
+    tree_builder = Gollum::DescendantTree::TreeBuilder.new(wiki, 'current_page.md')
+    expect(tree_builder.tree).to eq(tree_with_correct_nesting)
+  end
+
+  def pages
+    build_mock_pages
+  end
+
+  def tree_with_correct_nesting
+    [{:title=>"Current Page", :url_path=>"current_page", :nest_index=>0},
+      {:title=>"Child", :url_path=>"current_page/child", :nest_index=>1},
+      {:title=>"Grandchild", :url_path=>"current_page/child/grandchild", :nest_index=>2},
+      {:title=>"GreatGrandchild",:url_path=>"current_page/child/grandchild/greatgrandchild", :nest_index=>3},
+      {:title=>"Child Sibling", :url_path=>"current_page/child_sibling", :nest_index=>1}]
+  end
+
+end

data/spec/gollum/descendant_tree/tree_renderer_spec.rb

@@ -0,0 +1,27 @@
+require 'spec_helper'
+
+describe Gollum::DescendantTree::TreeRenderer do
+
+  it "correctly renders a tree with indexes" do
+    wiki = double
+    wiki.stub(:pages).and_return(pages)
+    tree_renderer = Gollum::DescendantTree::TreeRenderer.new
+    expect(tree_renderer.render(tree_with_nesting)).to eq(correct_output)
+  end
+
+  def pages
+    build_mock_pages
+  end
+
+  def correct_output
+    "<ul class='tree'>\n<li><a href='/current_page'>Current Page</a><ul>\n<li><a href='/current_page/child'>Child</a><ul>\n<li><a href='/current_page/child/grandchild'>Grandchild</a><ul>\n<li><a href='/current_page/child/grandchild/greatgrandchild'>GreatGrandchild</a></li></ul>\n</li></ul>\n<li><a href='/current_page/child_sibling'>Child Sibling</a></ul></li>\n</ul>\n"
+  end
+
+  def tree_with_nesting
+    [{:title=>"Current Page", :url_path=>"current_page", :nest_index=>0},
+      {:title=>"Child", :url_path=>"current_page/child", :nest_index=>1},
+      {:title=>"Grandchild", :url_path=>"current_page/child/grandchild", :nest_index=>2},
+      {:title=>"GreatGrandchild",:url_path=>"current_page/child/grandchild/greatgrandchild", :nest_index=>3},
+      {:title=>"Child Sibling", :url_path=>"current_page/child_sibling", :nest_index=>1}]
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,9 @@
+require 'rspec'
+require 'gollum/app'
+require 'gollum-descendant_tree'
+require 'support/test_helpers'
+
+
+RSpec.configure do |config|
+  config.include Gollum::DescendantTree::TestHelpers::PageMockFactory
+end

data/spec/support/test_helpers.rb

@@ -0,0 +1,30 @@
+module Gollum
+  module DescendantTree
+    module TestHelpers
+      module PageMockFactory
+        def build_mock_pages
+          pages_info = [
+            ['current_page', 'current_page.md', 'Current Page'],
+            ['current_page/child','child.md','Child'],
+            ['current_page/child/grandchild','grandchild.md','Grandchild'],
+            ['current_page/child/grandchild/greatgrandchild','greatgrandchild.md','GreatGrandchild'],
+            ['current_page/child_sibling', 'childsibling.md', 'Child Sibling']
+          ]
+          pages = []
+          pages_info.each do |page|
+            pages << create_page(page)
+          end
+          pages
+        end
+
+        def create_page(page_config)
+          page = double
+          page.stub(:url_path).and_return(page_config[0])
+          page.stub(:filename).and_return(page_config[1])
+          page.stub(:title).and_return(page_config[2])
+          page
+        end
+      end
+    end
+  end
+end

metadata

@@ -0,0 +1,126 @@
+--- !ruby/object:Gem::Specification
+name: gollum-descendant_tree
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+  prerelease: 
+platform: ruby
+authors:
+- Aaron Froehlich
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-07-05 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: &70271551146020 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :development
+  prerelease: false
+  version_requirements: *70271551146020
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: &70271551144980 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *70271551144980
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: &70271551141900 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '2.13'
+  type: :development
+  prerelease: false
+  version_requirements: *70271551141900
+- !ruby/object:Gem::Dependency
+  name: gollum
+  requirement: &70271551140480 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 2.4.0
+  type: :runtime
+  prerelease: false
+  version_requirements: *70271551140480
+- !ruby/object:Gem::Dependency
+  name: titleize
+  requirement: &70271551139500 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :runtime
+  prerelease: false
+  version_requirements: *70271551139500
+description: Provides a tag that can be used in gollum to output descedants of the
+  current page
+email:
+- aaron@singlebrook.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .rspec
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- gollum-descendant_tree.gemspec
+- lib/gollum-descendant_tree.rb
+- lib/gollum/descendant_tree/tree_builder.rb
+- lib/gollum/descendant_tree/tree_renderer.rb
+- lib/gollum/descendant_tree/version.rb
+- lib/gollum/markup.rb
+- spec/gollum/descendant_tree/markup_spec.rb
+- spec/gollum/descendant_tree/tree_builder_spec.rb
+- spec/gollum/descendant_tree/tree_renderer_spec.rb
+- spec/spec_helper.rb
+- spec/support/test_helpers.rb
+homepage: https://github.com/singlebrook/gollum-descendant_tree
+licenses:
+- MIT
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.15
+signing_key: 
+specification_version: 3
+summary: Descendant Tree is similar to Gollum's _TOC_ tag, except that it outputs
+  an unordered list of all descendants of the current page, as determined by the page
+  paths.
+test_files:
+- spec/gollum/descendant_tree/markup_spec.rb
+- spec/gollum/descendant_tree/tree_builder_spec.rb
+- spec/gollum/descendant_tree/tree_renderer_spec.rb
+- spec/spec_helper.rb
+- spec/support/test_helpers.rb