simple-navigation 3.0.0.beta2 → 3.0.0

data/CHANGELOG

@@ -1,3 +1,8 @@
+*3.0.0
+
+* added ability to specify dynamic items using an array of hashes. Credits to Anshul Khandelwal for input and discussion.
+* added ability to specify attributes for the generated link-tag in list renderer (up to now the attributes have been applied to the li-tag). Credits to Anthony Navarre for input and discussion.
+
 *3.0.0.beta2
 
 * moving code for initializing plugin in sinatra to separate gem

data/lib/simple_navigation/core/configuration.rb

@@ -35,9 +35,9 @@ module SimpleNavigation
     # 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
+    # 1. Directly provide your items to the method (e.g. when loading your items from the database).
     #
-    # ==== Example for block style
+    # ==== Example for block style (configuration file)
     #   config.items do |primary|
     #     primary.item :my_item, 'My item', my_item_path
     #     ...

data/lib/simple_navigation/core/item_adapter.rb

@@ -14,6 +14,9 @@ module SimpleNavigation
   # * <tt>options</tt>
   # * <tt>items</tt> - if one of your items has a subnavigation it must respond to <tt>items</tt> providing the subnavigation.
   #
+  # You can also specify your items as a list of hashes. The hashes will be converted to objects automatically.
+  # The hashes representing the items obviously must have the keys :key, :name and :url and optionally the keys :options and :items.
+  #
   # See SimpleNavigation::ItemContainer#item for the purpose of these methods.
   class ItemAdapter
     extend Forwardable
@@ -23,7 +26,7 @@ module SimpleNavigation
     attr_reader :item
 
     def initialize(item)
-      @item = item
+      @item = item.instance_of?(Hash) ? to_object(item) : item
     end
 
     # Returns the options for this item. If the wrapped item does not implement an options method, an empty hash is returned.
@@ -41,5 +44,20 @@ module SimpleNavigation
       SimpleNavigation::Item.new(item_container, key, name, url, options, items)
     end
 
+    protected
+    
+    # Converts the specified hash into an object. Each key will be added as method.
+    #
+    def to_object(hash)
+      mod = Module.new do
+        hash.each_pair do |key, value|
+          define_method key do
+            value
+          end
+        end
+      end
+      Object.new.extend(mod)
+    end
+
   end
 end

data/lib/simple_navigation/core/item_container.rb

@@ -71,7 +71,7 @@ module SimpleNavigation
     #
     # The options are the same as in the view's render_navigation call (they get passed on)
     def render(options={})
-      renderer_class = if options[:renderer]
+      renderer_instance = if options[:renderer]
         if options[:renderer].instance_of?(Symbol) && SimpleNavigation.registered_renderers.key?(options[:renderer])
           SimpleNavigation.registered_renderers[options[:renderer]].new(options)
         else
@@ -80,7 +80,7 @@ module SimpleNavigation
       else
         self.renderer.new(options)
       end
-      renderer_class.render(self)
+      renderer_instance.render(self)
     end
 
     # Returns true if any of this container's items is selected.

data/lib/simple_navigation/rendering/renderer/list.rb

@@ -12,12 +12,12 @@ module SimpleNavigation
 
       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)
+          li_options = item.html_options.reject {|k, v| k == :link}
+          li_content = link_to(item.name, item.url, link_options_for(item))
           if include_sub_navigation?(item)
             li_content << render_sub_navigation_for(item)
           end
-          list << content_tag(:li, li_content, html_options)
+          list << content_tag(:li, li_content, li_options)
         end.join
         if skip_if_empty? && item_container.empty?
           ''
@@ -25,7 +25,23 @@ module SimpleNavigation
           content_tag(:ul, list_content, {:id => item_container.dom_id, :class => item_container.dom_class}) 
         end
       end
+      
+      protected
+      
+      # Extracts the options relevant for the generated link
+      #
+      def link_options_for(item)
+        special_options = {:method => item.method, :class => item.selected_class}.reject {|k, v| v.nil? }
+        link_options = item.html_options[:link]
+        return special_options unless link_options
+        opts = special_options.merge(link_options)
+        opts[:class] = [link_options[:class], item.selected_class].flatten.compact.join(' ')
+        opts.delete(:class) if opts[:class].nil? || opts[:class] == ''
+        opts
+      end
+      
+      
     end
