simple-navigation-ext 0.0.1

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

@@ -0,0 +1,58 @@
+require 'spec_helper'
+require 'html/document' unless defined? HTML::Document
+
+describe SimpleNavigation::Renderer::Links 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::Links, :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
+      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
+
+      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
+        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
+        end
+      end
+  
+    end
+    
+  end
+end

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

@@ -0,0 +1,189 @@
+require 'spec_helper'
+require 'html/document' unless defined? HTML::Document
+
+describe SimpleNavigation::Renderer::List 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::List, :rails, options
+      HTML::Document.new(@renderer.render(primary_navigation)).root
+    end
+
+    context 'regarding result' do
+
+      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(3).entries
+      end
+      it "should render an a-tag inside each li-tag" do
+        HTML::Selector.new('li a').select(render).should have(3).entries
+      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
+          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
+          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
+          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 '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
+          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
+          end
+        end
+
+      end
+
+      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)
+          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
+          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
+          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'}}
+          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}}
+          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'}}
+          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_spec.rb

@@ -0,0 +1,307 @@
+require 'spec_helper'
+
+describe SimpleNavigation do
+
+  before(:each) do
+    SimpleNavigation.config_file_path = 'path_to_config'
+  end
+
+  describe 'config_file_name' do
+    context 'for :default navigation_context' do
+      it "should return the name of the default config file" do
+        SimpleNavigation.config_file_name.should == 'navigation.rb'
+      end
+    end
+    context 'for other navigation_context' do
+      it "should return the name of the config file matching the specified context" do
+        SimpleNavigation.config_file_name(:my_other_context).should == 'my_other_context_navigation.rb'
+      end
+      it "should convert camelcase-contexts to underscore" do
+        SimpleNavigation.config_file_name(:WhyWouldYouDoThis).should == 'why_would_you_do_this_navigation.rb'
+      end
+    end
+  end
+  
+  describe 'config_file_path=' do
+    before(:each) do
+      SimpleNavigation.config_file_paths = ['existing_path']
+    end
+    it "should override the config_file_paths" do
+      SimpleNavigation.config_file_path = 'new_path'
+      SimpleNavigation.config_file_paths.should == ['new_path']
+    end
+  end
+  
+  describe 'config_file' do
+    context 'no config_file_paths are set' do
+      before(:each) do
+        SimpleNavigation.config_file_paths = []
+      end
+      it "should return nil" do
+        SimpleNavigation.config_file.should be_nil
+      end
+    end
+    context 'one config_file_path is set' do
+      before(:each) do
+        SimpleNavigation.config_file_paths = ['my_config_file_path']
+      end
+      context 'requested config file does exist' do
+        before(:each) do
+          File.stub!(:exists? => true)
+        end
+        it "should return the path to the config_file" do
+          SimpleNavigation.config_file.should == 'my_config_file_path/navigation.rb'
+        end
+      end
+      context 'requested config file does not exist' do
+        before(:each) do
+          File.stub!(:exists? => false)
+        end
+        it "should return nil" do
+          SimpleNavigation.config_file.should be_nil        
+        end
+      end
+    end
+    context 'multiple config_file_paths are set' do
+      before(:each) do
+        SimpleNavigation.config_file_paths = ['first_path', 'second_path']
+      end
+      context 'requested config file does exist' do
+        before(:each) do
+          File.stub!(:exists? => true)
+        end
+        it "should return the path to the first matching config_file" do
+          SimpleNavigation.config_file.should == 'first_path/navigation.rb'
+        end
+      end
+      context 'requested config file does not exist' do
+        before(:each) do
+          File.stub!(:exists? => false)
+        end
+        it "should return nil" do
+          SimpleNavigation.config_file.should be_nil        
+        end
+      end
+    end
+  end
+  
+  describe 'config_file?' do
+    context 'config_file present' do
+      before(:each) do
+        SimpleNavigation.stub!(:config_file => 'file')
+      end
+      it {SimpleNavigation.config_file?.should be_true}
+    end
+    context 'config_file not present' do
+      before(:each) do
+        SimpleNavigation.stub!(:config_file => nil)
+      end
+      it {SimpleNavigation.config_file?.should be_false}
+    end
+  end
+
+  describe 'self.default_config_file_path' do
+    before(:each) do
+      SimpleNavigation.stub!(:root => 'root')
+    end
+    it {SimpleNavigation.default_config_file_path.should == 'root/config'}
+  end
+  
+  describe 'regarding renderers' do
+    it "should have registered the builtin renderers by default" do
+      SimpleNavigation.registered_renderers.should_not be_empty
+    end
+
+    describe 'register_renderer' do
+      before(:each) do
+        @renderer = stub(:renderer)
+      end
+      it "should add the specified renderer to the list of renderers" do
+        SimpleNavigation.register_renderer(:my_renderer => @renderer)
+        SimpleNavigation.registered_renderers[:my_renderer].should == @renderer
+      end
+    end
+
+  end
+
+  describe 'set_env' do
+    before(:each) do
+      SimpleNavigation.config_file_paths = []
+      SimpleNavigation.stub!(:default_config_file_path => 'default_path')
+      SimpleNavigation.set_env('root', 'my_env')
+    end
+    it "should set the root" do
+      SimpleNavigation.root.should == 'root'
+    end
+    it "should set the environment" do
+      SimpleNavigation.environment.should == 'my_env'
+    end
+    it "should add the default-config path to the list of config_file_paths" do
+      SimpleNavigation.config_file_paths.should == ['default_path']
+    end
+  end
+
+  describe 'load_config' do
+    context 'config_file_path is set' do
+      before(:each) do
+        SimpleNavigation.stub!(:config_file => 'path_to_config_file')
+      end
+      context 'config_file does exist' do
+        before(:each) do
+          SimpleNavigation.stub!(:config_file? => true)
+          IO.stub!(:read => 'file_content')
+        end
+        it "should not raise an error" do
+          lambda{SimpleNavigation.load_config}.should_not raise_error
+        end
+        it "should read the specified config file from disc" do
+          IO.should_receive(:read).with('path_to_config_file')
+          SimpleNavigation.load_config
+        end
+        it "should store the read content in the module (default context)" do
+          SimpleNavigation.should_receive(:config_file).with(:default)
+          SimpleNavigation.load_config
+          SimpleNavigation.config_files[:default].should == 'file_content'
+        end
+        it "should store the content in the module (non default context)" do
+          SimpleNavigation.should_receive(:config_file).with(:my_context)
+          SimpleNavigation.load_config(:my_context)
+          SimpleNavigation.config_files[:my_context].should == 'file_content'
+        end
+      end
+      
+      context 'config_file does not exist' do
+        before(:each) do
+          SimpleNavigation.stub!(:config_file? => false)
+        end
+        it {lambda{SimpleNavigation.load_config}.should raise_error}
+      end
+    end
+    
+    context 'config_file_path is not set' do
+      before(:each) do
+        SimpleNavigation.config_file_path = nil
+      end
+      it {lambda{SimpleNavigation.load_config}.should raise_error}
+    end
+    
+    describe 'regarding caching of the config-files' do
+      before(:each) do
+        IO.stub!(:read).and_return('file_content')
+        SimpleNavigation.config_file_path = 'path_to_config'
+        File.stub!(:exists? => true)
+      end
+      context "environment undefined" do
+        before(:each) do
+          SimpleNavigation.stub!(:environment => nil)
+        end
+        it "should load the config file twice" do
+          IO.should_receive(:read).twice
+          SimpleNavigation.load_config
+          SimpleNavigation.load_config
+        end
+      end
+      context "environment defined" do
+        before(:each) do
+          SimpleNavigation.stub!(:environment => 'production')
+        end
+        context "environment=production" do
+          it "should load the config file only once" do
+            IO.should_receive(:read).once
+            SimpleNavigation.load_config
+            SimpleNavigation.load_config   
+          end
+        end
+        
+        context "environment=development" do
+          before(:each) do
+            SimpleNavigation.stub!(:environment => 'development')
+          end
+          it "should load the config file twice" do
+            IO.should_receive(:read).twice
+            SimpleNavigation.load_config
+            SimpleNavigation.load_config
+          end
+        end
+        
+        context "environment=test" do
+          before(:each) do
+            SimpleNavigation.stub!(:environment => 'test')
+          end
+          it "should load the config file twice" do
+            IO.should_receive(:read).twice
+            SimpleNavigation.load_config
+            SimpleNavigation.load_config
+          end
+        end
+      end
+      after(:each) do
+        SimpleNavigation.config_files = {}
+      end
+    end
+  end
+  
+  describe 'config' do
+    it {SimpleNavigation.config.should == SimpleNavigation::Configuration.instance}
+  end
+  
+  describe 'active_item_container_for' do
+    before(:each) do
+      @primary = stub(:primary)
+      SimpleNavigation.config.stub!(:primary_navigation => @primary)
+    end
+    context 'level is :all' do
+      it "should return the primary_navigation" do
+        SimpleNavigation.active_item_container_for(:all).should == @primary
+      end
+    end
+    context 'level is :leaves' do
+      it "should return the currently active leaf-container" do
+        @primary.should_receive(:active_leaf_container)
+        SimpleNavigation.active_item_container_for(:leaves)
+      end
+    end
+    context 'level is a Range' do
+      it "should take the min of the range to lookup the active container" do
+        @primary.should_receive(:active_item_container_for).with(2)
+        SimpleNavigation.active_item_container_for(2..3)
+      end
+    end
+    context 'level is an Integer' do
+      it "should consider the Integer to lookup the active container" do
+        @primary.should_receive(:active_item_container_for).with(1)
+        SimpleNavigation.active_item_container_for(1)
+      end
+    end
+    context 'level is something else' do
+      it "should raise an ArgumentError" do
+        lambda {SimpleNavigation.active_item_container_for('something else')}.should raise_error(ArgumentError)
+      end
+    end
+  end
+
+  describe 'load_adapter' do
+    context 'Rails' do
+      before(:each) do
+        SimpleNavigation.stub!(:framework => :rails)
+        SimpleNavigation.load_adapter
+      end
+      it {SimpleNavigation.adapter_class.should == SimpleNavigation::Adapters::Rails}
+    end
+    context 'Padrino' do
+      before(:each) do
+        SimpleNavigation.stub!(:framework => :padrino)
+        SimpleNavigation.load_adapter
+      end
+      it {SimpleNavigation.adapter_class.should == SimpleNavigation::Adapters::Padrino}
+    end
+    context 'Sinatra' do
+      before(:each) do
+        SimpleNavigation.stub!(:framework => :sinatra)
+        SimpleNavigation.load_adapter
+      end
+      it {SimpleNavigation.adapter_class.should == SimpleNavigation::Adapters::Sinatra}
+    end
+  end
+  
+end

data/spec/spec_helper.rb

@@ -0,0 +1,96 @@
+ENV["RAILS_ENV"] = "test"
+require 'rubygems'
+require 'rspec'
+require 'action_controller'
+
+module Rails
+  module VERSION
+    MAJOR = 2
+  end
+end unless defined? Rails
+
+$:.unshift File.dirname(__FILE__)
+$:.unshift File.join(File.dirname(__FILE__), '../lib')
+
+require 'simple_navigation'
+
+# SimpleNavigation.root = './'
+RAILS_ROOT = './' unless defined?(RAILS_ROOT)
+RAILS_ENV = 'test' unless defined?(RAILS_ENV)
+
+
+RSpec.configure do |config|
+  # == Mock Framework
+  #
+  # If you prefer to use mocha, flexmock or RR, uncomment the appropriate line:
+  #
+  # config.mock_with :mocha
+  # config.mock_with :flexmock
+  # config.mock_with :rr
+  config.mock_with :rspec
+
+end
+
+# spec helper methods
+def sub_items
+  [
+    [:subnav1, 'subnav1', 'subnav1_url', {}],
+    [:subnav2, 'subnav2', 'subnav2_url', {}]
+  ]
+end
+
+def primary_items
+  [
+    [:users, 'users', 'first_url', {:id => 'my_id'}],
+    [:invoices, 'invoices', 'second_url', {}],
+    [:accounts, 'accounts', 'third_url', {:style => 'float:right', :link => {:style => 'float:left'}}]
+  ]
+end
+
+def primary_container
+  container = SimpleNavigation::ItemContainer.new(1)
+  container.dom_id = 'nav_dom_id'
+  container.dom_class = 'nav_dom_class'
+  @items = primary_items.map {|params| SimpleNavigation::Item.new(container, *params)}
+  @items.each {|i| i.stub!(:selected? => false)}
+  container.instance_variable_set(:@items, @items)
+  primary_item(:invoices) {|item| item.instance_variable_set(:@sub_navigation, subnav_container)}
+  container
+end
+
+def primary_item(key)
+  yield @items.find {|i| i.key == key}
+end
+
+def select_item(key)
+  if(key == :subnav1)
+    select_item(:invoices)
+    primary_item(:invoices) do |item|
+      item.instance_variable_get(:@sub_navigation).items.find { |i| i.key == key}.stub!(:selected? => true)
+    end
+  else
+    primary_item(key) {|item| item.stub!(:selected? => true) unless item.frozen?}
+  end
+end
+
+def subnav_container
+  container = SimpleNavigation::ItemContainer.new(2)
+  items = sub_items.map {|params| SimpleNavigation::Item.new(container, *params)}
+  items.each {|i| i.stub!(:selected? => false)}
+  container.instance_variable_set(:@items, items)
+  container
+end
+
+def setup_renderer_for(renderer_class, framework, options)
+  setup_adapter_for framework
+  @renderer = renderer_class.new(options)
+end
+
+def setup_adapter_for(framework)
+  adapter = case framework
+  when :rails
+    SimpleNavigation::Adapters::Rails.new(stub(:context, :view_context => ActionView::Base.new))
+  end
+  SimpleNavigation.stub!(:adapter => adapter)
+  adapter
+end