simple-navigation 3.5.1 → 3.6.0

data/CHANGELOG

@@ -1,3 +1,7 @@
+*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).
+
 *3.5.1
 
 * Fixed specs related to testing name_generator functionality - stub the name_generator method rather than calling it to ensure subsequent tests aren't affected.

data/VERSION

@@ -1 +1 @@
-3.5.1
+3.6.0

data/lib/simple_navigation/core/item.rb

@@ -8,16 +8,14 @@ module SimpleNavigation
     # see ItemContainer#item
     #
     # The subnavigation (if any) is either provided by a block or passed in directly as <tt>items</tt>
-    def initialize(container, key, name, url, options, items=nil, &sub_nav_block)
+    def initialize(container, key, name, url_or_options = {}, options_or_nil={}, items=nil, &sub_nav_block)
       @container = container
+      options = setup_url_and_options(url_or_options, options_or_nil)
       @container.dom_class = options.delete(:container_class) if options[:container_class]
       @container.dom_id = options.delete(:container_id) if options[:container_id]
       @key = key
       @method = options.delete(:method)
       @name = name
-      @url = url.instance_of?(Proc) ? url.call : url
-      @highlights_on = options.delete(:highlights_on)
-      @html_options = options
       if sub_nav_block || items
         @sub_navigation = ItemContainer.new(@container.level + 1)
         sub_nav_block.call @sub_navigation if sub_nav_block
@@ -95,7 +93,7 @@ module SimpleNavigation
           raise ArgumentError, ':highlights_on must be a Regexp, Proc or :subpath'
         end
       elsif auto_highlight?
-        !!(root_path_match? || SimpleNavigation.current_page?(url_without_anchor))
+        !!(root_path_match? || (url_without_anchor && SimpleNavigation.current_page?(url_without_anchor)))
       else
         false
       end
@@ -122,8 +120,24 @@ module SimpleNavigation
     end
 
     def url_without_anchor
-      url.split('#').first
+      url && url.split('#').first
     end
 
+    private
+    def setup_url_and_options(url_or_options, options_or_nil)
+      options = options_or_nil
+      url = url_or_options
+      case url_or_options
+      when Hash
+        # url_or_options is options (there is no url)
+        options = url_or_options
+      when Proc
+        @url = url.call
+      else
+        @url = url
+      end
+      @highlights_on = options.delete(:highlights_on)
+      @html_options = options
+    end
   end
 end

data/lib/simple_navigation/core/item_container.rb

@@ -19,7 +19,7 @@ module SimpleNavigation
     #
     # The <tt>name</tt> will be displayed in the rendered navigation. This can also be a call to your I18n-framework.
     #
-    # The <tt>url</tt> is the address that the generated item points to. You can also use url_helpers (named routes, restful routes helper, url_for etc.)
+    # The <tt>url</tt> is the address that the generated item points to. You can also use url_helpers (named routes, restful routes helper, url_for etc.) <tt>url</tt> is optional - items without URLs should not be rendered as links.
     #
     # The <tt>options</tt> can be used to specify the following things:
     # * <tt>any html_attributes</tt> - will be included in the rendered navigation item (e.g. id, class etc.)
@@ -34,8 +34,9 @@ module SimpleNavigation
     #   when the item should be highlighted, you can set a regexp which is matched againstthe current URI.
     #
     # The <tt>block</tt> - if specified - will hold the item's sub_navigation.
-    def item(key, name, url, options={}, &block)
-      (@items << SimpleNavigation::Item.new(self, key, name, url, options, nil, &block)) if should_add_item?(options)
+    def item(key, name, url_or_options = {}, options_or_nil = {}, &block)
+      options = url_or_options.is_a?(Hash) ? url_or_options : options_or_nil
+      (@items << SimpleNavigation::Item.new(self, key, name, url_or_options, options_or_nil, nil, &block)) if should_add_item?(options)
     end
 
     def items=(items)
@@ -143,4 +144,4 @@ module SimpleNavigation
 
   end
 
-end
+end

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

@@ -19,7 +19,7 @@ module SimpleNavigation
       def a_tags(item_container)
         item_container.items.inject([]) do |list, item|
           if item.selected?
-            list << link_to(item.name, item.url, {:method => item.method}.merge(item.html_options.except(:class,:id))) if item.selected?
+            list << tag_for(item) if item.selected?
             if include_sub_navigation?(item)
               list.concat a_tags(item.sub_navigation)
             end
@@ -31,6 +31,14 @@ module SimpleNavigation
       def join_with
         @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))
+        else
+          link_to(item.name, item.url, {:method => item.method}.merge(item.html_options.except(:class,:id)))
+        end
+      end
     end
 
   end

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

@@ -14,12 +14,19 @@ module SimpleNavigation
 
       def render(item_container)
         div_content = item_container.items.inject([]) do |list, item|
-          list << link_to(item.name, item.url, {:method => item.method}.merge(item.html_options))
+          list << tag_for(item)
         end.join
         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
+      end
     end
 
   end
-end
+end

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

@@ -13,7 +13,7 @@ module SimpleNavigation
       def render(item_container)
         list_content = item_container.items.inject([]) do |list, item|
           li_options = item.html_options.reject {|k, v| k == :link}
-          li_content = link_to(item.name, item.url, link_options_for(item))
+          li_content = tag_for(item)
           if include_sub_navigation?(item)
             li_content << render_sub_navigation_for(item)
           end
@@ -27,7 +27,15 @@ module SimpleNavigation
       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)

data/spec/lib/simple_navigation/core/item_container_spec.rb

@@ -220,6 +220,61 @@ describe SimpleNavigation::ItemContainer do
 
     end
 
+    context 'optional url and optional options' do
+      context 'item specifed without url or options' do
+        it 'should add the create item to the list of items' do
+          @item_container.items.should_receive(:<<)
+          @item_container.item('key', 'name')
+        end
+      end
+      context 'item specified with only a url' do
+        it 'should add the item to the list' do
+          @item_container.items.should_receive(:<<)
+          @item_container.item('key', 'name', 'url')
+        end
+      end
+      context 'item specified with only options' do        
+        context 'containing no conditions' do
+          it 'should add the created item to the list of items' do
+            @item_container.items.should_receive(:<<)
+            @item_container.item('key', 'name', {:option => true})
+          end
+        end
+        context 'containing negative condition' do
+          it 'should not add the created item to the list of items' do
+            @item_container.items.should_not_receive(:<<)
+            @item_container.item('key', 'name', {:if => lambda{false}, :option => true})
+          end
+        end
+        context 'containing positive condition' do
+          it 'should add the created item to the list of items' do
+            @item_container.items.should_receive(:<<)
+            @item_container.item('key', 'name', {:if => lambda{true}, :option => true})
+          end
+        end
+      end
+      context 'item specified with a url and options' do
+        context 'containing no conditions' do
+          it 'should add the created item to the list of items' do
+            @item_container.items.should_receive(:<<)
+            @item_container.item('key', 'name', 'url', {:option => true})
+          end
+        end
+        context 'containing negative condition' do
+          it 'should not add the created item to the list of items' do
+            @item_container.items.should_not_receive(:<<)
+            @item_container.item('key', 'name', 'url', {:if => lambda{false}, :option => true})
+          end
+        end
+        context 'containing positive condition' do
+          it 'should add the created item to the list of items' do
+            @item_container.items.should_receive(:<<)
+            @item_container.item('key', 'name', 'url', {:if => lambda{true}, :option => true})
+          end
+        end
+      end
+    end
+
     context 'conditions given for item' do
 
       context '"if" given' do

data/spec/lib/simple_navigation/core/item_spec.rb

@@ -114,8 +114,50 @@ describe SimpleNavigation::Item do
         end
         it {@item.url.should == 'my_url'}
       end
+      context 'url is nil' do
+        before(:each) do
+          @item = SimpleNavigation::Item.new(@item_container, :my_key, 'name', nil, {})
+        end
+        it {@item.url.should == nil}
+      end
+      context 'url is unspecified' do
+        before(:each) do
+          @item = SimpleNavigation::Item.new(@item_container, :my_key, 'name')
+        end
+        it {@item.url.should == nil}
+      end
     end
 
