simple-navigation 3.6.0 → 3.7.0

data/CHANGELOG

@@ -1,3 +1,9 @@
+*3.7.0
+
+* Added new adapater for working with the Nanoc static site generation framework.
+* Fix issue #22 - last link in a breadcrumb trail may now be rendered as static text insted by supplying :static_leaf => true as an option
+* Allow breadcrumbs to be provided with link id and classes by supplying :allow_classes_and_ids => true as an option
+
 *3.6.0
 
 * Added linkless items functionality - the `url` parameter is now optional, items which aren't links will be rendered within a 'span' element rather than an 'a' element. `options` remain optional (defaults to an empty Hash).  `options` may be provided without providing a `url` (detected by checking if the '`url`' parameter is a Hash or otherwise).

data/VERSION

@@ -1 +1 @@
-3.6.0
+3.7.0

data/lib/simple_navigation.rb

@@ -46,6 +46,7 @@ module SimpleNavigation
       return :rails if defined?(Rails)
       return :padrino if defined?(Padrino)
       return :sinatra if defined?(Sinatra)
+      return :nanoc if defined?(Nanoc3)
       raise 'simple_navigation currently only works for Rails, Sinatra and Padrino apps'
     end
     
@@ -58,6 +59,8 @@ module SimpleNavigation
         SimpleNavigation::Adapters::Sinatra
       when :padrino
         SimpleNavigation::Adapters::Padrino
+      when :nanoc
+        SimpleNavigation::Adapters::Nanoc
       end
     end
 

data/lib/simple_navigation/adapters.rb

@@ -5,5 +5,6 @@ module SimpleNavigation
     autoload :Rails, 'simple_navigation/adapters/rails'
     autoload :Padrino, 'simple_navigation/adapters/padrino'
     autoload :Sinatra, 'simple_navigation/adapters/sinatra'
+    autoload :Nanoc, 'simple_navigation/adapters/nanoc'
   end
-end
+end

data/lib/simple_navigation/adapters/nanoc.rb

@@ -0,0 +1,45 @@
+module SimpleNavigation
+  module Adapters
+    class Nanoc < Base
+      class << self
+        def register(root)
+          SimpleNavigation.set_env(root, 'development')
+          Nanoc3::Context.send(:include, SimpleNavigation::Helpers)
+        end
+      end
+
+      def initialize(ctx)
+        @context = ctx
+      end
+
+      # Returns the context in which the config files will be evaluated
+      def context_for_eval
+        context
+      end
+      
+      # Returns true if the current request's url matches the specified url. 
+      # Used to determine if an item should be autohighlighted.
+      def current_page?(url)
+        path = context.item.path
+        path && path.chop == url
+      end
+      
+      # Returns a link with the specified name, url and options.
+      # Used for rendering.
+      def link_to(name, url, options={})
+        "<a href='#{url}' #{to_attributes(options)}>#{name}</a>"
+      end
+
+      # Returns a tag of the specified type, content and options.
+      # Used for rendering.
+      def content_tag(type, content, options={})
+        "<#{type} #{to_attributes(options)}>#{content}</#{type}>"
+      end
+
+      private
+      def to_attributes(options)
+        options.map {|k, v| v.nil? ? nil : "#{k}='#{v}'"}.compact.join(' ')
+      end
+    end
+  end
+end

data/lib/simple_navigation/core/item.rb

@@ -59,7 +59,7 @@ module SimpleNavigation
     # Returns the configured active_leaf_class if the item is the selected leaf,
     # nil otherwise
     def active_leaf_class
-      selected_by_condition? ? SimpleNavigation.config.active_leaf_class : nil
+      !selected_by_subnav? && selected_by_condition? ? SimpleNavigation.config.active_leaf_class : nil
     end
 
     # Returns the configured selected_class if the item is selected,

data/lib/simple_navigation/rendering/renderer/base.rb

@@ -65,7 +65,43 @@ module SimpleNavigation
       def expand_sub_navigation?(item)
         expand_all? || item.selected?
       end
