simple-navigation 3.14.0 → 4.0.0

data/spec/{lib/simple_navigation → simple_navigation}/adapters/sinatra_spec.rb

@@ -1,16 +1,14 @@
-require 'spec_helper'
-
 describe SimpleNavigation::Adapters::Sinatra do
   let(:adapter) { SimpleNavigation::Adapters::Sinatra.new(context) }
   let(:context) { double(:context) }
   let(:request) { double(:request, fullpath: '/full?param=true', path: '/full') }
 
-  before { context.stub(request: request) }
+  before { allow(context).to receive_messages(request: request) }
 
   describe '#context_for_eval' do
     context "when adapter's context is not set" do
       it 'raises an exception' do
-        adapter.stub(context: nil)
+        allow(adapter).to receive_messages(context: nil)
         expect{ adapter.context_for_eval }.to raise_error
       end
     end
@@ -35,7 +33,7 @@ describe SimpleNavigation::Adapters::Sinatra do
   end
 
   describe '#current_page?' do
-    before { request.stub(scheme: 'http', host_with_port: 'my_host:5000') }
+    before { allow(request).to receive_messages(scheme: 'http', host_with_port: 'my_host:5000') }
 
     shared_examples 'detecting current page' do |url, expected|
       context "when url is #{url}" do
@@ -59,7 +57,7 @@ describe SimpleNavigation::Adapters::Sinatra do
 
     context 'when URL is encoded' do
       before do
-        request.stub(fullpath: '/full%20with%20spaces?param=true',
+        allow(request).to receive_messages(fullpath: '/full%20with%20spaces?param=true',
                      path: '/full%20with%20spaces')
       end
 

data/spec/simple_navigation/config_file_finder_spec.rb

@@ -0,0 +1,50 @@
+require 'fileutils'
+require 'simple_navigation/config_file_finder'
+
+module SimpleNavigation
+  describe ConfigFileFinder do
+    subject(:finder) { ConfigFileFinder.new(paths) }
+
+    let(:paths) { ['/path/one', '/path/two'] }
+
+    describe '#find', memfs: true do
+      before { FileUtils.mkdir_p(paths) }
+
+      context 'when the context is :default' do
+        let(:context) { :default }
+
+        context 'and a navigation.rb file is found in one of the paths' do
+          before { FileUtils.touch('/path/one/navigation.rb') }
+
+          it 'returns its full path' do
+            expect(finder.find(context)).to eq '/path/one/navigation.rb'
+          end
+        end
+
+        context 'and no navigation.rb file is found in the paths' do
+          it 'raises an exception' do
+            expect{ finder.find(context) }.to raise_error
+          end
+        end
+      end
+
+      context 'when the context is :other' do
+        let(:context) { :other }
+
+        context 'and a other_navigation.rb file is found in one of the paths' do
+          before { FileUtils.touch('/path/two/other_navigation.rb') }
+
+          it 'returns its full path' do
+            expect(finder.find(context)).to eq '/path/two/other_navigation.rb'
+          end
+        end
+
+        context 'and no other_navigation.rb file is found in the paths' do
+          it 'raise an exception' do
+            expect{ finder.find(context) }.to raise_error
+          end
+        end
+      end
+    end
+  end
+end

data/spec/simple_navigation/config_file_spec.rb

@@ -0,0 +1,25 @@
+require 'simple_navigation/config_file'
+
+module SimpleNavigation
+  describe ConfigFile do
+    subject(:config_file) { ConfigFile.new(context) }
+
+    let(:context) { :default }
+
+    describe '#name' do
+      context 'when the context is :default' do
+        it 'returns navigation.rb' do
+          expect(config_file.name).to eq 'navigation.rb'
+        end
+      end
+
+      context 'when the context is different from :default' do
+        let(:context) { :HelloWorld }
+
+        it 'returns UNDERSCORED_CONTEXT_navigation.rb' do
+          expect(config_file.name).to eq 'hello_world_navigation.rb'
+        end
+      end
+    end
+  end
+end

data/spec/{lib/simple_navigation/core → simple_navigation}/configuration_spec.rb

@@ -1,5 +1,3 @@
-require 'spec_helper'
-
 module SimpleNavigation
   describe Configuration do
     subject(:config) { Configuration.instance }
@@ -15,20 +13,20 @@ module SimpleNavigation
       let(:eval_context) { double(:eval_context) }
 
       before do
-        eval_context.stub(:instance_eval)
-        SimpleNavigation.stub(context_for_eval: eval_context,
-                              config_files: config_files)
+        allow(eval_context).to receive(:instance_eval)
+        allow(SimpleNavigation).to \
+          receive_messages(context_for_eval: eval_context, config_files: config_files)
       end
 
       context "with default navigation context" do
-        it "should instance_eval the default config_file-string inside the context" do
+        it "calls instance_eval with the default config_file-string inside the context" do
           expect(eval_context).to receive(:instance_eval).with('default')
           Configuration.eval_config
         end
       end
 
       context 'with non default navigation context' do
-        it "should instance_eval the specified config_file-string inside the context" do
+        it "calls instance_eval with the specified config_file-string inside the context" do
           expect(eval_context).to receive(:instance_eval).with('my_context')
           Configuration.eval_config(:my_context)
         end
@@ -49,30 +47,42 @@ module SimpleNavigation
       end
 
       it 'sets autogenerate_item_ids to true as default' do
-        expect(config.autogenerate_item_ids).to be_true
+        expect(config.autogenerate_item_ids).to be true
       end
 
       it 'sets auto_highlight to true as default' do
-        expect(config.auto_highlight).to be_true
+        expect(config.auto_highlight).to be true
+      end
+
+      it 'sets the id_generator to a callable object' do
+        expect(config.id_generator).to respond_to(:call)
       end
 
-      it 'should set the id_generator' do
-        expect(config.id_generator).not_to be_nil
+      it 'sets the name_generator to a callable object' do
+        expect(config.name_generator).to respond_to(:call)
       end
 
-      it 'should set the name_generator' do
-        expect(config.name_generator).not_to be_nil
+      it 'sets the consider_item_names_as_safe to false' do
+        expect(config.consider_item_names_as_safe).to be false
+      end
+
+      it 'sets highlights_on_subpath to false as default' do
+        expect(config.highlight_on_subpath).to be false
       end
       
-      it 'should set the consider_item_names_as_safe to false' do
-        expect(config.consider_item_names_as_safe).to be_false
+      it 'sets ignore_query_params_on_auto_highlight to true as default' do
+        expect(config.ignore_query_params_on_auto_highlight).to be true
+      end
+
+      it 'sets ignore_anchors_on_auto_highlight to true as default' do
+        expect(config.ignore_anchors_on_auto_highlight).to be true
       end
     end
 
     describe '#items' do
       let(:container) { double(:items_container) }
 
-      before { ItemContainer.stub(:new).and_return(container) }
+      before { allow(ItemContainer).to receive_messages(new: container) }
 
       context 'when a block is given' do
         context 'and items_provider is specified' do
@@ -107,8 +117,8 @@ module SimpleNavigation
           let(:items_provider) { double(:items_provider, items: items) }
 
           before do
-            SimpleNavigation::ItemsProvider.stub(new: items_provider)
-            container.stub(:items=)
+            allow(SimpleNavigation::ItemsProvider).to receive_messages(new: items_provider)
+            allow(container).to receive(:items=)
           end
 
           it 'creates a new Provider object for the specified provider' do
@@ -144,7 +154,7 @@ module SimpleNavigation
       end
 
       context 'when primary_nav is not set' do
-        it "should return false if no primary_nav is set" do
+        it 'returns false if no primary_nav is set' do
           config.instance_variable_set(:@primary_navigation, nil)
           expect(config).not_to be_loaded
         end

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

@@ -1,21 +1,18 @@
-require 'spec_helper'
-
-class TestController
-  include SimpleNavigation::Helpers
-end
-
 module SimpleNavigation
   describe Helpers do
-    subject(:controller) { TestController.new }
+    subject(:controller) { test_controller_class.new }
 
     let(:invoices_item) { navigation[:invoices] }
     let(:item) { nil }
     let(:navigation) { setup_navigation('nav_id', 'nav_class') }
+    let(:test_controller_class) do
+      Class.new { include SimpleNavigation::Helpers }
+    end
     let(:unpaid_item) { invoices_item.sub_navigation[:unpaid] }
 
     before do
-      Configuration.stub(:eval_config)
-      SimpleNavigation.stub(load_config: nil,
+      allow(Configuration).to receive(:eval_config)
+      allow(SimpleNavigation).to receive_messages(load_config: nil,
                             primary_navigation: navigation,
                             config_file?: true,
                             context_for_eval: controller)
@@ -357,7 +354,7 @@ module SimpleNavigation
             let(:item_container) { double(:container).as_null_object }
 
             before do
-              SimpleNavigation.stub(active_item_container_for: item_container)
+              allow(SimpleNavigation).to receive_messages(active_item_container_for: item_container)
             end
 
             it 'finds the selected sub navigation for the specified level' do
@@ -391,7 +388,7 @@ module SimpleNavigation
       end
 
       context 'when the :levels option is set' do
-        before { SimpleNavigation.stub(active_item_container_for: navigation) }
+        before { allow(SimpleNavigation).to receive_messages(active_item_container_for: navigation) }
 
         it 'treats it like the :level option' do
           expect(navigation).to receive(:render).with(level: 2)
@@ -408,7 +405,7 @@ module SimpleNavigation
       end
 
       context 'when no primary configuration is defined' do
-        before { SimpleNavigation.stub(primary_navigation: nil) }
+        before { allow(SimpleNavigation).to receive_messages(primary_navigation: nil) }
 
         it 'raises an exception' do
           expect{controller.render_navigation}.to raise_error
@@ -419,7 +416,7 @@ module SimpleNavigation
         let(:active_item_container) { double(:container).as_null_object }
 
         before do
-          SimpleNavigation.stub(active_item_container_for: active_item_container)
+          allow(SimpleNavigation).to receive_messages(active_item_container_for: active_item_container)
         end
 
         it 'calls render on the active_item_container' do

data/spec/{lib/simple_navigation/core → simple_navigation}/item_adapter_spec.rb

@@ -1,5 +1,3 @@
-require 'spec_helper'
-
 module SimpleNavigation
   describe ItemAdapter do
     let(:item_adapter) { ItemAdapter.new(item) }
@@ -28,7 +26,7 @@ module SimpleNavigation
         context 'when item responds to options' do
           let(:options) { double(:options) }
 
-          before { item.stub(options: options) }
+          before { allow(item).to receive_messages(options: options) }
 
           it "returns the item's options" do
             expect(item_adapter.options).to be options
@@ -45,7 +43,7 @@ module SimpleNavigation
       describe '#items' do
         context 'when item responds to items' do
           context 'and items is nil' do
-            before { item.stub(items: nil) }
+            before { allow(item).to receive_messages(items: nil) }
 
             it 'returns nil' do
               expect(item_adapter.items).to be_nil
@@ -54,7 +52,7 @@ module SimpleNavigation
 
           context 'when items is not nil' do
             context 'and items is empty' do
-              before { item.stub(items: []) }
+              before { allow(item).to receive_messages(items: []) }
 
               it 'returns nil' do
                 expect(item_adapter.items).to be_nil
@@ -64,7 +62,7 @@ module SimpleNavigation
             context 'and items is not empty' do
               let(:items) { [true] }
 
-              before { item.stub(items: items) }
+              before { allow(item).to receive_messages(items: items) }
 
               it 'returns the items' do
                 expect(item_adapter.items).to eq items
@@ -83,11 +81,11 @@ module SimpleNavigation
       describe '#to_simple_navigation_item' do
         let(:container) { double(:container) }
 
-        before { item.stub(items: [], options: {}) }
+        before { allow(item).to receive_messages(items: [], options: {}) }
 
         it 'creates an Item' do
           expect(Item).to receive(:new)
-                          .with(container, 'key', 'name', 'url', {}, nil)
+                          .with(container, 'key', 'name', 'url', {})
           item_adapter.to_simple_navigation_item(container)
         end
       end
@@ -172,13 +170,18 @@ module SimpleNavigation
       describe '#to_simple_navigation_item' do
         let(:container) { double(:container) }
 
-        before { item.merge(items: [], options: {}) }
+        before { item.merge(options: {}) }
 
-        it 'creates an Item' do
+        it 'passes the right arguments to Item' do
           expect(Item).to receive(:new)
-                          .with(container, 'key', 'name', 'url', {}, nil)
+                          .with(container, 'key', 'name', 'url', {})
           item_adapter.to_simple_navigation_item(container)
         end
+
+        it 'creates an Item' do
+          created_item = item_adapter.to_simple_navigation_item(container)
+          expect(created_item).to be_an(Item)
+        end
       end
     end
   end

data/spec/{lib/simple_navigation/core → simple_navigation}/item_container_spec.rb

@@ -1,12 +1,10 @@
-require 'spec_helper'
-
 module SimpleNavigation
   describe ItemContainer do
     subject(:item_container) { ItemContainer.new }
 
     shared_examples 'adding the item to the list' do
       it 'adds the item to the list' do
-        Item.stub(:new).and_return(item)
+        allow(Item).to receive_messages(new: item)
         item_container.item(*args)
         expect(item_container.items).to include(item)
       end
@@ -14,7 +12,7 @@ module SimpleNavigation
 
     shared_examples 'not adding the item to the list' do
       it "doesn't add the item to the list" do
-        Item.stub(:new).and_return(item)
+        allow(Item).to receive_messages(new: item)
         item_container.item(*args)
         expect(item_container.items).not_to include(item)
       end
@@ -75,12 +73,14 @@ module SimpleNavigation
       let(:real_item) { double(:real_item) }
 
       before do
-        ItemAdapter.stub(:new).and_return(item_adapter)
-        item_adapter.stub(to_simple_navigation_item: real_item)
+        allow(ItemAdapter).to receive_messages(new: item_adapter)
+        allow(item_adapter).to receive(:to_simple_navigation_item)
+                               .with(item_container)
+                               .and_return(real_item)
       end
 
       context 'when the item should be added' do
-        before { item_container.stub(should_add_item?: true) }
+        before { allow(item_container).to receive_messages(should_add_item?: true) }
 
         it 'converts it to an Item and adds it to the items collection' do
           item_container.items = items
@@ -89,7 +89,7 @@ module SimpleNavigation
       end
 
       context 'when the item should not be added' do
-        before { item_container.stub(should_add_item?: false) }
+        before { allow(item_container).to receive_messages(should_add_item?: false) }
 
         it "doesn't add it to the items collection" do
           item_container.items = items
@@ -114,7 +114,7 @@ module SimpleNavigation
 
       context 'when an item is selected' do
         it 'returns true' do
-          item_1.stub(selected?: true)
+          allow(item_1).to receive_messages(selected?: true)
           expect(item_container).to be_selected
         end
       end
@@ -125,8 +125,8 @@ module SimpleNavigation
       let(:item_2) { double(:item, selected?: false) }
 
       before(:each) do
-        SimpleNavigation.stub(current_navigation_for: :nav)
-        item_container.stub(:[] => nil)
+        allow(SimpleNavigation).to receive_messages(current_navigation_for: :nav)
+        allow(item_container).to receive_messages(:[] => nil)
         item_container.instance_variable_set(:@items, [item_1, item_2])
       end
 
@@ -138,7 +138,7 @@ module SimpleNavigation
         end
 
         context 'and an item selected' do
-          before { item_1.stub(selected?: true) }
+          before { allow(item_1).to receive_messages(selected?: true) }
 
           it 'returns the selected item' do
             expect(item_container.selected_item).to be item_1
@@ -156,7 +156,7 @@ module SimpleNavigation
 
       context "when the desired level is different than the container's" do
         context 'and no subnavigation is selected' do
-          before { item_container.stub(selected_sub_navigation?: false) }
+          before { allow(item_container).to receive_messages(selected_sub_navigation?: false) }
 
           it 'returns nil' do
             expect(item_container.active_item_container_for(2)).to be_nil
@@ -168,9 +168,9 @@ module SimpleNavigation
           let(:selected_item) { double(:selected_item) }
 
           before do
-            item_container.stub(selected_sub_navigation?: true,
-                                selected_item: selected_item)
-            selected_item.stub(sub_navigation: sub_navigation)
+            allow(item_container).to \
+              receive_messages(selected_sub_navigation?: true, selected_item: selected_item)
+            allow(selected_item).to receive_messages(sub_navigation: sub_navigation)
           end
 
           it 'calls recursively on the sub_navigation' do
@@ -188,9 +188,9 @@ module SimpleNavigation
         let(:selected_item) { double(:selected_item) }
 
         before do
-          item_container.stub(selected_sub_navigation?: true,
+          allow(item_container).to receive_messages(selected_sub_navigation?: true,
                               selected_item: selected_item)
-          selected_item.stub(sub_navigation: sub_navigation)
+          allow(selected_item).to receive_messages(sub_navigation: sub_navigation)
         end
 
         it 'calls recursively on the sub_navigation' do
@@ -200,7 +200,7 @@ module SimpleNavigation
       end
 
       context 'when the current container is the leaf already' do
-        before { item_container.stub(selected_sub_navigation?: false) }
+        before { allow(item_container).to receive_messages(selected_sub_navigation?: false) }
 
         it 'returns itsself' do
           expect(item_container.active_leaf_container).to be item_container
@@ -217,9 +217,8 @@ module SimpleNavigation
         let(:sub_container) { double(:sub_container) }
 
         it 'yields a new ItemContainer' do
-          Item.any_instance
-              .stub(:sub_navigation)
-              .and_return(sub_container)
+          allow_any_instance_of(Item).to \
+            receive_messages(sub_navigation: sub_container)
 
           expect{ |blk|
             item_container.item('key', 'name', 'url', options, &blk)
@@ -227,9 +226,9 @@ module SimpleNavigation
         end
 
         it "creates a new Item with the given params and block" do
-          Item.stub(:new)
-              .with(item_container, 'key', 'name', 'url', options, nil, &block)
-              .and_return(item)
+          allow(Item).to receive(:new)
+                         .with(item_container, 'key', 'name', 'url', options, &block)
+                         .and_return(item)
           item_container.item('key', 'name', 'url', options, &block)
           expect(item_container.items).to include(item)
         end
@@ -242,15 +241,15 @@ module SimpleNavigation
 
       context 'when no block is given' do
         it 'creates a new Item with the given params and no sub navigation' do
-          Item.stub(:new)
-              .with(item_container, 'key', 'name', 'url', options, nil)
-              .and_return(item)
+          allow(Item).to receive(:new)
+                         .with(item_container, 'key', 'name', 'url', options)
+                         .and_return(item)
           item_container.item('key', 'name', 'url', options)
           expect(item_container.items).to include(item)
         end
 
         it 'adds the created item to the list of items' do
-          Item.stub(:new).and_return(item)
+          allow(Item).to receive_messages(new: item)
           item_container.item('key', 'name', 'url', options) {}
           expect(item_container.items).to include(item)
         end
@@ -278,13 +277,13 @@ module SimpleNavigation
 
           context 'and options contains a negative condition' do
             it_behaves_like 'not adding the item to the list' do
-              let(:args) { ['key', 'name', { if: ->{ false }, option: true }] }
+              let(:args) { ['key', 'name', nil, { if: ->{ false }, option: true }] }
             end
           end
 
           context 'and options contains a positive condition' do
             it_behaves_like 'adding the item to the list' do
-              let(:args) { ['key', 'name', { if: ->{ true }, option: true }] }
+              let(:args) { ['key', 'name', nil, { if: ->{ true }, option: true }] }
             end
           end
         end
@@ -308,6 +307,105 @@ module SimpleNavigation
             end
           end
         end
+
+        context 'when a frozen options hash is given' do
+          let(:options) do
+            { html: { id: 'test' } }.freeze
+          end
+
+          it 'does not raise an exception' do
+            expect{
+              item_container.item('key', 'name', 'url', options)
+            }.not_to raise_error
+          end
+        end
+
+        describe "container options" do
+          before do
+            allow(item_container).to receive_messages(should_add_item?: add_item)
+            item_container.item :key, 'name', 'url', options
+          end
+
+          context 'when the container :id option is specified' do
+            let(:options) {{ container: { id: 'c_id' } }}
+
+            context 'and the item should be added' do
+              let(:add_item) { true }
+
+              it 'changes its dom_id' do
+                expect(item_container.dom_id).to eq 'c_id'
+              end
+            end
+
+            context "and the item shouldn't be added" do
+              let(:add_item) { false }
+
+              it "doesn't change its dom_id" do
+                expect(item_container.dom_id).to be_nil
+              end
+            end
+          end
+
+          context 'when the container :class option is specified' do
+            let(:options) {{ container: { class: 'c_class' } }}
+
+            context 'and the item should be added' do
+              let(:add_item) { true }
+
+              it 'changes its dom_class' do
+                expect(item_container.dom_class).to eq 'c_class'
+              end
+            end
+
+            context "and the item shouldn't be added" do
+              let(:add_item) { false }
+
+              it "doesn't change its dom_class" do
+                expect(item_container.dom_class).to be_nil
+              end
+            end
+          end
+
+          context 'when the container :attributes option is specified' do
+            let(:options) {{ container: { attributes: { option: true } } }}
+
+            context 'and the item should be added' do
+              let(:add_item) { true }
+
+              it 'changes its dom_attributes' do
+                expect(item_container.dom_attributes).to eq(option: true)
+              end
+            end
+
+            context "and the item shouldn't be added" do
+              let(:add_item) { false }
+
+              it "doesn't change its dom_attributes" do
+                expect(item_container.dom_attributes).to eq({})
+              end
+            end
+          end
+
+          context 'when the container :selected_class option is specified' do
+            let(:options) {{ container: { selected_class: 'sel_class' } }}
+
+            context 'and the item should be added' do
+              let(:add_item) { true }
+
+              it 'changes its selected_class' do
+                expect(item_container.selected_class).to eq 'sel_class'
+              end
+            end
+
+            context "and the item shouldn't be added" do
+              let(:add_item) { false }
+
+              it "doesn't change its selected_class" do
+                expect(item_container.selected_class).to be_nil
+              end
+            end
+          end
+        end
       end
 
       describe 'Conditions' do
@@ -315,11 +413,6 @@ module SimpleNavigation
           let(:options) {{ if: proc{condition} }}
           let(:condition) { nil }
 
-          it 'removes :if from the options' do
-            item_container.item('key', 'name', 'url', options)
-            expect(options).not_to have_key(:if)
-          end
-
           context 'and it evals to true' do
             let(:condition) { true }
 
@@ -351,11 +444,6 @@ module SimpleNavigation
           let(:options) {{ unless: proc{condition} }}
           let(:condition) { nil }
 
-          it "removes :unless from the options" do
-            item_container.item('key', 'name', 'url', options)
-            expect(options).not_to have_key(:unless)
-          end
-
           context 'and it evals to false' do
             let(:condition) { false }
 
@@ -436,7 +524,7 @@ module SimpleNavigation
       context 'when no renderer is specified' do
         let(:options) { Hash.new }
 
-        before { item_container.stub(renderer: renderer_class) }
+        before { allow(item_container).to receive_messages(renderer: renderer_class) }
 
         it "instantiates the container's renderer with the options" do
           expect(renderer_class).to receive(:new).with(options)