simple-navigation 2.1.0 → 2.2.0

data/CHANGELOG

@@ -1,3 +1,9 @@
+*2.2.0
+
+* Allow Ranges for :level option. Credits to Ying Tsen Hong.
+* Changing the API of Helpers#render_navigation. Now supports Ranges for :level option and :expand_all to render all levels as expanded. Old Api is still supported, but deprecated.
+* Deprecated render_all_levels in config-file.
+
 *2.1.0
 
 * included Ben Marini's commit which allows individual id-generators. Thanks Ben!

data/VERSION.yml

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

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

@@ -6,12 +6,7 @@ SimpleNavigation::Configuration.run do |navigation|
   
   # Specify the class that will be applied to active navigation items. Defaults to 'selected'
   # navigation.selected_class = 'your_selected_class'
-  
-  # Normally only the current sub menu is renderedwhen render_navigation is called
-  # setting this to true render all submenus which is useful for javascript
-  # driven hovering menus like the jquery superfish plugin
-  # navigation.render_all_levels = true
-  
+    
   # Item keys are normally added to list items as id.
   # This setting turns that off
   # navigation.autogenerate_item_ids = false

data/lib/simple_navigation.rb

@@ -55,8 +55,23 @@ module SimpleNavigation
       self.controller.instance_variable_get(:"@sn_current_navigation_#{level}")
     end
 
+    # Returns the active item container for the specified level. Valid levels are
+    # * :all - in this case the primary_navigation is 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
+    # 
+    # Returns nil if there is no active item_container for the specified level.
     def active_item_container_for(level)
-      self.primary_navigation.active_item_container_for(level)
+      case level
+      when :all
+        self.primary_navigation
+      when Integer
+        self.primary_navigation.active_item_container_for(level)
+      when Range
+        self.primary_navigation.active_item_container_for(level.min)
+      else
+        raise ArgumentError, "Invalid navigation level: #{level}"
+      end
     end
     
     # If any navigation has been explicitely set in the controller this method evaluates the specified args set in the controller and sets

data/lib/simple_navigation/configuration.rb

@@ -6,7 +6,8 @@ module SimpleNavigation
   class Configuration
     include Singleton
     
-    attr_accessor :renderer, :selected_class, :render_all_levels, :autogenerate_item_ids, :id_generator, :auto_highlight
+    attr_accessor :renderer, :selected_class, :autogenerate_item_ids, :id_generator, :auto_highlight
+    attr_reader :render_all_levels
     attr_reader :primary_navigation
 
     class << self
@@ -45,12 +46,17 @@ module SimpleNavigation
     def initialize
       @renderer = SimpleNavigation::Renderer::List
       @selected_class = 'selected'
-      @render_all_levels = false
       @autogenerate_item_ids = true
       @id_generator = Proc.new {|id| id.to_s }
       @auto_highlight = true
     end
   
+    # Adds a deprecation warning when this options is set in the config file
+    def render_all_levels=(do_it)
+      ActiveSupport::Deprecation.warn("Setting render_all_levels in the config-file has been deprected. Please use render_navigation(:expand_all => true) instead")
+      @render_all_levels = do_it
+    end
+  
     # This is the main method for specifying the navigation items. It can be used in two ways:
     # 
     # 1. Declaratively specify your items in the config/navigation.rb file using a block. It then yields an SimpleNavigation::ItemContainer for adding navigation items.

data/lib/simple_navigation/helpers.rb

@@ -3,8 +3,10 @@ module SimpleNavigation
   # View helpers to render the navigation.
   #
   # Use render_navigation as following to render your navigation:
-  # * call <tt>render_navigation</tt> without :level option to render your navigation as nested tree.
+  # * call <tt>render_navigation</tt> without :level option to render your complete navigation as nested tree.
   # * call <tt>render_navigation(:level => x)</tt> to render a specific navigation level (e.g. :level => 1 to render your primary navigation, :level => 2 to render the sub navigation and so forth)
+  # * call <tt>render_navigation(:level => 2..3)</tt> to render navigation levels 2 and 3). 
+  #   For example, you could use render_navigation(:level => 1) to render your primary navigation as tabs and render_navigation(:level => 2..3) to render the rest of the navigation as a tree in a sidebar.
   # 
   # ==== Examples (using Haml)
   #   #primary_navigation= render_navigation(:level => 1)
@@ -13,49 +15,44 @@ module SimpleNavigation
   #
   #   #nested_navigation= render_navigation
   #
-  # Please note that <tt>render_primary_navigation</tt> and <tt>render_sub_navigation</tt> still work, but have been deprecated and may be removed in a future release.
+  #   #top_navigation= render_navigation(:level => 1..2)
+  #   #sidebar_navigation= render_navigation(:level => 3)
   module Helpers
     
     # Renders the navigation according to the specified options-hash. 
     #
     # The following options are supported:
-    # * <tt>:level</tt> - defaults to :nested which renders the the sub_navigation for an active primary_navigation inside that active primary_navigation item. 
+    # * <tt>:level</tt> - defaults to :all which renders the the sub_navigation for an active primary_navigation inside that active primary_navigation item. 
     #   Specify a specific level to only render that level of navigation (e.g. :level => 1 for primary_navigation etc...).
+    #   Specifiy a Range of levels to render only those specific levels (e.g. :level => 1..2 to render both your first and second levels, maybe you want to render your third level somewhere else on the page)
+    # * <tt>:expand_all</tt> - defaults to false. If set to true the all specified levels will be rendered as a fully expanded tree (always open). This is useful for javascript menus like Superfish.
     # * <tt>:context</tt> - specifies the context for which you would render the navigation. 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>render_navigation(:context => :admin)</tt> the file config/admin_navigation.rb
     #   will be loaded and used for rendering the navigation.
-    # * <tt>:all_open</tt> - setting this options to true means that all items are always open (ie. fully expanded tree). Same as setting render_all_levels option in the config-file.
     # * <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. 
     def render_navigation(*args)
       args = [Hash.new] if args.empty?
       options = extract_backwards_compatible_options(*args)
-      options = {:context => :default, :level => :nested}.merge(options)
-      SimpleNavigation.load_config(options[:context]) rescue nil
-      SimpleNavigation::Configuration.eval_config(self, options[:context]) rescue nil
-      SimpleNavigation.config.render_all_levels = options[:all_open] unless options[:all_open].nil?
+      options = {:context => :default, :level => :all}.merge(options)
+      ctx = options.delete(:context)
+      SimpleNavigation.load_config(ctx) rescue nil
+      SimpleNavigation::Configuration.eval_config(self, ctx) rescue nil
       SimpleNavigation.config.items(options[:items]) if options[:items]
       SimpleNavigation.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
-      case options[:level]
-      when Integer
-        active_item_container = SimpleNavigation.active_item_container_for(options[:level])
-        active_item_container.render if active_item_container
-      when :nested
-        SimpleNavigation.primary_navigation.render(true)
-      else
-        raise ArgumentError, "Invalid navigation level: #{options[:level]}"
-      end
+      active_item_container = SimpleNavigation.active_item_container_for(options[:level])
+      active_item_container.render(options) unless active_item_container.nil?
     end
     
     # Deprecated. Renders the primary_navigation with the configured renderer. Calling render_navigation(:level => 0) has the same effect.
     def render_primary_navigation(options = {})
-      ActiveSupport::Deprecation.warn("SimpleNavigation::Helpers.render_primary_navigation has been deprected. Please use render_navigation(:level => 1) instead")
+      ActiveSupport::Deprecation.warn("SimpleNavigation::Helpers.render_primary_navigation has been deprecated. Please use render_navigation(:level => 1) instead")
       render_navigation(options.merge(:level => 1))
     end
     
     # Deprecated. Renders the sub_navigation with the configured renderer. Calling render_navigation(:level => 1) has the same effect.
     def render_sub_navigation(options = {})
-      ActiveSupport::Deprecation.warn("SimpleNavigation::Helpers.render_primary_navigation has been deprected. Please use render_navigation(:level => 2) instead")
+      ActiveSupport::Deprecation.warn("SimpleNavigation::Helpers.render_primary_navigation has been deprecated. Please use render_navigation(:level => 2) instead")
       render_navigation(options.merge(:level => 2))
     end
 
@@ -65,20 +62,33 @@ module SimpleNavigation
       case args.first
       when Hash
         options = args.first
+        options[:level] = options.delete(:levels) if options[:levels]
+        deprecated_api! if options[:level] == :primary || options[:level] == :secondary || options[:level] == :nested
         options[:level] = 1 if options[:level] == :primary
         options[:level] = 2 if options[:level] == :secondary
+        options[:level] = :all if options[:level] == :nested
       when Symbol
+        deprecated_api!
         raise ArgumentError, "Invalid arguments" unless [:primary, :secondary, :nested].include? args.first
         options = Hash.new
         options[:level] = args.first
+        options[:level] = :all if options[:level] == :nested
         options[:level] = 1 if options[:level] == :primary
         options[:level] = 2 if options[:level] == :secondary
         options.merge!(args[1] || {})
       else
         raise ArgumentError, "Invalid arguments"
       end
+      if options[:all_open]
+        options[:expand_all] = options.delete(:all_open)
+        ActiveSupport::Deprecation.warn("render_navigation(:all_open => true) has been deprecated, please use render_navigation(:expand_all => true) instead")
+      end
       options
     end
     
+    def deprecated_api!
+      ActiveSupport::Deprecation.warn("You are using a deprecated API of SimpleNavigation::Helpers.render_navigation, please check the documentation on http://wiki.github.com/andi/simple-navigation")
+    end
+      
   end
 end

data/lib/simple_navigation/item_container.rb

@@ -66,9 +66,9 @@ module SimpleNavigation
   
     # Renders the items in this ItemContainer using the configured renderer.
     #
-    # Set <tt>include_sub_navigation</tt> to true if you want to nest the sub_navigation into the active parent_navigation
-    def render(include_sub_navigation=false)
-      self.renderer.new.render(self, include_sub_navigation)
+    # The options are the same as in the view's render_navigation call (they get passed on)
+    def render(options={})
+      self.renderer.new(options).render(self)
     end
 
     # Returns true if any of this container's items is selected.

data/lib/simple_navigation/renderer/base.rb

@@ -8,7 +8,7 @@ module SimpleNavigation
       include ActionView::Helpers::UrlHelper
       include ActionView::Helpers::TagHelper
       
-      attr_reader :controller
+      attr_reader :controller, :options
 
       class << self
         
@@ -23,21 +23,55 @@ module SimpleNavigation
 
       controller_method :form_authenticity_token, :protect_against_forgery?, :request_forgery_protection_token
       
-      def initialize #:nodoc:
+      def initialize(options) #:nodoc:
+        @options = options
         @controller = SimpleNavigation.controller
       end
             
+      def expand_all?
+        !!options[:expand_all]
+      end
+      
+      def level
+        options[:level] || :all
+      end      
+      
+      def include_sub_navigation?(item)
+        consider_sub_navigation?(item) && expand_sub_navigation?(item)
+      end      
+      
+      def render_sub_navigation_for(item)
+        item.sub_navigation.render(self.options)
+      end
+            
       # Renders the specified ItemContainer to HTML.
       #
-      # If <tt>include_sub_navigation</tt> is set to true, the renderer should nest the sub_navigation for the active navigation 
-      # inside that navigation item.
-      #
-      # A renderer should also take the option SimpleNavigation.config.render_all_levels into account. If it is set to true then it should render all navigation levels
-      # independent of the <tt>include_sub_navigation</tt> option.
+      # When implementing a renderer, please consider to call include_sub_navigation? to determin
+      # whether an item's sub_navigation should be rendered or not.
       #  
-      def render(item_container, include_sub_navigation=false)
+      def render(item_container)
         raise 'subclass responsibility'
       end
+         
+      protected
+      
+      def consider_sub_navigation?(item)
+        return false if item.sub_navigation.nil?
+        case level
+        when :all
+          return true
+        when Integer
+          return false
+        when Range
+          return item.sub_navigation.level <= level.max
+        end
+        false
+      end
+      
+      def expand_sub_navigation?(item)
+        expand_all? || item.selected?
+      end
+      
             
     end
   end

data/lib/simple_navigation/renderer/list.rb

@@ -4,28 +4,24 @@ module SimpleNavigation
     # Renders an ItemContainer as a <ul> element and its containing items as <li> elements. 
     # It adds the 'selected' class to li element AND the link inside the li element that is currently active.
     #
-    # If the sub navigation should be included, it renders another <ul> containing the sub navigation inside the active <li> element.
-    #
-    # If the SimpleNavigation.config.render_all_levels option is set to true, it always renders all levels of navigation (fully expanded tree).
+    # If the sub navigation should be included (based on the level and expand_all options), it renders another <ul> containing the sub navigation inside the active <li> element.
     #
     # 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, include_sub_navigation=false)
+      def render(item_container)
         list_content = item_container.items.inject([]) do |list, item|
           html_options = item.html_options
           li_content = link_to(item.name, item.url, :class => item.selected_class, :method => item.method)
-          if item.sub_navigation
-            if SimpleNavigation.config.render_all_levels || (include_sub_navigation && item.selected?)
-              li_content << (item.sub_navigation.render(include_sub_navigation))
-            end
+          if include_sub_navigation?(item)
+            li_content << render_sub_navigation_for(item)
           end  
           list << content_tag(:li, li_content, html_options)
         end
         content_tag(:ul, list_content.join, {:id => item_container.dom_id, :class => item_container.dom_class})
       end
-      
     end
+    
   end
-end
+end

data/simple-navigation.gemspec

@@ -5,11 +5,11 @@
 
 Gem::Specification.new do |s|
   s.name = %q{simple-navigation}
-  s.version = "2.1.0"
+  s.version = "2.2.0"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Andi Schacke"]
-  s.date = %q{2009-12-18}
+  s.date = %q{2010-01-17}
   s.description = %q{With the simple-navigation gem installed you can easily create multilevel navigations for your Ruby on Rails applications. The navigation is defined in a single configuration file. It supports automatic as well as explicit highlighting of the currently active navigation.}
   s.email = %q{andreas.schacke@gmail.com}
   s.extra_rdoc_files = [

data/spec/lib/simple_navigation/configuration_spec.rb

@@ -120,9 +120,6 @@ describe SimpleNavigation::Configuration do
     it "should set the selected_class to 'selected' as default" do
       @config.selected_class.should == 'selected'
     end
-    it "should set render_all_levels to false as default" do
-      @config.render_all_levels.should be_false
-    end
     it "should set autogenerate_item_ids to true as default" do
       @config.autogenerate_item_ids.should be_true
     end
@@ -186,6 +183,15 @@ describe SimpleNavigation::Configuration do
     end
   end
 
+  describe 'render_all_levels=' do
+    it "should set the instance var" do
+      ActiveSupport::Deprecation.silence do
+        @config.render_all_levels = true
+        @config.render_all_levels.should be_true
+      end
+    end
+  end
+
   describe 'loaded?' do
     it "should return true if primary_nav is set" do
       @config.instance_variable_set(:@primary_navigation, :bla)

data/spec/lib/simple_navigation/helpers_spec.rb

@@ -34,28 +34,7 @@ describe SimpleNavigation::Helpers do
       SimpleNavigation::Configuration.should_receive(:eval_config).with(@controller, :default)
       @controller.render_navigation
     end
-    
-    describe "regarding setting the 'render_all_levels' option" do
-      context 'all_open is not specified' do
-        it "should not set the option" do
-          SimpleNavigation.config.should_not_receive(:render_all_levels=)
-          @controller.render_navigation
-        end
-      end
-      context 'all_open is true' do
-        it "should set the option to true" do
-          SimpleNavigation.config.should_receive(:render_all_levels=).with(true)
-          @controller.render_navigation(:all_open => true)
-        end
-      end
-      context 'all_open is false' do
-        it "should set the option to false" do
-          SimpleNavigation.config.should_receive(:render_all_levels=).with(false)
-          @controller.render_navigation(:all_open => false)
-        end
-      end
-    end
-    
+        
     describe 'regarding setting of items' do
       context 'not items specified in options' do
         it "should not set the items directly" do
@@ -81,17 +60,43 @@ describe SimpleNavigation::Helpers do
       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, :null_object => true)
+        SimpleNavigation.stub!(:active_item_container_for => @active_item_container)
+      end
+      it "should lookup the active_item_container based on the level" do
+        SimpleNavigation.should_receive(:active_item_container_for).with(:all)
+        @controller.render_navigation
+      end
+      context 'active_item_container is nil' do
+        before(:each) do
+          SimpleNavigation.stub!(:active_item_container_for => nil)
+        end
+        it "should not call render" do
+          @active_item_container.should_not_receive(:render)
+          @controller.render_navigation
+        end
+      end
+      context 'active_item_container is not nil' do
+        it "should call render on the container" do
+          @active_item_container.should_receive(:render)
+          @controller.render_navigation
+        end
+      end
+    end
+    
     context 'primary' do
       it "should call render on the primary_navigation" do
         @primary_navigation.should_receive(:render)
-        @controller.render_navigation(:primary)
+        ActiveSupport::Deprecation.silence {@controller.render_navigation(:primary)}
       end
       it "should call render on the primary_navigation (specifying level through options)" do
         @primary_navigation.should_receive(:render)
-        @controller.render_navigation(:level => :primary)
+        ActiveSupport::Deprecation.silence {@controller.render_navigation(:level => :primary)}
       end
       it "should call render on the primary_navigation (specifying level through options)" do
-        @primary_navigation.should_receive(:render)
+        @primary_navigation.should_receive(:render).with(:level => 1)
         @controller.render_navigation(:level => 1)
       end
     end
@@ -104,19 +109,19 @@ describe SimpleNavigation::Helpers do
         end
         it "should find the selected sub_navigation for the specified level" do
           SimpleNavigation.should_receive(:active_item_container_for).with(2)
-          @controller.render_navigation(:secondary)
+          ActiveSupport::Deprecation.silence {@controller.render_navigation(:secondary)}
         end
         it "should find the selected sub_navigation for the specified level" do
           SimpleNavigation.should_receive(:active_item_container_for).with(2)
-          @controller.render_navigation(:level => :secondary)
+          ActiveSupport::Deprecation.silence {@controller.render_navigation(:level => :secondary)}
         end
         it "should find the selected sub_navigation for the specified level" do
           SimpleNavigation.should_receive(:active_item_container_for).with(1)
           @controller.render_navigation(:level => 1)
         end
         it "should call render on the active item_container" do
-          @selected_item_container.should_receive(:render)
-          @controller.render_navigation(:secondary)
+          @selected_item_container.should_receive(:render).with(:level => 2)
+          ActiveSupport::Deprecation.silence {@controller.render_navigation(:secondary)}
         end
       end
       context 'without an active item_container set' do
@@ -124,22 +129,22 @@ describe SimpleNavigation::Helpers do
           SimpleNavigation.stub!(:active_item_container_for => nil)
         end
         it "should not raise an error" do
-          lambda{@controller.render_navigation(:secondary)}.should_not raise_error
+          lambda{ActiveSupport::Deprecation.silence {@controller.render_navigation(:secondary)}}.should_not raise_error
         end
       end
       
     end
     
     context 'nested' do
-      it "should call render on the primary navigation with the include_subnavigation option set" do
-        @primary_navigation.should_receive(:render).with(true)
-        @controller.render_navigation(:nested)
+      it "should call render on the primary navigation with the :level => :all option set" do
+        @primary_navigation.should_receive(:render).with(:level => :all)
+        ActiveSupport::Deprecation.silence {@controller.render_navigation(:nested)}
       end
     end
     
     context 'unknown level' do
       it "should raise an error" do
-        lambda {@controller.render_navigation(:unknown)}.should raise_error(ArgumentError)
+        lambda {ActiveSupport::Deprecation.silence {@controller.render_navigation(:unknown)}}.should raise_error(ArgumentError)
       end
       it "should raise an error" do
         lambda {@controller.render_navigation(:level => :unknown)}.should raise_error(ArgumentError)
@@ -151,7 +156,7 @@ describe SimpleNavigation::Helpers do
   end
   
   describe 'render_primary_navigation' do  
-    it "should delegate to render_navigation(:primary)" do
+    it "should delegate to render_navigation(:level => 1)" do
       ActiveSupport::Deprecation.silence do
         @controller.should_receive(:render_navigation).with(:level => 1)
         @controller.render_primary_navigation
@@ -160,7 +165,7 @@ describe SimpleNavigation::Helpers do
   end
   
   describe 'render_sub_navigation' do
-    it "should delegate to render_navigation(:secondary)" do
+    it "should delegate to render_navigation(:level => 2)" do
       ActiveSupport::Deprecation.silence do
         @controller.should_receive(:render_navigation).with(:level => 2)
         @controller.render_sub_navigation
@@ -168,4 +173,22 @@ describe SimpleNavigation::Helpers do
     end
   end
   
+  describe "should treat :level and :levels options the same" do
+    before(:each) do
+      @selected_item_container = stub(:selected_container, :null_object => true)
+      SimpleNavigation.stub!(:active_item_container_for => @selected_item_container)
+    end
+    it  "should pass a valid levels options as level" do
+      @selected_item_container.should_receive(:render).with(:level => 2)
+      @controller.render_navigation(:levels => 2)
+    end
+  end
+  
+  describe 'option all_open should work as expand_all' do
+    it "should call render on the primary navigation with the include_subnavigation option set" do
+      @primary_navigation.should_receive(:render).with(:level => :all, :expand_all => true)
+      ActiveSupport::Deprecation.silence {@controller.render_navigation(:level => :all, :all_open => true)}
+    end    
+  end
+  
 end

data/spec/lib/simple_navigation/item_container_spec.rb

@@ -315,18 +315,15 @@ describe SimpleNavigation::ItemContainer do
       @item_container.stub!(:renderer).and_return(@renderer)
       @items = stub(:items)
       @item_container.stub!(:items).and_return(@items)
+      @options = stub(:options)
     end
     it "should instatiate a renderer" do
-      @renderer.should_receive(:new)
-      @item_container.render(:current_navigation)
+      @renderer.should_receive(:new).with(@options)
+      @item_container.render(@options)
     end
     it "should call render on the renderer and pass self" do
-      @renderer_instance.should_receive(:render).with(@item_container, anything)
-      @item_container.render(:current_navigation)
-    end
-    it "should call render on the renderer and pass the include_sub_navigation option" do
-      @renderer_instance.should_receive(:render).with(anything, true)
-      @item_container.render(true)
+      @renderer_instance.should_receive(:render).with(@item_container)
+      @item_container.render
     end
     
   end

data/spec/lib/simple_navigation/renderer/base_spec.rb

@@ -2,9 +2,10 @@ require File.dirname(__FILE__) + '/../../../spec_helper'
 
 describe SimpleNavigation::Renderer::Base do
   before(:each) do
+    @options = stub(:options, :null_object => true)
     @controller = stub(:controller)
     SimpleNavigation.stub!(:controller).and_return(@controller)
-    @base_renderer = SimpleNavigation::Renderer::Base.new
+    @base_renderer = SimpleNavigation::Renderer::Base.new(@options)
   end
   it "should inclue ActionView::Helpers::UrlHelper" do
     @base_renderer.should respond_to(:link_to)
@@ -21,6 +22,7 @@ describe SimpleNavigation::Renderer::Base do
   
   describe 'initialize' do
     it {@base_renderer.controller.should == @controller}
+    it {@base_renderer.options.should == @options}
   end
   
   describe 'controller_method' do
@@ -56,5 +58,154 @@ describe SimpleNavigation::Renderer::Base do
       lambda {@base_renderer.render(:container)}.should raise_error('subclass responsibility')
     end
   end
+  
+  describe 'expand_all?' do
+    context 'option is set' do
+      context 'expand_all is true' do
+        before(:each) do
+          @base_renderer.stub!(:options => {:expand_all => true})
+        end
+        it {@base_renderer.expand_all?.should be_true}
+      end
+      context 'expand_all is false' do
+        before(:each) do
+          @base_renderer.stub!(:options => {:expand_all => false})
+        end
+        it {@base_renderer.expand_all?.should be_false}
+      end
+    end
+    context 'option is not set' do
+      before(:each) do
+        @base_renderer.stub!(:options => {})
+      end
+      it {@base_renderer.expand_all?.should be_false}
+    end
+  end
+
+  describe 'level' do
+    context 'options[level] is set' do
+      before(:each) do
+        @base_renderer.stub!(:options => {:level => 1})
+      end
+      it {@base_renderer.level.should == 1}
+    end
+    context 'options[level] is not set' do
+      before(:each) do
+        @base_renderer.stub!(:options => {})
+      end
+      it {@base_renderer.level.should == :all}
+    end
+  end
+
+  describe 'consider_sub_navigation?' do
+    before(:each) do
+      @item = stub(:item)
+    end
+    context 'item has no subnavigation' do
+      before(:each) do
+        @item.stub!(:sub_navigation => nil)
+      end
+      it {@base_renderer.send(:consider_sub_navigation?, @item).should be_false}
+    end
+    context 'item has subnavigation' do
+      before(:each) do
+        @sub_navigation = stub(:sub_navigation)
+        @item.stub!(:sub_navigation => @sub_navigation)
+      end
+      context 'level is something unknown' do
+        before(:each) do
+          @base_renderer.stub!(:level => 'unknown')
+        end
+        it {@base_renderer.send(:consider_sub_navigation?, @item).should be_false}        
+      end
+      context 'level is :all' do
+        before(:each) do
+          @base_renderer.stub!(:level => :all)
+        end
+        it {@base_renderer.send(:consider_sub_navigation?, @item).should be_true}
+      end
+      context 'level is an Integer' do
+        before(:each) do
+          @base_renderer.stub!(:level => 2)
+        end
+        it {@base_renderer.send(:consider_sub_navigation?, @item).should be_false}
+      end
+      context 'level is a Range' do
+        before(:each) do
+          @base_renderer.stub!(:level => 2..3)
+        end
+        context 'subnavs level > range.max' do
+          before(:each) do
+            @sub_navigation.stub!(:level => 4)
+          end
+          it {@base_renderer.send(:consider_sub_navigation?, @item).should be_false}
+        end
+        context 'subnavs level = range.max' do
+          before(:each) do
+            @sub_navigation.stub!(:level => 3)
+          end
+          it {@base_renderer.send(:consider_sub_navigation?, @item).should be_true}
+          
+        end
+        context 'subnavs level < range.max' do
+          before(:each) do
+            @sub_navigation.stub!(:level => 2)
+          end
+          it {@base_renderer.send(:consider_sub_navigation?, @item).should be_true}
+        end
+      end
+    end
+  end
+
+  describe 'include_sub_navigation?' do
+    before(:each) do
+      @item = stub(:item)
+    end
+    context 'consider_sub_navigation? is true' do
+      before(:each) do
+        @base_renderer.stub!(:consider_sub_navigation? => true)
+      end
+      context 'expand_sub_navigation? is true' do
+        before(:each) do
+          @base_renderer.stub!(:expand_sub_navigation? => true)
+        end
+        it {@base_renderer.include_sub_navigation?(@item).should be_true}
+      end
+      context 'expand_sub_navigation? is false' do
+        before(:each) do
+          @base_renderer.stub!(:expand_sub_navigation? => false)
+        end
+        it {@base_renderer.include_sub_navigation?(@item).should be_false}
+      end
+    end
+    context 'consider_sub_navigation is false' do
+      before(:each) do
+        @base_renderer.stub!(:consider_sub_navigation? => false)
+      end
+      context 'expand_sub_navigation? is true' do
+        before(:each) do
+          @base_renderer.stub!(:expand_sub_navigation? => true)
+        end
+        it {@base_renderer.include_sub_navigation?(@item).should be_false}
+      end
+      context 'expand_sub_navigation? is false' do
+        before(:each) do
+          @base_renderer.stub!(:expand_sub_navigation? => false)
+        end
+        it {@base_renderer.include_sub_navigation?(@item).should be_false}
+      end
+    end
+  end
+
+  describe 'render_sub_navigation_for' do
+    before(:each) do
+      @sub_navigation = stub(:sub_navigation)
+      @item = stub(:item, :sub_navigation => @sub_navigation)
+    end
+    it "should call render on the sub_navigation (passing the options)" do
+      @sub_navigation.should_receive(:render).with(@options)
+      @base_renderer.render_sub_navigation_for(@item)
+    end
+  end
 
 end

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

@@ -47,11 +47,11 @@ describe SimpleNavigation::Renderer::List do
       container
     end
 
-    def render(current_nav=nil, include_subnav=false)
+    def render(current_nav=nil, options={:level => :all})
       primary_navigation = primary_container
       select_item(current_nav) if current_nav
-      @renderer = SimpleNavigation::Renderer::List.new
-      HTML::Document.new(@renderer.render(primary_navigation, include_subnav)).root
+      @renderer = SimpleNavigation::Renderer::List.new(options)
+      HTML::Document.new(@renderer.render(primary_navigation)).root
     end
       
     it "should render a ul-tag around the items" do
@@ -103,31 +103,25 @@ describe SimpleNavigation::Renderer::List do
     
     context 'nested sub_navigation' do
       it "should nest the current_primary's subnavigation inside the selected li-element" do
-        HTML::Selector.new('li.selected ul li').select(render(:invoices, true)).should have(2).entries
+        HTML::Selector.new('li.selected ul li').select(render(:invoices)).should have(2).entries
       end
       it "should be possible to identify sub items using an html selector (using ids)" do
-        HTML::Selector.new('#invoices #subnav1').select(render(:invoices, true)).should have(1).entries
+        HTML::Selector.new('#invoices #subnav1').select(render(:invoices)).should have(1).entries
       end
-      context 'render_all_levels = false' do
-        before(:each) do
-          SimpleNavigation.config.render_all_levels = false
-        end
+      context 'expand_all => false' do
         it "should not render the invoices submenu if the user-primary is active" do
-          HTML::Selector.new('#invoices #subnav1').select(render(:users, true)).should be_empty
-          HTML::Selector.new('#invoices #subnav2').select(render(:users, true)).should be_empty
+          HTML::Selector.new('#invoices #subnav1').select(render(:users, :level => :all, :expand_all => false)).should be_empty
+          HTML::Selector.new('#invoices #subnav2').select(render(:users, :level => :all, :expand_all => false)).should be_empty
         end
       end
       
-      context 'render_all_levels = true' do
-        before(:each) do
-          SimpleNavigation.config.render_all_levels = true
-        end
+      context 'expand_all => true' do
         it "should render the invoices submenu even if the user-primary is active" do
-          HTML::Selector.new('#invoices #subnav1').select(render(:users, true)).should have(1).entry
-          HTML::Selector.new('#invoices #subnav2').select(render(:users, true)).should have(1).entry
+          HTML::Selector.new('#invoices #subnav1').select(render(:users, :level => :all, :expand_all => true)).should have(1).entry
+          HTML::Selector.new('#invoices #subnav2').select(render(:users, :level => :all, :expand_all => true)).should have(1).entry
         end
       end
-      
+          
     end
     
   end

data/spec/lib/simple_navigation_spec.rb

@@ -153,9 +153,27 @@ describe SimpleNavigation do
       @primary = stub(:primary)
       SimpleNavigation.config.stub!(:primary_navigation => @primary)
     end
-    it "should call active_item_container_for on the primary_navigation with the specified level" do
-      @primary.should_receive(:active_item_container_for).with(1)
-      SimpleNavigation.active_item_container_for 1
+    context 'level is :all' do
+      it "should return the primary_navigation" do
+        SimpleNavigation.active_item_container_for(:all).should == @primary
+      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)
+        SimpleNavigation.active_item_container_for(2..3)
+      end
+    end
+    context 'level is an Integer' do
+      it "should consider the Integer to lookup the active container" do
+        @primary.should_receive(:active_item_container_for).with(1)
+        SimpleNavigation.active_item_container_for(1)
+      end
+    end
+    context 'level is something else' do
+      it "should raise an ArgumentError" do
+        lambda {SimpleNavigation.active_item_container_for('something else')}.should raise_error(ArgumentError)
+      end
     end
   end
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: simple-navigation
 version: !ruby/object:Gem::Version 
-  version: 2.1.0
+  version: 2.2.0
 platform: ruby
 authors: 
 - Andi Schacke
@@ -9,7 +9,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2009-12-18 00:00:00 +01:00
+date: 2010-01-17 00:00:00 +01:00
 default_executable: 
 dependencies: []