+    context 'optional url and optional options' do
+      context 'when constructed without any optional parameters' do
+        before(:each) do
+          @item = SimpleNavigation::Item.new(@item_container, :my_key, 'name')
+        end
+        it {@item.url.should == nil}
+        it {@item.instance_variable_get(:@html_options).should == {}}
+      end
+      context 'when constructed with only a url' do
+        before(:each) do
+          @item = SimpleNavigation::Item.new(@item_container, :my_key, 'name', 'url')
+        end
+        it {@item.url.should == 'url'}
+        it {@item.instance_variable_get(:@html_options).should == {}}
+      end
+      context 'when constructed with only options' do
+        before(:each) do
+          @item = SimpleNavigation::Item.new(@item_container, :my_key, 'name', {:option => true})
+        end
+        it {@item.url.should == nil}
+        it {@item.instance_variable_get(:@html_options).should == {:option => true}}
+      end
+      context 'when constructed with a url and options' do
+        before(:each) do
+          @item = SimpleNavigation::Item.new(@item_container, :my_key, 'name', 'url', {:option => true})
+        end
+        it {@item.url.should == 'url'}
+        it {@item.instance_variable_get(:@html_options).should == {:option => true}}
+      end
+    end
   end
 
   describe 'name' do
@@ -399,6 +441,11 @@ describe SimpleNavigation::Item do
             @adapter.should_receive(:current_page?).with('url')
             @item.send(:selected_by_condition?)
           end
+          it "should not be queried when url is nil" do
+            @item.stub!(:url => nil)
+            @adapter.should_not_receive(:current_page?)
+            @item.send(:selected_by_condition?)
+          end
           it {@item.send(:selected_by_condition?).should be_true}
         end
         context 'no match' do
@@ -438,6 +485,11 @@ describe SimpleNavigation::Item do
       @item.stub!(:url => '/bli')
       @item.send(:root_path_match?).should be_false
     end
+    it "should not match if url is nil" do
+      @adapter.stub(:request_path => 'bla')
+      @item.stub!(:url => nil)
+      @item.send(:root_path_match?).should be_false
+    end
   end
 
   describe 'auto_highlight?' do

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

@@ -55,4 +55,4 @@ describe SimpleNavigation::Renderer::Links do
     end
     
   end
-end
+end

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

@@ -24,11 +24,14 @@ describe SimpleNavigation::Renderer::List do
         HTML::Selector.new('ul.nav_dom_class').select(render).should have(1).entries
       end
       it "should render a li tag for each item" do
-        HTML::Selector.new('li').select(render).should have(3).entries
+        HTML::Selector.new('li').select(render).should have(4).entries
       end
-      it "should render an a-tag inside each li-tag" do
+      it "should render an a-tag inside each li-tag (for items with links)" do
         HTML::Selector.new('li a').select(render).should have(3).entries
       end
+      it "should render a span-tag inside each li-tag (for items without links)" do
+        HTML::Selector.new('li span').select(render).should have(1).entries
+      end
 
       context 'concerning item names' do
         context 'with a custom name generator defined' do

data/spec/spec_helper.rb

@@ -34,16 +34,17 @@ end
 # spec helper methods
 def sub_items
   [
-    [:subnav1, 'subnav1', 'subnav1_url', {}],
-    [:subnav2, 'subnav2', 'subnav2_url', {}]
+    [:subnav1, 'subnav1', 'subnav1_url'],
+    [:subnav2, 'subnav2', 'subnav2_url']
   ]
 end
 
 def primary_items
   [
     [:users, 'users', 'first_url', {:id => 'my_id'}],
-    [:invoices, 'invoices', 'second_url', {}],
-    [:accounts, 'accounts', 'third_url', {:style => 'float:right', :link => {:style => 'float:left'}}]
+    [:invoices, 'invoices', 'second_url'],
+    [:accounts, 'accounts', 'third_url', {:style => 'float:right', :link => {:style => 'float:left'}}],
+    [:miscellany, 'miscellany']
   ]
 end
 

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: simple-navigation
 version: !ruby/object:Gem::Version 
-  hash: 17
+  hash: 31
   prerelease: false
   segments: 
   - 3
-  - 5
-  - 1
-  version: 3.5.1
+  - 6
+  - 0
+  version: 3.6.0
 platform: ruby
 authors: 
 - Andi Schacke
@@ -16,7 +16,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2011-11-19 00:00:00 +00:00
+date: 2011-12-03 00:00:00 +00:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency