simple-navigation 3.14.0 → 4.0.0

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

@@ -1,5 +1,3 @@
-require 'spec_helper'
-
 module SimpleNavigation
   describe ItemsProvider do
     let(:items_provider) { ItemsProvider.new(provider) }
@@ -11,7 +9,7 @@ module SimpleNavigation
         let(:context) { double(:context, provider_method: items) }
         let(:provider) { :provider_method }
 
-        before { SimpleNavigation.stub(context_for_eval: context) }
+        before { allow(SimpleNavigation).to receive_messages(context_for_eval: context) }
 
         it 'retrieves the items from the evaluation context' do
           expect(items_provider.items).to eq items

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

@@ -1,5 +1,3 @@
-require 'spec_helper'
-
 module SimpleNavigation
   module Renderer
     describe Base do
@@ -8,15 +6,15 @@ module SimpleNavigation
       let(:adapter) { double(:adapter) }
       let(:options) { Hash.new }
 
-      before { SimpleNavigation.stub(adapter: adapter) }
+      before { allow(SimpleNavigation).to receive_messages(adapter: adapter) }
 
       it 'delegates the :link_to method to adapter' do
-        adapter.stub(link_to: 'link_to')
+        allow(adapter).to receive_messages(link_to: 'link_to')
         expect(base.link_to).to eq 'link_to'
       end
 
       it 'delegates the :content_tag method to adapter' do
-        adapter.stub(content_tag: 'content_tag')
+        allow(adapter).to receive_messages(content_tag: 'content_tag')
         expect(base.content_tag).to eq 'content_tag'
       end
 
@@ -44,7 +42,7 @@ module SimpleNavigation
             let(:options) {{ expand_all: true }}
 
             it 'returns true' do
-              expect(base.expand_all?).to be_true
+              expect(base.expand_all?).to be true
             end
           end
 
@@ -52,7 +50,7 @@ module SimpleNavigation
             let(:options) {{ expand_all: false }}
 
             it 'returns false' do
-              expect(base.expand_all?).to be_false
+              expect(base.expand_all?).to be false
             end
           end
         end
@@ -61,7 +59,7 @@ module SimpleNavigation
           let(:options) { Hash.new }
 
           it 'returns false' do
-            expect(base.expand_all?).to be_false
+            expect(base.expand_all?).to be false
           end
         end
       end
@@ -72,7 +70,7 @@ module SimpleNavigation
             let(:options) {{ skip_if_empty: true }}
 
             it 'returns true' do
-              expect(base.skip_if_empty?).to be_true
+              expect(base.skip_if_empty?).to be true
             end
           end
 
@@ -80,7 +78,7 @@ module SimpleNavigation
             let(:options) {{ skip_if_empty: false }}
 
             it 'returns true' do
-              expect(base.skip_if_empty?).to be_false
+              expect(base.skip_if_empty?).to be false
             end
           end
         end
@@ -89,7 +87,7 @@ module SimpleNavigation
           let(:options) { Hash.new }
 
           it 'returns true' do
-            expect(base.skip_if_empty?).to be_false
+            expect(base.skip_if_empty?).to be false
           end
         end
       end
@@ -115,13 +113,13 @@ module SimpleNavigation
       describe '#consider_sub_navigation?' do
         let(:item) { double(:item) }
 
-        before { item.stub(sub_navigation: sub_navigation) }
+        before { allow(item).to receive_messages(sub_navigation: sub_navigation) }
 
         context 'when the item has no sub navigation' do
           let(:sub_navigation) { nil }
 
           it 'returns false' do
-            expect(base.send(:consider_sub_navigation?, item)).to be_false
+            expect(base.send(:consider_sub_navigation?, item)).to be false
           end
         end
 
@@ -129,53 +127,53 @@ module SimpleNavigation
           let(:sub_navigation) { double(:sub_navigation) }
 
           context 'and the renderer has an unknown level' do
-            before { base.stub(level: 'unknown') }
+            before { allow(base).to receive_messages(level: 'unknown') }
 
             it 'returns false' do
