simple-navigation 2.0.1 → 2.1.0

data/CHANGELOG

@@ -1,3 +1,9 @@
+*2.1.0
+
+* included Ben Marini's commit which allows individual id-generators. Thanks Ben!
+* added ability to specify navigation items through items_provider. This is useful for generating the navigation dynamically (e.g. from database)
+* items can now even be passed directly into render_navigation method.
+
 *2.0.1
 
 * fixed handling of a non-existent explicit navigation item for a navigation context

data/VERSION.yml

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

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

@@ -15,6 +15,11 @@ SimpleNavigation::Configuration.run do |navigation|
   # Item keys are normally added to list items as id.
   # This setting turns that off
   # navigation.autogenerate_item_ids = false
+  
+  # You can override the default logic that is used to autogenerate the item ids.
+  # To do this, define a Proc which takes the key of the current item as argument.
+  # The example below would add a prefix to each key.
+  # navigation.id_generator = Proc.new {|key| "my-prefix-#{key}"}
 
   # The auto highlight feature is turned on by default.
   # This turns it off globally (for the whole plugin)

data/lib/simple_navigation.rb

@@ -2,8 +2,10 @@
 require 'simple_navigation/configuration'
 require 'simple_navigation/helpers'
 require 'simple_navigation/controller_methods'
+require 'simple_navigation/item_adapter'
 require 'simple_navigation/item'
 require 'simple_navigation/item_container'
+require 'simple_navigation/items_provider'
 require 'simple_navigation/renderer/base'
 require 'simple_navigation/renderer/list'
 
@@ -114,3 +116,7 @@ end
 # 4) Enhance SampleProject (more examples)
 #
 # 5) Make SampleProject public
+#
+# - allow :function navigation item to specify function
+# - allow specification of link-options in item (currently options are passed to li-element)
+# - render_navigation: do not rescue from config-file not found error if no items are passed in directly

data/lib/simple_navigation/configuration.rb

@@ -6,7 +6,7 @@ module SimpleNavigation
   class Configuration
     include Singleton
     
-    attr_accessor :renderer, :selected_class, :render_all_levels, :autogenerate_item_ids, :auto_highlight
+    attr_accessor :renderer, :selected_class, :render_all_levels, :autogenerate_item_ids, :id_generator, :auto_highlight
     attr_reader :primary_navigation
 
     class << self
@@ -47,13 +47,35 @@ module SimpleNavigation
       @selected_class = 'selected'
       @render_all_levels = false
       @autogenerate_item_ids = true
+      @id_generator = Proc.new {|id| id.to_s }
       @auto_highlight = true
     end
   
-    # Yields an SimpleNavigation::ItemContainer for adding navigation items
-    def items(&block)
+    # 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.
+    # 1. Directly provide your items to the method (e.g. when loading your items from the database). Either specify 
+    #
+    # ==== Example for block style
+    #   config.items do |primary|
+    #     primary.item :my_item, 'My item', my_item_path
+    #     ...
+    #   end
+    #
+    # ==== To consider when directly providing items
+    # * a methodname (as symbol) that returns your items. The method needs to be available in the view (i.e. a helper method)
+    # * an object that responds to :items
+    # * an enumerable containing your items
+    # The items you specify have to fullfill certain requirements. See SimpleNavigation::ItemAdapter for more details.
+    #
+    def items(items_provider=nil, &block)
+      raise 'please specify either items_provider or block, but not both' if (items_provider && block) || (items_provider.nil? && block.nil?)
       @primary_navigation = ItemContainer.new
-      block.call @primary_navigation
+      if block
+        block.call @primary_navigation
+      else
+        @primary_navigation.items = SimpleNavigation::ItemsProvider.new(items_provider).items
+      end
     end
     
     # Returns true if the config_file has already been evaluated.
@@ -61,6 +83,10 @@ module SimpleNavigation
       !@primary_navigation.nil?
     end    
     
+    def context_for_eval
+      self.class.context_for_eval
+    end
+    
   end  
   
 end

data/lib/simple_navigation/helpers.rb

@@ -24,14 +24,18 @@ module SimpleNavigation
     # * <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])
-      SimpleNavigation::Configuration.eval_config(self, options[:context])
+      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?
+      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])

data/lib/simple_navigation/item.rb

@@ -6,16 +6,19 @@ module SimpleNavigation
     attr_writer :html_options
     
     # see ItemContainer#item
-    def initialize(container, key, name, url, options, sub_nav_block) #:nodoc:
+    #
+    # 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)
       @container = container
       @key = key
       @method = options.delete(:method)
       @name = name
       @url = url
       @html_options = options
-      if sub_nav_block
+      if sub_nav_block || items
         @sub_navigation = ItemContainer.new(@container.level + 1)
-        sub_nav_block.call @sub_navigation
+        sub_nav_block.call @sub_navigation if sub_nav_block
+        @sub_navigation.items = items if items
       end
     end
     
@@ -33,7 +36,7 @@ module SimpleNavigation
     # Returns the html-options hash for the item, i.e. the options specified for this item in the config-file.
     # It also adds the 'selected' class to the list of classes if necessary. 
     def html_options
-      default_options = self.autogenerate_item_ids? ? {:id => key.to_s} : {}
+      default_options = self.autogenerate_item_ids? ? {:id => autogenerated_item_id} : {}
       options = default_options.merge(@html_options)
       options[:class] = [@html_options[:class], self.selected_class].flatten.compact.join(' ')
       options.delete(:class) if options[:class].blank?
@@ -81,6 +84,10 @@ module SimpleNavigation
       SimpleNavigation.config.autogenerate_item_ids
     end
 
+    def autogenerated_item_id
+      SimpleNavigation.config.id_generator.call(key)
+    end
+
     def auto_highlight?
       SimpleNavigation.config.auto_highlight && @container.auto_highlight
     end

data/lib/simple_navigation/item_adapter.rb

@@ -0,0 +1,41 @@
+module SimpleNavigation
+  
+  # This class acts as an adapter to items that are not defined using the DSL in the config/navigation.rb, but directly provided inside the application.
+  # When defining the items that way, every item you provide needs to define the following methods:
+  #
+  # * <tt>key</tt>
+  # * <tt>name</tt>
+  # * <tt>url</tt>
+  #
+  # and optionally
+  # 
+  # * <tt>options</tt>
+  # * <tt>items</tt> - if one of your items has a subnavigation it must respond to <tt>items</tt> providing the subnavigation.
+  #
+  # See SimpleNavigation::ItemContainer#item for the purpose of these methods.
+  class ItemAdapter
+    delegate :key, :name, :url, :to => :item
+    
+    attr_reader :item
+
+    def initialize(item)
+      @item = item
+    end
+        
+    # Returns the options for this item. If the wrapped item does not implement an options method, an empty hash is returned.
+    def options
+      @item.respond_to?(:options) ? @item.options : {}
+    end
+    
+    # Returns the items (subnavigation) for this item if it responds to :items and the items-collection is not empty. Returns nil otherwise.
+    def items
+      (@item.respond_to?(:items) && !(@item.items.nil? || @item.items.empty?)) ? @item.items : nil
+    end
+    
+    # Converts this Item into a SimpleNavigation::Item
+    def to_simple_navigation_item(item_container)
+      SimpleNavigation::Item.new(item_container, key, name, url, options, items)
+    end
+    
+  end
+end

data/lib/simple_navigation/item_container.rb

@@ -32,7 +32,14 @@ module SimpleNavigation
     #
     # 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, block)) if should_add_item?(options)
+      (@items << SimpleNavigation::Item.new(self, key, name, url, options, nil, &block)) if should_add_item?(options)
+    end
+
+    def items=(items)
+      items.each do |item|
+        item = SimpleNavigation::ItemAdapter.new(item)
+        (@items << item.to_simple_navigation_item(self)) if should_add_item?(item.options)
+      end
     end
 
     # Returns the Item with the specified key, nil otherwise.

data/lib/simple_navigation/items_provider.rb

@@ -0,0 +1,35 @@
+module SimpleNavigation
+  
+  # Acts as a proxy to navigation items that are passed into the SimpleNavigation::Configuration#items method. It hides the logic 
+  # for finding items from the Configuration object.
+  #
+  class ItemsProvider
+    
+    attr_reader :provider
+    
+    # It accepts the following types of provider:
+    # * methodname as symbol - the specified method should return the relevant items and has to be available in the view (a helper method)
+    # * object that responds to :items
+    # * enumerable object that represents the items
+    #
+    # See SimpleNavigation::ItemAdapter for the requirements that need to be fulfilled by the provided items.
+    #
+    def initialize(provider)
+      @provider = provider
+    end
+    
+    # Returns the navigation items
+    def items
+      if provider.instance_of?(Symbol)
+        SimpleNavigation.config.context_for_eval.send(provider)
+      elsif provider.respond_to?(:items)
+        provider.items
+      elsif provider.respond_to?(:each)
+        provider
+      else
+        raise "items_provider either must be a symbol specifying the helper-method to call, an object with an items-method defined or an enumerable representing the items"
+      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.0.1"
+  s.version = "2.1.0"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Andi Schacke"]
-  s.date = %q{2009-10-13}
+  s.date = %q{2009-12-18}
   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 = [
@@ -32,7 +32,9 @@ Gem::Specification.new do |s|
      "lib/simple_navigation/controller_methods.rb",
      "lib/simple_navigation/helpers.rb",
      "lib/simple_navigation/item.rb",
+     "lib/simple_navigation/item_adapter.rb",
      "lib/simple_navigation/item_container.rb",
+     "lib/simple_navigation/items_provider.rb",
      "lib/simple_navigation/renderer/base.rb",
      "lib/simple_navigation/renderer/list.rb",
      "rails/init.rb",
@@ -40,8 +42,10 @@ Gem::Specification.new do |s|
      "spec/lib/simple_navigation/configuration_spec.rb",
      "spec/lib/simple_navigation/controller_methods_spec.rb",
      "spec/lib/simple_navigation/helpers_spec.rb",
+     "spec/lib/simple_navigation/item_adapter_spec.rb",
      "spec/lib/simple_navigation/item_container_spec.rb",
      "spec/lib/simple_navigation/item_spec.rb",
+     "spec/lib/simple_navigation/items_provider_spec.rb",
      "spec/lib/simple_navigation/renderer/base_spec.rb",
      "spec/lib/simple_navigation/renderer/list_spec.rb",
      "spec/lib/simple_navigation_spec.rb",
@@ -58,8 +62,10 @@ Gem::Specification.new do |s|
     "spec/lib/simple_navigation/configuration_spec.rb",
      "spec/lib/simple_navigation/controller_methods_spec.rb",
      "spec/lib/simple_navigation/helpers_spec.rb",
+     "spec/lib/simple_navigation/item_adapter_spec.rb",
      "spec/lib/simple_navigation/item_container_spec.rb",
      "spec/lib/simple_navigation/item_spec.rb",
+     "spec/lib/simple_navigation/items_provider_spec.rb",
      "spec/lib/simple_navigation/renderer/base_spec.rb",
      "spec/lib/simple_navigation/renderer/list_spec.rb",
      "spec/lib/simple_navigation_spec.rb",

data/spec/lib/simple_navigation/configuration_spec.rb

@@ -129,20 +129,60 @@ describe SimpleNavigation::Configuration do
     it "should set auto_highlight to true as default" do
       @config.auto_highlight.should be_true
     end
+    it "should set the id_generator" do
+      @config.id_generator.should_not be_nil
+    end
   end  
   describe 'items' do
     before(:each) do
       @container = stub(:items_container)
       SimpleNavigation::ItemContainer.stub!(:new).and_return(@container)
     end
-    it "should should yield an new ItemContainer" do
-      @config.items do |container|
-        container.should == @container
+    context 'block given' do
+      context 'items_provider specified' do
+        it {lambda {@config.items(stub(:provider)) {}}.should raise_error}
+      end
+      context 'no items_provider specified' do
+        it "should should yield an new ItemContainer" do
+          @config.items do |container|
+            container.should == @container
+          end
+        end
+        it "should assign the ItemContainer to an instance-var" do
+          @config.items {}
+          @config.primary_navigation.should == @container
+        end
+        it "should not set the items on the container" do
+          @container.should_not_receive(:items=)
+          @config.items {}
+        end
       end
     end
-    it "should assign the ItemContainer to an instance-var" do
-      @config.items {}
-      @config.primary_navigation.should == @container
+    context 'no block given' do
+      context 'items_provider specified' do
+        before(:each) do
+          @external_provider = stub(:external_provider)
+          @items = stub(:items)
+          @items_provider = stub(:items_provider, :items => @items)
+          SimpleNavigation::ItemsProvider.stub!(:new => @items_provider)
+          @container.stub!(:items=)
+        end
+        it "should create an new Provider object for the specified provider" do
+          SimpleNavigation::ItemsProvider.should_receive(:new).with(@external_provider)
+          @config.items(@external_provider)
+        end
+        it "should call items on the provider object" do
+          @items_provider.should_receive(:items)
+          @config.items(@external_provider)
+        end
+        it "should set the items on the container" do
+          @container.should_receive(:items=).with(@items)
+          @config.items(@external_provider)
+        end
+      end
+      context 'items_provider not specified' do
+        it {lambda {@config.items}.should raise_error}
+      end
     end
   end
 
@@ -157,6 +197,13 @@ describe SimpleNavigation::Configuration do
     end
   end
   
+  describe 'context_for_eval' do
+    it "should delegate to the Configuration class" do
+      @config.class.should_receive(:context_for_eval)
+      @config.context_for_eval
+    end
+  end
+  
 end
 
 

data/spec/lib/simple_navigation/helpers_spec.rb

@@ -35,6 +35,52 @@ describe SimpleNavigation::Helpers do
       @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
+          SimpleNavigation.config.should_not_receive(:items)
+          @controller.render_navigation
+        end
+      end
+      context 'items specified in options' do
+        before(:each) do
+          @items = stub(:items)
+        end
+        it "should set the items directly" do
+          SimpleNavigation.config.should_receive(:items).with(@items)
+          @controller.render_navigation(:items => @items)
+        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 'primary' do
       it "should call render on the primary_navigation" do
         @primary_navigation.should_receive(:render)

data/spec/lib/simple_navigation/item_adapter_spec.rb

@@ -0,0 +1,102 @@
+require File.expand_path(File.dirname(__FILE__) + '/../../spec_helper')
+
+describe SimpleNavigation::ItemAdapter do
+  
+  before(:each) do
+    @item = stub(:item)
+    @item_adapter = SimpleNavigation::ItemAdapter.new(@item)
+  end
+  
+  describe 'key' do
+    it "should delegate key to item" do
+      @item.should_receive(:key)
+      @item_adapter.key
+    end
+  end  
+  
+  describe 'url' do
+    it "should delegate url to item" do
+      @item.should_receive(:url)
+      @item_adapter.url
+    end
+  end
+  
+  describe 'name' do
+    it "should delegate name to item" do
+      @item.should_receive(:name)
+      @item_adapter.name
+    end
+  end
+  
+  describe 'initialize' do
+    it "should set the item" do
+      @item_adapter.item.should == @item
+    end
+  end
+  
+  describe 'options' do
+    context 'item does respond to options' do
+      before(:each) do
+        @options = stub(:options)
+        @item.stub!(:options => @options)
+      end
+      it "should return the item's options'" do
+        @item_adapter.options.should == @options
+      end
+    end
+    context 'item does not respond to options' do
+      it "should return an empty hash" do
+        @item_adapter.options.should == {}
+      end
+    end
+  end
+  
+  describe 'items' do
+    context 'item does respond to items' do
+      context 'items is nil' do
+        before(:each) do
+          @item.stub!(:items => nil)
+        end
+        it "should return nil" do
+          @item_adapter.items.should be_nil
+        end
+      end
+      context 'items is not nil' do
+        context 'items is empty' do
+          before(:each) do
+            @item.stub!(:items => [])
+          end
+          it "should return nil" do
+            @item_adapter.items.should be_nil
+          end
+        end
+        context 'items is not empty' do
+          before(:each) do
+            @items = stub(:items, :empty? => false)
+            @item.stub!(:items => @items)
+          end
+          it "should return the items" do
+            @item_adapter.items.should == @items
+          end
+        end
+      end
+    end
+    context 'item does not respond to items' do
+      it "should return nil" do
+        @item_adapter.items.should be_nil
+      end
+    end
+  end
+  
+  describe 'to_simple_navigation_item' do
+    before(:each) do
+      @container = stub(:container)
+      @item.stub!(:url => 'url', :name => 'name', :key => 'key', :options => {}, :items => [])
+    end
+    it "should create a SimpleNavigation::Item" do
+      SimpleNavigation::Item.should_receive(:new).with(@container, 'key', 'name', 'url', {}, nil)
+      @item_adapter.to_simple_navigation_item(@container)
+    end
+  end
+  
+end

data/spec/lib/simple_navigation/item_container_spec.rb

@@ -15,6 +15,48 @@ describe SimpleNavigation::ItemContainer do
     end
   end
 
+  describe 'items=' do
+    before(:each) do
+      @item = stub(:item)
+      @items = [@item]
+      @item_adapter = stub(:item_adapter, :null_object => true)
+      SimpleNavigation::ItemAdapter.stub(:new => @item_adapter)
+      @item_container.stub!(:should_add_item? => true)
+    end
+    it "should wrap each item in an ItemAdapter" do
+      SimpleNavigation::ItemAdapter.should_receive(:new)
+      @item_container.items = @items
+    end
+    context 'item should be added' do
+      before(:each) do
+        @item_container.stub!(:should_add_item? => true)
+        @simple_navigation_item = stub(:simple_navigation_item)
+        @item_adapter.stub!(:to_simple_navigation_item => @simple_navigation_item)
+      end
+      it "should convert the item to a SimpleNavigation::Item" do
+        @item_adapter.should_receive(:to_simple_navigation_item).with(@item_container)
+        @item_container.items = @items
+      end
+      it "should add the item to the items-collection" do
+        @item_container.items.should_receive(:<<).with(@simple_navigation_item)
+        @item_container.items = @items
+      end
+    end
+    context 'item should not be added' do
+      before(:each) do
+        @item_container.stub!(:should_add_item? => false)
+      end
+      it "should not convert the item to a SimpleNavigation::Item" do
+        @item_adapter.should_not_receive(:to_simple_navigation_item)
+        @item_container.items = @items
+      end
+      it "should not add the item to the items-collection" do
+        @item_container.items.should_not_receive(:<<)
+        @item_container.items = @items
+      end
+    end
+  end
+
   describe 'selected?' do
     before(:each) do
       @item_1 = stub(:item, :selected? => false)
@@ -148,7 +190,7 @@ describe SimpleNavigation::ItemContainer do
           end
         end
         it "should create a new Navigation-Item with the given params and the specified block" do
-          SimpleNavigation::Item.should_receive(:new).with(@item_container, 'key', 'name', 'url', @options, @proc)
+          SimpleNavigation::Item.should_receive(:new).with(@item_container, 'key', 'name', 'url', @options, nil, &@proc)
           @item_container.item('key', 'name', 'url', @options, &@proc)
         end
         it "should add the created item to the list of items" do

data/spec/lib/simple_navigation/item_spec.rb

@@ -3,16 +3,53 @@ require File.dirname(__FILE__) + '/../../spec_helper'
 describe SimpleNavigation::Item do
 
   before(:each) do
-    @item_container = stub(:item_container)
-    @item = SimpleNavigation::Item.new(@item_container, :my_key, 'name', 'url', {}, nil)
+    @item_container = stub(:item_container, :level => 1)
+    @item = SimpleNavigation::Item.new(@item_container, :my_key, 'name', 'url', {})
   end
 
   describe 'initialize' do
+    context 'subnavigation' do
+      before(:each) do
+        @subnav_container = stub(:subnav_container, :null_object => true)
+        SimpleNavigation::ItemContainer.stub!(:new => @subnav_container)
+      end
+      context 'block given' do
+        it "should create a new ItemContainer with a level+1" do
+          SimpleNavigation::ItemContainer.should_receive(:new).with(2)
+          SimpleNavigation::Item.new(@item_container, :my_key, 'name', 'url', {}) {}
+        end
+        it "should call the block" do
+          @subnav_container.should_receive(:test)
+          SimpleNavigation::Item.new(@item_container, :my_key, 'name', 'url', {}) {|subnav| subnav.test}
+        end
+      end
+      context 'no block given' do
+        context 'items given' do
+          before(:each) do
+            @items = stub(:items)
+          end
+          it "should create a new ItemContainer with a level+1" do
+            SimpleNavigation::ItemContainer.should_receive(:new).with(2)
+            SimpleNavigation::Item.new(@item_container, :my_key, 'name', 'url', {}, @items)
+          end
+          it "should set the items on the subnav_container" do
+            @subnav_container.should_receive(:items=).with(@items)
+            SimpleNavigation::Item.new(@item_container, :my_key, 'name', 'url', {}, @items)
+          end
+        end
+        context 'no items given' do
+          it "should not create a new ItemContainer" do
+            SimpleNavigation::ItemContainer.should_not_receive(:new)
+            @item = SimpleNavigation::Item.new(@item_container, :my_key, 'name', 'url', {})
+          end
+        end
+      end
+    end
     context 'method' do
       context 'defined' do
         before(:each) do
           @options = {:method => :delete}
-          @item = SimpleNavigation::Item.new(@item_container, :my_key, 'name', 'url', @options, nil)
+          @item = SimpleNavigation::Item.new(@item_container, :my_key, 'name', 'url', @options)
         end
         it 'should set the method as instance_var' do
           @item.method.should == :delete
@@ -93,7 +130,7 @@ describe SimpleNavigation::Item do
       context 'with classes defined in options' do
         before(:each) do
           @options = {:class => 'my_class'}
-          @item = SimpleNavigation::Item.new(@item_container, :my_key, 'name', 'url', @options, nil)
+          @item = SimpleNavigation::Item.new(@item_container, :my_key, 'name', 'url', @options)
         end
         context 'with item selected' do
           before(:each) do
@@ -113,7 +150,7 @@ describe SimpleNavigation::Item do
       context 'without classes in options' do
         before(:each) do
           @options = {}
-          @item = SimpleNavigation::Item.new(@item_container, :my_key, 'name', 'url', @options, nil)
+          @item = SimpleNavigation::Item.new(@item_container, :my_key, 'name', 'url', @options)
         end
         context 'with item selected' do
           before(:each) do
@@ -305,34 +342,34 @@ describe SimpleNavigation::Item do
       @global = stub(:config)
       SimpleNavigation.stub!(:config => @global)
     end
-    context 'global auto_hightlight on' do
+    context 'global auto_highlight on' do
       before(:each) do
         @global.stub!(:auto_highlight => true)
       end
-      context 'container auto_hightlight on' do
+      context 'container auto_highlight on' do
         before(:each) do
           @item_container.stub!(:auto_highlight => true)
         end
         it {@item.send(:auto_highlight?).should be_true}
       end
-      context 'container auto_hightlight off' do
+      context 'container auto_highlight off' do
         before(:each) do
           @item_container.stub!(:auto_highlight => false)
         end
         it {@item.send(:auto_highlight?).should be_false}
       end
     end
-    context 'global auto_hightlight off' do
+    context 'global auto_highlight off' do
       before(:each) do
         @global.stub!(:auto_highlight => false)
       end
-      context 'container auto_hightlight on' do
+      context 'container auto_highlight on' do
         before(:each) do
           @item_container.stub!(:auto_highlight => true)
         end
         it {@item.send(:auto_highlight?).should be_false}
       end
-      context 'container auto_hightlight off' do
+      context 'container auto_highlight off' do
         before(:each) do
           @item_container.stub!(:auto_highlight => false)
         end
@@ -341,4 +378,20 @@ describe SimpleNavigation::Item do
     end
   end
 
+  describe 'autogenerated_item_id' do
+    context 'calls' do
+      before(:each) do
+        @id_generator = stub(:id_generator)
+        SimpleNavigation.config.stub!(:id_generator => @id_generator)
+      end
+      it "should call the configured generator with the key as param" do
+        @id_generator.should_receive(:call).with(:my_key)
+        @item.send(:autogenerated_item_id)
+      end
+    end
+    context 'default generator' do
+      it {@item.send(:autogenerated_item_id).should == 'my_key'}
+    end
+  end
+
 end

data/spec/lib/simple_navigation/items_provider_spec.rb

@@ -0,0 +1,60 @@
+require File.expand_path(File.dirname(__FILE__) + '/../../spec_helper')
+
+describe SimpleNavigation::ItemsProvider do
+  
+  before(:each) do
+    @provider = stub(:provider)
+    @items_provider = SimpleNavigation::ItemsProvider.new(@provider)
+  end
+  
+  describe 'initialize' do
+    it "should set the provider" do
+      @items_provider.provider.should == @provider
+    end
+  end
+  
+  describe 'items' do
+    before(:each) do
+      @items = stub(:items)
+    end
+    context 'provider is symbol' do
+      before(:each) do
+        @items_provider.instance_variable_set(:@provider, :provider_method)
+        @context = stub(:context, :provider_method => @items)
+        SimpleNavigation::Configuration.stub!(:context_for_eval => @context)
+      end
+      it "should call the method specified by symbol on the context" do
+        @context.should_receive(:provider_method)
+        @items_provider.items
+      end
+      it "should return the items returned by the helper method" do
+        @items_provider.items.should == @items
+      end
+    end
+    context 'provider responds to items' do
+      before(:each) do
+        @provider.stub!(:items => @items)
+      end
+      it "should get the items from the items_provider" do
+        @provider.should_receive(:items)
+        @items_provider.items
+      end
+      it "should return the items of the provider" do
+        @items_provider.items.should == @items
+      end
+    end
+    context 'provider is a collection' do
+      before(:each) do
+        @items_collection = []
+        @items_provider.instance_variable_set(:@provider, @items_collection)      
+      end
+      it "should return the collection itsself" do
+        @items_provider.items.should == @items_collection
+      end
+    end
+    context 'neither symbol nor items_provider.items nor collection' do
+      it {lambda {@items_provider.items}.should raise_error}
+    end
+  end
+  
+end

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

@@ -7,16 +7,16 @@ describe SimpleNavigation::Renderer::List do
     
     def sub_items
       [
-        [:subnav1, 'subnav1', 'subnav1_url', {}, nil],
-        [:subnav2, 'subnav2', 'subnav2_url', {}, nil]
+        [:subnav1, 'subnav1', 'subnav1_url', {}],
+        [:subnav2, 'subnav2', 'subnav2_url', {}]
       ]
     end
     
     def primary_items
       [
-        [:users, 'users', 'first_url', {:id => 'my_id'}, nil],
-        [:invoices, 'invoices', 'second_url', {}, nil],
-        [:accounts, 'accounts', 'third_url', {:style => 'float:right'}, nil]
+        [:users, 'users', 'first_url', {:id => 'my_id'}],
+        [:invoices, 'invoices', 'second_url', {}],
+        [:accounts, 'accounts', 'third_url', {:style => 'float:right'}]
       ]
     end
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: simple-navigation
 version: !ruby/object:Gem::Version 
-  version: 2.0.1
+  version: 2.1.0
 platform: ruby
 authors: 
 - Andi Schacke
@@ -9,7 +9,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2009-10-13 00:00:00 +02:00
+date: 2009-12-18 00:00:00 +01:00
 default_executable: 
 dependencies: []
 
@@ -37,7 +37,9 @@ files:
 - lib/simple_navigation/controller_methods.rb
 - lib/simple_navigation/helpers.rb
 - lib/simple_navigation/item.rb
+- lib/simple_navigation/item_adapter.rb
 - lib/simple_navigation/item_container.rb
+- lib/simple_navigation/items_provider.rb
 - lib/simple_navigation/renderer/base.rb
 - lib/simple_navigation/renderer/list.rb
 - rails/init.rb
@@ -45,8 +47,10 @@ files:
 - spec/lib/simple_navigation/configuration_spec.rb
 - spec/lib/simple_navigation/controller_methods_spec.rb
 - spec/lib/simple_navigation/helpers_spec.rb
+- spec/lib/simple_navigation/item_adapter_spec.rb
 - spec/lib/simple_navigation/item_container_spec.rb
 - spec/lib/simple_navigation/item_spec.rb
+- spec/lib/simple_navigation/items_provider_spec.rb
 - spec/lib/simple_navigation/renderer/base_spec.rb
 - spec/lib/simple_navigation/renderer/list_spec.rb
 - spec/lib/simple_navigation_spec.rb
@@ -85,8 +89,10 @@ test_files:
 - spec/lib/simple_navigation/configuration_spec.rb
 - spec/lib/simple_navigation/controller_methods_spec.rb
 - spec/lib/simple_navigation/helpers_spec.rb
+- spec/lib/simple_navigation/item_adapter_spec.rb
 - spec/lib/simple_navigation/item_container_spec.rb
 - spec/lib/simple_navigation/item_spec.rb
+- spec/lib/simple_navigation/items_provider_spec.rb
 - spec/lib/simple_navigation/renderer/base_spec.rb
 - spec/lib/simple_navigation/renderer/list_spec.rb
 - spec/lib/simple_navigation_spec.rb