simple-navigation-ext 0.0.1

data/spec/lib/simple_navigation/rails_controller_methods_spec.rb

@@ -0,0 +1,249 @@
+require '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)
+          @controller.class_eval do
+            navigation key1, key2
+          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
+          @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
+          @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/rendering/helpers_spec.rb

@@ -0,0 +1,183 @@
+require 'spec_helper'
+
+describe SimpleNavigation::Helpers do
+  class ControllerMock
+    include SimpleNavigation::Helpers
+  end
+
+  def blackbox_setup()
+    @controller = ControllerMock.new
+    @controller.stub!(:load_config)
+    setup_adapter_for :rails
+    primary_navigation = primary_container
+    SimpleNavigation.stub!(:primary_navigation => primary_navigation)
+  end
+
+  def whitebox_setup
+    @controller = ControllerMock.new
+    SimpleNavigation.stub!(:load_config)
+    SimpleNavigation::Configuration.stub!(:eval_config)
+    @primary_navigation = stub(:primary_navigation).as_null_object
+    SimpleNavigation.stub!(:primary_navigation).and_return(@primary_navigation)
+    SimpleNavigation.stub!(:config_file? => true)
+  end
+
+  describe 'active_navigation_item_name' do
+    before(:each) do
+      blackbox_setup
+    end
+    context 'active item_container for desired level exists' do
+      context 'container has selected item' do
+        before(:each) do
+          select_item(:subnav1)
+        end
+        it {@controller.active_navigation_item_name(:level => 2).should == 'subnav1'}
+        it {@controller.active_navigation_item_name.should == 'subnav1'}
+        it {@controller.active_navigation_item_name(:level => 1).should == 'invoices'}
+        it {@controller.active_navigation_item_name(:level => :all).should == 'subnav1'}
+      end
+      context 'container does not have selected item' do
+        it {@controller.active_navigation_item_name.should == ''}
+      end
+    end
+    context 'no active item_container for desired level' do
+      it {@controller.active_navigation_item_name(:level => 5).should == ''}
+    end
+  end
+
+  describe 'render_navigation' do
+  
+    before(:each) do
+      whitebox_setup
+    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
+      end
+    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
+          SimpleNavigation.config.should_not_receive(:items)
+          @controller.render_navigation
+        end
+      end
+      context 'items specified in options' do
+        before(:each) do
+          @items = stub(:items)
+        end
+        it "should set the items directly" do
+          SimpleNavigation.config.should_receive(:items).with(@items)
+          @controller.render_navigation(:items => @items)
+        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).as_null_object
+        SimpleNavigation.stub!(:active_item_container_for => @active_item_container)
+      end
+      it "should lookup the active_item_container based on the level" do
+        SimpleNavigation.should_receive(:active_item_container_for).with(:all)
+        @controller.render_navigation
+      end
+      context 'active_item_container is nil' do
+        before(:each) do
+          SimpleNavigation.stub!(:active_item_container_for => nil)
+        end
+        it "should not call render" do
+          @active_item_container.should_not_receive(:render)
+          @controller.render_navigation
+        end
+      end
+      context 'active_item_container is not nil' do
+        it "should call render on the container" do
+          @active_item_container.should_receive(:render)
+          @controller.render_navigation
+        end
+      end
+    end
+  
+    context 'primary' do
+      it "should call render on the primary_navigation (specifying level through options)" do
+        @primary_navigation.should_receive(:render).with(:level => 1)
+        @controller.render_navigation(:level => 1)
+      end
+    end
+  
+    context 'secondary' do
+      context 'with current_primary_navigation set' do
+        before(:each) do
+          @selected_item_container = stub(:selected_container).as_null_object
+          SimpleNavigation.stub!(:active_item_container_for => @selected_item_container)
+        end
+        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 => 2)
+        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).with(:level => 2)
+          @controller.render_navigation(:level => 2)
+        end
+      end
+      context 'without an active item_container set' do
+        before(:each) do
+          SimpleNavigation.stub!(:active_item_container_for => nil)
+        end
+        it "should not raise an error" do
+          lambda {@controller.render_navigation(:level => 2)}.should_not raise_error
+        end
+      end
+  
+    end
+  
+    context 'unknown level' do
+      it "should raise an error" do
+        lambda {@controller.render_navigation(:level => :unknown)}.should raise_error(ArgumentError)
+      end
+    end
+  
+  end
+  
+  describe "should treat :level and :levels options the same" do
+    before(:each) do
+      whitebox_setup
+      @selected_item_container = stub(:selected_container).as_null_object
+      SimpleNavigation.stub!(:active_item_container_for => @selected_item_container)
+    end
+    it  "should pass a valid levels options as level" do
+      @selected_item_container.should_receive(:render).with(:level => 2)
+      @controller.render_navigation(:levels => 2)
+    end
+  end
+
+end

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

@@ -0,0 +1,199 @@
+require 'spec_helper'
+
+describe SimpleNavigation::Renderer::Base do
+  before(:each) do
+    @options = stub(:options).as_null_object
+    @adapter = stub(:adapter)
+    SimpleNavigation.stub!(:adapter => @adapter)
+    @base_renderer = SimpleNavigation::Renderer::Base.new(@options)
+  end
+  
+  describe 'delegated methods' do
+    it {@base_renderer.should respond_to(:link_to)}
+    it {@base_renderer.should respond_to(:content_tag)}
+  end
+
+  describe 'initialize' do
+    it {@base_renderer.adapter.should == @adapter}
+    it {@base_renderer.options.should == @options}
+  end
+    
+  describe 'render' do
+    it "be subclass responsability" do
+      lambda {@base_renderer.render(:container)}.should raise_error('subclass responsibility')
+    end
+  end
+    
+  describe 'expand_all?' do
+    context 'option is set' do
+      context 'expand_all is true' do
+        before(:each) do
+          @base_renderer.stub!(:options => {:expand_all => true})
+        end
+        it {@base_renderer.expand_all?.should be_true}
+      end
+      context 'expand_all is false' do
+        before(:each) do
+          @base_renderer.stub!(:options => {:expand_all => false})
+        end
+        it {@base_renderer.expand_all?.should be_false}
+      end
+    end
+    context 'option is not set' do
+      before(:each) do
+        @base_renderer.stub!(:options => {})
+      end
+      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
+      before(:each) do
+        @base_renderer.stub!(:options => {:level => 1})
+      end
+      it {@base_renderer.level.should == 1}
+    end
+    context 'options[level] is not set' do
+      before(:each) do
+        @base_renderer.stub!(:options => {})
+      end
+      it {@base_renderer.level.should == :all}
+    end
+  end
+
+  describe 'consider_sub_navigation?' do
+    before(:each) do
+      @item = stub(:item)
+    end
+    context 'item has no subnavigation' do
+      before(:each) do
+        @item.stub!(:sub_navigation => nil)
+      end
+      it {@base_renderer.send(:consider_sub_navigation?, @item).should be_false}
+    end
+    context 'item has subnavigation' do
+      before(:each) do
+        @sub_navigation = stub(:sub_navigation)
+        @item.stub!(:sub_navigation => @sub_navigation)
+      end
+      context 'level is something unknown' do
+        before(:each) do
+          @base_renderer.stub!(:level => 'unknown')
+        end
+        it {@base_renderer.send(:consider_sub_navigation?, @item).should be_false}
+      end
+      context 'level is :all' do
+        before(:each) do
+          @base_renderer.stub!(:level => :all)
+        end
+        it {@base_renderer.send(:consider_sub_navigation?, @item).should be_true}
+      end
+      context 'level is an Integer' do
+        before(:each) do
+          @base_renderer.stub!(:level => 2)
+        end
+        it {@base_renderer.send(:consider_sub_navigation?, @item).should be_false}
+      end
+      context 'level is a Range' do
+        before(:each) do
+          @base_renderer.stub!(:level => 2..3)
+        end
+        context 'subnavs level > range.max' do
+          before(:each) do
+            @sub_navigation.stub!(:level => 4)
+          end
+          it {@base_renderer.send(:consider_sub_navigation?, @item).should be_false}
+        end
+        context 'subnavs level = range.max' do
+          before(:each) 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
+            @sub_navigation.stub!(:level => 2)
+          end
+          it {@base_renderer.send(:consider_sub_navigation?, @item).should be_true}
+        end
+      end
+    end
+  end
+
+  describe 'include_sub_navigation?' do
+    before(:each) do
+      @item = stub(:item)
+    end
+    context 'consider_sub_navigation? is true' do
+      before(:each) do
+        @base_renderer.stub!(:consider_sub_navigation? => true)
+      end
+      context 'expand_sub_navigation? is true' do
+        before(:each) do
+          @base_renderer.stub!(:expand_sub_navigation? => true)
+        end
+        it {@base_renderer.include_sub_navigation?(@item).should be_true}
+      end
+      context 'expand_sub_navigation? is false' do
+        before(:each) do
+          @base_renderer.stub!(:expand_sub_navigation? => false)
+        end
+        it {@base_renderer.include_sub_navigation?(@item).should be_false}
+      end
+    end
+    context 'consider_sub_navigation is false' do
+      before(:each) do
+        @base_renderer.stub!(:consider_sub_navigation? => false)
+      end
+      context 'expand_sub_navigation? is true' do
+        before(:each) do
+          @base_renderer.stub!(:expand_sub_navigation? => true)
+        end
+        it {@base_renderer.include_sub_navigation?(@item).should be_false}
+      end
+      context 'expand_sub_navigation? is false' do
+        before(:each) do
+          @base_renderer.stub!(:expand_sub_navigation? => false)
+        end
+        it {@base_renderer.include_sub_navigation?(@item).should be_false}
+      end
+    end
+  end
+
+  describe 'render_sub_navigation_for' do
+    before(:each) do
+      @sub_navigation = stub(:sub_navigation)
+      @item = stub(:item, :sub_navigation => @sub_navigation)
+    end
+    it "should call render on the sub_navigation (passing the options)" do
+      @sub_navigation.should_receive(:render).with(@options)
+      @base_renderer.render_sub_navigation_for(@item)
+    end
+  end
+
+end

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

@@ -0,0 +1,58 @@
+require '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
+      setup_renderer_for SimpleNavigation::Renderer::Breadcrumbs, :rails, 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(:each) 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
+  end
+end