simple-navigation 1.1.2 → 1.2.0

data/CHANGELOG

@@ -1,3 +1,6 @@
+*1.2.0
+* added capability to add conditions to navigation-items (primary.item key, name, url, :if => Proc.new {current_user.admin?})
+
 *1.1.2
 
 * Bugfix: config now gets evaluated on every render_navigation call. Credits to Joël Azémar.

data/VERSION.yml

@@ -1,4 +1,4 @@
 --- 
 :major: 1
-:minor: 1
-:patch: 2
+:minor: 2
+:patch: 0

data/generators/navigation_config/templates/config/navigation.rb

@@ -13,16 +13,22 @@ SimpleNavigation::Configuration.run do |navigation|
     # key - a symbol which uniquely defines your navigation item in the scope of the primary_navigation
     # name - will be displayed in the rendered navigation. This can also be a call to your I18n-framework.
     # url - the address that the generated item links to. You can also use url_helpers (named routes, restful routes helper, url_for etc.)
-    # html_options - can be used to specify attributes that will be included in the rendered navigation item (e.g. id, class etc.)
+    # options - can be used to specify attributes that will be included in the rendered navigation item (e.g. id, class etc.)
     #
-    primary.item :key_1, 'name', url, html_options
+    primary.item :key_1, 'name', url, options
     
     # Add an item which has a sub navigation (same params, but with block)
-    primary.item :key_2, 'name', url, html_options do |sub_nav|
+    primary.item :key_2, 'name', url, options do |sub_nav|
       # Add an item to the sub navigation (same params again)
-      sub_nav.item :key_2_1, 'name', url, html_options
+      sub_nav.item :key_2_1, 'name', url, options
     end 
   
+    # You can also specify a condition-proc that needs to be fullfilled to display an item.
+    # Conditions are part of the options. They are evaluated in the context of the views,
+    # thus you can use all the methods and vars you have available in the views.
+    primary.item :key_3, 'Admin', url, :class => 'special', :if => Proc.new { current_user.admin? }
+    primary.item :key_4, 'Account', url, :unless => Proc.new { logged_in? }
+  
   end
   
 end

data/lib/simple_navigation/item_container.rb

@@ -19,11 +19,18 @@ module SimpleNavigation
     #
     # 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>html_options</tt> can be used to specify attributes that will be included in the rendered navigation item (e.g. id, class etc.)
+    # The <tt>options</tt> can be used to specify the following things:
+    # * <tt>html_attributes</tt> - will be included in the rendered navigation item (e.g. id, class etc.)
+    # * <tt>:if</tt> - Specifies a proc to call to determine if the item should
+    #   be rendered (e.g. <tt>:if => Proc.new { current_user.admin? }</tt>). The
+    #   proc should evaluate to a true or false value and is evaluated in the context of the view.
+    # * <tt>:unless</tt> - Specifies a proc to call to determine if the item should not
+    #   be rendered (e.g. <tt>:unless => Proc.new { current_user.admin? }</tt>). The
+    #   proc should evaluate to a true or false value and is evaluated in the context of the view.
     #
     # The <tt>block</tt> - if specified - will hold the item's sub_navigation.
-    def item(key, name, url, html_options={}, &block)
-      @items << Item.new(key, name, url, html_options, block)
+    def item(key, name, url, options={}, &block)
+      (@items << Item.new(key, name, url, options, block)) if should_add_item?(options)
     end
 
     # Returns the Item with the specified key, nil otherwise.
@@ -37,6 +44,25 @@ module SimpleNavigation
     def render(current_navigation, include_sub_navigation=false, current_sub_navigation=nil)
       self.renderer.new(current_navigation, current_sub_navigation).render(self, include_sub_navigation)
     end
+
+    private
+    
+    # partially borrowed from ActionSupport::Callbacks
+    def should_add_item?(options) #:nodoc:
+      [options.delete(:if)].flatten.compact.all? { |m| evaluate_method(m) } &&
+      ![options.delete(:unless)].flatten.compact.any? { |m| evaluate_method(m) }
+    end
+    
+    # partially borrowed from ActionSupport::Callbacks
+    def evaluate_method(method) #:nodoc:
+      case method
+        when Proc, Method
+          method.call
+        else
+          raise ArgumentError, ":if or :unless must be procs or lambdas"
+      end
+    end
+
     
   end
   

data/spec/lib/simple_navigation/item_container_spec.rb

@@ -17,36 +17,115 @@ describe SimpleNavigation::ItemContainer do
 
   describe 'item' do
     
-    context 'block given' do    
+    context 'unconditional item' do
+    
       before(:each) do
-        @sub_container = stub(:sub_container)
-        SimpleNavigation::ItemContainer.stub!(:new).and_return(@sub_container)
+        @item_container.stub!(:should_add_item?).and_return(true)
       end
+    
+      context 'block given' do    
+        before(:each) do
+          @sub_container = stub(:sub_container)
+          SimpleNavigation::ItemContainer.stub!(:new).and_return(@sub_container)
+        end
       
-      it "should should yield an new ItemContainer" do
-        @item_container.item('key', 'name', 'url', 'options') do |container|
-          container.should == @sub_container
+        it "should should yield an new ItemContainer" do
+          @item_container.item('key', 'name', 'url', 'options') do |container|
+            container.should == @sub_container
+          end
+        end
+        it "should create a new Navigation-Item with the given params and the specified block" do
+          SimpleNavigation::Item.should_receive(:new).with('key', 'name', 'url', 'options', @proc)
+          @item_container.item('key', 'name', 'url', 'options', &@proc)
+        end
+        it "should add the created item to the list of items" do
+          @item_container.items.should_receive(:<<)
+          @item_container.item('key', 'name', 'url', 'options') {}
         end
       end
-      it "should create a new Navigation-Item with the given params and the specified block" do
-        SimpleNavigation::Item.should_receive(:new).with('key', 'name', 'url', 'options', @proc)
-        @item_container.item('key', 'name', 'url', 'options', &@proc)
-      end
-      it "should add the created item to the list of items" do
-        @item_container.items.should_receive(:<<)
-        @item_container.item('key', 'name', 'url', 'options') {}
+    
+      context 'no block given' do
+        it "should create a new Navigation_item with the given params and nil as sub_navi" do
+          SimpleNavigation::Item.should_receive(:new).with('key', 'name', 'url', 'options', nil)
+          @item_container.item('key', 'name', 'url', 'options')
+        end
+        it "should add the created item to the list of items" do
+          @item_container.items.should_receive(:<<)
+          @item_container.item('key', 'name', 'url', 'options')
+        end
       end
+
     end
     
-    context 'no block given' do
-      it "should create a new Navigation_item with the given params and nil as sub_navi" do
-        SimpleNavigation::Item.should_receive(:new).with('key', 'name', 'url', 'options', nil)
-        @item_container.item('key', 'name', 'url', 'options')
-      end
-      it "should add the created item to the list of items" do
-        @item_container.items.should_receive(:<<)
-        @item_container.item('key', 'name', 'url', 'options')
+    context 'conditions given for item' do
+    
+      context '"if" given' do
+
+        before(:each) do
+          @options = {:if => Proc.new {@condition}}
+        end
+        
+        it "should remove if from options" do
+          @item_container.item('key', 'name', 'url', @options)
+          @options[:if].should be_nil
+        end
+        
+        context 'if evals to true' do
+          before(:each) do
+            @condition = true
+          end
+          it "should create a new Navigation-Item" do
+            SimpleNavigation::Item.should_receive(:new)
+            @item_container.item('key', 'name', 'url', @options)
+          end
+        end
+        
+        context 'if evals to false' do
+          before(:each) do
+            @condition = false
+          end
+          it "should not create a new Navigation-Item" do
+            SimpleNavigation::Item.should_not_receive(:new)
+            @item_container.item('key', 'name', 'url', @options)
+          end
+        end
+        
+        context '"unless" given' do
+          
+          before(:each) do
+            @options = {:unless => Proc.new {@condition}}
+          end
+          
+          
+          it "should remove unless from options" do
+            @item_container.item('key', 'name', 'url', @options)
+            @options[:unless].should be_nil
+          end
+          
+          context 'unless evals to false' do
+            before(:each) do
+              @condition = false
+            end
+            it "should create a new Navigation-Item" do
+              SimpleNavigation::Item.should_receive(:new)
+              @item_container.item('key', 'name', 'url', @options)
+            end
+          end
+
+          context 'unless evals to true' do
+            before(:each) do
+              @condition = true
+            end
+            it "should not create a new Navigation-Item" do
+              SimpleNavigation::Item.should_not_receive(:new)
+              @item_container.item('key', 'name', 'url', @options)
+            end
+          end
+        
+        end
+        
       end
+
     end
     
   end

data/spec/spec_helper.rb

@@ -1,5 +1,5 @@
 ENV["RAILS_ENV"] = "test"
-RAILS_ENV = "test"
+RAILS_ENV = "test" unless defined? RAILS_ENV
 require 'rubygems'
 require 'spec'
 require 'active_support'

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: simple-navigation
 version: !ruby/object:Gem::Version 
-  version: 1.1.2
+  version: 1.2.0
 platform: ruby
 authors: 
 - Andi Schacke
@@ -9,7 +9,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2009-04-18 00:00:00 +02:00
+date: 2009-05-10 00:00:00 +02:00
 default_executable: 
 dependencies: []