simple-navigation 1.4.2 → 2.0.0

data/lib/simple_navigation/renderer/list.rb

@@ -3,21 +3,22 @@ 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.
     #
-    # By default, the renderer sets the item's key as dom_id for the rendered <li> element. The id can be explicitely specified by setting
-    # the id in the html-options of the 'item' method in the config/navigation.rb file.
-    class List < Renderer::Base
-      
+    # If the SimpleNavigation.config.render_all_levels option is set to true, it always renders all levels of navigation (fully expanded tree).
+    #
+    # 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)
         list_content = item_container.items.inject([]) do |list, item|
-          html_options = item.html_options(current_navigation)
-          li_content = link_to(item.name, item.url, :class => item.selected_class(current_navigation), :method => item.method)
+          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
-              li_content << (item.sub_navigation.render(current_sub_navigation))
-            else
-              li_content << (item.sub_navigation.render(current_sub_navigation)) if include_sub_navigation && item.selected?(current_navigation)
+            if SimpleNavigation.config.render_all_levels || (include_sub_navigation && item.selected?)
+              li_content << (item.sub_navigation.render(include_sub_navigation))
             end
           end  
           list << content_tag(:li, li_content, html_options)

data/lib/simple_navigation.rb

@@ -10,9 +10,8 @@ require 'simple_navigation/renderer/list'
 # A plugin for generating a simple navigation. See README for resources on usage instructions.
 module SimpleNavigation
 
-  mattr_accessor :config_files
-  mattr_accessor :config_file_path
-  mattr_accessor :controller
+  mattr_accessor :config_files, :config_file_path, :controller, :template, :explicit_current_navigation
+
   self.config_files = {}
   
   class << self
@@ -30,20 +29,83 @@ module SimpleNavigation
 
     # Returns the singleton instance of the SimpleNavigation::Configuration
     def config 
-      Configuration.instance
+      SimpleNavigation::Configuration.instance
     end
   
     # Returns the ItemContainer that contains the items for the primary navigation
     def primary_navigation
       config.primary_navigation
     end
-  
+
     # Returns the path to the config_file for the given navigation_context
     def config_file_name(navigation_context = :default)
       file_name = navigation_context == :default ? '' : "#{navigation_context.to_s.underscore}_"
       File.join(config_file_path, "#{file_name}navigation.rb")
     end
 
+    def explicit_navigation_args
+      self.controller.instance_variable_get(:"@sn_current_navigation_args")
+    end
+
+    # Reads the current navigation for the specified level from the controller.
+    # Returns nil if there is no current navigation set for level.
+    def current_navigation_for(level)
+      self.controller.instance_variable_get(:"@sn_current_navigation_#{level}")
+    end
+
+    def active_item_container_for(level)
+      self.primary_navigation.active_item_container_for(level)
+    end
+    
+    # If any navigation has been explicitely set in the controller this method evaluates the specified args set in the controller and sets
+    # the correct instance variable in the controller.
+    def handle_explicit_navigation
+      if SimpleNavigation.explicit_navigation_args
+        level, navigation = parse_explicit_navigation_args
+        self.controller.instance_variable_set(:"@sn_current_navigation_#{level}", navigation)
+      end
+    end
+
+    private
+  
+    # TODO: refactor this ugly thing to make it nice and short
+    def parse_explicit_navigation_args
+      args = SimpleNavigation.explicit_navigation_args
+      args = [Hash.new] if args.empty?
+      if args.first.kind_of? Hash
+        options = args.first
+      else # args is a list of current navigation for several levels
+        options = {}
+        if args.size == 1 #only an navi-key has been specified, try to find out level
+          level = SimpleNavigation.primary_navigation.level_for_item(args.first)
+          options[:"level_#{level}"] = args.first
+        else
+          args.each_with_index {|arg, i| options[:"level_#{i + 1}"] = arg}
+        end
+      end
+      #only the deepest level is relevant
+      level = options.inject(0) do |max, kv|
+        kv.first.to_s =~ /level_(\d)/
+        max = $1.to_i if $1.to_i > max
+        max
+      end
+      raise ArgumentError, "Invalid level specified or item key not found" if level == 0
+      [level, options[:"level_#{level}"]]
+    end
+
   end
 
-end
+end
+
+# TODOs for the next releases:
+# 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...
+#
+# 2) ability to turn off autohighlighting for a single item... 
+# 
+# 3) add JoinRenderer (HorizontalRenderer?) (wich does not render a list, but just the items joined with a specified char (e.g. | ))
+#
+# 4) Enhance SampleProject (more examples)
+#
+# 5) Make SampleProject public

data/simple-navigation.gemspec

@@ -5,12 +5,12 @@
 
 Gem::Specification.new do |s|
   s.name = %q{simple-navigation}
-  s.version = "1.4.2"
+  s.version = "2.0.0"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Andi Schacke"]
-  s.date = %q{2009-09-23}
-  s.description = %q{Simple Navigation is a ruby library for creating a navigation (optionally with sub navigation) for your rails app.}
+  s.date = %q{2009-10-10}
+  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 = [
     "README"
@@ -53,7 +53,7 @@ Gem::Specification.new do |s|
   s.require_paths = ["lib"]
   s.rubyforge_project = %q{andi}
   s.rubygems_version = %q{1.3.5}
-  s.summary = %q{Simple Navigation is a ruby library for creating a navigation (optionally with sub navigation) for your rails app.}
+  s.summary = %q{Simple Navigation is a ruby library for creating navigations (with multiple levels) for your Ruby on Rails application.}
   s.test_files = [
     "spec/lib/simple_navigation/configuration_spec.rb",
      "spec/lib/simple_navigation/controller_methods_spec.rb",

data/spec/lib/simple_navigation/configuration_spec.rb

@@ -18,6 +18,7 @@ describe SimpleNavigation::Configuration do
     before(:each) do
       @context = mock(:context)
       @context.stub!(:instance_eval)
+      SimpleNavigation::Configuration.stub!(:context_for_eval => @context)
       @config_files = {:default => 'default', :my_context => 'my_context'}
       SimpleNavigation.stub!(:config_files).and_return(@config_files)
     end
@@ -39,6 +40,53 @@ describe SimpleNavigation::Configuration do
       SimpleNavigation.should_receive(:controller=).with(@controller)
       SimpleNavigation::Configuration.eval_config(@context)
     end
+    it "should set the template" do
+      @template = stub(:template)
+      @controller = stub(:controller, :instance_variable_get => @template)
+      SimpleNavigation.stub!(:controller => @controller)
+      SimpleNavigation.should_receive(:template=).with(@template)
+      SimpleNavigation::Configuration.eval_config(@context)
+    end
+  end
+
+  describe 'context_for_eval' do
+    context 'controller is present' do
+      before(:each) do
+        @controller = stub(:controller)
+        SimpleNavigation.stub!(:controller => @controller)
+      end
+      context 'template is present' do
+        before(:each) do
+          @template = stub(:template)
+          SimpleNavigation.stub!(:template => @template)
+        end
+        it {SimpleNavigation::Configuration.context_for_eval.should == @template}
+      end
+      context 'template is not present' do
+        before(:each) do
+          SimpleNavigation.stub!(:template => nil)
+        end
+        it {SimpleNavigation::Configuration.context_for_eval.should == @controller}
+      end
+    end
+    context 'controller is not present' do
+      before(:each) do
+        SimpleNavigation.stub!(:controller => nil)
+      end
+      context 'template is present' do
+        before(:each) do
+          @template = stub(:template)
+          SimpleNavigation.stub!(:template => @template)
+        end
+        it {SimpleNavigation::Configuration.context_for_eval.should == @template}
+      end
+      context 'template is not present' do
+        before(:each) do
+          SimpleNavigation.stub!(:template => nil)
+        end
+        it {lambda {SimpleNavigation::Configuration.context_for_eval}.should raise_error}
+      end
+    end
   end
 
   describe 'self.extract_controller_from' do
@@ -78,6 +126,9 @@ describe SimpleNavigation::Configuration do
     it "should set autogenerate_item_ids to true as default" do
       @config.autogenerate_item_ids.should be_true
     end
+    it "should set auto_highlight to true as default" do
+      @config.auto_highlight.should be_true
+    end
   end  
   describe 'items' do
     before(:each) do
@@ -95,6 +146,16 @@ describe SimpleNavigation::Configuration do
     end
   end
 
+  describe 'loaded?' do
+    it "should return true if primary_nav is set" do
+      @config.instance_variable_set(:@primary_navigation, :bla)
+      @config.should be_loaded
+    end
+    it "should return false if no primary_nav is set" do
+      @config.instance_variable_set(:@primary_navigation, nil)
+      @config.should_not be_loaded
+    end
+  end
   
 end
 

data/spec/lib/simple_navigation/controller_methods_spec.rb

@@ -39,17 +39,17 @@ describe SimpleNavigation::ControllerMethods do
         end
       end
       
-      it "should not have an instance-method 'set_navigation if navigation-method has not been called" do
-        @controller.respond_to?(:set_navigation).should be_false
+      it "should not have an instance-method 'sn_set_navigation' if navigation-method has not been called" do
+        @controller.respond_to?(:sn_set_navigation).should be_false
       end
-      it 'should create an instance-method "set_navigation" when being called' do
+      it 'should create an instance-method "sn_set_navigation" when being called' do
         call_navigation(:key)
-        @controller.respond_to?(:set_navigation).should be_true
+        @controller.respond_to?(:sn_set_navigation).should be_true
       end
       it 'the created method should call current_navigation with the specified keys' do
         call_navigation(:primary, :secondary)
         @controller.should_receive(:current_navigation).with(:primary, :secondary)
-        @controller.set_navigation
+        @controller.sn_set_navigation
       end
     end
     
@@ -58,17 +58,13 @@ describe SimpleNavigation::ControllerMethods do
   describe 'instance_methods' do
     
     describe 'current_navigation' do
-      it "should set the current_primary_navigation as specified" do
+      it "should set the sn_current_navigation_args as specified" do
         @controller.current_navigation(:first)
-        @controller.instance_variable_get(:@current_primary_navigation).should == :first
+        @controller.instance_variable_get(:@sn_current_navigation_args).should == [:first]
       end
-      it "should set the current_secondary_navigation as specified" do
+      it "should set the sn_current_navigation_args as specified" do
         @controller.current_navigation(:first, :second)
-        @controller.instance_variable_get(:@current_secondary_navigation).should == :second
-      end
-      it "should set the current_secondary_navigation to nil if no secondary is specified" do
-        @controller.current_navigation(:first)
-        @controller.instance_variable_get(:@current_secondary_navigation).should be_nil
+        @controller.instance_variable_get(:@sn_current_navigation_args).should == [:first, :second]
       end
     end
     

data/spec/lib/simple_navigation/helpers_spec.rb

@@ -36,40 +36,46 @@ describe SimpleNavigation::Helpers do
     end
     
     context 'primary' do
-      before(:each) do
-        @controller.instance_variable_set(:@current_primary_navigation, :current_primary)
-      end
       it "should call render on the primary_navigation" do
-        @primary_navigation.should_receive(:render).with(:current_primary)
+        @primary_navigation.should_receive(:render)
         @controller.render_navigation(:primary)
       end
       it "should call render on the primary_navigation (specifying level through options)" do
-        @primary_navigation.should_receive(:render).with(:current_primary)
+        @primary_navigation.should_receive(:render)
         @controller.render_navigation(:level => :primary)
       end
+      it "should call render on the primary_navigation (specifying level through options)" do
+        @primary_navigation.should_receive(:render)
+        @controller.render_navigation(:level => 1)
+      end
     end
     
     context 'secondary' do
       context 'with current_primary_navigation set' do
         before(:each) do
-          @sub_navigation = stub(:sub_navigation, :null_object => true)
-          @primary_navigation.stub!(:[]).and_return(@sub_navigation)
-          @controller.instance_variable_set(:@current_primary_navigation, :current_primary)
-          @controller.instance_variable_set(:@current_secondary_navigation, :current_secondary)
+          @selected_item_container = stub(:selected_container, :null_object => true)
+          SimpleNavigation.stub!(:active_item_container_for => @selected_item_container)
         end
-        it "should find the sub_navigation belonging to the current primary_navigation" do
-          @primary_navigation.should_receive(:[]).with(:current_primary)
+        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)
         end
-        it "should call render on the current primary_navigation's sub_navigation" do
-          @sub_navigation.should_receive(:render).with(:current_secondary)
+        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)
+        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)
         end
       end
-      context 'without current_primary_navigation set' do
+      context 'without an active item_container set' do
         before(:each) do
-          @primary_navigation.stub!(:[]).and_return(nil)
-          @controller.instance_variable_set(:@current_primary_navigation, nil)
+          SimpleNavigation.stub!(:active_item_container_for => nil)
         end
         it "should not raise an error" do
           lambda{@controller.render_navigation(:secondary)}.should_not raise_error
@@ -79,24 +85,8 @@ describe SimpleNavigation::Helpers do
     end
     
     context 'nested' do
-      before(:each) do
-        @controller.instance_variable_set(:@current_primary_navigation, :current_primary)
-        @controller.instance_variable_set(:@current_secondary_navigation, :current_secondary)
-      end
-      it "should call render on the primary navigation" do
-        @primary_navigation.should_receive(:render).with(anything, anything, anything)
-        @controller.render_navigation(:nested)
-      end
-      it "should call render with the current_primary_navigation" do
-        @primary_navigation.should_receive(:render).with(:current_primary, anything, anything)
-        @controller.render_navigation(:nested)
-      end
-      it "should call render with the include_subnavigation option set" do
-        @primary_navigation.should_receive(:render).with(anything, true, anything)
-        @controller.render_navigation(:nested)
-      end
-      it "should call render with the current_sub_navigation" do
-        @primary_navigation.should_receive(:render).with(anything, anything, :current_secondary)
+      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)
       end
     end
@@ -105,20 +95,30 @@ describe SimpleNavigation::Helpers do
       it "should raise an error" do
         lambda {@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)
+      end
+      it "should raise an error" do
+        lambda {@controller.render_navigation('level')}.should raise_error(ArgumentError)
+      end
     end
   end
   
   describe 'render_primary_navigation' do  
     it "should delegate to render_navigation(:primary)" do
-      @controller.should_receive(:render_navigation).with(:level => :primary)
-      @controller.render_primary_navigation
+      ActiveSupport::Deprecation.silence do
+        @controller.should_receive(:render_navigation).with(:level => 1)
+        @controller.render_primary_navigation
+      end
     end
   end
   
   describe 'render_sub_navigation' do
     it "should delegate to render_navigation(:secondary)" do
-      @controller.should_receive(:render_navigation).with(:level => :secondary)
-      @controller.render_sub_navigation
+      ActiveSupport::Deprecation.silence do
+        @controller.should_receive(:render_navigation).with(:level => 2)
+        @controller.render_sub_navigation
+      end
     end
   end
   

data/spec/lib/simple_navigation/item_container_spec.rb

@@ -15,6 +15,118 @@ describe SimpleNavigation::ItemContainer do
     end
   end
 
+  describe 'selected?' do
+    before(:each) do
+      @item_1 = stub(:item, :selected? => false)
+      @item_2 = stub(:item, :selected? => false)
+      @item_container.instance_variable_set(:@items, [@item_1, @item_2])
+    end
+    it "should return nil if no item is selected" do
+      @item_container.should_not be_selected
+    end
+    it "should return true if one item is selected" do
+      @item_1.stub!(:selected? => true)
+      @item_container.should be_selected
+    end
+  end
+
+  describe 'selected_item' do
+    before(:each) do
+      @item_1 = stub(:item, :selected? => false)
+      @item_2 = stub(:item, :selected? => false)
+      @item_container.instance_variable_set(:@items, [@item_1, @item_2])
+    end
+    context 'navigation explicitely set' do
+      before(:each) do
+        @item_container.stub!(:[] => @item_1)
+      end
+      it "should return the explicitely selected item" do
+        @item_container.selected_item.should == @item_1
+      end
+    end
+    context 'navigation not explicitely set' do
+      before(:each) do
+        @item_container.stub!(:[] => nil)
+      end
+      context 'no item selected' do
+        it "should return nil" do
+          @item_container.selected_item.should be_nil
+        end
+      end
+      context 'one item selected' do
+        before(:each) do
+          @item_1.stub!(:selected? => true)
+        end
+        it "should return the selected item" do
+          @item_container.selected_item.should == @item_1
+        end
+      end
+    end
+  end
+
+  describe 'selected_sub_navigation?' do
+    context 'with an item selected' do
+      before(:each) do
+        @selected_item = stub(:selected_item)
+        @item_container.stub!(:selected_item => @selected_item)
+      end
+      context 'selected item has sub_navigation' do
+        before(:each) do
+          @sub_navigation = stub(:sub_navigation)
+          @selected_item.stub!(:sub_navigation => @sub_navigation)
+        end
+        it {@item_container.send(:selected_sub_navigation?).should be_true}
+      end
+      context 'selected item does not have sub_navigation' do
+        before(:each) do
+          @selected_item.stub!(:sub_navigation => nil)
+        end
+        it {@item_container.send(:selected_sub_navigation?).should be_false}
+      end
+    end
+    context 'without an item selected' do
+      before(:each) do
+        @item_container.stub!(:selected_item => nil)
+      end
+      it {@item_container.send(:selected_sub_navigation?).should be_false}
+    end
+
+  end
+
+  describe 'active_item_container_for' do
+    context "the desired level is the same as the container's" do
+      it {@item_container.active_item_container_for(1).should == @item_container}
+    end
+    context "the desired level is different than the container's" do
+      context 'with no selected subnavigation' do
+        before(:each) do
+          @item_container.stub!(:selected_sub_navigation? => false)
+        end
+        it {@item_container.active_item_container_for(2).should be_nil}
+      end
+      context 'with selected subnavigation' do
+        before(:each) do
+          @item_container.stub!(:selected_sub_navigation? => true)
+          @sub_nav = stub(:sub_nav)
+          @selected_item = stub(:selected_item)
+          @item_container.stub!(:selected_item => @selected_item)
+          @selected_item.stub!(:sub_navigation => @sub_nav)
+        end
+        it "should call recursively on the sub_navigation" do
+          @sub_nav.should_receive(:active_item_container_for).with(2)
+          @item_container.active_item_container_for(2)
+        end
+      end
+    end
+  end
+
+  describe 'current_explicit_navigation' do
+    it "should call SimpleNavigation.current_navigation with the container's level" do
+      SimpleNavigation.should_receive(:current_navigation_for).with(1)
+      @item_container.current_explicit_navigation
+    end
+  end
+
   describe 'item' do
     
     context 'unconditional item' do
@@ -36,7 +148,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('key', 'name', 'url', @options, @proc)
+          SimpleNavigation::Item.should_receive(:new).with(@item_container, 'key', 'name', 'url', @options, @proc)
           @item_container.item('key', 'name', 'url', @options, &@proc)
         end
         it "should add the created item to the list of items" do
@@ -47,7 +159,7 @@ describe SimpleNavigation::ItemContainer do
     
       context 'no block given' do
         it "should create a new Navigation_item with the given params and nil as sub_navi" do
-          SimpleNavigation::Item.should_receive(:new).with('key', 'name', 'url', @options, nil)
+          SimpleNavigation::Item.should_receive(:new).with(@item_container, 'key', 'name', 'url', @options, nil)
           @item_container.item('key', 'name', 'url', @options)
         end
         it "should add the created item to the list of items" do
@@ -91,6 +203,12 @@ describe SimpleNavigation::ItemContainer do
           end
         end
         
+        context 'if is not a proc or method' do
+          it "should raise an error" do
+            lambda {@item_container.item('key', 'name', 'url', {:if => 'text'})}.should raise_error
+          end
+        end
+
         context '"unless" given' do
           
           before(:each) do
@@ -156,8 +274,8 @@ describe SimpleNavigation::ItemContainer do
       @items = stub(:items)
       @item_container.stub!(:items).and_return(@items)
     end
-    it "should instatiate a renderer with the current_primary and current_secondary" do
-      @renderer.should_receive(:new).with(:current_navigation, nil)
+    it "should instatiate a renderer" do
+      @renderer.should_receive(:new)
       @item_container.render(:current_navigation)
     end
     it "should call render on the renderer and pass self" do
@@ -166,9 +284,32 @@ describe SimpleNavigation::ItemContainer do
     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(:current_navigation, true, :current_sub_navigation)
+      @item_container.render(true)
     end
     
   end
   
+  describe 'level_for_item' do
+    before(:each) do
+      @item_container.item(:p1, 'p1', 'p1')
+      @item_container.item(:p2, 'p2', 'p2') do |p2|
+        p2.item(:s1, 's1', 's1')
+        p2.item(:s2, 's2', 's2') do |s2|
+          s2.item(:ss1, 'ss1', 'ss1')
+          s2.item(:ss2, 'ss2', 'ss2')
+        end
+        p2.item(:s3, 's3', 's3')
+      end
+      @item_container.item(:p3, 'p3', 'p3')
+    end
+    it {@item_container.level_for_item(:p1).should == 1}
+    it {@item_container.level_for_item(:p3).should == 1}
+    it {@item_container.level_for_item(:s1).should == 2}
+    it {@item_container.level_for_item(:ss1).should == 3}
+    it {@item_container.level_for_item(:x).should be_nil}
+
+
+
+  end
+
 end