middleman-navigation 1.0.2 → 1.0.3

data/.gitignore

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

data/Gemfile

@@ -2,3 +2,23 @@ source "http://rubygems.org"
 
 # Specify your gem's dependencies in middleman-navigation.gemspec
 gemspec
+
+group :development do
+  gem "rake",     "~> 0.9.2"
+  gem "rdoc",     "~> 3.9"
+  gem "yard",     "~> 0.8.0"
+end
+
+group :test do
+  gem "sinatra"
+  gem "cucumber", "~> 1.2.0"
+  gem "fivemat"
+  gem "aruba",    "~> 0.4.11"
+  gem "rspec",    "~> 2.7"
+  gem "timecop",  "~> 0.4.0"
+  gem "kramdown"
+  
+  platforms :ruby do
+    gem "redcarpet", "~> 2.1.1"
+  end
+end

data/History.md

@@ -0,0 +1,21 @@
+
+1.0.2 / 2013-01-28 
+==================
+
+  * Added support for including root node in navigation.
+
+1.0.1 / 2013-01-25 
+==================
+
+  * Added matcher to support active page detection for directory indexes.
+  * Refactored frontmatter defaults, monkey patching defaults into the frontmatter_manager until we're allowed to specify them via middleman.
+  * Added support for app http_prefix configuration.
+  * Refactored simple-navigation patch to duplicate less code.
+  * Prevented simple-navigation from remembering @selected on navigation items.
+  * Resolved current_path issue, refactored to not run on every request.
+  * Refactoring for middleman 3 and simple-navigation.
+
+1.0.0 / 2013-01-18 
+==================
+
+  * Removed things from .gitignore that should be in global config. See: https://help.github.com/articles/ignoring-files

data/Rakefile

@@ -1,13 +1,7 @@
-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
+require 'cucumber/rake/task'
+
+Cucumber::Rake::Task.new do |t|
+  t.cucumber_opts = %w{--format pretty}
 end
-Jeweler::RubygemsDotOrgTasks.new
+
+task :default => :cucumber

data/features/basic.feature

@@ -0,0 +1,14 @@
+Feature: Simple flat navigation
+  Scenario: Navigation should render
+    Given the Server is running at "basic-app"
+    When I go to "/index.html"
+    Then I should see "Home."
+    Then the Home menu item should be selected
+    When I go to "/subpage.html"
+    Then I should see "Subpage."
+    Then the Subpage menu item should be selected
+    Then the Another menu item should not be selected
+    When I go to "/another.html"
+    Then I should see "Subpage."
+    Then the Another menu item should be selected
+    Then the Subpage menu item should not be selected

data/features/step_definitions/nav_steps.rb

@@ -0,0 +1,6 @@
+Then /^the ([\w\s]+) menu item should (not )?be selected$/ do |name, negate|
+  expectation = negate ? :should_not : :should
+  doc = Nokogiri::HTML(@browser.last_response.body)
+  selected = doc.css('li.selected').map(&:content).join
+  selected.send(expectation, match(name))
+end

data/features/support/env.rb

@@ -0,0 +1,9 @@
+ENV["TEST"] = "true"
+ENV["AUTOLOAD_SPROCKETS"] = "false"
+
+PROJECT_ROOT_PATH = File.dirname(File.dirname(File.dirname(__FILE__)))
+require "sinatra"
+require "nokogiri"
+require "middleman-core"
+require "middleman-core/step_definitions"
+require File.join(PROJECT_ROOT_PATH, 'lib', 'middleman-navigation')

data/fixtures/basic-app/config.rb

@@ -0,0 +1 @@
+activate :navigation

data/fixtures/basic-app/source/another.erb

@@ -0,0 +1,7 @@
+---
+title: Another
+---
+
+Subpage.
+
+<%= render_navigation %>

data/fixtures/basic-app/source/index.erb

@@ -0,0 +1,7 @@
+---
+title: Home
+---
+
+Home.
+
+<%= render_navigation %>

data/fixtures/basic-app/source/subpage.erb

@@ -0,0 +1,7 @@
+---
+title: Subpage
+---
+
+Subpage.
+
+<%= render_navigation %>

data/lib/middleman-navigation/tree.rb

@@ -12,15 +12,21 @@ module Middleman
         end
       end
 
+      def self.with_defaults(navigation)
+        navigation = {} if navigation.blank?
+        Middleman::Navigation::FRONTMATTER_DEFAULTS.merge navigation
+      end
+
       def self.traverse(resource, navigation)
         children = visible_children(resource)
 
-        unless children.blank?
-          navigation.items do |level|
-            if resource == @root
-              add_navigation_node @root, level unless @root.data.navigation[:hidden]
-            end
+        navigation.items do |level|
+          if resource == @root
+            options = with_defaults @root.data.navigation
+            add_navigation_node @root, level unless options[:hidden]
+          end
 
+          unless children.blank?
             children.each do |child|
               add_navigation_node child, level
               traverse child, level
@@ -30,18 +36,19 @@ module Middleman
       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 = resource.children
+        visible.select!{|child| !with_defaults(child.data.navigation)[:hidden]}
+        visible.sort! {|a, b| with_defaults(a.data.navigation)[:weight] <=> with_defaults(b.data.navigation)[:weight]}
         visible
       end
 
       def self.add_navigation_node(node, level)
-        title = node.data.navigation[:title] || node.data.title
-        url = node.data.navigation[:destination] || node.url
+        options = with_defaults(node.data.navigation)
+        title = options[:title] || node.data.title
+        url = options[:destination] || node.url
 
-        level.item node.destination_path, title, url, :highlights_on => %r(#{url}(#{@app.index_file})?)
+        level.item node.destination_path, title, url, :highlights_on => %r(^#{url}(#{@app.index_file})?$)
       end
     end
   end
-end
+end

data/lib/middleman-navigation/version.rb

@@ -1,5 +1,5 @@
 module Middleman
   module Navigation
-    VERSION = "1.0.2"
+    VERSION = "1.0.3"
   end
 end

data/lib/middleman-navigation.rb

@@ -1,9 +1,12 @@
 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'
+
+require 'active_support/hash_with_indifferent_access'
+
 SimpleNavigation::config_file_paths << File.expand_path("../simple-navigation", __FILE__)
 
 module Middleman
@@ -13,7 +16,7 @@ module Middleman
       title: nil,
       destination: nil,
       weight: 0,
-    }.stringify_keys
+    }.with_indifferent_access
 
     class << self
       def registered(app)

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

@@ -1,11 +1,13 @@
 module SimpleNavigation
   module Adapters
     class Sinatra < Base
-      cattr_accessor :middleman_app
+      def self.middleman_app=(app)
+        @@middleman_app = app
+      end
 
       # 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 ||= @@middleman_app.nil? ? '/' : @@middleman_app.inst.http_prefix
         @prefix + request.path
       end
     end

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

@@ -1,11 +1,6 @@
-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
+class SimpleNavigation::Item
+  # We want simple-navigation to be forgetful about @selected.
+  def selected?
+    selected_by_config? || selected_by_subnav? || selected_by_condition?
   end
 end

data/middleman-navigation.gemspec

@@ -19,10 +19,11 @@ Gem::Specification.new do |s|
   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_dependency("middleman-core", ["~> 3.2.1"])
+  s.add_dependency("simple-navigation", ["> 3.0.0"])
 
-  s.add_development_dependency "rspec"
+  s.add_development_dependency "activesupport", ["~> 3.2.6"]
+  s.add_development_dependency "nokogiri"
   s.add_development_dependency "bundler"
   s.add_development_dependency "gem-release" # Seems a better fit than Jeweler.
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: middleman-navigation
 version: !ruby/object:Gem::Version
-  version: 1.0.2
+  version: 1.0.3
   prerelease: 
 platform: ruby
 authors:
@@ -10,24 +10,24 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-01-29 00:00:00.000000000 Z
+date: 2014-01-15 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
-  name: middleman
+  name: middleman-core
   requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
-    - - ! '>'
+    - - ~>
       - !ruby/object:Gem::Version
-        version: 3.0.0
+        version: 3.2.1
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     none: false
     requirements:
-    - - ! '>'
+    - - ~>
       - !ruby/object:Gem::Version
-        version: 3.0.0
+        version: 3.2.1
 - !ruby/object:Gem::Dependency
   name: simple-navigation
   requirement: !ruby/object:Gem::Requirement
@@ -45,7 +45,23 @@ dependencies:
       - !ruby/object:Gem::Version
         version: 3.0.0
 - !ruby/object:Gem::Dependency
-  name: rspec
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 3.2.6
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 3.2.6
+- !ruby/object:Gem::Dependency
+  name: nokogiri
   requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
@@ -102,10 +118,17 @@ extra_rdoc_files: []
 files:
 - .gitignore
 - Gemfile
+- History.md
 - README.markdown
 - Rakefile
+- features/basic.feature
+- features/step_definitions/nav_steps.rb
+- features/support/env.rb
+- fixtures/basic-app/config.rb
+- fixtures/basic-app/source/another.erb
+- fixtures/basic-app/source/index.erb
+- fixtures/basic-app/source/subpage.erb
 - 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
@@ -134,8 +157,9 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: middleman-navigation
-rubygems_version: 1.8.23
+rubygems_version: 1.8.24
 signing_key: 
 specification_version: 3
 summary: Add simple navigation helpers for your Middleman project
 test_files: []
+has_rdoc: 

data/lib/middleman-navigation/front_matter.rb

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