simple-navigation 2.7.3 → 3.0.0.beta1

data/spec/lib/simple_navigation/rails_controller_methods_spec.rb

@@ -0,0 +1,251 @@
+require File.dirname(__FILE__) + '/../../spec_helper'
+
+describe 'explicit navigation in rails' do
+  require 'simple_navigation/rails_controller_methods'
+
+  it 'should have enhanced the ActionController after loading the extensions' do
+    ActionController::Base.instance_methods.map {|m| m.to_s}.should include('current_navigation')
+  end
+
+  describe SimpleNavigation::ControllerMethods do
+
+    def stub_loading_config
+      SimpleNavigation::Configuration.stub!(:load)
+    end
+
+    before(:each) do
+      stub_loading_config
+      class TestController
+        class << self
+          def helper_method(*args)
+            @helper_methods = args
+          end
+          def before_filter(*args)
+            @before_filters = args
+          end
+        end
+      end
+      TestController.send(:include, SimpleNavigation::ControllerMethods)
+      @controller = TestController.new
+    end
+
+    describe 'when being included' do
+      it "should extend the ClassMethods" do
+        @controller.class.should respond_to(:navigation)
+      end
+      it "should include the InstanceMethods" do
+        @controller.should respond_to(:current_navigation)
+      end
+    end
+
+    describe 'class_methods' do
+
+      describe 'navigation' do
+
+        def call_navigation(key1, key2=nil)
+          ActiveSupport::Deprecation.silence do
+            @controller.class_eval do
+              navigation key1, key2
+            end
+          end
+        end
+
+        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 "sn_set_navigation" when being called' do
+          call_navigation(:key)
+          @controller.respond_to?(:sn_set_navigation).should be_true
+        end
+        it "the created method should not be public" do
+          call_navigation(:key)
+          @controller.public_methods.map(&:to_sym).should_not include(:sn_set_navigation)
+        end
+        it "the created method should be protected" do
+          call_navigation(:key)
+          @controller.protected_methods.map(&:to_sym).should include(:sn_set_navigation)
+        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.send(:sn_set_navigation)
+        end
+      end
+
+    end
+
+    describe 'instance_methods' do
+
+      describe 'current_navigation' do
+        it "should set the sn_current_navigation_args as specified" do
+          ActiveSupport::Deprecation.silence {@controller.current_navigation(:first)}
+          @controller.instance_variable_get(:@sn_current_navigation_args).should == [:first]
+        end
+        it "should set the sn_current_navigation_args as specified" do
+          ActiveSupport::Deprecation.silence {@controller.current_navigation(:first, :second)}
+          @controller.instance_variable_get(:@sn_current_navigation_args).should == [:first, :second]
+        end
+      end
+
+    end
+
+  end
+
+  describe 'SimpleNavigation module additions' do
+
+    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)
+        @adapter = stub(:adapter, :controller => @controller)
+        SimpleNavigation.stub!(:adapter => @adapter)
+      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
+          context 'specified key is a valid navigation item' 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 'specified key is an invalid navigation item' do
+            before(:each) do
+              @primary = stub(:primary, :level_for_item => nil)
+              SimpleNavigation.stub!(:primary_navigation => @primary)
+              args :key
+            end
+            it "should raise an ArgumentError" do
+              lambda {SimpleNavigation.handle_explicit_navigation}.should raise_error(ArgumentError)
+            end
+          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
+
+    describe 'current_navigation_for' do
+      before(:each) do
+        @controller = stub(:controller)
+        @adapter = stub(:adapter, :controller => @controller)
+        SimpleNavigation.stub!(:adapter => @adapter)
+      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
+
+  end  
+
+  describe SimpleNavigation::Item do
+    before(:each) do
+      @item_container = stub(:item_container, :level => 1)
+      @item = SimpleNavigation::Item.new(@item_container, :my_key, 'name', 'url', {})
+      
+    end
+    describe 'selected_by_config?' do
+      context 'navigation explicitly set' do
+        it "should return true if current matches key" do
+          SimpleNavigation.stub!(:current_navigation_for => :my_key)
+          @item.should be_selected_by_config
+        end
+        it "should return false if current does not match key" do
+          SimpleNavigation.stub!(:current_navigation_for => :other_key)
+          @item.should_not be_selected_by_config
+        end
+      end
+      context 'navigation not explicitly set' do
+        before(:each) do
+          SimpleNavigation.stub!(:current_navigation_for => nil)
+        end
+        it {@item.should_not be_selected_by_config}
+      end
+    end
+  end
+  
+  describe SimpleNavigation::ItemContainer do
+    describe 'selected_item' do
+      before(:each) do
+        SimpleNavigation.stub!(:current_navigation_for)
+        @item_container = SimpleNavigation::ItemContainer.new
+        
+        @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
+    
+  end
+  
+end
+

data/spec/lib/simple_navigation/{helpers_spec.rb → rendering/helpers_spec.rb}

@@ -1,10 +1,10 @@
-require File.dirname(__FILE__) + '/../../spec_helper'
+require File.dirname(__FILE__) + '/../../../spec_helper'
 
 describe SimpleNavigation::Helpers do
   class ControllerMock
     include SimpleNavigation::Helpers
   end
-  
+
   before(:each) do
     @controller = ControllerMock.new
     SimpleNavigation.stub!(:load_config)
@@ -13,49 +13,30 @@ describe SimpleNavigation::Helpers do
     SimpleNavigation.stub!(:primary_navigation).and_return(@primary_navigation)
     SimpleNavigation.stub!(:config_file? => true)
   end
-  
+
   describe 'render_navigation' do
-    
-    context 'with config_file present' do
-      before(:each) do
-        SimpleNavigation.stub!(:config_file? => true)
-      end
-      describe 'regarding loading of the config-file' do
-        context 'no options specified' do
-          it "should load the config-file for the default context" do
-            SimpleNavigation.should_receive(:load_config).with(:default)
-            @controller.render_navigation
-          end
-        end
-    
-        context 'with options specified' do
-          it "should load the config-file for the specified context" do
-            SimpleNavigation.should_receive(:load_config).with(:my_context)
-            @controller.render_navigation(:context => :my_context)
-          end
+
+    describe 'regarding loading of the config-file' do
+      context 'no options specified' do
+        it "should load the config-file for the default context" do
+          SimpleNavigation.should_receive(:load_config).with(:default)
+          @controller.render_navigation
         end
       end
-  
-      it "should eval the config on every request" do
-        SimpleNavigation::Configuration.should_receive(:eval_config).with(@controller, :default)
-        @controller.render_navigation
+
+      context 'with options specified' do
+        it "should load the config-file for the specified context" do
+          SimpleNavigation.should_receive(:load_config).with(:my_context)
+          @controller.render_navigation(:context => :my_context)
+        end
       end
     end
-    context 'with config_file not present' do
-      before(:each) do
-        SimpleNavigation.stub!(:config_file? => false)
-      end
-      it "should not load the config file" do
-        SimpleNavigation.should_not_receive(:load_config)
-        @controller.render_navigation
-      end
-  
-      it "should not eval the config on every request" do
-        SimpleNavigation::Configuration.should_not_receive(:eval_config)
-        @controller.render_navigation
-      end
+
+    it "should eval the config on every request" do
+      SimpleNavigation::Configuration.should_receive(:eval_config).with(:default)
+      @controller.render_navigation
     end
-        
+
     describe 'regarding setting of items' do
       context 'not items specified in options' do
         it "should not set the items directly" do
@@ -73,14 +54,14 @@ describe SimpleNavigation::Helpers do
         end
       end
     end
-    
+
     describe 'no primary navigation defined' do
       before(:each) do
         SimpleNavigation.stub!(:primary_navigation => nil)
       end
       it {lambda {@controller.render_navigation}.should raise_error}
     end
-    
+
     context 'rendering of the item_container' do
       before(:each) do
         @active_item_container = stub(:item_container, :null_object => true)
@@ -106,7 +87,7 @@ describe SimpleNavigation::Helpers do
         end
       end
     end
-    
+
     context 'primary' do
       it "should call render on the primary_navigation" do
         @primary_navigation.should_receive(:render)
@@ -121,7 +102,7 @@ describe SimpleNavigation::Helpers do
         @controller.render_navigation(:level => 1)
       end
     end
-    
+
     context 'secondary' do
       context 'with current_primary_navigation set' do
         before(:each) do
@@ -153,16 +134,16 @@ describe SimpleNavigation::Helpers do
           lambda{ActiveSupport::Deprecation.silence {@controller.render_navigation(:secondary)}}.should_not raise_error
         end
       end
-      
+
     end
-    
+
     context 'nested' do
       it "should call render on the primary navigation with the :level => :all option set" do
         @primary_navigation.should_receive(:render).with(:level => :all)
         ActiveSupport::Deprecation.silence {@controller.render_navigation(:nested)}
       end
     end
-    
+
     context 'unknown level' do
       it "should raise an error" do
         lambda {ActiveSupport::Deprecation.silence {@controller.render_navigation(:unknown)}}.should raise_error(ArgumentError)
@@ -175,8 +156,8 @@ describe SimpleNavigation::Helpers do
       end
     end
   end
-  
-  describe 'render_primary_navigation' do  
+
+  describe 'render_primary_navigation' do
     it "should delegate to render_navigation(:level => 1)" do
       ActiveSupport::Deprecation.silence do
         @controller.should_receive(:render_navigation).with(:level => 1)
@@ -184,7 +165,7 @@ describe SimpleNavigation::Helpers do
       end
     end
   end
-  
+
   describe 'render_sub_navigation' do
     it "should delegate to render_navigation(:level => 2)" do
       ActiveSupport::Deprecation.silence do
@@ -193,7 +174,7 @@ describe SimpleNavigation::Helpers do
       end
     end
   end
-  
+
   describe "should treat :level and :levels options the same" do
     before(:each) do
       @selected_item_container = stub(:selected_container, :null_object => true)
@@ -204,12 +185,12 @@ describe SimpleNavigation::Helpers do
       @controller.render_navigation(:levels => 2)
     end
   end
-  
+
   describe 'option all_open should work as expand_all' do
     it "should call render on the primary navigation with the include_subnavigation option set" do
       @primary_navigation.should_receive(:render).with(:level => :all, :expand_all => true)
       ActiveSupport::Deprecation.silence {@controller.render_navigation(:level => :all, :all_open => true)}
-    end    
+    end
   end
-  
+
 end

data/spec/lib/simple_navigation/{renderer → rendering/renderer}/base_spec.rb

@@ -1,80 +1,29 @@
-require File.dirname(__FILE__) + '/../../../spec_helper'
+require File.dirname(__FILE__) + '/../../../../spec_helper'
 
 describe SimpleNavigation::Renderer::Base do
   before(:each) do
     @options = stub(:options, :null_object => true)
-    @controller = stub(:controller)
-    SimpleNavigation.stub!(:controller).and_return(@controller)
+    @adapter = stub(:adapter)
+    SimpleNavigation.stub!(:adapter => @adapter)
     @base_renderer = SimpleNavigation::Renderer::Base.new(@options)
   end
-  it "should inclue ActionView::Helpers::UrlHelper" do
-    @base_renderer.should respond_to(:link_to)
-  end
-  it "should include ActionView::Helpers::TagHelper" do
-    @base_renderer.should respond_to(:content_tag)
-  end
   
   describe 'delegated methods' do
-    it {@base_renderer.should respond_to(:form_authenticity_token)}
-    it {@base_renderer.should respond_to(:protect_against_forgery?)}
-    it {@base_renderer.should respond_to(:request_forgery_protection_token)}
+    it {@base_renderer.should respond_to(:link_to)}
+    it {@base_renderer.should respond_to(:content_tag)}
   end
-  
+
   describe 'initialize' do
-    it {@base_renderer.controller.should == @controller}
+    it {@base_renderer.adapter.should == @adapter}
     it {@base_renderer.options.should == @options}
   end
-  
-  describe 'controller_method' do
-    context 'delegate a single method' do
-      before(:each) do
-        @base_renderer.class_eval do
-          controller_method :my_method
-        end
-      end
-      it 'should delegate a controller_method to the controller' do
-        @controller.should_receive(:my_method)
-        @base_renderer.my_method
-      end
-    end
     
-    context 'delegate multiple methods' do
-      before(:each) do
-        @base_renderer.class_eval do
-          controller_method :test1, :test2
-        end
-      end
-      it 'should delegate all controller_methods to the controller' do
-        @controller.should_receive(:test1)
-        @base_renderer.test1
-        @controller.should_receive(:test2)
-        @base_renderer.test2
-      end      
-    end
-  end
-  
   describe 'render' do
     it "be subclass responsability" do
       lambda {@base_renderer.render(:container)}.should raise_error('subclass responsibility')
     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
@@ -97,7 +46,7 @@ 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
@@ -155,7 +104,7 @@ describe SimpleNavigation::Renderer::Base do
         before(:each) do
           @base_renderer.stub!(:level => 'unknown')
         end
-        it {@base_renderer.send(:consider_sub_navigation?, @item).should be_false}        
+        it {@base_renderer.send(:consider_sub_navigation?, @item).should be_false}
       end
       context 'level is :all' do
         before(:each) do
@@ -184,7 +133,7 @@ describe SimpleNavigation::Renderer::Base do
             @sub_navigation.stub!(:level => 3)
           end
           it {@base_renderer.send(:consider_sub_navigation?, @item).should be_true}
-          
+
         end
         context 'subnavs level < range.max' do
           before(:each) do