-
+  
   end
 end

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

@@ -1,6 +1,6 @@
 require File.expand_path(File.dirname(__FILE__) + '/../../../spec_helper')
 
-describe SimpleNavigation::ItemAdapter do
+describe SimpleNavigation::ItemAdapter, 'when item is an object' do
 
   before(:each) do
     @item = stub(:item)
@@ -99,4 +99,111 @@ describe SimpleNavigation::ItemAdapter do
     end
   end
 
+end
+
+describe SimpleNavigation::ItemAdapter, 'when item is a hash' do
+
+  before(:each) do
+    @item = {:key => 'key', :url => 'url', :name => 'name'}
+    @item_adapter = SimpleNavigation::ItemAdapter.new(@item)
+  end
+
+  describe 'key' do
+    it "should delegate key to item" do
+      @item_adapter.item.should_receive(:key)
+      @item_adapter.key
+    end
+  end
+
+  describe 'url' do
+    it "should delegate url to item" do
+      @item_adapter.item.should_receive(:url)
+      @item_adapter.url
+    end
+  end
+
+  describe 'name' do
+    it "should delegate name to item" do
+      @item_adapter.item.should_receive(:name)
+      @item_adapter.name
+    end
+  end
+
+  describe 'initialize' do
+    it "should set the item" do
+      @item_adapter.item.should_not be_nil
+    end
+    it "should have converted the item into an object" do
+      @item_adapter.item.should respond_to(:url)
+    end
+  end
+
+  describe 'options' do
+    context 'item does respond to options' do
+      before(:each) do
+        @item = {:key => 'key', :url => 'url', :name => 'name', :options => {:my => :options}}
+        @item_adapter = SimpleNavigation::ItemAdapter.new(@item)
+      end
+      it "should return the item's options'" do
+        @item_adapter.options.should == {:my => :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 = {:key => 'key', :url => 'url', :name => 'name', :items => nil}
+          @item_adapter = SimpleNavigation::ItemAdapter.new(@item)
+        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 = {:key => 'key', :url => 'url', :name => 'name', :items => []}
+            @item_adapter = SimpleNavigation::ItemAdapter.new(@item)
+          end
+          it "should return nil" do
+            @item_adapter.items.should be_nil
+          end
+        end
+        context 'items is not empty' do
+          before(:each) do
+            @item = {:key => 'key', :url => 'url', :name => 'name', :items => ['not', 'empty']}
+            @item_adapter = SimpleNavigation::ItemAdapter.new(@item)
+          end
+          it "should return the items" do
+            @item_adapter.items.should == ['not', 'empty']
+          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 = {:key => 'key', :url => 'url', :name => 'name', :items => [], :options => {}}
+      @item_adapter = SimpleNavigation::ItemAdapter.new(@item)
+    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/rendering/renderer/list_spec.rb

@@ -29,19 +29,38 @@ describe SimpleNavigation::Renderer::List do
       it "should render an a-tag inside each li-tag" do
         HTML::Selector.new('li a').select(render).should have(3).entries
       end
-      it "should pass the specified html_options to the li element" do
-        HTML::Selector.new('li[style=float:right]').select(render).should have(1).entries
-      end
-      it "should give the li the id specified in the html_options" do
-        HTML::Selector.new('li#my_id').select(render).should have(1).entries
-      end
-      it "should give the li the default id (stringified key) if no id is specified in the html_options" do
-        HTML::Selector.new('ul li#invoices').select(render).should have(1).entries
-      end
-      it "should not apply the the default id where there is an id specified in the html_options" do
-        HTML::Selector.new('ul li#users').select(render).should be_empty
-      end
 
+      context 'concerning html attributes' do
+        context 'default case (no options defined for link tag)' do
+          it "should pass the specified html_options to the li element" do
+            HTML::Selector.new('li[style=float:right]').select(render).should have(1).entries
+          end
+          it "should give the li the id specified in the html_options" do
+            HTML::Selector.new('li#my_id').select(render).should have(1).entries
+          end
+          it "should give the li the default id (stringified key) if no id is specified in the html_options" do
+            HTML::Selector.new('ul li#invoices').select(render).should have(1).entries
+          end
+          it "should not apply the the default id where there is an id specified in the html_options" do
+            HTML::Selector.new('ul li#users').select(render).should be_empty
+          end
+        end
+        context 'with attributes defined for the link tag as well' do
+          it "should add the link attributes to the link" do
+            HTML::Selector.new('a[style=float:left]').select(render).should have(1).entries
+          end
+          it "should add the li attributes to the li element" do
+            HTML::Selector.new('li[style=float:right]').select(render).should have(1).entries
+          end
+          it "should give the li the default id (stringified key) if no id is specified in the html_options for the li-element" do
+            HTML::Selector.new('ul li#invoices').select(render).should have(1).entries
+          end
+          it "should not apply the the default id where there is an id specified in the html_options for th li-element" do
+            HTML::Selector.new('ul li#users').select(render).should be_empty
+          end
+        end
+      end
+      
       context 'with current_navigation set' do
         it "should mark the matching li-item as selected (with the css_class specified in configuration)" do
           HTML::Selector.new('li.selected').select(render(:invoices)).should have(1).entries
@@ -49,7 +68,6 @@ describe SimpleNavigation::Renderer::List do
         it "should also mark the links inside the selected li's as selected" do
           HTML::Selector.new('li.selected a.selected').select(render(:invoices)).should have(1).entries
         end
-
       end
 
       context 'without current_navigation set' do
@@ -125,5 +143,47 @@ describe SimpleNavigation::Renderer::List do
       end
     end
     
+    describe 'link_options_for' do
+      before(:each) do
+        setup_renderer_for SimpleNavigation::Renderer::List, :rails, options
+      end
+      context 'no link options specified' do
+        context 'method specified' do
+          context 'item selected' do
+            before(:each) do
+              @item = stub(:item, :method => :delete, :selected_class => 'selected', :html_options => {})
+            end
+            it {@renderer.send(:link_options_for, @item).should == {:method => :delete, :class => 'selected'}}
+          end
+          context 'item not selected' do
+            before(:each) do
+              @item = stub(:item, :method => :delete, :selected_class => nil, :html_options => {})
+            end
+            it {@renderer.send(:link_options_for, @item).should == {:method => :delete}}
+          end
+        end
+        context 'method not specified' do
+          context 'item selected' do
+            before(:each) do
+              @item = stub(:item, :method => nil, :selected_class => 'selected', :html_options => {})
+            end
+            it {@renderer.send(:link_options_for, @item).should == {:class => 'selected'}}
+          end
+          context 'item not selected' do
+            before(:each) do
+              @item = stub(:item, :method => nil, :selected_class => nil, :html_options => {})
+            end
+            it {@renderer.send(:link_options_for, @item).should == {}}
+          end        
+        end
+      end
+      context 'link options specified' do
+        before(:each) do
+          @item = stub(:item, :method => :delete, :selected_class => 'selected', :html_options => {:link => {:class => 'link_class', :style => 'float:left'}})
+        end
+        it {@renderer.send(:link_options_for, @item).should == {:method => :delete, :class => 'link_class selected', :style => 'float:left'}}
+      end
+    end
+    
   end
 end

data/spec/spec_helper.rb

@@ -35,7 +35,7 @@ def primary_items
   [
     [:users, 'users', 'first_url', {:id => 'my_id'}],
     [:invoices, 'invoices', 'second_url', {}],
-    [:accounts, 'accounts', 'third_url', {:style => 'float:right'}]
+    [:accounts, 'accounts', 'third_url', {:style => 'float:right', :link => {:style => 'float:left'}}]
   ]
 end
 

metadata

@@ -1,13 +1,12 @@
 --- !ruby/object:Gem::Specification 
 name: simple-navigation
 version: !ruby/object:Gem::Version 
-  prerelease: true
+  prerelease: false
   segments: 
   - 3
   - 0
   - 0
-  - beta2
-  version: 3.0.0.beta2
+  version: 3.0.0
 platform: ruby
 authors: 
 - Andi Schacke
@@ -15,7 +14,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-09-02 00:00:00 +02:00
+date: 2010-09-28 00:00:00 +02:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency