simple-navigation 3.0.2 → 3.1.0

data/CHANGELOG

@@ -1,3 +1,6 @@
+*3.1.0
+* added new helper method 'active_navigation_item_name' to render the name of the currently active item
+
 *3.0.2
 
 * dom_id and dom_class can now be set as option in the item's definition (useful for dynamic menu items).

data/VERSION

@@ -1 +1 @@
-3.0.2
+3.1.0

data/lib/simple_navigation.rb

@@ -113,6 +113,7 @@ module SimpleNavigation
 
     # Returns the active item container for the specified level. Valid levels are
     # * :all - in this case the primary_navigation is returned.
+    # * :leaves - the 'deepest' active item_container will be returned
     # * a specific level - the active item_container for the specified level will be returned
     # * a range of levels - the active item_container for the range's minimum will be returned
     #
@@ -121,6 +122,8 @@ module SimpleNavigation
       case level
       when :all
         self.primary_navigation
+      when :leaves
+        self.primary_navigation.active_leaf_container
       when Integer
         self.primary_navigation.active_item_container_for(level)
       when Range
@@ -142,7 +145,15 @@ module SimpleNavigation
     #   render_navigation(:renderer => :my_renderer)
     def register_renderer(renderer_hash)
       self.registered_renderers.merge!(renderer_hash)
-    end    
+    end
+    
+    private
+    
+    def apply_defaults(options)
+      options[:level] = options.delete(:levels) if options[:levels]
+      {:context => :default, :level => :all}.merge(options)
+    end
+    
 
   end
 

data/lib/simple_navigation/adapters/rails.rb

@@ -8,6 +8,7 @@ module SimpleNavigation
         SimpleNavigation.set_env(rails_root, rails_env)        
         ActionController::Base.send(:include, SimpleNavigation::Helpers)
         ActionController::Base.send(:helper_method, :render_navigation)
+        ActionController::Base.send(:helper_method, :active_navigation_item_name)
       end
       
       def initialize(context)

data/lib/simple_navigation/core/item_container.rb

@@ -103,6 +103,16 @@ module SimpleNavigation
       return nil unless selected_sub_navigation?
       return selected_item.sub_navigation.active_item_container_for(desired_level)
     end
+    
+    # Returns the deepest possible active item_container. 
+    # (recursively searches in the sub_navigation if this container has a selected sub_navigation). 
+    def active_leaf_container
+      if selected_sub_navigation?
+        selected_item.sub_navigation.active_leaf_container
+      else
+        self
+      end
+    end
 
     # Returns true if there are no items defined for this container.
     def empty?

data/lib/simple_navigation/rendering/helpers.rb

@@ -33,6 +33,37 @@ module SimpleNavigation
     # * <tt>:renderer</tt> - specify the renderer to be used for rendering the navigation. Either provide the Class or a symbol matching a registered renderer. Defaults to :list (html list renderer).
     def render_navigation(options={})
       options = apply_defaults(options)
+      load_config(options)
+      active_item_container = SimpleNavigation.active_item_container_for(options[:level])
+      active_item_container.render(options) unless active_item_container.nil?
+    end
+
+    # Returns the name of the currently active navigation item belonging to the specified level.
+    #
+    # The following options are supported:
+    # * <tt>:level</tt> - defaults to :all which returns the most specific/deepest selected item (the leaf).
+    #   Specify a specific level to only look for the selected item in the specified level of navigation (e.g. :level => 1 for primary_navigation etc...).
+    # * <tt>:context</tt> - specifies the context for which you would like to find the active navigation item. Defaults to :default which loads the default navigation.rb (i.e. config/navigation.rb).
+    #   If you specify a context then the plugin tries to load the configuration file for that context, e.g. if you call <tt>active_navigation_item_name(:context => :admin)</tt> the file config/admin_navigation.rb
+    #   will be loaded and used for searching the active item.
+    # * <tt>:items</tt> - you can specify the items directly (e.g. if items are dynamically generated from database). See SimpleNavigation::ItemsProvider for documentation on what to provide as items.
+    #
+    # Returns an empty string if no active item can be found for the specified options
+    def active_navigation_item_name(options={})
+      options = apply_defaults(options)
+      load_config(options)
+      options[:level] = :leaves if options[:level] == :all
+      active_item_container = SimpleNavigation.active_item_container_for(options[:level])
+      if active_item_container && !active_item_container.selected_item.nil?
+        active_item_container.selected_item.name
+      else
+        ''
+      end
+    end
+
+    private
+
+    def load_config(options)
       ctx = options.delete(:context)
       SimpleNavigation.init_adapter_from self
       SimpleNavigation.load_config(ctx) 
