middleman-navigation 1.0.0

data/.gitignore

@@ -0,0 +1,4 @@
+*.gem
+.bundle
+Gemfile.lock
+.rvmrc

data/Gemfile

@@ -0,0 +1,4 @@
+source "http://rubygems.org"
+
+# Specify your gem's dependencies in middleman-navigation.gemspec
+gemspec

data/README.markdown

@@ -0,0 +1,57 @@
+This gem adds simple helpers to [Middleman](http://middlemanapp.com) static site generator 
+to add navigation menus and breadcrumbs.
+
+This version of the gem requires Middleman 3, and renders using [Simple Navigation](https://github.com/andi/simple-navigation) and its helpers. 
+
+*The implementation and options are significantly different from earlier versions!* If you'd like the old approach, see the tag for v0.2.
+
+# Installation
+
+1. add the gem in your Gemfile:
+
+      gem "middleman-navigation"
+
+2. run bundler
+
+      bundle install
+
+3. include it in your config.rb file
+
+      activate :navigation
+
+# Usage
+
+The gem adds a menu helper to Middleman.
+
+## Menu
+
+Automatic generate menu reading pages at project root folder.
+
+Example:
+
+    = render_navigation
+
+
+### Metadata
+
+The behaviour of the menu can be changed by adding options to your pages' frontmatter.
+
+Example:
+
+    ---
+    navigation:
+      weight: 80
+      title:  Custom Title
+      hidden: false
+    ---
+
+    Here you have the actual page source
+
+
+*hidden*: option explicitly remove the current page from it's parent menu. By default all pages with an underscore in the beginning or end of their source file name are hidden
+
+*weight*: is used to alter the order of the links in the navigation menu (the smaller the weight, the earlier the page will be listed)
+
+*title*: is used to set a custom title to menu, default to file name
+
+

data/Rakefile

@@ -0,0 +1,13 @@
+require 'jeweler'
+Jeweler::Tasks.new do |gem|
+  # gem is a Gem::Specification... see http://docs.rubygems.org/read/chapter/20 for more options
+  gem.name = "middleman-navigation"
+  gem.homepage = "http://github.com/michaek/middleman-navigation"
+  gem.license = "MIT"
+  gem.summary = %q{Add simple navigation helpers for your Middleman project}
+  gem.description = %q{Add simple navigation helpers for your Middleman project}
+  gem.email = ["giovanni.cangiani@epfl.ch", "m@hellm.com"]
+  gem.authors = ["Giovanni Cangiani", "Michael Hellein"]
+  # dependencies defined in Gemfile
+end
+Jeweler::RubygemsDotOrgTasks.new

data/lib/middleman-navigation.rb

@@ -0,0 +1,34 @@
+require 'middleman-navigation/tree'
+require 'middleman-navigation/resource_list_manipulator'
+require 'middleman-navigation/front_matter'
+require 'simple-navigation'
+require 'simple-navigation/adapters/sinatra-middleman'
+require 'simple-navigation/core/item'
+SimpleNavigation::config_file_paths << File.expand_path("../simple-navigation", __FILE__)
+
+module Middleman
+  module Navigation
+    FRONTMATTER_DEFAULTS = {
+      hidden: false,
+      title: nil,
+      destination: nil,
+      weight: 0,
+    }.stringify_keys
+
+    class << self
+      def registered(app)
+        # Make a reference to the app on our patched simple-navigation Sinatra 
+        # adapter so we can use the app's settings for proper URLs.
+        SimpleNavigation::Adapters::Sinatra.middleman_app = app
+
+        app.helpers SimpleNavigation::Helpers
+        app.ready do
+          sitemap.register_resource_list_manipulator :navigation, ResourceListManipulator.new(sitemap)
+        end
+      end
+      alias :included :registered
+    end
+  end
+end
+
+::Middleman::Extensions.register(:navigation, Middleman::Navigation) 

data/lib/middleman-navigation/front_matter.rb

@@ -0,0 +1,27 @@
+# This approach to defaults is gross, and it doesn't belong here!
+# TODO: There should be a way in middleman for extensions to provide frontmatter defaults.
+# TODO: Remove this when middleman supports that.
+module Middleman::CoreExtensions
+  module FrontMatter
+    class FrontmatterManager
+      def with_defaults(data)
+        unless data.first.blank?
+          data.first['navigation'] ||= {}
+          data.first['navigation'].reverse_merge! Middleman::Navigation::FRONTMATTER_DEFAULTS
+        end
+        data
+      end
+
+      def parse_yaml_front_matter_with_defaults(content)
+        with_defaults parse_yaml_front_matter_without_defaults(content)
+      end
+
+      def parse_json_front_matter_with_defaults(content)
+        with_defaults parse_json_front_matter_without_defaults(content)
+      end
+
+      alias_method_chain :parse_yaml_front_matter, :defaults
+      alias_method_chain :parse_json_front_matter, :defaults
+    end
+  end
+end

data/lib/middleman-navigation/resource_list_manipulator.rb

@@ -0,0 +1,13 @@
+module Middleman
+  module Navigation
+    class ResourceListManipulator
+      def initialize(sitemap)
+        @sitemap = sitemap
+      end
+      def manipulate_resource_list(resources)
+        Tree.build @sitemap
+        resources
+      end      
+    end
+  end
+end

data/lib/middleman-navigation/tree.rb

@@ -0,0 +1,40 @@
+module Middleman
+  module Navigation
+    class Tree
+      def self.build(sitemap)
+        app = sitemap.app
+        root_path = app.http_prefix + app.index_file
+        root = sitemap.find_resource_by_destination_path root_path
+
+        unless root.blank?
+          SimpleNavigation::Configuration.run do |navigation|
+            traverse(root, navigation)
+          end
+        end
+      end
+
+      def self.traverse(resource, navigation)
+        children = visible_children(resource)
+
+        unless children.blank?
+          navigation.items do |level|
+            children.each do |child|
+              title = child.data.navigation[:title] || child.data.title
+              url = child.data.navigation[:destination] || child.url
+
+              level.item child.destination_path, title, url
+              traverse child, level
+            end
+          end
+        end
+      end
+
+      def self.visible_children(resource)
+        visible = resource.children.select {|child| child.data.navigation.present?}
+        visible.select!{|child| !child.data.navigation[:hidden]}
+        visible.sort! {|a, b| a.data.navigation[:weight] <=> b.data.navigation[:weight]}
+        visible
+      end
+    end
+  end
+end

data/lib/middleman-navigation/version.rb

@@ -0,0 +1,5 @@
+module Middleman
+  module Navigation
+    VERSION = "1.0.0"
+  end
+end

data/lib/middleman_extension.rb

@@ -0,0 +1 @@
+require 'middleman-navigation'

data/lib/simple-navigation/adapters/sinatra-middleman.rb

@@ -0,0 +1,13 @@
+module SimpleNavigation
+  module Adapters
+    class Sinatra < Base
+      cattr_accessor :middleman_app
+
+      # Our request doesn't have a fullpath, so we must return path instead.
+      def request_uri
+        @prefix ||= middleman_app.nil? ? '/' : middleman_app.inst.http_prefix
+        @prefix + request.path
+      end
+    end
+  end
+end

data/lib/simple-navigation/core/item.rb

@@ -0,0 +1,11 @@
+module SimpleNavigation
+  class Item
+    # We want simple-navigation to be forgetful about @selected.
+    def selected_with_forgetfulness?
+      is_selected = selected_without_forgetfulness?
+      @selected = nil
+      is_selected
+    end
+    alias_method_chain :selected?, :forgetfulness
+  end
+end

data/lib/simple-navigation/navigation.rb

@@ -0,0 +1,2 @@
+# This file is a stub to prevent simple-navigation from complaining about its absence.
+# All the real work goes on in middleman-navigation.rb.

data/middleman-navigation.gemspec

@@ -0,0 +1,28 @@
+# -*- encoding: utf-8 -*-
+$:.push File.expand_path("../lib", __FILE__)
+require "middleman-navigation/version"
+
+Gem::Specification.new do |s|
+  s.name        = "middleman-navigation"
+  s.version     = Middleman::Navigation::VERSION
+  s.platform    = Gem::Platform::RUBY
+  s.authors     = ["Giovanni Cangiani", "Michael Hellein"]
+  s.email       = ["giovanni.cangiani@epfl.ch", "m@hellm.com"]
+  s.homepage    = "https://github.com/multiscan/middleman-navigation"
+  s.summary     = %q{Add simple navigation helpers for your Middleman project}
+  s.description = %q{Add simple navigation helpers for your Middleman project}
+
+  s.rubyforge_project = "middleman-navigation"
+
+  s.files         = `git ls-files`.split("\n")
+  s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
+  s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
+  s.require_paths = ["lib"]
+  
+  s.add_runtime_dependency("middleman", ["> 3.0.0"])
+  s.add_runtime_dependency("simple-navigation", ["> 3.0.0"])
+
+  s.add_development_dependency "rspec"
+  s.add_development_dependency "bundler"
+  s.add_development_dependency "gem-release" # Seems a better fit than Jeweler.
+end

metadata

@@ -0,0 +1,141 @@
+--- !ruby/object:Gem::Specification
+name: middleman-navigation
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+  prerelease: 
+platform: ruby
+authors:
+- Giovanni Cangiani
+- Michael Hellein
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-01-20 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: middleman
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>'
+      - !ruby/object:Gem::Version
+        version: 3.0.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>'
+      - !ruby/object:Gem::Version
+        version: 3.0.0
+- !ruby/object:Gem::Dependency
+  name: simple-navigation
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>'
+      - !ruby/object:Gem::Version
+        version: 3.0.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>'
+      - !ruby/object:Gem::Version
+        version: 3.0.0
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: gem-release
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Add simple navigation helpers for your Middleman project
+email:
+- giovanni.cangiani@epfl.ch
+- m@hellm.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- README.markdown
+- Rakefile
+- lib/middleman-navigation.rb
+- lib/middleman-navigation/front_matter.rb
+- lib/middleman-navigation/resource_list_manipulator.rb
+- lib/middleman-navigation/tree.rb
+- lib/middleman-navigation/version.rb
+- lib/middleman_extension.rb
+- lib/simple-navigation/adapters/sinatra-middleman.rb
+- lib/simple-navigation/core/item.rb
+- lib/simple-navigation/navigation.rb
+- middleman-navigation.gemspec
+homepage: https://github.com/multiscan/middleman-navigation
+licenses: []
+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: middleman-navigation
+rubygems_version: 1.8.23
+signing_key: 
+specification_version: 3
+summary: Add simple navigation helpers for your Middleman project
+test_files: []