jekyll-nested-menu-generator 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: cb45ee0365553b9ac6faf9081ecebaed43379898
+  data.tar.gz: ba27088d82105b6d650f778e562f39599fdfd11d
+SHA512:
+  metadata.gz: e79a38174b5c91d361ae35a322369cfdf4ff5e31ae89213305ce5130157ce3c35e1d49a34a3abfee24cd80d232dc7968d9018d12336fb1c46700509c6f445059
+  data.tar.gz: 5f6eadad685e24fe6e1dd62ebaf45cd232130fdd1114d8960e873092701b3c94faee66d9b3b078a6b9a1b9197d1fff2593b5eb5fbcf7ee5294cfb09c389f3ccf

data/.ruby-version

@@ -0,0 +1 @@
+2.2.0

data/.travis.yml

@@ -0,0 +1,6 @@
+language: ruby
+rvm:
+  - 1.9.3-p547
+  - 2.1.5
+  - 2.2.0
+script: "bundle exec rspec"

data/Gemfile

@@ -0,0 +1,11 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in jekyll-swfobject.gemspec
+gemspec
+
+group :test do
+  gem "fakefs", require: "fakefs/safe"
+  gem 'nokogiri'
+  gem 'pry'
+  gem 'rspec'
+end

data/Gemfile.lock

@@ -0,0 +1,105 @@
+PATH
+  remote: .
+  specs:
+    jekyll-nested-menu-generator (0.0.1)
+      jekyll
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    blankslate (2.1.2.4)
+    celluloid (0.16.0)
+      timers (~> 4.0.0)
+    classifier-reborn (2.0.3)
+      fast-stemmer (~> 1.0)
+    coderay (1.1.0)
+    coffee-script (2.3.0)
+      coffee-script-source
+      execjs
+    coffee-script-source (1.9.0)
+    colorator (0.1)
+    diff-lcs (1.2.5)
+    execjs (2.3.0)
+    fakefs (0.6.5)
+    fast-stemmer (1.0.2)
+    ffi (1.9.6)
+    hitimes (1.2.2)
+    jekyll (2.5.3)
+      classifier-reborn (~> 2.0)
+      colorator (~> 0.1)
+      jekyll-coffeescript (~> 1.0)
+      jekyll-gist (~> 1.0)
+      jekyll-paginate (~> 1.0)
+      jekyll-sass-converter (~> 1.0)
+      jekyll-watch (~> 1.1)
+      kramdown (~> 1.3)
+      liquid (~> 2.6.1)
+      mercenary (~> 0.3.3)
+      pygments.rb (~> 0.6.0)
+      redcarpet (~> 3.1)
+      safe_yaml (~> 1.0)
+      toml (~> 0.1.0)
+    jekyll-coffeescript (1.0.1)
+      coffee-script (~> 2.2)
+    jekyll-gist (1.1.0)
+    jekyll-paginate (1.1.0)
+    jekyll-sass-converter (1.3.0)
+      sass (~> 3.2)
+    jekyll-watch (1.2.1)
+      listen (~> 2.7)
+    kramdown (1.5.0)
+    liquid (2.6.2)
+    listen (2.8.5)
+      celluloid (>= 0.15.2)
+      rb-fsevent (>= 0.9.3)
+      rb-inotify (>= 0.9)
+    mercenary (0.3.5)
+    method_source (0.8.2)
+    mini_portile (0.6.2)
+    nokogiri (1.6.6.2)
+      mini_portile (~> 0.6.0)
+    parslet (1.5.0)
+      blankslate (~> 2.0)
+    posix-spawn (0.3.9)
+    pry (0.10.1)
+      coderay (~> 1.1.0)
+      method_source (~> 0.8.1)
+      slop (~> 3.4)
+    pygments.rb (0.6.2)
+      posix-spawn (~> 0.3.6)
+      yajl-ruby (~> 1.2.0)
+    rb-fsevent (0.9.4)
+    rb-inotify (0.9.5)
+      ffi (>= 0.5.0)
+    redcarpet (3.2.2)
+    rspec (3.2.0)
+      rspec-core (~> 3.2.0)
+      rspec-expectations (~> 3.2.0)
+      rspec-mocks (~> 3.2.0)
+    rspec-core (3.2.0)
+      rspec-support (~> 3.2.0)
+    rspec-expectations (3.2.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.2.0)
+    rspec-mocks (3.2.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.2.0)
+    rspec-support (3.2.0)
+    safe_yaml (1.0.4)
+    sass (3.4.11)
+    slop (3.6.0)
+    timers (4.0.1)
+      hitimes
+    toml (0.1.2)
+      parslet (~> 1.5.0)
+    yajl-ruby (1.2.1)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  fakefs
+  jekyll-nested-menu-generator!
+  nokogiri
+  pry
+  rspec

data/LICENSE.md

@@ -0,0 +1,27 @@
+Copyright (c) 2015, GovDelivery, Inc.
+All rights reserved.
+
+Redistribution and use in source and binary forms, with or without 
+modification, are permitted provided that the following conditions are met:
+
+1. Redistributions of source code must retain the above copyright notice, this 
+   list of conditions and the following disclaimer.
+
+2. Redistributions in binary form must reproduce the above copyright notice, 
+   this list of conditions and the following disclaimer in the documentation 
+   and/or other materials provided with the distribution.
+
+3. Neither the name of GovDelivery nor the names of its contributors may be 
+   used to endorse or promote products derived from this software without 
+   specific prior written permission.
+
+THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
+ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED 
+WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE 
+DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE 
+FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL 
+DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR 
+SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER 
+CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, 
+OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE 
+OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

data/README.md

@@ -0,0 +1,23 @@
+[![Build Status](https://travis-ci.org/govdelivery/jekyll-nested-menu-generator.svg?branch=master)](https://travis-ci.org/govdelivery/jekyll-nested-menu-generator)
+[![Gem Version](https://badge.fury.io/rb/jekyll-nested-menu-generator.svg)](http://badge.fury.io/rb/jekyll-nested-menu-generator)
+
+jekyll-nested-menu-generator
+=======================
+
+Provides a tag that will generated a nested navigation menu for files contained
+in a specified folder. Generated menus are cached during site build.
+
+## Installation
+
+Add the following to your application's Gemfile:
+
+    gem 'jekyll-nested-menu-generator'
+
+and then execute:
+
+    bundle install
+
+Or install it manually:
+
+    gem install jekyll-nested-menu-generator
+

data/jekyll-nested-menu-generator.gemspec

@@ -0,0 +1,19 @@
+Gem::Specification.new do |s|
+  s.name        = 'jekyll-nested-menu-generator'
+  s.version     = '0.0.1'
+  s.date        = '2015-02-04'
+  s.authors     = ['GovDelivery']
+  s.email       = 'support@govdelivery.com'
+  s.homepage    = 'https://github.com/govdelivery/jekyll-nested-menu-generator'
+  s.license     = 'BSD-3-Clause'
+  s.summary     = 'Tag for generating a nested navigation menu.'
+  s.description = %q{Provides a tag that generates a nested navigation menu for
+                     a specificed folder. Useful for automatically generating
+                     a multilevel menu that mirrors your directory structure,
+                     or generating a menu of generated pages.}
+
+  s.add_runtime_dependency 'jekyll'
+
+  s.files        = `git ls-files`.split($\)
+  s.require_paths = ['lib']
+end

data/lib/jekyll-nested-menu-generator.rb

@@ -0,0 +1,75 @@
+module Jekyll
+
+  class NestedMenuTag < Liquid::Tag
+
+    def initialize(tag_name, menu_root, tokens)
+      @menu_root = menu_root.strip
+      super
+    end
+
+    def render(context)
+      menu(context)
+    end
+
+    private
+      def menu(context)
+        site_data_key = "#{@menu_root}_menu_items"
+        root_string = "/#{@menu_root}" 
+        if not context['site']['data'].include?(site_data_key)
+          menu_hash = {}
+          menu_items = ''
+          context['site']['pages'].find_all{|page| page.url.start_with?(root_string)}.each do |page|
+            path_parts = page.path.split('/')
+            path_parts.shift
+            menu_hash = build_menu_hash(page, path_parts, menu_hash)
+          end
+
+          context['site']['data'][site_data_key] = build_menu_string(menu_hash)
+        end
+
+        context['site']['data'][site_data_key]
+      end
+
+      def build_menu_hash(page, path_parts, menu_hash=nil)
+        if path_parts.empty?
+          return page
+        end
+
+        menu_hash = {} if menu_hash.nil?
+        path_part = path_parts.shift
+
+        menu_hash[path_part] = build_menu_hash(page, path_parts, menu_hash[path_part])
+
+        menu_hash
+      end
+
+      def build_menu_string(menu_hash)
+        menu_string = ''
+        menu_hash.each do |dir_name, dir|
+          item_string_part = ''
+
+          # Seperate the child pages from other decendent pages
+          if dir.is_a?(Jekyll::Page)
+            dir_hash = {}
+            dir_hash[dir.name] = dir
+            dir = dir_hash
+          end
+          pages = dir.select{ |k, v| v.is_a?(Jekyll::Page) }
+          dir = dir.reject{ |k, v| v.is_a?(Jekyll::Page) } 
+
+          pages.each do |file_name, page|
+            item_string_part << "<a href='#{page.url}'>#{page.data['title'].split('/').last}</a>"
+          end
+
+          if not dir.empty?
+            item_string_part << build_menu_string(dir)
+          end
+
+          menu_string << "<li>#{item_string_part}</li>"
+        end
+        "<ul>#{menu_string}</ul>"
+      end
+  end
+end
+
+Liquid::Template.register_tag('nested_menu', Jekyll::NestedMenuTag)

data/spec/nested_menu_spec.rb

@@ -0,0 +1,70 @@
+require_relative './spec_helper.rb'
+
+def test_content
+  content = <<EOF
+---
+title: Test!
+---
+
+I'm testing things
+EOF
+end
+
+describe 'nested_menu', fakefs:true do
+
+  def setup_page(*args)
+    dir, file = args
+    dir, file = ['', dir] if file.nil?
+    @page = Page.new(@site, source_dir, dir, file)
+  end
+
+
+
+  let(:page) { '{% nested_menu files %}' }
+
+  before(:all) do
+    FakeFS.activate!
+    @site = Jekyll::Site.new(Jekyll.configuration({
+      "source" => source_dir,
+      "destination" => dest_dir,
+      "skip_config_files" => true
+    }))
+
+    [
+      'files/one',
+      'files/two',
+      'files/three',
+      'files/one/a',
+      'files/one/b',
+      'content',
+      'images'
+    ].each do |dir|
+      FileUtils.mkdir_p(File.join(source_dir, dir)) if not File.directory? File.join(source_dir, dir)
+      File.open(File.join(source_dir, dir, 'index.md'), 'w') { |f| f << test_content }
+      @site.pages << Jekyll::Page.new(@site, source_dir, dir, 'index.md')
+    end
+  end
+
+  after(:all) do
+    FakeFS.deactivate!
+  end
+
+  it 'Yields a nested menu of items in the specificed folder' do
+    t = Liquid::Template.parse(page)
+    o = t.render!({'site' => {
+        'pages' => @site.pages,
+        'data' => {}
+      }})
+
+    o_obj = Nokogiri::XML.parse(o)
+    expect(o_obj.xpath('/ul')).not_to be_empty
+    expect(o_obj.xpath('/ul/li[1]/a[.="Test!"][@href="/files/one/index.html"]')).not_to be_empty
+    expect(o_obj.xpath('/ul/li[2]/a[.="Test!"][@href="/files/two/index.html"]')).not_to be_empty
+    expect(o_obj.xpath('/ul/li[3]/a[.="Test!"][@href="/files/three/index.html"]')).not_to be_empty
+    expect(o_obj.xpath('/ul/li[1]/ul/li[1]/a[.="Test!"][@href="/files/one/a/index.html"]')).not_to be_empty
+    expect(o_obj.xpath('/ul/li[1]/ul/li[2]/a[.="Test!"][@href="/files/one/b/index.html"]')).not_to be_empty
+    expect(o_obj.xpath('//a[@href="/content/index.html"]')).to be_empty
+    expect(o_obj.xpath('//a[@href="/images/index.html"]')).to be_empty
+
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,21 @@
+require 'jekyll'
+require 'rspec'
+require 'nokogiri'
+require 'fakefs/spec_helpers'
+require_relative '../lib/jekyll-nested-menu-generator.rb'
+
+RSpec.configure do |config|
+  config.include FakeFS::SpecHelpers, fakefs:true
+end
+
+def dest_dir(*subdirs)
+  test_dir('dest', *subdirs)
+end
+
+def source_dir(*subdirs)
+  test_dir('source', *subdirs)
+end
+
+def test_dir(*subdirs)
+  File.join(File.dirname(__FILE__), *subdirs)
+end

metadata

@@ -0,0 +1,71 @@
+--- !ruby/object:Gem::Specification
+name: jekyll-nested-menu-generator
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- GovDelivery
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-02-04 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: jekyll
+  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: |-
+  Provides a tag that generates a nested navigation menu for
+                       a specificed folder. Useful for automatically generating
+                       a multilevel menu that mirrors your directory structure,
+                       or generating a menu of generated pages.
+email: support@govdelivery.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".ruby-version"
+- ".travis.yml"
+- Gemfile
+- Gemfile.lock
+- LICENSE.md
+- README.md
+- jekyll-nested-menu-generator.gemspec
+- lib/jekyll-nested-menu-generator.rb
+- spec/nested_menu_spec.rb
+- spec/spec_helper.rb
+homepage: https://github.com/govdelivery/jekyll-nested-menu-generator
+licenses:
+- BSD-3-Clause
+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.4.5
+signing_key: 
+specification_version: 4
+summary: Tag for generating a nested navigation menu.
+test_files: []