-            
+
+      # to allow overriding when there is specific logic determining
+      # when a link should not be rendered (eg. breadcrumbs renderer
+      # does not render the final breadcrumb as a link when instructed
+      # not to do so.)
+      def suppress_link?(item)
+        item.url.nil?
+      end
+
+      # determine and return link or static content depending on
+      # item/renderer conditions.
+      def tag_for(item)
+        if suppress_link?(item)
+          content_tag('span', item.name, link_options_for(item).except(:method))
+        else
+          link_to(item.name, item.url, options_for(item))
+        end
+      end
+
+      # to allow overriding when link options should be special-cased
+      # (eg. links renderer uses item options for the a-tag rather
+      # than an li-tag).
+      def options_for(item)
+        link_options_for(item)
+      end
+
+      # Extracts the options relevant for the generated link
+      #
+      def link_options_for(item)
+        special_options = {:method => item.method, :class => item.selected_class}.reject {|k, v| v.nil? }
+        link_options = item.html_options[:link]
+        return special_options unless link_options
+        opts = special_options.merge(link_options)
+        opts[:class] = [link_options[:class], item.selected_class].flatten.compact.join(' ')
+        opts.delete(:class) if opts[:class].nil? || opts[:class] == ''
+        opts
+      end            
     end
   end
 end

data/lib/simple_navigation/rendering/renderer/breadcrumbs.rb

@@ -32,14 +32,21 @@ module SimpleNavigation
         @join_with ||= options[:join_with] || " "
       end
 
-      def tag_for(item)
-        if item.url.nil?
-          content_tag('span', item.name, item.html_options.except(:class,:id))
+      def suppress_link?(item)
+        super || (options[:static_leaf] && item.active_leaf_class)
+      end
+
+      # Extracts the options relevant for the generated link
+      #
+      def link_options_for(item)
+        if options[:allow_classes_and_ids]
+          opts = super
+          opts[:id] = "breadcrumb_#{opts[:id]}" if opts[:id]
+          opts
         else
-          link_to(item.name, item.url, {:method => item.method}.merge(item.html_options.except(:class,:id)))
+          {:method => item.method}.merge(item.html_options.except(:class,:id))
         end
       end
     end
-
   end
 end

data/lib/simple_navigation/rendering/renderer/links.rb

@@ -11,7 +11,6 @@ module SimpleNavigation
     # The ItemContainer's dom_class and dom_id are applied to the surrounding <div> element.
     #
     class Links < SimpleNavigation::Renderer::Base
-
       def render(item_container)
         div_content = item_container.items.inject([]) do |list, item|
           list << tag_for(item)
@@ -19,14 +18,10 @@ module SimpleNavigation
         content_tag(:div, div_content, {:id => item_container.dom_id, :class => item_container.dom_class})
       end
 
-      def tag_for(item)
-        if item.url.nil?
-          content_tag('span', item.name, item.html_options)
-        else
-          link_to(item.name, item.url, {:method => item.method}.merge(item.html_options))
-        end
+      protected
+      def options_for(item)
+        {:method => item.method}.merge(item.html_options)
       end
     end
-
   end
 end

data/lib/simple_navigation/rendering/renderer/list.rb

@@ -9,7 +9,6 @@ module SimpleNavigation
     # By default, the renderer sets the item's key as dom_id for the rendered <li> element unless the config option <tt>autogenerate_item_ids</tt> is set to false.
     # The id can also be explicitely specified by setting the id in the html-options of the 'item' method in the config/navigation.rb file.
     class List < SimpleNavigation::Renderer::Base
-
       def render(item_container)
         list_content = item_container.items.inject([]) do |list, item|
           li_options = item.html_options.reject {|k, v| k == :link}
@@ -25,31 +24,6 @@ module SimpleNavigation
           content_tag(:ul, list_content, {:id => item_container.dom_id, :class => item_container.dom_class}) 
         end
       end
