simple-navigation 2.4.2 → 2.5.0

data/CHANGELOG

@@ -1,3 +1,8 @@
+*2.5.0
+
+* added new renderer Renderer::Links to simply render the navigation as links inside a div.
+* also make item.name html_safe (in order you have html_code in the item's name). Thanks again, Johan Svensson.
+
 *2.4.2
 
 * Rails 3.0.0.beta2 compatibility

data/VERSION.yml

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

data/lib/simple_navigation/configuration.rb

@@ -27,7 +27,7 @@ module SimpleNavigation
     
     # Sets the config's default-settings
     def initialize
-      @renderer = SimpleNavigation::Renderer::List
+      @renderer = SimpleNavigation.default_renderer || SimpleNavigation::Renderer::List
       @selected_class = 'selected'
       @autogenerate_item_ids = true
       @id_generator = Proc.new {|id| id.to_s }

data/lib/simple_navigation/renderer/base.rb

@@ -43,7 +43,13 @@ module SimpleNavigation
       def render_sub_navigation_for(item)
         item.sub_navigation.render(self.options)
       end
-            
+      
+      # Marks the specified input as html_safe (for Rails3). Does nothing if html_safe is not defined on input. 
+      #
+      def html_safe(input)
+        input.respond_to?(:html_safe) ? input.html_safe : input
+      end
+                  
       # Renders the specified ItemContainer to HTML.
       #
       # When implementing a renderer, please consider to call include_sub_navigation? to determin

data/lib/simple_navigation/renderer/links.rb

@@ -0,0 +1,25 @@
+module SimpleNavigation
+  module Renderer
+    
+    # Renders an ItemContainer as a <div> element and its containing items as <a> elements. 
+    # It adds the 'selected' class to the <a> element that is currently active.
+    #
+    # The Links renderer cannot be used to render nested navigations. If you would like it to use with nested navigations, you have to render each level separately.
+    #
+    # By default, the renderer sets the item's key as dom_id for the rendered <a> 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.
+    # The ItemContainer's dom_class and dom_id are applied to the surrounding <div> element.
+    #
+    class Links < SimpleNavigation::Renderer::Base
+      
+      def render(item_container)
+        div_content = item_container.items.inject([]) do |list, item|
+          list << link_to(html_safe(item.name), item.url, {:method => item.method}.merge(item.html_options))
+        end.join
+        content_tag(:div, html_safe(div_content), {:id => item_container.dom_id, :class => item_container.dom_class})
+      end
+      
+    end
+    
+  end
+end

data/lib/simple_navigation/renderer/list.rb

@@ -13,14 +13,13 @@ 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_content = link_to(html_safe(item.name), item.url, :class => item.selected_class, :method => item.method)
           if include_sub_navigation?(item)
             li_content << render_sub_navigation_for(item)
           end  
           list << content_tag(:li, li_content, html_options)
         end.join
-        list_content = list_content.html_safe if list_content.respond_to?(:html_safe)
-        content_tag(:ul, list_content, {:id => item_container.dom_id, :class => item_container.dom_class})
+        content_tag(:ul, html_safe(list_content), {:id => item_container.dom_id, :class => item_container.dom_class})
       end
     end
     

data/lib/simple_navigation.rb

@@ -8,13 +8,14 @@ require 'simple_navigation/item_container'
 require 'simple_navigation/items_provider'
 require 'simple_navigation/renderer/base'
 require 'simple_navigation/renderer/list'
+require 'simple_navigation/renderer/links'
 require 'simple_navigation/initializer'
 require 'simple_navigation/railtie' if Rails::VERSION::MAJOR == 3
 
 # A plugin for generating a simple navigation. See README for resources on usage instructions.
 module SimpleNavigation
 
-  mattr_accessor :config_files, :config_file_path, :controller, :template, :explicit_current_navigation, :rails_env, :rails_root
+  mattr_accessor :config_files, :config_file_path, :default_renderer, :controller, :template, :explicit_current_navigation, :rails_env, :rails_root
 
   self.config_files = {}
   

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

@@ -59,6 +59,22 @@ describe SimpleNavigation::Renderer::Base do
     end
   end
   
+  describe 'html_safe' do
+    before(:each) do
+      @input = stub :input
+    end
+    context 'input does respond to html_safe' do
+      before(:each) do
+        @safe = stub :safe
+        @input.stub!(:html_safe => @safe)
+      end
+      it {@base_renderer.html_safe(@input).should == @safe}
+    end
+    context 'input does not respond to html_safe' do
+      it {@base_renderer.html_safe(@input).should == @input}
+    end
+  end
+  
   describe 'expand_all?' do
     context 'option is set' do
       context 'expand_all is true' do

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

@@ -0,0 +1,121 @@
+require File.dirname(__FILE__) + '/../../../spec_helper'
+require 'html/document' unless defined? HTML::Document
+
+describe SimpleNavigation::Renderer::Links do
+    
+  describe 'render' do
+    
+
+    def render(current_nav=nil, options={:level => :all})
+      primary_navigation = primary_container
+      select_item(current_nav) if current_nav
+      @renderer = SimpleNavigation::Renderer::Links.new(options)
+      HTML::Document.new(@renderer.render(primary_navigation)).root
+    end
+      
+    context 'regarding result' do
+      
+      it "should render a div-tag around the items" do
+        HTML::Selector.new('div').select(render).should have(1).entries
+      end
+      it "the rendered div-tag should have the specified dom_id" do
+        HTML::Selector.new('div#nav_dom_id').select(render).should have(1).entries
+      end
+      it "the rendered div-tag should have the specified class" do
+        HTML::Selector.new('div.nav_dom_class').select(render).should have(1).entries
+      end
+      it "should render an a-tag for each item" do
+        HTML::Selector.new('a').select(render).should have(3).entries
+      end
+      it "should pass the specified html_options to the a element" do
+        HTML::Selector.new('a[style=float:right]').select(render).should have(1).entries
+      end
+      it "should give the a-tag the id specified in the html_options" do
+        HTML::Selector.new('a#my_id').select(render).should have(1).entries
+      end
+      it "should give the a-tag the default id (stringified key) if no id is specified in the html_options" do
+        HTML::Selector.new('a#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('a#users').select(render).should be_empty
+      end
+    
+      context 'with current_navigation set' do
+        it "should mark the matching a-item as selected (with the css_class specified in configuration)" do
+          HTML::Selector.new('a.selected').select(render(:invoices)).should have(1).entries
+        end      
+      end
+    
+      context 'without current_navigation set' do
+        it "should not mark any of the items as selected" do
+          HTML::Selector.new('a.selected').select(render).should be_empty
+        end
+      end
+    
+      # 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)).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)).should have(1).entries
+      #   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, :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 '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, :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
+    
+    context 'regarding method calls' do
+      
+      context 'regarding the div_content' do
+        before(:each) do
+          @primary_navigation = primary_container
+          @div_content = stub(:div_content)
+          @div_items = stub(:div_items, :join => @div_content)
+          @items.stub!(:inject => @div_items)
+          @renderer = SimpleNavigation::Renderer::Links.new(options)
+        end
+      
+        it "should join the list_items" do
+          @div_items.should_receive(:join)
+        end
+      
+        it "should html_saferize the list_content" do
+          @renderer.should_receive(:html_safe).with(@div_content)
+        end
+      
+        after(:each) do
+          @renderer.render(@primary_navigation)
+        end
+      end
+      
+      context 'regarding the items' do
+        before(:each) do
+          @primary_navigation = primary_container
+          @renderer = SimpleNavigation::Renderer::Links.new(options)
+        end
+        
+        it "should call html_safe on every item's name" do
+          @items.each do |item|
+            @renderer.should_receive(:html_safe).with(item.name)
+          end
+          @renderer.should_receive(:html_safe).with(anything)
+          @renderer.render(@primary_navigation)
+        end
+      end
+      
+    end
+    
+  end
+end

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

@@ -5,48 +5,6 @@ describe SimpleNavigation::Renderer::List do
     
   describe 'render' do
     
-    def sub_items
-      [
-        [:subnav1, 'subnav1', 'subnav1_url', {}],
-        [:subnav2, 'subnav2', 'subnav2_url', {}]
-      ]
-    end
-    
-    def primary_items
-      [
-        [:users, 'users', 'first_url', {:id => 'my_id'}],
-        [:invoices, 'invoices', 'second_url', {}],
-        [:accounts, 'accounts', 'third_url', {:style => 'float:right'}]
-      ]
-    end
-
-    def primary_container
-      container = SimpleNavigation::ItemContainer.new(0)
-      container.dom_id = 'nav_dom_id'
-      container.dom_class = 'nav_dom_class'
-      @items = primary_items.map {|params| SimpleNavigation::Item.new(container, *params)}
-      @items.each {|i| i.stub!(:selected? => false)}
-      container.instance_variable_set(:@items, @items)
-      primary_item(:invoices) {|item| item.instance_variable_set(:@sub_navigation, subnav_container)}
-      container
-    end
-
-    def primary_item(key)
-      yield @items.find {|i| i.key == key}
-    end
-
-    def select_item(key)
-      primary_item(key) {|item| item.stub!(:selected? => true)}
-    end
-
-    def subnav_container
-      container = SimpleNavigation::ItemContainer.new(1)
-      items = sub_items.map {|params| SimpleNavigation::Item.new(container, *params)}
-      items.each {|i| i.stub!(:selected? => false)}
-      container.instance_variable_set(:@items, items)
-      container
-    end
-
     def render(current_nav=nil, options={:level => :all})
       primary_navigation = primary_container
       select_item(current_nav) if current_nav
@@ -128,37 +86,42 @@ describe SimpleNavigation::Renderer::List do
     end
     
     context 'regarding method calls' do
-      before(:each) do
-        @primary_navigation = primary_container
-        @list_content = stub(:list_content)
-        @list_items = stub(:list_items, :join => @list_content)
-        @items.stub!(:inject => @list_items)
-        @renderer = SimpleNavigation::Renderer::List.new(options)
-      end
       
-      it "should join the list_items" do
-        @list_items.should_receive(:join)
-      end
-      
-      context 'html_safe is defined on the joined list_content' do
+      context 'regarding the list_content' do
         before(:each) do
-          @safe_list_content = stub(:safe_list_content)
-          @list_content.stub!(:html_safe => @safe_list_content)
+          @primary_navigation = primary_container
+          @list_content = stub(:list_content)
+          @list_items = stub(:list_items, :join => @list_content)
+          @items.stub!(:inject => @list_items)
+          @renderer = SimpleNavigation::Renderer::List.new(options)
         end
-        
-        it "should create the ul-element with the html_safe content" do
-          @renderer.should_receive(:content_tag).with(:ul, @safe_list_content, anything)
+      
+        it "should join the list_items" do
+          @list_items.should_receive(:join)
         end
-      end
       
-      context 'html_safe is not defined on the joined list_content' do
-        it "should create the ul-element with the normal list content" do
-          @renderer.should_receive(:content_tag).with(:ul, @list_content, anything)
+        it "should html_saferize the list_content" do
+          @renderer.should_receive(:html_safe).with(@list_content)
+        end
+      
+        after(:each) do
+          @renderer.render(@primary_navigation)
         end
       end
-    
-      after(:each) do
-        @renderer.render(@primary_navigation)
+      
+      context 'regarding the items' do
+        before(:each) do
+          @primary_navigation = primary_container
+          @renderer = SimpleNavigation::Renderer::List.new(options)
+        end
+        
+        it "should call html_safe on every item's name" do
+          @items.each do |item|
+            @renderer.should_receive(:html_safe).with(item.name)
+          end
+          @renderer.should_receive(:html_safe).with(anything)
+          @renderer.render(@primary_navigation)
+        end
       end
       
     end

data/spec/spec_helper.rb

@@ -19,4 +19,47 @@ SimpleNavigation.rails_root = './'
 
 # Spec::Runner.configure do |config|
   # no special config
-# endx
+# endx
+
+# spec helper methods
+def sub_items
+  [
+    [:subnav1, 'subnav1', 'subnav1_url', {}],
+    [:subnav2, 'subnav2', 'subnav2_url', {}]
+  ]
+end
+
+def primary_items
+  [
+    [:users, 'users', 'first_url', {:id => 'my_id'}],
+    [:invoices, 'invoices', 'second_url', {}],
+    [:accounts, 'accounts', 'third_url', {:style => 'float:right'}]
+  ]
+end
+
+def primary_container
+  container = SimpleNavigation::ItemContainer.new(0)
+  container.dom_id = 'nav_dom_id'
+  container.dom_class = 'nav_dom_class'
+  @items = primary_items.map {|params| SimpleNavigation::Item.new(container, *params)}
+  @items.each {|i| i.stub!(:selected? => false)}
+  container.instance_variable_set(:@items, @items)
+  primary_item(:invoices) {|item| item.instance_variable_set(:@sub_navigation, subnav_container)}
+  container
+end
+
+def primary_item(key)
+  yield @items.find {|i| i.key == key}
+end
+
+def select_item(key)
+  primary_item(key) {|item| item.stub!(:selected? => true)}
+end
+
+def subnav_container
+  container = SimpleNavigation::ItemContainer.new(1)
+  items = sub_items.map {|params| SimpleNavigation::Item.new(container, *params)}
+  items.each {|i| i.stub!(:selected? => false)}
+  container.instance_variable_set(:@items, items)
+  container
+end

metadata

@@ -4,9 +4,9 @@ version: !ruby/object:Gem::Version
   prerelease: false
   segments: 
   - 2
-  - 4
-  - 2
-  version: 2.4.2
+  - 5
+  - 0
+  version: 2.5.0
 platform: ruby
 authors: 
 - Andi Schacke
@@ -14,7 +14,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-04-11 00:00:00 +02:00
+date: 2010-04-13 00:00:00 +02:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -59,6 +59,7 @@ files:
 - lib/simple_navigation/items_provider.rb
 - lib/simple_navigation/railtie.rb
 - lib/simple_navigation/renderer/base.rb
+- lib/simple_navigation/renderer/links.rb
 - lib/simple_navigation/renderer/list.rb
 - rails/init.rb
 - spec/lib/simple_navigation/configuration_spec.rb
@@ -69,6 +70,7 @@ files:
 - 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/links_spec.rb
 - spec/lib/simple_navigation/renderer/list_spec.rb
 - spec/lib/simple_navigation_spec.rb
 - spec/spec_helper.rb
@@ -112,6 +114,7 @@ test_files:
 - 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/links_spec.rb
 - spec/lib/simple_navigation/renderer/list_spec.rb
 - spec/lib/simple_navigation_spec.rb
 - spec/spec_helper.rb