-              expect(base.send(:consider_sub_navigation?, item)).to be_false
+              expect(base.send(:consider_sub_navigation?, item)).to be false
             end
           end
 
           context 'and the renderer has a level set to :all' do
-            before { base.stub(level: :all) }
+            before { allow(base).to receive_messages(level: :all) }
 
             it 'returns false' do
-              expect(base.send(:consider_sub_navigation?, item)).to be_true
+              expect(base.send(:consider_sub_navigation?, item)).to be true
             end
           end
 
           context "when the renderer's level is a number" do
-            before { base.stub(level: 2) }
+            before { allow(base).to receive_messages(level: 2) }
 
             it 'returns false' do
-              expect(base.send(:consider_sub_navigation?, item)).to be_false
+              expect(base.send(:consider_sub_navigation?, item)).to be false
             end
           end
 
           context "when the renderer's level is a Range" do
-            before { base.stub(level: 2..3) }
+            before { allow(base).to receive_messages(level: 2..3) }
 
             context "and sub navigation's level is greater than range.max" do
-              before { sub_navigation.stub(level: 4) }
+              before { allow(sub_navigation).to receive_messages(level: 4) }
 
               it 'returns false' do
-                expect(base.send(:consider_sub_navigation?, item)).to be_false
+                expect(base.send(:consider_sub_navigation?, item)).to be false
               end
             end
 
             context "and sub navigation's level is equal to range.max" do
-              before { sub_navigation.stub(level: 3) }
+              before { allow(sub_navigation).to receive_messages(level: 3) }
 
               it 'returns true' do
-                expect(base.send(:consider_sub_navigation?, item)).to be_true
+                expect(base.send(:consider_sub_navigation?, item)).to be true
               end
             end
 
             context "and sub navigation's level is equal to range.min" do
-              before { sub_navigation.stub(level: 2) }
+              before { allow(sub_navigation).to receive_messages(level: 2) }
 
               it 'returns true' do
-                expect(base.send(:consider_sub_navigation?, item)).to be_true
+                expect(base.send(:consider_sub_navigation?, item)).to be true
               end
             end
           end
@@ -186,41 +184,41 @@ module SimpleNavigation
         let(:item) { double(:item) }
 
         context 'when consider_sub_navigation? is true' do
-          before { base.stub(consider_sub_navigation?: true) }
+          before { allow(base).to receive_messages(consider_sub_navigation?: true) }
 
           context 'and expand_sub_navigation? is true' do
-            before { base.stub(expand_sub_navigation?: true) }
+            before { allow(base).to receive_messages(expand_sub_navigation?: true) }
 
             it 'returns true' do
-              expect(base.include_sub_navigation?(item)).to be_true
+              expect(base.include_sub_navigation?(item)).to be true
             end
           end
 
           context 'and expand_sub_navigation? is false' do
-            before { base.stub(expand_sub_navigation?: false) }
+            before { allow(base).to receive_messages(expand_sub_navigation?: false) }
 
             it 'returns false' do
-              expect(base.include_sub_navigation?(item)).to be_false
+              expect(base.include_sub_navigation?(item)).to be false
             end
           end
         end
 
         context 'consider_sub_navigation? is false' do
-          before { base.stub(consider_sub_navigation?: false) }
+          before { allow(base).to receive_messages(consider_sub_navigation?: false) }
 
           context 'and expand_sub_navigation? is true' do
-            before { base.stub(expand_sub_navigation?: true) }
+            before { allow(base).to receive_messages(expand_sub_navigation?: true) }
 
             it 'returns false' do
-              expect(base.include_sub_navigation?(item)).to be_false
+              expect(base.include_sub_navigation?(item)).to be false
             end
           end
 
           context 'and expand_sub_navigation? is false' do
-            before { base.stub(expand_sub_navigation?: false) }
+            before { allow(base).to receive_messages(expand_sub_navigation?: false) }
 
             it 'returns false' do
-              expect(base.include_sub_navigation?(item)).to be_false
+              expect(base.include_sub_navigation?(item)).to be false
             end
           end
         end

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