@@ -40,12 +71,8 @@ module SimpleNavigation
       SimpleNavigation.config.items(options[:items]) if options[:items]
       SimpleNavigation.handle_explicit_navigation if SimpleNavigation.respond_to?(:handle_explicit_navigation)
       raise "no primary navigation defined, either use a navigation config file or pass items directly to render_navigation" unless SimpleNavigation.primary_navigation
-      active_item_container = SimpleNavigation.active_item_container_for(options[:level])
-      active_item_container.render(options) unless active_item_container.nil?
     end
 
-    private
-
     def apply_defaults(options)
       options[:level] = options.delete(:levels) if options[:levels]
       {:context => :default, :level => :all}.merge(options)

data/spec/lib/simple_navigation/adapters/rails_spec.rb

@@ -29,6 +29,7 @@ describe SimpleNavigation::Adapters::Rails do
     end
     it "should install the helper methods in the controller" do
       ActionController::Base.should_receive(:helper_method).with(:render_navigation)
+      ActionController::Base.should_receive(:helper_method).with(:active_navigation_item_name)
       SimpleNavigation.register
     end
     

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

@@ -152,6 +152,30 @@ describe SimpleNavigation::ItemContainer do
       end
     end
   end
+  
+  describe 'active_leaf_container' do
+    context 'the current container has a selected subnavigation' do
+      before(:each) do
+        @item_container.stub!(:selected_sub_navigation? => true)
+        @sub_nav = stub(:sub_nav)
+        @selected_item = stub(:selected_item)
+        @item_container.stub!(:selected_item => @selected_item)
+        @selected_item.stub!(:sub_navigation => @sub_nav)
+      end
+      it "should call recursively on the sub_navigation" do
+        @sub_nav.should_receive(:active_leaf_container)
+        @item_container.active_leaf_container
+      end
+    end
+    context 'the current container is the leaf already' do
+      before(:each) do
+        @item_container.stub!(:selected_sub_navigation? => false)
+      end
+      it "should return itsself" do
+        @item_container.active_leaf_container.should == @item_container
+      end
+    end
+  end
 
   describe 'item' do
 

data/spec/lib/simple_navigation/rendering/helpers_spec.rb

@@ -5,7 +5,15 @@ describe SimpleNavigation::Helpers do
     include SimpleNavigation::Helpers
   end
 
-  before(:each) do
+  def blackbox_setup()
+    @controller = ControllerMock.new
+    @controller.stub!(:load_config)
+    setup_adapter_for :rails
+    primary_navigation = primary_container
+    SimpleNavigation.stub!(:primary_navigation => primary_navigation)
+  end
+
+  def whitebox_setup
     @controller = ControllerMock.new
     SimpleNavigation.stub!(:load_config)
     SimpleNavigation::Configuration.stub!(:eval_config)
@@ -14,8 +22,35 @@ describe SimpleNavigation::Helpers do
     SimpleNavigation.stub!(:config_file? => true)
   end
 
-  describe 'render_navigation' do
+  describe 'active_navigation_item_name' do
+    before(:each) do
+      blackbox_setup
+    end
+    context 'active item_container for desired level exists' do
+      context 'container has selected item' do
+        before(:each) do
+          select_item(:subnav1)
+        end
+        it {@controller.active_navigation_item_name(:level => 2).should == 'subnav1'}
+        it {@controller.active_navigation_item_name.should == 'subnav1'}
+        it {@controller.active_navigation_item_name(:level => 1).should == 'invoices'}
+        it {@controller.active_navigation_item_name(:level => :all).should == 'subnav1'}
+      end
+      context 'container does not have selected item' do
+        it {@controller.active_navigation_item_name.should == ''}
+      end
+    end
+    context 'no active item_container for desired level' do
+      it {@controller.active_navigation_item_name(:level => 5).should == ''}
+    end
+  end
 
+  describe 'render_navigation' do
+  
+    before(:each) do
+      whitebox_setup
+    end
+  
     describe 'regarding loading of the config-file' do
       context 'no options specified' do
         it "should load the config-file for the default context" do
@@ -23,7 +58,7 @@ describe SimpleNavigation::Helpers do
           @controller.render_navigation
         end
       end
