Merge branch 'lawitschka/conditional-menus'

Author: gregbell

lib/active_admin/menu_item.rb

@@ -62,6 +62,12 @@ def <=>(other)
       result = name <=> other.name if result == 0
       result
     end
+    
+    # Returns the display if block. If the block was not explicitly defined
+    # a default block always returning true will be returned.
+    def display_if_block
+      @display_if_block || lambda { |_| true }
+    end
 
   end  
 end

lib/active_admin/namespace.rb

@@ -190,7 +190,7 @@ def register_with_menu(config)
         # Update the url if it's already been created
         add_to[config.menu_item_name].url = config.route_collection_path
       else
-        add_to.add(config.menu_item_name, config.route_collection_path)
+        add_to.add(config.menu_item_name, config.route_collection_path, config.menu_item_priority, { :if => config.menu_item_display_if })
       end
     end
   end

lib/active_admin/resource.rb

@@ -136,6 +136,16 @@ def parent_menu_item_name
     def menu_item_name
       @menu_options[:label] || plural_resource_name
     end
+    
+    # Returns the items priority for altering the default sort order
+    def menu_item_priority
+      @menu_options[:priority] || 10
+    end
+    
+    # Returns a proc for deciding whether to display the menu item or not in the view
+    def menu_item_display_if
+      @menu_options[:if] || proc { true }
+    end
 
     # Should this resource be added to the menu system?
     def include_in_menu?

lib/active_admin/views/tabs_renderer.rb

@@ -22,6 +22,12 @@ def render_menu(menu)
       end
 
       def render_item(item)
+        if !call_method_or_proc_on(self, item.display_if_block)
+          return
+        elsif (!item.url or item.url == '#') and item.children.any? and (item.children.detect {|child| call_method_or_proc_on(self, child.display_if_block)}).nil?
+          return
+        end
+        
         content_tag :li, :id => item.dom_id, :class => [("current" if current?(item)), ("has_nested" unless item.children.blank?)].compact.join(" ") do
           unless item.children.blank?
             link_to(item.name, item.url || "#") + render_nested_menu(item)

spec/unit/menu_item_spec.rb

@@ -27,6 +27,12 @@ module ActiveAdmin
       item = MenuItem.new("Dashboard", "/admin", 10, :if => block )
       item.display_if_block.should == block
     end
+    
+    it "should have a default display if block always returning true" do
+      item = MenuItem.new("Dashboard", "/admin")
+      item.display_if_block.should be_instance_of(Proc)
+      item.display_if_block.call(self).should == true
+    end
 
     describe "url generation and caching" do
       it "should generate a url if it is a symbol" do

spec/unit/namespace_spec.rb

@@ -118,8 +118,40 @@ module ::Mock; class Resource; def self.has_many(arg1, arg2); end; end; end
       end
 
       describe "disabling the menu" do
-        # TODO
-        it "should not create a menu item"
+        before do
+          namespace.register Category do
+            menu false
+          end
+          namespace.load_menu!
+        end
+        it "should not create a menu item" do
+          namespace.menu["Categories"].should be_nil
+        end
+      end
+      
+      describe "setting menu priority" do
+        before do
+          namespace.register Category do
+            menu :priority => 2
+          end
+          namespace.load_menu!
+        end
+        it "should have a custom priority of 2" do
+          namespace.menu["Categories"].priority.should == 2
+        end
+      end
+      
+      describe "setting a condition for displaying" do
+        before do
+          namespace.register Category do
+            menu :if => proc { false }
+          end
+          namespace.load_menu!
+        end
+        it "should have a proc returning false" do
+          namespace.menu["Categories"].display_if_block.should be_instance_of(Proc)
+          namespace.menu["Categories"].display_if_block.call.should == false
+        end
       end
 
       describe "adding as a belongs to" do

spec/unit/resource_spec.rb

@@ -121,6 +121,27 @@ module ::Mock; class Resource; end; end
         end.parent_menu_item_name.should == "Blog"
       end
     end
+    
+    describe "menu item priority" do
+      it "should be 10 when not set" do
+        config.menu_item_priority.should == 10
+      end
+      it "should be settable" do
+        config.menu :priority => 2
+        config.menu_item_priority.should == 2
+      end
+    end
+    
+    describe "menu item display if" do
+      it "should be a proc always returning true if not set" do
+        config.menu_item_display_if.should be_instance_of(Proc)
+        config.menu_item_display_if.call.should == true
+      end
+      it "should be settable" do
+        config.menu :if => proc { false }
+        config.menu_item_display_if.call.should == false
+      end
+    end
 
     describe "route names" do
       let(:config){ ActiveAdmin.register Category }

spec/unit/tabs_renderer_spec.rb

@@ -13,6 +13,15 @@
     reports = menu["Reports"]
     reports.add "A Sub Reports", "/admin/a-sub-reports"
     reports.add "B Sub Reports", "/admin/b-sub-reports"
+    menu.add "Administration", "/admin/administration"
+    administration = menu["Administration"]
+    administration.add "User administration", '/admin/user-administration', 10, :if => proc { false }
+    menu.add "Management", "#"
+    management = menu["Management"]
+    management.add "Order management", '/admin/order-management', 10, :if => proc { false }
+    management.add "Bill management", '/admin/bill-management', 10, :if => :admin_logged_in?
+    
+    renderer.stub!(:admin_logged_in?).and_return(false)
   end
 
   it "should generate a ul" do
@@ -39,6 +48,26 @@
     html.should have_tag("li", :parent => { :tag => "ul" }, :attributes => {:id => "a_sub_reports"})
     html.should have_tag("li", :parent => { :tag => "ul" }, :attributes => {:id => "b_sub_reports"})
   end
+  
+  it "should not generate a link for user administration" do
+    html.should_not have_tag("a", "User administration", :attributes => { :href => '/admin/user-administration' })
+  end
+  
+  it "should generate the administration parent menu" do
+    html.should have_tag("a", "Administration", :attributes => { :href => '/admin/administration' })
+  end
+  
+  it "should not generate a link for order management" do
+    html.should_not have_tag("a", "Order management", :attributes => { :href => '/admin/order-management' })
+  end
+  
+  it "should not generate a link for bill management" do
+    html.should_not have_tag("a", "Bill management", :attributes => { :href => '/admin/bill-management' })
+  end
+  
+  it "should not generate the management parent menu" do
+    html.should_not have_tag("a", "Management", :attributes => { :href => '#' })
+  end
 
   describe "marking current item" do
     it "should add the 'current' class to the li" do