@@ -1,5 +1,3 @@
-require 'spec_helper'
-
 module SimpleNavigation
   module Renderer
     describe Breadcrumbs do
@@ -9,7 +7,7 @@ module SimpleNavigation
       let(:options) {{ level: :all }}
       let(:output) { HTML::Document.new(raw_output).root }
       let(:raw_output) { renderer.render(navigation) }
-      let(:renderer) { setup_renderer(Breadcrumbs, options) }
+      let(:renderer) { Breadcrumbs.new(options) }
 
       before { select_an_item(navigation[item]) if item }
 
@@ -92,11 +90,10 @@ module SimpleNavigation
 
         context 'when a sub navigation item is selected' do
           before do
-            navigation[:invoices].stub(selected?: true)
+            allow(navigation[:invoices]).to receive_messages(selected?: true)
 
-            navigation[:invoices]
-              .sub_navigation[:unpaid]
-              .stub(selected?: true, selected_by_condition?: true)
+            allow(navigation[:invoices].sub_navigation[:unpaid]).to \
+              receive_messages(selected?: true, selected_by_condition?: true)
           end
 
           it 'renders all items as links' do

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

@@ -1,8 +1,3 @@
-require 'spec_helper'
-require 'json_spec'
-
-RSpec.configure { |config| config.include JsonSpec::Helpers }
-
 module SimpleNavigation
   module Renderer
     describe Json do
@@ -12,8 +7,8 @@ module SimpleNavigation
         let(:item) { :invoices }
         let(:options) {{ level: :all }}
         let(:output) { renderer.render(navigation) }
-        let(:parsed_output) { parse_json(output) }
-        let(:renderer) { setup_renderer(Json, options) }
+        let(:parsed_output) { JSON.parse(output) }
+        let(:renderer) { Json.new(options) }
 
         before { select_an_item(navigation[item]) if item }
 
@@ -48,11 +43,10 @@ module SimpleNavigation
           end
 
           before do
-            navigation[:invoices].stub(selected?: true)
+            allow(navigation[:invoices]).to receive_messages(selected?: true)
 
-            navigation[:invoices]
-              .sub_navigation[:unpaid]
-              .stub(selected?: true, selected_by_condition?: true)
+            allow(navigation[:invoices].sub_navigation[:unpaid]).to \
+              receive_messages(selected?: true, selected_by_condition?: true)
           end
 
           it 'marks all the parent items as selected' do

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

@@ -1,5 +1,3 @@
-require 'spec_helper'
-
 module SimpleNavigation
   module Renderer
     describe Links do
@@ -10,7 +8,7 @@ module SimpleNavigation
         let(:options) {{ level: :all }}
         let(:output) { HTML::Document.new(raw_output).root }
         let(:raw_output) { renderer.render(navigation) }
-        let(:renderer) { setup_renderer(Links, options) }
+        let(:renderer) { Links.new(options) }
 
         before { select_an_item(navigation[item]) if item }
 
@@ -64,17 +62,16 @@ module SimpleNavigation
           let(:options) {{ level: :all, join_with: ' | ' }}
 
           it 'separates the items with the specified separator' do
-            expect(raw_output.scan(' | ')).to have(3).items
+            expect(raw_output.scan(' | ').size).to eq 3
           end
         end
 
         context 'when a sub navigation item is selected' do
           before do
-            navigation[:invoices].stub(selected?: true)
+            allow(navigation[:invoices]).to receive_messages(selected?: true)
 
-            navigation[:invoices]
-              .sub_navigation[:unpaid]
-              .stub(selected?: true, selected_by_condition?: true)
+            allow(navigation[:invoices].sub_navigation[:unpaid]).to \
+              receive_messages(selected?: true, selected_by_condition?: true)
           end
 
           it 'renders the main parent as selected' do

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

@@ -1,5 +1,3 @@
-require 'spec_helper'
-
 module SimpleNavigation
   module Renderer
     describe List do
@@ -9,7 +7,7 @@ module SimpleNavigation
       let(:options) {{ level: :all }}
       let(:output) { HTML::Document.new(raw_output).root }
       let(:raw_output) { renderer.render(navigation) }
-      let(:renderer) { setup_renderer(List, options) }
+      let(:renderer) { List.new(options) }
 
       before { select_an_item(navigation[item]) if item }
 
@@ -78,11 +76,10 @@ module SimpleNavigation
 
         context 'when a sub navigation item is selected' do
           before do
-            navigation[:invoices].stub(selected?: true)
+            allow(navigation[:invoices]).to receive_messages(selected?: true)
 
-            navigation[:invoices]
-              .sub_navigation[:unpaid]
-              .stub(selected?: true, selected_by_condition?: true)
+            allow(navigation[:invoices].sub_navigation[:unpaid]).to \
+              receive_messages(selected?: true, selected_by_condition?: true)
           end
 
           it 'renders the parent items as selected' do

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

@@ -1,5 +1,3 @@
-require 'spec_helper'
-
 module SimpleNavigation
   module Renderer
     describe Text do
@@ -8,7 +6,7 @@ module SimpleNavigation
       let(:item) { nil }
       let(:options) {{ level: :all }}
       let(:output) { renderer.render(navigation) }
-      let(:renderer) { setup_renderer(Text, options) }
+      let(:renderer) { Text.new(options) }
 
       before { select_an_item(navigation[item]) if item }
 
@@ -29,11 +27,10 @@ module SimpleNavigation
 
         context 'when a sub navigation item is selected' do
           before do
-            navigation[:invoices].stub(selected?: true)
+            allow(navigation[:invoices]).to receive_messages(selected?: true)
 
-            navigation[:invoices]
-              .sub_navigation[:unpaid]
-              .stub(selected?: true, selected_by_condition?: true)
+            allow(navigation[:invoices].sub_navigation[:unpaid]).to \
+              receive_messages(selected?: true, selected_by_condition?: true)
           end
 
           it 'separates the items with a space' do

data/spec/simple_navigation_spec.rb

