simple-navigation 3.11.0 → 3.12.0

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

@@ -1,48 +1,69 @@
 require 'spec_helper'
+require 'json_spec'
 
-describe SimpleNavigation::Renderer::Json do
+RSpec.configure { |config| config.include JsonSpec::Helpers }
 
-  describe 'render' do
+module SimpleNavigation
+  module Renderer
+    describe Json do
+      describe '#render' do
+        let!(:navigation) { setup_navigation('nav_id', 'nav_class') }
 
-    def render(current_nav=nil, options={})
-      primary_navigation = primary_container
-      select_item(current_nav)
-      setup_renderer_for SimpleNavigation::Renderer::Json, :rails, options
-      @renderer.render(primary_navigation)
-    end
+        let(:item) { :invoices }
+        let(:options) {{ level: :all }}
+        let(:output) { renderer.render(navigation) }
+        let(:parsed_output) { parse_json(output) }
+        let(:renderer) { setup_renderer(Json, options) }
 
-    def prerendered_menu
-      '[{"name":"users","url":"first_url","selected":false,"items":null},{"name":"invoices","url":"second_url","selected":true,"items":[{"name":"subnav1","url":"subnav1_url","selected":false,"items":null},{"name":"subnav2","url":"subnav2_url","selected":false,"items":null}]},{"name":"accounts","url":"third_url","selected":false,"items":null},{"name":"miscellany","url":null,"selected":false,"items":null}]'
-    end
+        before { select_an_item(navigation[item]) if item }
 
-    context 'regarding result' do
+        context 'when an item is selected' do
 
-      it "should return a string" do
-        render(:invoices).class.should == String
-      end
+          it 'renders the selected page' do
+            invoices_item = parsed_output.find { |item| item['name'] == 'Invoices' }
+            expect(invoices_item).to include('selected' => true)
+          end
+        end
+
+        # FIXME: not sure if :as_hash returning an array makes sense...
+        context 'when the :as_hash option is true' do
+          let(:options) {{ level: :all, as_hash: true }}
+
+          it 'returns a hash' do
+            expect(output).to be_an Array
+          end
 
-      it "should render the selected page" do
-        json = parse_json(render(:invoices))
-        found = json.any? do |item| 
-          item["name"] == "invoices" and item["selected"]
+          it 'renders the selected page' do
+            invoices_item = output.find { |item| item[:name] == 'Invoices' }
+            expect(invoices_item).to include(selected: true)
+          end
         end
-        found.should == true
-      end
 
-    end
+        context 'when a sub navigation item is selected' do
+          let(:invoices_item) do
+            parsed_output.find { |item| item['name'] == 'Invoices' }
+          end
+          let(:unpaid_item) do
+            invoices_item['items'].find { |item| item['name'] == 'Unpaid' }
+          end
 
-    context 'regarding hash result' do
-      it "should return a hash" do
-        render(:invoices, :as_hash => true).class.should == Array
-      end
+          before do
+            navigation[:invoices].stub(selected?: true)
 
-      it "should render the selected page" do
-        found = render(:invoices, :as_hash => true).any? do |item|
-          item[:name] == "invoices" and item[:selected]
+            navigation[:invoices]
+              .sub_navigation[:unpaid]
+              .stub(selected?: true, selected_by_condition?: true)
+          end
+
+          it 'marks all the parent items as selected' do
+            expect(invoices_item).to include('selected' => true)
+          end
+
+          it 'marks the item as selected' do
+            expect(unpaid_item).to include('selected' => true)
+          end
         end
-        found.should == true
       end
-
     end
   end
 end

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

@@ -1,64 +1,91 @@
 require 'spec_helper'
-require 'html/document' unless defined? HTML::Document
 
-describe SimpleNavigation::Renderer::Links do
+module SimpleNavigation
+  module Renderer
+    describe Links do
+      describe '#render' do
+        let!(:navigation) { setup_navigation('nav_id', 'nav_class') }
 
-    
-  describe 'render' do
+        let(:item) { nil }
+        let(:options) {{ level: :all }}
+        let(:output) { HTML::Document.new(raw_output).root }
+        let(:raw_output) { renderer.render(navigation) }
+        let(:renderer) { setup_renderer(Links, options) }
 
-    def render(current_nav=nil, options={:level => :all})
-      primary_navigation = primary_container
-      select_item(current_nav) if current_nav
-      setup_renderer_for SimpleNavigation::Renderer::Links, :rails, options
-      HTML::Document.new(@renderer.render(primary_navigation)).root
-    end
+        before { select_an_item(navigation[item]) if item }
 
-    context 'regarding result' do
+        it "renders a 'div' tag for the navigation" do
+          expect(output).to have_css('div')
+        end
 
-      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
-      it "should render an a-tag for each item" do
-        HTML::Selector.new('a').select(render).should have(3).entries
-      end
-      it "should pass the specified html_options to the a element" do
-        HTML::Selector.new('a[style=float:right]').select(render).should have(1).entries
-      end
-      it "should give the a-tag the id specified in the html_options" do
-        HTML::Selector.new('a#my_id').select(render).should have(1).entries
-      end
-      it "should give the a-tag the default id (stringified key) if no id is specified in the html_options" do
-        HTML::Selector.new('a#invoices').select(render).should have(1).entries
-      end
-      it "should not apply the the default id where there is an id specified in the html_options" do
-        HTML::Selector.new('a#users').select(render).should be_empty
-      end
+        it "sets the right html id on the rendered 'div' tag" do
+          expect(output).to have_css('div#nav_id')
+        end
 
-      context 'with current_navigation set' do
-        it "should mark the matching a-item as selected (with the css_class specified in configuration)" do
-          HTML::Selector.new('a.selected').select(render(:invoices)).should have(1).entries
+        it "sets the right html classes on the rendered 'div' tag" do
+          expect(output).to have_css('div.nav_class')
         end
-      end
 
-      context 'without current_navigation set' do
-        it "should not mark any of the items as selected" do
-          HTML::Selector.new('a.selected').select(render).should be_empty
+        it "renders an 'a' tag for each item" do
+          expect(output).to have_css('a', 3)
         end
-      end
 
-      context 'with a custom seperator specified' do
-        it "should separate the items with the separator" do
-          HTML::Selector.new('div').select_first(render(:subnav1, :join_with => " | ")).to_s.split(" | ").should have(4).entries
+        it "renders the 'a' tags with the corresponding item's :html_options" do
+          expect(output).to have_css('a[style=float:right]')
+        end
+
+        context 'when an item has a specified id' do
+          it "renders the 'a' tags with the specified id" do
+            expect(output).to have_css('a#users_id')
+          end
+        end
+
+        context 'when an item has no specified id' do
+          it "uses a default id by stringifying the item's key" do
+            expect(output).to have_css('a#invoices')
+          end
+        end
+
+        context 'when no item is selected' do
+          it "renders items without the 'selected' class" do
+            expect(output).not_to have_css('a.selected')
+          end
+        end
+
+        context 'when an item is selected' do
+          let(:item) { :invoices }
+
+          it "renders the selected item with the 'selected' class" do
+            expect(output).to have_css('a#invoices.selected')
+          end
+        end
+
+        context "when the :join_with option is set" do
+          let(:options) {{ level: :all, join_with: ' | ' }}
+
+          it 'separates the items with the specified separator' do
+            expect(raw_output.scan(' | ')).to have(3).items
+          end
+        end
+
+        context 'when a sub navigation item is selected' do
+          before do
+            navigation[:invoices].stub(selected?: true)
+
+            navigation[:invoices]
+              .sub_navigation[:unpaid]
+              .stub(selected?: true, selected_by_condition?: true)
+          end
+
+          it 'renders the main parent as selected' do
+            expect(output).to have_css('a#invoices.selected')
+          end
+
+          it "doesn't render the nested item's link" do
+            expect(output).not_to have_css('a#unpaid')
+          end
         end
       end
-  
     end
-    
   end
 end

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

@@ -1,211 +1,99 @@
 require 'spec_helper'
-require 'html/document' unless defined? HTML::Document
 
-describe SimpleNavigation::Renderer::List do
+module SimpleNavigation
+  module Renderer
+    describe List do
+      let!(:navigation) { setup_navigation('nav_id', 'nav_class') }
 
-  describe 'render' do
+      let(:item) { nil }
+      let(:options) {{ level: :all }}
+      let(:output) { HTML::Document.new(raw_output).root }
+      let(:raw_output) { renderer.render(navigation) }
+      let(:renderer) { setup_renderer(List, options) }
 
-    def render(current_nav=nil, options={:level => :all})
-      primary_navigation = primary_container
-      select_item(current_nav) if current_nav
-      setup_renderer_for SimpleNavigation::Renderer::List, :rails, options
-      HTML::Document.new(@renderer.render(primary_navigation)).root
-    end
+      before { select_an_item(navigation[item]) if item }
 
-    context 'regarding result' do
+      describe '#render' do
+        it "renders an 'ul' tag for the navigation" do
+          expect(output).to have_css('ul')
+        end
 
-      it "should render a ul-tag around the items" do
-        HTML::Selector.new('ul').select(render).should have(1).entries
-      end
-      it "the rendered ul-tag should have the specified dom_id" do
-        HTML::Selector.new('ul#nav_dom_id').select(render).should have(1).entries
-      end
-      it "the rendered ul-tag should have the specified class" do
-        HTML::Selector.new('ul.nav_dom_class').select(render).should have(1).entries
-      end
-      it "should render a li tag for each item" do
-        HTML::Selector.new('li').select(render).should have(4).entries
-      end
-      it "should render an a-tag inside each li-tag (for items with links)" do
-        HTML::Selector.new('li a').select(render).should have(3).entries
-      end
-      it "should render a span-tag inside each li-tag (for items without links)" do
-        HTML::Selector.new('li span').select(render).should have(1).entries
-      end
+        it "sets the right html id on the rendered 'ul' tag" do
+          expect(output).to have_css('ul#nav_id')
+        end
 
-      context 'concerning item names' do
-        context 'with a custom name generator defined' do
-          before(:each) do
-            SimpleNavigation.config.stub!(:name_generator => Proc.new {|name| "<span>name</span>"})
-          end
-          it "should apply the name generator" do
-            HTML::Selector.new('li a span').select(render).should have(3).entries
-          end
+        it "sets the right html classes on the rendered 'ul' tag" do
+          expect(output).to have_css('ul.nav_class')
         end
-        context 'no customer generator defined' do
-          before(:each) do
-            SimpleNavigation.config.stub!(:name_generator => Proc.new {|name| "name"})
-          end
-          it "should apply the name generator" do
-            HTML::Selector.new('li a span').select(render).should have(0).entries
+
+        context 'when an item has no specified id' do
+          it "renders the item's 'li' tag with the item's stingified key as id" do
+            expect(output).to have_css('li#invoices')
           end
         end
-      end
 
-      context 'concerning html attributes' do
-        context 'default case (no options defined for link tag)' do
-          it "should pass the specified html_options to the li element" do
-            HTML::Selector.new('li[style=float:right]').select(render).should have(1).entries
-          end
-          it "should give the li the id specified in the html_options" do
-            HTML::Selector.new('li#my_id').select(render).should have(1).entries
-          end
-          it "should give the li the default id (stringified key) if no id is specified in the html_options" do
-            HTML::Selector.new('ul li#invoices').select(render).should have(1).entries
-          end
-          it "should not apply the the default id where there is an id specified in the html_options" do
-            HTML::Selector.new('ul li#users').select(render).should be_empty
+        context 'when an item has a specified id' do
+          it "renders the item's 'li' tag with the specified id" do
+            expect(output).to have_css('li#users_id')
           end
         end
-        context 'with attributes defined for the link tag as well' do
-          it "should add the link attributes to the link" do
-            HTML::Selector.new('a[style=float:left]').select(render).should have(1).entries
-          end
-          it "should add the li attributes to the li element" do
-            HTML::Selector.new('li[style=float:right]').select(render).should have(1).entries
-          end
-          it "should give the li the default id (stringified key) if no id is specified in the html_options for the li-element" do
-            HTML::Selector.new('ul li#invoices').select(render).should have(1).entries
+
+        context 'when no item is selected' do
+          it "renders each item as 'li' tag without any selected class" do
+            expect(output).not_to have_css('ul li.selected')
           end
-          it "should not apply the the default id where there is an id specified in the html_options for th li-element" do
-            HTML::Selector.new('ul li#users').select(render).should be_empty
+
+          it "renders each item as 'a' tag without any selected class" do
+            expect(output).not_to have_css('ul li a.selected')
           end
         end
-      end
-      
-      context 'with current_navigation set' do
-        it "should mark the matching li-item as selected (with the css_class specified in configuration)" do
-          HTML::Selector.new('li.selected').select(render(:invoices)).should have(1).entries
-        end
-        it "should also mark the links inside the selected li's as selected" do
-          HTML::Selector.new('li.selected a.selected').select(render(:invoices)).should have(1).entries
-        end
-      end
 
-      context 'without current_navigation set' do
-        it "should not mark any of the items as selected" do
-          HTML::Selector.new('li.selected').select(render).should be_empty
-        end
-        it "should not mark any links as selected" do
-          HTML::Selector.new('a.selected').select(render).should be_empty
-        end
-      end
+        context 'when an item is selected' do
+          let(:item) { :invoices }
 
-      context 'nested sub_navigation' do
-        it "should nest the current_primary's subnavigation inside the selected li-element" do
-          HTML::Selector.new('li.selected ul li').select(render(:invoices)).should have(2).entries
-        end
-        it "should be possible to identify sub items using an html selector (using ids)" do
-          HTML::Selector.new('#invoices #subnav1').select(render(:invoices)).should have(1).entries
-        end
-        context 'expand_all => false' do
-          it "should not render the invoices submenu if the user-primary is active" do
-            HTML::Selector.new('#invoices #subnav1').select(render(:users, :level => :all, :expand_all => false)).should be_empty
-            HTML::Selector.new('#invoices #subnav2').select(render(:users, :level => :all, :expand_all => false)).should be_empty
+          it "renders the item's 'li' tag with its id and selected classes" do
+            expect(output).to have_css('li#invoices.selected')
           end
-        end
 
-        context 'expand_all => true' do
-          it "should render the invoices submenu even if the user-primary is active" do
-            HTML::Selector.new('#invoices #subnav1').select(render(:users, :level => :all, :expand_all => true)).should have(1).entry
-            HTML::Selector.new('#invoices #subnav2').select(render(:users, :level => :all, :expand_all => true)).should have(1).entry
+          it "renders the item's 'a' tag with the selected classes" do
+            expect(output).to have_css('li#invoices a.selected')
           end
         end
 
-      end
+        context 'when the :ordered option is true' do
+          let(:options) {{ level: :all, ordered: true }}
 
-      context 'skip_if_empty' do
-
-        def render_container(options={})
-          setup_renderer_for SimpleNavigation::Renderer::List, :rails, options
-          HTML::Document.new(@renderer.render(@container)).root
-        end
-
-        context 'container is empty' do
-          before(:each) do
-            @container = SimpleNavigation::ItemContainer.new(0)
+          it "renders an 'ol' tag for the navigation" do
+            expect(output).to have_css('ol')
           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
+          it "sets the right html id on the rendered 'ol' tag" do
+            expect(output).to have_css('ol#nav_id')
           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
+
+          it "sets the right html classes on the rendered 'ol' tag" do
+            expect(output).to have_css('ol.nav_class')
           end
         end
-      end
-    end
-    
-    describe 'link_options_for' do
-      before(:each) do
-        setup_renderer_for SimpleNavigation::Renderer::List, :rails, {}
-      end
-      context 'no link options specified' do
-        context 'method specified' do
-          context 'item selected' do
-            before(:each) do
-              @item = stub(:item, :method => :delete, :selected_class => 'selected', :html_options => {})
-            end
-            it {@renderer.send(:link_options_for, @item).should == {:method => :delete, :class => 'selected'}}
+
+        context 'when a sub navigation item is selected' do
+          before do
+            navigation[:invoices].stub(selected?: true)
+
+            navigation[:invoices]
+              .sub_navigation[:unpaid]
+              .stub(selected?: true, selected_by_condition?: true)
           end
-          context 'item not selected' do
-            before(:each) do
-              @item = stub(:item, :method => :delete, :selected_class => nil, :html_options => {})
-            end
-            it {@renderer.send(:link_options_for, @item).should == {:method => :delete}}
+
+          it 'renders the parent items as selected' do
+            expect(output).to have_css('li#invoices.selected')
           end
-        end
-        context 'method not specified' do
-          context 'item selected' do
-            before(:each) do
-              @item = stub(:item, :method => nil, :selected_class => 'selected', :html_options => {})
-            end
-            it {@renderer.send(:link_options_for, @item).should == {:class => 'selected'}}
+
+          it "renders the selected nested item's link as selected" do
+            expect(output).to have_css('li#unpaid.selected')
           end
-          context 'item not selected' do
-            before(:each) do
-              @item = stub(:item, :method => nil, :selected_class => nil, :html_options => {})
-            end
-            it {@renderer.send(:link_options_for, @item).should == {}}
-          end        
-        end
-      end
-      context 'link options specified' do
-        before(:each) do
-          @item = stub(:item, :method => :delete, :selected_class => 'selected', :html_options => {:link => {:class => 'link_class', :style => 'float:left'}})
         end
-        it {@renderer.send(:link_options_for, @item).should == {:method => :delete, :class => 'link_class selected', :style => 'float:left'}}
       end
     end
-    
   end
 end

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

@@ -1,39 +1,52 @@
 require 'spec_helper'
 
-describe SimpleNavigation::Renderer::Text do
+module SimpleNavigation
+  module Renderer
+    describe Text do
+      let!(:navigation) { setup_navigation('nav_id', 'nav_class') }
 
-  describe 'render' do
+      let(:item) { nil }
+      let(:options) {{ level: :all }}
+      let(:output) { renderer.render(navigation) }
+      let(:renderer) { setup_renderer(Text, options) }
 
-    def render(current_nav=nil, options={:level => :all})
-      primary_navigation = primary_container
-      select_item(current_nav)
-      setup_renderer_for SimpleNavigation::Renderer::Text, :rails, options
-      @renderer.render(primary_navigation)
-    end
-    context 'regarding result' do
-
-      it "should render the selected page" do
-        render(:invoices).should == "invoices"
-      end
+      before { select_an_item(navigation[item]) if item }
 
-      context 'nested sub_navigation' do
-        it "should add an entry for each selected item" do
-          render(:subnav1).should == "invoices subnav1"
+      describe '#render' do
+        context 'when no item is selected' do
+          it 'renders an empty string' do
+            expect(output).to eq ''
+          end
         end
-      end
 
-      context 'with a custom seperator specified' do
-        it "should separate the items with the separator" do
-          render(:subnav1, :join_with => " | ").should == "invoices | subnav1" 
-        end
-      end
-      
-      context 'custom name generator is set' do
-        before(:each) do
-          SimpleNavigation.config.stub!(:name_generator => Proc.new {|name| "<span>name</span>"})
+        context 'when an item is selected' do
+          let(:item) { :invoices }
+
+          it "renders the selected item's name" do
+            expect(output).to eq 'Invoices'
+          end
         end
-        it "should not apply the name generator (since it is text only)" do
-          render(:subnav1, :join_with => " | ").should == "invoices | subnav1" 
+
+        context 'when a sub navigation item is selected' do
+          before do
+            navigation[:invoices].stub(selected?: true)
+
+            navigation[:invoices]
+              .sub_navigation[:unpaid]
+              .stub(selected?: true, selected_by_condition?: true)
+          end
+
+          it 'separates the items with a space' do
+            expect(output).to eq 'Invoices Unpaid'
+          end
+
+          context "and the :join_with option is set" do
+            let(:options) {{ level: :all, join_with: ' | ' }}
+
+            it 'separates the items with the specified separator' do
+              expect(output).to eq 'Invoices | Unpaid'
+            end
+          end
         end
       end
     end