simple-navigation 2.5.4 → 2.6.0

data/CHANGELOG

@@ -1,3 +1,10 @@
+*2.6.0
+
+* added rendering option 'skip_if_empty' to Renderer::List to avoid rendering of empty ul-tags
+* added breadcrumbs renderer incl. specs. A big thanks to Markus Schirp.
+* added ability to register a renderer / specify your renderer as symbol in render_navigation
+* renderer can be specified in render_navigation. Credits to Andi Badi from Galaxy Cats.
+
 *2.5.4
 
 * bugfix: SimpleNavigation.config_file? without params does not check for _navigation.rb file anymore. Credits to Markus Schirp.

data/VERSION.yml

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

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

@@ -2,6 +2,7 @@
 SimpleNavigation::Configuration.run do |navigation|  
   # Specify a custom renderer if needed. 
   # The default renderer is SimpleNavigation::Renderer::List which renders HTML lists.
+  # The renderer can also be specified as option in the render_navigation call. 
   # navigation.renderer = Your::Custom::Renderer
   
   # Specify the class that will be applied to active navigation items. Defaults to 'selected'

data/lib/simple_navigation/configuration.rb

@@ -7,8 +7,7 @@ module SimpleNavigation
     include Singleton
     
     attr_accessor :renderer, :selected_class, :autogenerate_item_ids, :id_generator, :auto_highlight
-    attr_reader :render_all_levels
-    attr_reader :primary_navigation
+    attr_reader :render_all_levels, :primary_navigation
 
     class << self
 
@@ -52,6 +51,7 @@ module SimpleNavigation
     #   end
     #
     # ==== To consider when directly providing items
+    # items_provider should be:
     # * 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
@@ -75,7 +75,7 @@ module SimpleNavigation
     def context_for_eval
       self.class.context_for_eval
     end
-    
+        
   end  
   
 end

data/lib/simple_navigation/controller_methods.rb

@@ -77,4 +77,4 @@ module SimpleNavigation
     end
 
   end
-end
+end

data/lib/simple_navigation/helpers.rb

@@ -30,6 +30,7 @@ module SimpleNavigation
     #   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>: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. 
+    # * <tt>:renderer</tt> - specify the renderer to be used for rendering the navigation. Either provide the Class or a symbol matching a registered renderer. Defaults to :list (html list renderer).
     def render_navigation(*args)
       args = [Hash.new] if args.empty?
       options = extract_backwards_compatible_options(*args)
@@ -94,4 +95,4 @@ module SimpleNavigation
     end
       
   end
-end
+end

data/lib/simple_navigation/item.rb

@@ -75,19 +75,17 @@ module SimpleNavigation
       url == '/' && SimpleNavigation.controller.request.path == '/'
     end
 
-    # Converts url to url_hash. Accesses routing system, quite slow... Not used at the moment
-    # def hash_for_url(url) #:nodoc:
-    #   ActionController::Routing::Routes.recognize_path(url, {:method => (method || :get)})
-    # end
-
+    # Returns true if the item's id should be added to the rendered output.
     def autogenerate_item_ids?
       SimpleNavigation.config.autogenerate_item_ids
     end
 
+    # Returns the item's id which is added to the rendered output.
     def autogenerated_item_id
       SimpleNavigation.config.id_generator.call(key)
     end
 
+    # Return true if auto_highlight is on for this item.
     def auto_highlight?
       SimpleNavigation.config.auto_highlight && @container.auto_highlight
     end

data/lib/simple_navigation/item_container.rb

@@ -68,7 +68,16 @@ module SimpleNavigation
     #
     # 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)
+      renderer_class = if options[:renderer]
+        if options[:renderer].instance_of?(Symbol) && SimpleNavigation.registered_renderers.key?(options[:renderer])
+          SimpleNavigation.registered_renderers[options[:renderer]].new(options)
+        else
+          options[:renderer].new(options)
+        end
+      else
+        self.renderer.new(options)
+      end
+      renderer_class.render(self)
     end
 
     # Returns true if any of this container's items is selected.
@@ -99,6 +108,11 @@ module SimpleNavigation
       return selected_item.sub_navigation.active_item_container_for(desired_level)
     end
 
+    # Returns true if there are no items defined for this container.
+    def empty?
+      items.empty?
+    end
+
     private
     
     def selected_sub_navigation?

data/lib/simple_navigation/renderer/base.rb

@@ -34,6 +34,10 @@ module SimpleNavigation
       
       def level
         options[:level] || :all
+      end
+      
+      def skip_if_empty?
+        !!options[:skip_if_empty]
       end      
       
       def include_sub_navigation?(item)
@@ -81,4 +85,4 @@ module SimpleNavigation
             
     end
   end
-end
+end

data/lib/simple_navigation/renderer/breadcrumbs.rb

@@ -0,0 +1,38 @@
+module SimpleNavigation
+  module Renderer
+    
+    # Renders an ItemContainer as a <div> element and its containing items as <a> elements. 
+    # It only renders 'selected' elements.
+    #
+    # 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 Breadcrumbs < SimpleNavigation::Renderer::Base
+      
+      def render(item_container)
+        a_tags = a_tags(item_container)
+        content_tag(:div, html_safe(a_tags(item_container).join(join_with)), {:id => item_container.dom_id, :class => item_container.dom_class})
+      end
+
+      protected
+
+      def a_tags(item_container)
+        item_container.items.inject([]) do |list, item|
+          if item.selected?
+            list << link_to(html_safe(item.name), item.url, {:method => item.method}.merge(item.html_options.except(:class,:id))) if item.selected?
+            if include_sub_navigation?(item)
+              list.concat a_tags(item.sub_navigation) 
+            end
+          end
+          list
+        end
+      end
+
+      def join_with
+        @join_with ||= options[:join_with] || " "
+      end
+    end
+    
+  end
+end

data/lib/simple_navigation/renderer/list.rb

@@ -19,7 +19,11 @@ module SimpleNavigation
           end  
           list << content_tag(:li, li_content, html_options)
         end.join
-        content_tag(:ul, html_safe(list_content), {:id => item_container.dom_id, :class => item_container.dom_class})
+        if skip_if_empty? && item_container.empty?
+          ''
+        else  
+          content_tag(:ul, html_safe(list_content), {:id => item_container.dom_id, :class => item_container.dom_class}) 
+        end
       end
     end
     

data/lib/simple_navigation.rb

@@ -9,18 +9,26 @@ require 'simple_navigation/items_provider'
 require 'simple_navigation/renderer/base'
 require 'simple_navigation/renderer/list'
 require 'simple_navigation/renderer/links'
+require 'simple_navigation/renderer/breadcrumbs'
 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, :default_renderer, :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, :registered_renderers
 
   self.config_files = {}
+  self.registered_renderers = {
+    :list         => SimpleNavigation::Renderer::List,
+    :links        => SimpleNavigation::Renderer::Links,
+    :breadcrumbs  => SimpleNavigation::Renderer::Breadcrumbs
+  }
+  
   
   class << self
 
+    # Sets the config file path and installs the ControllerMethods in ActionController::Base.
     def init_rails
       SimpleNavigation.config_file_path = SimpleNavigation.default_config_file_path unless SimpleNavigation.config_file_path
       ActionController::Base.send(:include, SimpleNavigation::ControllerMethods)
@@ -30,6 +38,7 @@ module SimpleNavigation
       File.join(SimpleNavigation.rails_root, 'config')
     end
   
+    # Returns true if the config_file for specified context does exist.
     def config_file?(navigation_context = :default)
       File.exists?(config_file_name(navigation_context))
     end
@@ -124,6 +133,21 @@ module SimpleNavigation
         context
       end
     end
+    
+    # Registers a renderer.
+    #
+    # === Example
+    # To register your own renderer: 
+    #
+    #   SimpleNavigation.register_renderer :my_renderer => My::RendererClass
+    # 
+    # Then in the view you can call:
+    #
+    #   render_navigation(:renderer => :my_renderer)
+    #
+    def register_renderer(renderer_hash)
+      self.registered_renderers.merge!(renderer_hash)
+    end
 
     private
   
@@ -158,7 +182,6 @@ module SimpleNavigation
 end
 
 # TODOs for the next releases:
-# 0) make sn_set_navigation private in controllers
 # 1) add ability to specify explicit highlighting in the config-file itself (directly with the item)
 #    - item.highlight_on :controller => 'users', :action => 'show' ...^
 #   --> with that we can get rid of the controller_methods...

data/spec/lib/simple_navigation/item_container_spec.rb

@@ -282,13 +282,10 @@ describe SimpleNavigation::ItemContainer do
               @item_container.item('key', 'name', 'url', @options)
             end
           end
-        
+          
         end
-        
       end
-
     end
-    
   end
   
   describe '[]' do
@@ -309,23 +306,51 @@ describe SimpleNavigation::ItemContainer do
   
   describe 'render' do
     before(:each) do
-      @renderer = stub(:renderer)
-      @renderer_instance = stub(:renderer_instance, :null_object => true)
-      @renderer.stub!(:new).and_return(@renderer_instance)
-      @item_container.stub!(:renderer).and_return(@renderer)
-      @items = stub(:items)
-      @item_container.stub!(:items).and_return(@items)
-      @options = stub(:options)
+      @renderer_instance = stub(:renderer, :null_object => true)
+      @renderer_class = stub(:renderer_class, :new => @renderer_instance)
     end
-    it "should instatiate a renderer" do
-      @renderer.should_receive(:new).with(@options)
-      @item_container.render(@options)
+    context 'renderer specified as option' do
+      context 'renderer-class specified' do
+        it "should instantiate the passed renderer_class with the options" do
+          @renderer_class.should_receive(:new).with(:renderer => @renderer_class)
+        end
+        it "should call render on the renderer and pass self" do
+          @renderer_instance.should_receive(:render).with(@item_container)
+        end          
+        after(:each) do
+          @item_container.render(:renderer => @renderer_class)
+        end
+      end
+      context 'renderer-symbol specified' do
+        before(:each) do
+          SimpleNavigation.registered_renderers = {:my_renderer => @renderer_class}
+        end
+        it "should instantiate the passed renderer_class with the options" do
+          @renderer_class.should_receive(:new).with(:renderer => :my_renderer)
+        end
+        it "should call render on the renderer and pass self" do
+          @renderer_instance.should_receive(:render).with(@item_container)
+        end     
+        after(:each) do
+          @item_container.render(:renderer => :my_renderer)
+        end     
+      end
     end
-    it "should call render on the renderer and pass self" do
-      @renderer_instance.should_receive(:render).with(@item_container)
-      @item_container.render
+    context 'no renderer specified' do
+      before(:each) do
+        @item_container.stub!(:renderer => @renderer_class)
+        @options = {}
+      end
+      it "should instantiate the container's renderer with the options" do
+        @renderer_class.should_receive(:new).with(@options)
+      end
+      it "should call render on the renderer and pass self" do
+        @renderer_instance.should_receive(:render).with(@item_container)
+      end
+      after(:each) do
+        @item_container.render(@options)
+      end
     end
-    
   end
   
   describe 'level_for_item' do
@@ -347,8 +372,17 @@ describe SimpleNavigation::ItemContainer do
     it {@item_container.level_for_item(:ss1).should == 3}
     it {@item_container.level_for_item(:x).should be_nil}
 
-
-
+  end
+  
+  describe 'empty?' do
+    it "should be empty if there are no items" do
+      @item_container.instance_variable_set(:@items, [])
+      @item_container.should be_empty
+    end
+    it "should not be empty if there are some items" do
+      @item_container.instance_variable_set(:@items, [stub(:item)])
+      @item_container.should_not be_empty
+    end
   end
 
 end

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

@@ -97,6 +97,29 @@ describe SimpleNavigation::Renderer::Base do
       it {@base_renderer.expand_all?.should be_false}
     end
   end
+  
+  describe 'skip_if_empty?' do
+    context 'option is set' do
+      context 'skip_if_empty is true' do
+        before(:each) do
+          @base_renderer.stub!(:options => {:skip_if_empty => true})
+        end
+        it {@base_renderer.skip_if_empty?.should be_true}
+      end
+      context 'skip_if_empty is false' do
+        before(:each) do
+          @base_renderer.stub!(:options => {:skip_if_empty => false})
+        end
+        it {@base_renderer.skip_if_empty?.should be_false}
+      end
+    end
+    context 'option is not set' do
+      before(:each) do
+        @base_renderer.stub!(:options => {})
+      end
+      it {@base_renderer.skip_if_empty?.should be_false}
+    end
+  end
 
   describe 'level' do
     context 'options[level] is set' do

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

@@ -0,0 +1,100 @@
+require File.dirname(__FILE__) + '/../../../spec_helper'
+require 'html/document' unless defined? HTML::Document
+
+describe SimpleNavigation::Renderer::Breadcrumbs 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::Breadcrumbs.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
+
+      context 'without current_navigation set' do
+        it "should not render any a-tag in the div-tag" do
+          HTML::Selector.new('div a').select(render).should have(0).entries
+        end
+      end
+    
+      context 'with current_navigation set' do
+        before :all do
+          @selection = HTML::Selector.new('div a').select(render(:invoices))
+        end
+        it "should render the selected a tags" do
+          @selection.should have(1).entries
+        end
+
+        it "should not render class or id" do
+          @selection.each do |tag|
+            raise unless tag.name == "a"
+            tag["id"].should be_nil
+            tag["class"].should be_nil
+          end
+        end
+      end
+    
+    
+      context 'nested sub_navigation' do
+        it "should add an a tag for each selected item" do
+          HTML::Selector.new('div a').select(render(:subnav1)).should have(2).entries
+        end
+      end
+    end
+    
+    context 'regarding method calls' do
+      
+      context 'regarding the list_content' 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::Breadcrumbs.new(options)
+        end
+      
+        it "should join the list_items" do
+          @list_items.should_receive(:join)
+        end
+      
+        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
+      
+      context 'regarding the items' do
+        before(:each) do
+          @primary_navigation = primary_container
+          select_item(:invoices)
+          @renderer = SimpleNavigation::Renderer::Breadcrumbs.new(options)
+        end
+        
+        it "should call html_safe on every rendered item's name" do
+          @items.each do |item|
+            @renderer.should_receive(:html_safe).with(item.name) if item.selected?
+          end
+          @renderer.should_receive(:html_safe).with(anything).twice()
+          @renderer.render(@primary_navigation)
+        end
+      end
+      
+    end
+  end
+end

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

@@ -83,6 +83,46 @@ describe SimpleNavigation::Renderer::List do
         end
           
       end
+      
+      context 'skip_if_empty' do
+        
+        def render_container(options={})
+          @renderer = SimpleNavigation::Renderer::List.new(options)
+          HTML::Document.new(@renderer.render(@container)).root
+        end
+        
+        context 'container is empty' do
+          before(:each) do
+            @container = SimpleNavigation::ItemContainer.new(0)
+          end
+          context 'skip_if_empty is true' do
+            it "should not render a ul tag for the empty container" do
+              HTML::Selector.new('ul').select(render_container(:skip_if_empty => true)).should be_empty
+            end
+          end
+          context 'skip_if_empty is false' do
+            it "should render a ul tag for the empty container" do
+              HTML::Selector.new('ul').select(render_container(:skip_if_empty => false)).should have(1).entry
+            end
+          end
+        end
+        
+        context 'container is not empty' do
+          before(:each) do
+            @container = primary_container
+          end
+          context 'skip_if_empty is true' do
+            it "should render a ul tag for the container" do
+              HTML::Selector.new('ul').select(render_container(:skip_if_empty => true)).should have(1).entry
+            end
+          end
+          context 'skip_if_empty is false' do
+            it "should render a ul tag for the container" do
+              HTML::Selector.new('ul').select(render_container(:skip_if_empty => false)).should have(1).entry
+            end
+          end
+        end
+      end
     end
     
     context 'regarding method calls' do
@@ -127,4 +167,4 @@ describe SimpleNavigation::Renderer::List do
     end
     
   end
-end
+end

data/spec/lib/simple_navigation_spec.rb

@@ -204,6 +204,23 @@ describe SimpleNavigation do
       end
     end
   end
+  
+  describe 'regarding renderers' do
+    it "should have registered the builtin renderers by default" do
+      SimpleNavigation.registered_renderers.should_not be_empty
+    end
+    
+    describe 'register_renderer' do
+      before(:each) do
+        @renderer = stub(:renderer)
+      end
+      it "should add the specified renderer to the list of renderers" do
+        SimpleNavigation.register_renderer(:my_renderer => @renderer)
+        SimpleNavigation.registered_renderers[:my_renderer].should == @renderer
+      end
+    end
+    
+  end
 
 
   describe 'load_config' do

data/spec/spec_helper.rb

@@ -53,7 +53,14 @@ def primary_item(key)
 end
 
 def select_item(key)
-  primary_item(key) {|item| item.stub!(:selected? => true)}
+  if(key == :subnav1) 
+    select_item(:invoices)
+    primary_item(:invoices) do |item|
+      item.instance_variable_get(:@sub_navigation).items.find { |i| i.key == key}.stub!(:selected? => true)
+    end
+    
+  end
+  primary_item(key) {|item| item.stub!(:selected? => true) unless item.frozen?}
 end
 
 def subnav_container

metadata

@@ -4,9 +4,9 @@ version: !ruby/object:Gem::Version
   prerelease: false
   segments: 
   - 2
-  - 5
-  - 4
-  version: 2.5.4
+  - 6
+  - 0
+  version: 2.6.0
 platform: ruby
 authors: 
 - Andi Schacke
@@ -14,7 +14,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-05-17 00:00:00 +02:00
+date: 2010-06-19 00:00:00 +02:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -60,6 +60,7 @@ files:
 - lib/simple_navigation/items_provider.rb
 - lib/simple_navigation/railtie.rb
 - lib/simple_navigation/renderer/base.rb
+- lib/simple_navigation/renderer/breadcrumbs.rb
 - lib/simple_navigation/renderer/links.rb
 - lib/simple_navigation/renderer/list.rb
 - rails/init.rb
@@ -71,6 +72,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/breadcrumbs_spec.rb
 - spec/lib/simple_navigation/renderer/links_spec.rb
 - spec/lib/simple_navigation/renderer/list_spec.rb
 - spec/lib/simple_navigation_spec.rb
@@ -115,6 +117,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/breadcrumbs_spec.rb
 - spec/lib/simple_navigation/renderer/links_spec.rb
 - spec/lib/simple_navigation/renderer/list_spec.rb
 - spec/lib/simple_navigation_spec.rb