@@ -0,0 +1,190 @@
+describe SimpleNavigation do
+  before { subject.config_file_path = 'path_to_config' }
+
+  describe 'config_file_path=' do
+    before { subject.config_file_paths = ['existing_path'] }
+
+    it 'overrides the config_file_paths' do
+      subject.config_file_path = 'new_path'
+      expect(subject.config_file_paths).to eq ['new_path']
+    end
+  end
+
+  describe '.default_config_file_path' do
+    before { allow(subject).to receive_messages(root: 'root') }
+
+    it 'returns the config file path according to :root setting' do
+      expect(subject.default_config_file_path).to eq 'root/config'
+    end
+  end
+
+  describe 'Regarding renderers' do
+    it 'registers the builtin renderers by default' do
+      expect(subject.registered_renderers).not_to be_empty
+    end
+
+    describe '.register_renderer' do
+      let(:renderer) { double(:renderer) }
+
+      it 'adds the specified renderer to the list of renderers' do
+        subject.register_renderer(my_renderer: renderer)
+        expect(subject.registered_renderers[:my_renderer]).to be renderer
+      end
+    end
+  end
+
+  describe '.set_env' do
+    before do
+      subject.config_file_paths = []
+      allow(subject).to receive_messages(default_config_file_path: 'default_path')
+      subject.set_env('root', 'my_env')
+    end
+
+    it 'sets the root' do
+      expect(subject.root).to eq 'root'
+    end
+
+    it 'sets the environment' do
+      expect(subject.environment).to eq 'my_env'
+    end
+
+    it 'adds the default-config path to the list of config_file_paths' do
+      expect(subject.config_file_paths).to eq ['default_path']
+    end
+  end
+
+  describe '.load_config', memfs: true do
+    let(:paths) { ['/path/one', '/path/two'] }
+
+    before do
+      FileUtils.mkdir_p(paths)
+      allow(subject).to receive_messages(config_file_paths: paths)
+    end
+
+    context 'when the config file for the context exists' do
+      before do
+        File.open('/path/two/navigation.rb', 'w') { |f| f.puts 'default content' }
+        File.open('/path/one/other_navigation.rb', 'w') { |f| f.puts 'other content' }
+      end
+
+      context 'when no context is provided' do
+        it 'stores the configuration in config_files for the default context' do
+          subject.load_config
+          expect(subject.config_files[:default]).to eq "default content\n"
+        end
+      end
+
+      context 'when a context is provided' do
+        it 'stores the configuration in config_files for the given context' do
+          subject.load_config(:other)
+          expect(subject.config_files[:other]).to eq "other content\n"
+        end
+      end
+
+      context 'and environment is production' do
+        before { allow(subject).to receive_messages(environment: 'production') }
+
+        it 'loads the config file only for the first call' do
+          subject.load_config
+          File.open('/path/two/navigation.rb', 'w') { |f| f.puts 'new content' }
+          subject.load_config
+          expect(subject.config_files[:default]).to eq "default content\n"
+        end
+      end
+
+      context "and environment isn't production" do
+        it 'loads the config file for every call' do
+          subject.load_config
+          File.open('/path/two/navigation.rb', 'w') { |f| f.puts 'new content' }
+          subject.load_config
+          expect(subject.config_files[:default]).to eq "new content\n"
+        end
+      end
+    end
+
+    context "when the config file for the context doesn't exists" do
+      it 'raises an exception' do
+        expect{ subject.load_config }.to raise_error
+      end
+    end
+  end
+
+  describe '.config' do
+    it 'returns the Configuration singleton instance' do
+      expect(subject.config).to be SimpleNavigation::Configuration.instance
+    end
+  end
+
+  describe '.active_item_container_for' do
+    let(:primary) { double(:primary) }
+
+    before { allow(subject.config).to receive_messages(primary_navigation: primary) }
+
+    context 'when level is :all' do
+      it 'returns the primary_navigation' do
+        nav = subject.active_item_container_for(:all)
+        expect(nav).to be primary
+      end
+    end
+
+    context 'when level is :leaves' do
+      it 'returns the currently active leaf-container' do
+        expect(primary).to receive(:active_leaf_container)
+        subject.active_item_container_for(:leaves)
+      end
+    end
+
+    context 'when level is a Range' do
+      it 'takes the min of the range to lookup the active container' do
+        expect(primary).to receive(:active_item_container_for).with(2)
+        subject.active_item_container_for(2..3)
+      end
+    end
+
+    context 'when level is an Integer' do
+      it 'considers the Integer to lookup the active container' do
+        expect(primary).to receive(:active_item_container_for).with(1)
+        subject.active_item_container_for(1)
+      end
+    end
+
+    context 'when level is something else' do
+      it 'raises an exception' do
+        expect{
+          subject.active_item_container_for('something else')
+        }.to raise_error
+      end
+    end
+  end
+
+  describe '.load_adapter' do
+    shared_examples 'loading the right adapter' do |framework, adapter|
+      context "when the context is #{framework}" do
+        before do
+          allow(subject).to receive_messages(framework: framework)
+          subject.load_adapter
+        end
+
+        it "returns the #{framework} adapter" do
+          adapter_class = SimpleNavigation::Adapters.const_get(adapter)
+          expect(subject.adapter_class).to be adapter_class
+        end
+      end
+    end
+
+    it_behaves_like 'loading the right adapter', :rails,   :Rails
+    it_behaves_like 'loading the right adapter', :padrino, :Padrino
+    it_behaves_like 'loading the right adapter', :sinatra, :Sinatra
+  end
+
+  describe '.init_adapter_from' do
+    let(:adapter) { double(:adapter) }
+    let(:adapter_class) { double(:adapter_class, new: adapter) }
+
+    it 'sets the adapter to a new instance of adapter_class' do
+      subject.adapter_class = adapter_class
+      subject.init_adapter_from(:default)
+      expect(subject.adapter).to be adapter
+    end
+  end
+end