-      
-      protected
-
-      def tag_for(item)
-        if item.url.nil?
-          content_tag('span', item.name, link_options_for(item).except(:method))
-        else
-          link_to(item.name, item.url, link_options_for(item))
-        end
-      end
-
-      # Extracts the options relevant for the generated link
-      #
-      def link_options_for(item)
-        special_options = {:method => item.method, :class => item.selected_class}.reject {|k, v| v.nil? }
-        link_options = item.html_options[:link]
-        return special_options unless link_options
-        opts = special_options.merge(link_options)
-        opts[:class] = [link_options[:class], item.selected_class].flatten.compact.join(' ')
-        opts.delete(:class) if opts[:class].nil? || opts[:class] == ''
-        opts
-      end
-      
-      
     end
-  
   end
 end

data/spec/lib/simple_navigation/rendering/renderer/breadcrumbs_spec.rb

@@ -45,6 +45,33 @@ describe SimpleNavigation::Renderer::Breadcrumbs do
             tag["class"].should be_nil
           end
         end
+
+        context 'with allow_classes_and_ids option' do
+          before(:each) do
+            @selection = HTML::Selector.new('div a').select(render(:users, :level => :all, :allow_classes_and_ids => true))
+          end
+          it "should render class and id" do
+            @selection.each do |tag|
+              raise unless tag.name == "a"
+              tag["id"].should_not be_nil
+              tag["class"].should_not be_nil
+            end
+          end
+        end
+
+        context 'with static_leaf option' do
+          before(:each) do
+            @selection = HTML::Selector.new('div *').select(render(:subnav1, :level => :all, :static_leaf => true))
+          end
+          it "should render link for non-leaes" do
+            @selection[0..-2].each do |tag|
+              tag.name.should == 'a'
+            end
+          end
+          it "should not render link for leaf" do
+            @selection.last.name.should == 'span'
+          end
+        end
       end
 
 

data/spec/spec_helper.rb

@@ -41,7 +41,7 @@ end
 
 def primary_items
   [
-    [:users, 'users', 'first_url', {:id => 'my_id'}],
+    [:users, 'users', 'first_url', {:id => 'my_id', :link => {:id => 'my_link_id'}}],
     [:invoices, 'invoices', 'second_url'],
     [:accounts, 'accounts', 'third_url', {:style => 'float:right', :link => {:style => 'float:left'}}],
     [:miscellany, 'miscellany']
@@ -77,10 +77,10 @@ def select_item(key)
   if(key == :subnav1)
     select_item(:invoices)
     primary_item(:invoices) do |item|
-      item.instance_variable_get(:@sub_navigation).items.find { |i| i.key == key}.stub!(:selected? => true)
+      item.instance_variable_get(:@sub_navigation).items.find { |i| i.key == key}.stub!(:selected? => true, :selected_by_condition? => true)
     end
   else
-    primary_item(key) {|item| item.stub!(:selected? => true, :selected_by_condition? => true) unless item.frozen?}
+    primary_item(key) {|item| item.stub!(:selected? => true) unless item.frozen?}
   end
 end
 

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: simple-navigation
 version: !ruby/object:Gem::Version 
-  hash: 31
+  hash: 27
   prerelease: false
   segments: 
   - 3
-  - 6
+  - 7
   - 0
-  version: 3.6.0
+  version: 3.7.0
 platform: ruby
 authors: 
 - Andi Schacke
@@ -16,7 +16,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2011-12-03 00:00:00 +00:00
+date: 2012-02-20 00:00:00 +00:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -101,6 +101,7 @@ files:
 - lib/simple_navigation.rb
 - lib/simple_navigation/adapters.rb
 - lib/simple_navigation/adapters/base.rb
+- lib/simple_navigation/adapters/nanoc.rb
 - lib/simple_navigation/adapters/padrino.rb
 - lib/simple_navigation/adapters/rails.rb
 - lib/simple_navigation/adapters/sinatra.rb