-
+  
       context 'with options specified' do
         it "should load the config-file for the specified context" do
           SimpleNavigation.should_receive(:load_config).with(:my_context)
@@ -31,12 +66,12 @@ describe SimpleNavigation::Helpers do
         end
       end
     end
-
+  
     it "should eval the config on every request" do
       SimpleNavigation::Configuration.should_receive(:eval_config).with(:default)
       @controller.render_navigation
     end
-
+  
     describe 'regarding setting of items' do
       context 'not items specified in options' do
         it "should not set the items directly" do
@@ -54,14 +89,14 @@ describe SimpleNavigation::Helpers do
         end
       end
     end
-
+  
     describe 'no primary navigation defined' do
       before(:each) do
         SimpleNavigation.stub!(:primary_navigation => nil)
       end
       it {lambda {@controller.render_navigation}.should raise_error}
     end
-
+  
     context 'rendering of the item_container' do
       before(:each) do
         @active_item_container = stub(:item_container).as_null_object
@@ -87,14 +122,14 @@ describe SimpleNavigation::Helpers do
         end
       end
     end
-
+  
     context 'primary' do
       it "should call render on the primary_navigation (specifying level through options)" do
         @primary_navigation.should_receive(:render).with(:level => 1)
         @controller.render_navigation(:level => 1)
       end
     end
-
+  
     context 'secondary' do
       context 'with current_primary_navigation set' do
         before(:each) do
@@ -122,18 +157,20 @@ describe SimpleNavigation::Helpers do
           lambda {@controller.render_navigation(:level => 2)}.should_not raise_error
         end
       end
-
+  
     end
-
+  
     context 'unknown level' do
       it "should raise an error" do
         lambda {@controller.render_navigation(:level => :unknown)}.should raise_error(ArgumentError)
       end
     end
+  
   end
-
+  
   describe "should treat :level and :levels options the same" do
     before(:each) do
+      whitebox_setup
       @selected_item_container = stub(:selected_container).as_null_object
       SimpleNavigation.stub!(:active_item_container_for => @selected_item_container)
     end

data/spec/lib/simple_navigation_spec.rb

@@ -255,6 +255,12 @@ describe SimpleNavigation do
         SimpleNavigation.active_item_container_for(:all).should == @primary
       end
     end
+    context 'level is :leaves' do
+      it "should return the currently active leaf-container" do
+        @primary.should_receive(:active_leaf_container)
+        SimpleNavigation.active_item_container_for(:leaves)
+      end
+    end
     context 'level is a Range' do
       it "should take the min of the range to lookup the active container" do
         @primary.should_receive(:active_item_container_for).with(2)

data/spec/spec_helper.rb

@@ -48,7 +48,7 @@ def primary_items
 end
 
 def primary_container
-  container = SimpleNavigation::ItemContainer.new(0)
+  container = SimpleNavigation::ItemContainer.new(1)
   container.dom_id = 'nav_dom_id'
   container.dom_class = 'nav_dom_class'
   @items = primary_items.map {|params| SimpleNavigation::Item.new(container, *params)}
@@ -74,7 +74,7 @@ def select_item(key)
 end
 
 def subnav_container
-  container = SimpleNavigation::ItemContainer.new(1)
+  container = SimpleNavigation::ItemContainer.new(2)
   items = sub_items.map {|params| SimpleNavigation::Item.new(container, *params)}
   items.each {|i| i.stub!(:selected? => false)}
   container.instance_variable_set(:@items, items)
@@ -82,10 +82,15 @@ def subnav_container
 end
 
 def setup_renderer_for(renderer_class, framework, options)
+  setup_adapter_for framework
+  @renderer = renderer_class.new(options)
+end
+
+def setup_adapter_for(framework)
   adapter = case framework
   when :rails
     SimpleNavigation::Adapters::Rails.new(stub(:context, :view_context => ActionView::Base.new))
   end
   SimpleNavigation.stub!(:adapter => adapter)
-  @renderer = renderer_class.new(options)
+  adapter
 end

metadata

@@ -5,9 +5,9 @@ version: !ruby/object:Gem::Version
   prerelease: false
   segments: 
   - 3
+  - 1
   - 0
-  - 2
-  version: 3.0.2
+  version: 3.1.0
 platform: ruby
 authors: 
 - Andi Schacke
@@ -15,7 +15,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-11-01 00:00:00 +01:00
+date: 2010-12-27 00:00:00 +01:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency