simple-navigation 1.4.2 → 2.0.0

data/spec/lib/simple_navigation/item_spec.rb

@@ -1,13 +1,18 @@
 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)
+  end
+
   describe 'initialize' do
     context 'method' do
       context 'defined' do
         before(:each) do
           @options = {:method => :delete}
-          @item = SimpleNavigation::Item.new(:my_key, 'name', 'url', @options, nil)          
+          @item = SimpleNavigation::Item.new(@item_container, :my_key, 'name', 'url', @options, nil)
         end
         it 'should set the method as instance_var' do
           @item.method.should == :delete
@@ -18,9 +23,6 @@ describe SimpleNavigation::Item do
       end
       
       context 'undefined' do
-        before(:each) do
-          @item = SimpleNavigation::Item.new(:my_key, 'name', 'url', {}, nil)          
-        end
         it 'should set the instance-var to nil' do
           @item.method.should be_nil
         end
@@ -29,30 +31,60 @@ describe SimpleNavigation::Item do
   end
   
   describe 'selected?' do
-    before(:each) do
-      @item = SimpleNavigation::Item.new(:my_key, 'name', 'url', {}, nil)
+    context 'explicitly selected' do
+      before(:each) do
+        @item.stub!(:selected_by_config? => true)
+      end
+      it {@item.should be_selected}
+      it "should not evaluate the subnav or urls" do
+        @item.should_not_receive(:selected_by_subnav?)
+        @item.should_not_receive(:selected_by_url?)
+        @item.selected?
+      end
+    end
+    context 'not explicitly selected' do
+      before(:each) do
+        @item.stub!(:selected_by_config? => false)
+      end
+      context 'subnav is selected' do
+        before(:each) do
+          @item.stub!(:selected_by_subnav? => true)
+        end
+        it {@item.should be_selected}
+      end
+      context 'subnav is not selected' do
+        before(:each) do
+           @item.stub!(:selected_by_subnav? => false)
+        end
+        context 'selected by url' do
+          before(:each) do
+             @item.stub!(:selected_by_url? => true)
+          end
+          it {@item.should be_selected}
+        end
+        context 'not selected by url' do
+          before(:each) do
+            @item.stub!(:selected_by_url? => false)
+          end
+          it {@item.should_not be_selected}
+        end
+      end
     end
-    it {@item.selected?(:my_key).should be_true}
-    it {@item.selected?(:my_other_key).should be_false}
   end
   
   describe 'selected_class' do
-    before(:each) do
-      @item = SimpleNavigation::Item.new(:my_key, 'name', 'url', {}, nil)
-    end
-    
     context 'item is selected' do
       before(:each) do
-        @item.stub!(:selected?).and_return(true)
+        @item.stub!(:selected? => true)
       end
-      it {@item.instance_eval {selected_class(:bla).should == 'selected'}}
+      it {@item.instance_eval {selected_class.should == 'selected'}}
     end
     
     context 'item is not selected' do
       before(:each) do
-        @item.stub!(:selected?).and_return(false)
+        @item.stub!(:selected? => false)
       end
-      it {@item.instance_eval {selected_class(:bla).should == nil}}
+      it {@item.instance_eval {selected_class.should == nil}}
     end
   end
   
@@ -61,40 +93,40 @@ describe SimpleNavigation::Item do
       context 'with classes defined in options' do
         before(:each) do
           @options = {:class => 'my_class'}
-          @item = SimpleNavigation::Item.new(:my_key, 'name', 'url', @options, nil)
+          @item = SimpleNavigation::Item.new(@item_container, :my_key, 'name', 'url', @options, nil)
         end
         context 'with item selected' do
           before(:each) do
-            @item.stub!(:selected?).and_return(true)
+            @item.stub!(:selected? => true)
           end
-          it {@item.html_options(:bla)[:class].should == 'my_class selected'}
+          it {@item.html_options[:class].should == 'my_class selected'}
         end
       
         context 'with item not selected' do
           before(:each) do
-            @item.stub!(:selected?).and_return(false)
+            @item.stub!(:selected? => false)
           end
-          it {@item.html_options(:bla)[:class].should == 'my_class'}
+          it {@item.html_options[:class].should == 'my_class'}
         end
       end
     
       context 'without classes in options' do
         before(:each) do
           @options = {}
-          @item = SimpleNavigation::Item.new(:my_key, 'name', 'url', @options, nil)
+          @item = SimpleNavigation::Item.new(@item_container, :my_key, 'name', 'url', @options, nil)
         end
         context 'with item selected' do
           before(:each) do
-            @item.stub!(:selected?).and_return(true)
+            @item.stub!(:selected? => true)
           end
-          it {@item.html_options(:bla)[:class].should == 'selected'}
+          it {@item.html_options[:class].should == 'selected'}
         end
       
         context 'with item not selected' do
           before(:each) do
-            @item.stub!(:selected?).and_return(false)
+            @item.stub!(:selected? => false)
           end
-          it {@item.html_options(:bla)[:class].should be_blank}
+          it {@item.html_options[:class].should be_blank}
         end
       end
     end
@@ -102,41 +134,41 @@ describe SimpleNavigation::Item do
     describe 'id' do
       context 'with autogenerate_item_ids == true' do
         before(:each) do
-          @item = SimpleNavigation::Item.new(:my_key, 'name', 'url', {}, nil)
           @item.stub!(:autogenerate_item_ids? => true)
+          @item.stub!(:selected? => false)
         end
         context 'with id defined in options' do
           before(:each) do
             @item.html_options = {:id => 'my_id'}
           end
-          it {@item.html_options(:bla)[:id].should == 'my_id'}
+          it {@item.html_options[:id].should == 'my_id'}
         end
       
         context 'with no id definied in options (using default id)' do
           before(:each) do
             @item.html_options = {}
           end
-          it {@item.html_options(:bla)[:id].should == 'my_key'}
+          it {@item.html_options[:id].should == 'my_key'}
         end
       end
 
       context 'with autogenerate_item_ids == false' do
         before(:each) do
-          @item = SimpleNavigation::Item.new(:my_key, 'name', 'url', {}, nil)
           @item.stub!(:autogenerate_item_ids? => false)
+          @item.stub!(:selected? => false)
         end
         context 'with id defined in options' do
           before(:each) do
             @item.html_options = {:id => 'my_id'}
           end
-          it {@item.html_options(:bla)[:id].should == 'my_id'}
+          it {@item.html_options[:id].should == 'my_id'}
         end
       
         context 'with no id definied in options (using default id)' do
           before(:each) do
             @item.html_options = {}
           end
-          it {@item.html_options(:bla)[:id].should be_nil}
+          it {@item.html_options[:id].should be_nil}
         end
      
       end
@@ -144,6 +176,169 @@ describe SimpleNavigation::Item do
     end
         
   end
-  
+
+  describe 'selected_by_subnav?' do
+    context 'item has subnav' do
+      before(:each) do
+        @sub_navigation = stub(:sub_navigation)
+        @item.stub!(:sub_navigation => @sub_navigation)
+      end
+      it "should return true if subnav is selected" do
+        @sub_navigation.stub!(:selected? => true)
+        @item.should be_selected_by_subnav
+      end
+      it "should return false if subnav is not selected" do
+        @sub_navigation.stub!(:selected? => false)
+        @item.should_not be_selected_by_subnav
+      end
+    end
+    context 'item does not have subnav' do
+      before(:each) do
+        @item.stub!(:sub_navigation => @sub_navigation)
+      end
+      it {@item.should_not be_selected_by_subnav}
+    end
+  end
+
+  describe 'selected_by_config?' do
+    context 'navigation explicitly set' do
+      it "should return true if current matches key" do
+        @item_container.stub!(:current_explicit_navigation => :my_key)
+        @item.should be_selected_by_config
+      end
+      it "should return false if current does not match key" do
+        @item_container.stub!(:current_explicit_navigation => :other_key)
+        @item.should_not be_selected_by_config
+      end
+    end
+    context 'navigation not explicitly set' do
+      before(:each) do
+        @item_container.stub!(:current_explicit_navigation => nil)
+      end
+      it {@item.should_not be_selected_by_config}
+    end
+  end
+
+  describe 'selected_by_url?' do
+    context 'auto_highlight is turned on' do
+      before(:each) do
+        @item.stub!(:auto_highlight? => true)
+      end
+      context 'root path matches' do
+        before(:each) do
+          @item.stub!(:root_path_match? => true)
+        end
+        it {@item.send(:selected_by_url?).should be_true}
+      end
+      context 'root path does not match' do
+        before(:each) do
+          @item.stub!(:root_path_match? => false)
+        end
+        context 'template is set' do
+          before(:each) do
+            @template = stub(:template)
+            SimpleNavigation.stub!(:template => @template)
+          end
+          context 'current request url matches url' do
+            before(:each) do
+              @template.stub!(:current_page? => true)
+            end
+            it "should test with the item's url" do
+              @template.should_receive(:current_page?).with('url')
+              @item.send(:selected_by_url?)
+            end
+            it {@item.send(:selected_by_url?).should be_true}
+          end
+          context 'no match' do
+            before(:each) do
+              @template.stub!(:current_page? => false)
+            end
+            it {@item.send(:selected_by_url?).should be_false}
+          end
+        end
+        context 'template is not set' do
+          before(:each) do
+            SimpleNavigation.stub!(:template => nil)
+          end
+          it {@item.send(:selected_by_url?).should be_false}
+        end
+      end
+    end
+    context 'auto_highlight is turned off' do
+      before(:each) do
+        @item.stub!(:auto_highlight? => false)
+      end
+      it {@item.send(:selected_by_url?).should be_false}
+    end
+  end
+
+  describe 'root_path_match?' do
+    before(:each) do
+      @request = stub(:request)
+      @controller = stub(:controller, :request => @request)
+      SimpleNavigation.stub!(:controller => @controller)
+    end
+    it "should match if both url == /" do
+      @request.stub!(:path => '/')
+      @item.stub!(:url => '/')
+      @item.send(:root_path_match?).should be_true
+    end
+    it "should not match if item url is not /" do
+      @request.stub!(:path => '/')
+      @item.stub!(:url => '/bla')
+      @item.send(:root_path_match?).should be_false
+    end
+    it "should not match if request url is not /" do
+      @request.stub!(:path => '/bla')
+      @item.stub!(:url => '/')
+      @item.send(:root_path_match?).should be_false
+    end
+    it "should not match if urls do not match" do
+      @request.stub!(:path => '/bla')
+      @item.stub!(:url => '/bli')
+      @item.send(:root_path_match?).should be_false
+    end
+  end
+
+  describe 'auto_highlight?' do
+    before(:each) do
+      @global = stub(:config)
+      SimpleNavigation.stub!(:config => @global)
+    end
+    context 'global auto_hightlight on' do
+      before(:each) do
+        @global.stub!(:auto_highlight => true)
+      end
+      context 'container auto_hightlight 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
+        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
+      before(:each) do
+        @global.stub!(:auto_highlight => false)
+      end
+      context 'container auto_hightlight 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
+        before(:each) do
+          @item_container.stub!(:auto_highlight => false)
+        end
+        it {@item.send(:auto_highlight?).should be_false}
+      end
+    end
+  end
 
 end

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

@@ -4,7 +4,7 @@ describe SimpleNavigation::Renderer::Base do
   before(:each) do
     @controller = stub(:controller)
     SimpleNavigation.stub!(:controller).and_return(@controller)
-    @base_renderer = SimpleNavigation::Renderer::Base.new(:current_primary, :current_secondary)
+    @base_renderer = SimpleNavigation::Renderer::Base.new
   end
   it "should inclue ActionView::Helpers::UrlHelper" do
     @base_renderer.should respond_to(:link_to)
@@ -20,8 +20,6 @@ describe SimpleNavigation::Renderer::Base do
   end
   
   describe 'initialize' do
-    it {@base_renderer.current_navigation.should == :current_primary}
-    it {@base_renderer.current_sub_navigation.should == :current_secondary}
     it {@base_renderer.controller.should == @controller}
   end
   
@@ -53,4 +51,10 @@ describe SimpleNavigation::Renderer::Base do
     end
   end
   
+  describe 'render' do
+    it "be subclass responsability" do
+      lambda {@base_renderer.render(:container)}.should raise_error('subclass responsibility')
+    end
+  end
+
 end

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

@@ -7,34 +7,50 @@ describe SimpleNavigation::Renderer::List do
     
     def sub_items
       [
-        SimpleNavigation::Item.new(:subnav1, 'subnav1', 'subnav1_url', {}, nil),
-        SimpleNavigation::Item.new(:subnav2, 'subnav2', 'subnav2_url', {}, nil)
+        [:subnav1, 'subnav1', 'subnav1_url', {}, nil],
+        [:subnav2, 'subnav2', 'subnav2_url', {}, nil]
       ]
     end
     
     def primary_items
-      @item1 = SimpleNavigation::Item.new(:users, 'users', 'first_url', {:id => 'my_id'}, nil)
-      @item2 = SimpleNavigation::Item.new(:invoices, 'invoices', 'second_url', {}, nil)
-      @item3 = SimpleNavigation::Item.new(:accounts, 'accounts', 'third_url', {:style => 'float:right'}, nil)
-      @item2.instance_variable_set(:@sub_navigation, item_container(sub_items))
-      [@item1, @item2, @item3]
+      [
+        [:users, 'users', 'first_url', {:id => 'my_id'}, nil],
+        [:invoices, 'invoices', 'second_url', {}, nil],
+        [:accounts, 'accounts', 'third_url', {:style => 'float:right'}, nil]
+      ]
     end
 
-    def item_container(items)
-      container = SimpleNavigation::ItemContainer.new
+    def primary_container
+      container = SimpleNavigation::ItemContainer.new(0)
       container.dom_id = 'nav_dom_id'
       container.dom_class = 'nav_dom_class'
-      container.instance_variable_set(:@items, items)
+      @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_navigation
-      @item_container = item_container(primary_items)
-      @item_container
+    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_navigation=nil, include_subnav=false)
-      @renderer = SimpleNavigation::Renderer::List.new(current_navigation)
+    def render(current_nav=nil, include_subnav=false)
+      primary_navigation = primary_container
+      select_item(current_nav) if current_nav
+      @renderer = SimpleNavigation::Renderer::List.new
       HTML::Document.new(@renderer.render(primary_navigation, include_subnav)).root
     end
       

data/spec/lib/simple_navigation_spec.rb

@@ -137,4 +137,87 @@ describe SimpleNavigation do
     it {SimpleNavigation.config.should == SimpleNavigation::Configuration.instance}
   end
   
+  describe 'current_navigation_for' do
+    before(:each) do
+      @controller = stub(:controller)
+      SimpleNavigation.stub!(:controller => @controller)
+    end
+    it "should access the correct instance_var in the controller" do
+      @controller.should_receive(:instance_variable_get).with(:@sn_current_navigation_1)
+      SimpleNavigation.current_navigation_for(1)
+    end
+  end
+
+  describe 'active_item_container_for' do
+    before(:each) do
+      @primary = stub(:primary)
+      SimpleNavigation.config.stub!(:primary_navigation => @primary)
+    end
+    it "should call active_item_container_for on the primary_navigation with the specified level" do
+      @primary.should_receive(:active_item_container_for).with(1)
+      SimpleNavigation.active_item_container_for 1
+    end
+  end
+
+  describe 'handle_explicit_navigation' do
+    def args(*args)
+      SimpleNavigation.stub!(:explicit_navigation_args => args.compact.empty? ? nil : args)
+    end
+
+    before(:each) do
+      @controller = stub(:controller)
+      SimpleNavigation.stub!(:controller => @controller)
+    end
+
+    context 'with explicit navigation set' do
+      context 'list of navigations' do
+        before(:each) do
+          args :first, :second, :third
+        end
+        it "should set the correct instance var in the controller" do
+          @controller.should_receive(:instance_variable_set).with(:@sn_current_navigation_3, :third)
+          SimpleNavigation.handle_explicit_navigation
+        end
+      end
+      context 'single navigation' do
+        before(:each) do
+          @primary = stub(:primary, :level_for_item => 2)
+          SimpleNavigation.stub!(:primary_navigation => @primary)
+          args :key
+        end
+        it "should set the correct instance var in the controller" do
+          @controller.should_receive(:instance_variable_set).with(:@sn_current_navigation_2, :key)
+          SimpleNavigation.handle_explicit_navigation
+        end
+      end
+      context 'hash with level' do
+        before(:each) do
+          args :level_2 => :key
+        end
+        it "should set the correct instance var in the controller" do
+          @controller.should_receive(:instance_variable_set).with(:@sn_current_navigation_2, :key)
+          SimpleNavigation.handle_explicit_navigation
+        end
+      end
+      context 'hash with multiple_levels' do
+        before(:each) do
+          args :level_2 => :key, :level_1 => :bla
+        end
+        it "should set the correct instance var in the controller" do
+          @controller.should_receive(:instance_variable_set).with(:@sn_current_navigation_2, :key)
+          SimpleNavigation.handle_explicit_navigation
+        end
+      end
+    end
+    context 'without explicit navigation set' do
+      before(:each) do
+        args nil
+      end
+      it "should not set the current_navigation instance var in the controller" do
+        @controller.should_not_receive(:instance_variable_set)
+        SimpleNavigation.handle_explicit_navigation
+      end
+    end
+  end
+
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: simple-navigation
 version: !ruby/object:Gem::Version 
-  version: 1.4.2
+  version: 2.0.0
 platform: ruby
 authors: 
 - Andi Schacke
@@ -9,11 +9,11 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2009-09-23 00:00:00 +02:00
+date: 2009-10-10 00:00:00 +02:00
 default_executable: 
 dependencies: []
 
-description: Simple Navigation is a ruby library for creating a navigation (optionally with sub navigation) for your rails app.
+description: 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.
 email: andreas.schacke@gmail.com
 executables: []
 
@@ -80,7 +80,7 @@ rubyforge_project: andi
 rubygems_version: 1.3.5
 signing_key: 
 specification_version: 3
-summary: Simple Navigation is a ruby library for creating a navigation (optionally with sub navigation) for your rails app.
+summary: Simple Navigation is a ruby library for creating navigations (with multiple levels) for your Ruby on Rails application.
 test_files: 
 - spec/lib/simple_navigation/configuration_spec.rb
 - spec/lib/simple_navigation/controller_methods_spec.rb