strikeroff-simple-navigation 2.0.2

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

@@ -0,0 +1,60 @@
+require File.dirname(__FILE__) + '/../../../spec_helper'
+
+describe SimpleNavigation::Renderer::Base do
+  before(:each) do
+    @controller = stub(:controller)
+    SimpleNavigation.stub!(:controller).and_return(@controller)
+    @base_renderer = SimpleNavigation::Renderer::Base.new
+  end
+  it "should inclue ActionView::Helpers::UrlHelper" do
+    @base_renderer.should respond_to(:link_to)
+  end
+  it "should include ActionView::Helpers::TagHelper" do
+    @base_renderer.should respond_to(:content_tag)
+  end
+  
+  describe 'delegated methods' do
+    it {@base_renderer.should respond_to(:form_authenticity_token)}
+    it {@base_renderer.should respond_to(:protect_against_forgery?)}
+    it {@base_renderer.should respond_to(:request_forgery_protection_token)}
+  end
+  
+  describe 'initialize' do
+    it {@base_renderer.controller.should == @controller}
+  end
+  
+  describe 'controller_method' do
+    context 'delegate a single method' do
+      before(:each) do
+        @base_renderer.class_eval do
+          controller_method :my_method
+        end
+      end
+      it 'should delegate a controller_method to the controller' do
+        @controller.should_receive(:my_method)
+        @base_renderer.my_method
+      end
+    end
+    
+    context 'delegate multiple methods' do
+      before(:each) do
+        @base_renderer.class_eval do
+          controller_method :test1, :test2
+        end
+      end
+      it 'should delegate all controller_methods to the controller' do
+        @controller.should_receive(:test1)
+        @base_renderer.test1
+        @controller.should_receive(:test2)
+        @base_renderer.test2
+      end      
+    end
+  end
+  
+  describe 'render' do
+    it "be subclass responsability" do
+      lambda {@base_renderer.render(:container)}.should raise_error('subclass responsibility')
+    end
+  end
+
+end

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

@@ -0,0 +1,134 @@
+require File.dirname(__FILE__) + '/../../../spec_helper'
+require 'html/document' unless defined? HTML::Document
+
+describe SimpleNavigation::Renderer::List do
+    
+  describe 'render' do
+    
+    def sub_items
+      [
+        [:subnav1, 'subnav1', 'subnav1_url', {}, nil],
+        [:subnav2, 'subnav2', 'subnav2_url', {}, nil]
+      ]
+    end
+    
+    def primary_items
+      [
+        [:users, 'users', 'first_url', {:id => 'my_id'}, nil],
+        [:invoices, 'invoices', 'second_url', {}, nil],
+        [:accounts, 'accounts', 'third_url', {:style => 'float:right'}, nil]
+      ]
+    end
+
+    def primary_container
+      container = SimpleNavigation::ItemContainer.new(0)
+      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)
+      primary_item(key) {|item| item.stub!(:selected? => true)}
+    end
+
+    def subnav_container
+      container = SimpleNavigation::ItemContainer.new(1)
+      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 render(current_nav=nil, include_subnav=false)
+      primary_navigation = primary_container
+      select_item(current_nav) if current_nav
+      @renderer = SimpleNavigation::Renderer::List.new
+      HTML::Document.new(@renderer.render(primary_navigation, include_subnav)).root
+    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(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
+    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
+    
+    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, true)).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, true)).should have(1).entries
+      end
+      context 'render_all_levels = false' do
+        before(:each) do
+          SimpleNavigation.config.render_all_levels = false
+        end
+        it "should not render the invoices submenu if the user-primary is active" do
+          HTML::Selector.new('#invoices #subnav1').select(render(:users, true)).should be_empty
+          HTML::Selector.new('#invoices #subnav2').select(render(:users, true)).should be_empty
+        end
+      end
+      
+      context 'render_all_levels = true' do
+        before(:each) do
+          SimpleNavigation.config.render_all_levels = true
+        end
+        it "should render the invoices submenu even if the user-primary is active" do
+          HTML::Selector.new('#invoices #subnav1').select(render(:users, true)).should have(1).entry
+          HTML::Selector.new('#invoices #subnav2').select(render(:users, true)).should have(1).entry
+        end
+      end
+      
+    end
+    
+  end
+end

data/spec/lib/simple_navigation_spec.rb

@@ -0,0 +1,235 @@
+require File.dirname(__FILE__) + '/../spec_helper'
+
+describe SimpleNavigation do
+  
+  describe 'config_files' do
+    before(:each) do
+      SimpleNavigation.config_files = {}
+    end
+    it "should be an empty hash after loading the module" do
+      SimpleNavigation.config_files.should == {}
+    end
+  end
+  
+  describe 'config_file_name' do
+    before(:each) do
+      SimpleNavigation.config_file_path = 'path_to_config'
+    end
+    context 'for :default navigation_context' do
+      it "should return the path to default config file" do
+        SimpleNavigation.config_file_name.should == 'path_to_config/navigation.rb'
+      end
+    end
+    
+    context 'for other navigation_context' do
+      it "should return the path to the config file matching the specified context" do
+        SimpleNavigation.config_file_name(:my_other_context).should == 'path_to_config/my_other_context_navigation.rb'
+      end
+      it "should convert camelcase-contexts to underscore" do
+        SimpleNavigation.config_file_name(:WhyWouldYouDoThis).should == 'path_to_config/why_would_you_do_this_navigation.rb'
+      end
+    end
+  end
+  
+  describe 'load_config' do
+    context 'config_file_path is set' do
+      before(:each) do
+        SimpleNavigation.config_file_path = 'path_to_config'
+        #SimpleNavigation.stub!(:config_file_name => 'path_to_config/navigation.rb')
+      end
+      
+      context 'config_file does exist' do
+        before(:each) do
+          File.stub!(:exists?).and_return(true)
+          IO.stub!(:read).and_return('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/navigation.rb')
+          SimpleNavigation.load_config
+        end
+        it "should store the read content in the module (default context)" do
+          SimpleNavigation.should_receive(:config_file_name).with(:default).twice
+          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_name).with(:my_context).twice
+          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
+          File.stub!(:exists?).and_return(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 "RAILS_ENV undefined" do
+        before(:each) do
+          ::RAILS_ENV = nil
+        end
+        it "should load the config file twice" do
+          IO.should_receive(:read).twice
+          SimpleNavigation.load_config
+          SimpleNavigation.load_config
+        end
+      end
+      context "RAILS_ENV defined" do
+        before(:each) do
+          ::RAILS_ENV = 'production'
+        end
+        context "RAILS_ENV=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 "RAILS_ENV=development" do
+          before(:each) do
+            ::RAILS_ENV = 'development'
+          end
+          it "should load the config file twice" do
+            IO.should_receive(:read).twice
+            SimpleNavigation.load_config
+            SimpleNavigation.load_config
+          end
+        end
+        
+        context "RAILS_ENV=test" do
+          before(:each) do
+            ::RAILS_ENV = '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 'current_navigation_for' do
+    before(:each) do
+      @controller = stub(:controller)
+      SimpleNavigation.stub!(:controller => @controller)
+    end
+    it "should access the correct instance_var in the controller" do
+      @controller.should_receive(:instance_variable_get).with(:@sn_current_navigation_1)
+      SimpleNavigation.current_navigation_for(1)
+    end
+  end
+
+  describe 'active_item_container_for' do
+    before(:each) do
+      @primary = stub(:primary)
+      SimpleNavigation.config.stub!(:primary_navigation => @primary)
+    end
+    it "should call active_item_container_for on the primary_navigation with the specified level" do
+      @primary.should_receive(:active_item_container_for).with(1)
+      SimpleNavigation.active_item_container_for 1
+    end
+  end
+
+  describe 'handle_explicit_navigation' do
+    def args(*args)
+      SimpleNavigation.stub!(:explicit_navigation_args => args.compact.empty? ? nil : args)
+    end
+
+    before(:each) do
+      @controller = stub(:controller)
+      SimpleNavigation.stub!(:controller => @controller)
+    end
+
+    context 'with explicit navigation set' do
+      context 'list of navigations' do
+        before(:each) do
+          args :first, :second, :third
+        end
+        it "should set the correct instance var in the controller" do
+          @controller.should_receive(:instance_variable_set).with(:@sn_current_navigation_3, :third)
+          SimpleNavigation.handle_explicit_navigation
+        end
+      end
+      context 'single navigation' do
+        context 'specified key is a valid navigation item' do
+          before(:each) do
+            @primary = stub(:primary, :level_for_item => 2)
+            SimpleNavigation.stub!(:primary_navigation => @primary)
+            args :key
+          end
+          it "should set the correct instance var in the controller" do
+            @controller.should_receive(:instance_variable_set).with(:@sn_current_navigation_2, :key)
+            SimpleNavigation.handle_explicit_navigation
+          end
+        end
+        context 'specified key is an invalid navigation item' do
+          before(:each) do
+            @primary = stub(:primary, :level_for_item => nil)
+            SimpleNavigation.stub!(:primary_navigation => @primary)
+            args :key
+          end
+          it "should not raise an ArgumentError" do
+            lambda {SimpleNavigation.handle_explicit_navigation}.should_not raise_error(ArgumentError)
+          end
+        end
+      end
+      context 'hash with level' do
+        before(:each) do
+          args :level_2 => :key
+        end
+        it "should set the correct instance var in the controller" do
+          @controller.should_receive(:instance_variable_set).with(:@sn_current_navigation_2, :key)
+          SimpleNavigation.handle_explicit_navigation
+        end
+      end
+      context 'hash with multiple_levels' do
+        before(:each) do
+          args :level_2 => :key, :level_1 => :bla
+        end
+        it "should set the correct instance var in the controller" do
+          @controller.should_receive(:instance_variable_set).with(:@sn_current_navigation_2, :key)
+          SimpleNavigation.handle_explicit_navigation
+        end
+      end
+    end
+    context 'without explicit navigation set' do
+      before(:each) do
+        args nil
+      end
+      it "should not set the current_navigation instance var in the controller" do
+        @controller.should_not_receive(:instance_variable_set)
+        SimpleNavigation.handle_explicit_navigation
+      end
+    end
+  end
+
+end

data/spec/spec_helper.rb

@@ -0,0 +1,17 @@
+ENV["RAILS_ENV"] = "test"
+RAILS_ENV = "test" unless defined? RAILS_ENV
+require 'rubygems'
+require 'spec'
+require 'active_support'
+require 'action_controller'
+
+RAILS_ROOT = './' unless defined? RAILS_ROOT
+
+$:.unshift File.dirname(__FILE__)
+$:.unshift File.join(File.dirname(__FILE__), '../lib')
+
+require 'simple_navigation'
+
+# Spec::Runner.configure do |config|
+  # no special config
+# endx

data/strikeroff-simple-navigation.gemspec

@@ -0,0 +1,33 @@
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = %q{strikeroff-simple-navigation}
+  s.version = "2.0.2"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 1.2") if s.respond_to? :required_rubygems_version=
+  s.authors = ["Vesov Ilya"]
+  s.date = %q{2009-11-01}
+  s.description = %q{strikeroff-simple-navigation}
+  s.email = %q{strikeroff@gmail.com}
+  s.extra_rdoc_files = ["CHANGELOG", "lib/simple_navigation/configuration.rb", "lib/simple_navigation/controller_methods.rb", "lib/simple_navigation/helpers.rb", "lib/simple_navigation/item.rb", "lib/simple_navigation/item_container.rb", "lib/simple_navigation/renderer/base.rb", "lib/simple_navigation/renderer/list.rb", "lib/simple_navigation.rb", "README"]
+  s.files = ["CHANGELOG", "generators/navigation_config/navigation_config_generator.rb", "generators/navigation_config/templates/config/navigation.rb", "generators/navigation_config/USAGE", "init.rb", "install.rb", "lib/simple_navigation/configuration.rb", "lib/simple_navigation/controller_methods.rb", "lib/simple_navigation/helpers.rb", "lib/simple_navigation/item.rb", "lib/simple_navigation/item_container.rb", "lib/simple_navigation/renderer/base.rb", "lib/simple_navigation/renderer/list.rb", "lib/simple_navigation.rb", "Manifest", "rails/init.rb", "Rakefile", "README", "spec/lib/simple_navigation/configuration_spec.rb", "spec/lib/simple_navigation/controller_methods_spec.rb", "spec/lib/simple_navigation/helpers_spec.rb", "spec/lib/simple_navigation/item_container_spec.rb", "spec/lib/simple_navigation/item_spec.rb", "spec/lib/simple_navigation/renderer/base_spec.rb", "spec/lib/simple_navigation/renderer/list_spec.rb", "spec/lib/simple_navigation_spec.rb", "spec/spec_helper.rb", "strikeroff-simple-navigation.gemspec", "uninstall.rb"]
+  s.homepage = %q{http://github.com/strikeroff}
+  s.rdoc_options = ["--line-numbers", "--inline-source", "--title", "Strikeroff-simple-navigation", "--main", "README", "-c utf-8"]
+  s.require_paths = ["lib"]
+  s.rubyforge_project = %q{strikeroff-simple-navigation}
+  s.rubygems_version = %q{1.3.5}
+  s.summary = %q{strikeroff-simple-navigation}
+
+  if s.respond_to? :specification_version then
+    current_version = Gem::Specification::CURRENT_SPECIFICATION_VERSION
+    s.specification_version = 3
+
+    if Gem::Version.new(Gem::RubyGemsVersion) >= Gem::Version.new('1.2.0') then
+      s.add_development_dependency(%q<echoe>, [">= 0"])
+    else
+      s.add_dependency(%q<echoe>, [">= 0"])
+    end
+  else
+    s.add_dependency(%q<echoe>, [">= 0"])
+  end
+end

data/uninstall.rb

@@ -0,0 +1 @@
+# Uninstall hook code here

metadata

@@ -0,0 +1,107 @@
+--- !ruby/object:Gem::Specification 
+name: strikeroff-simple-navigation
+version: !ruby/object:Gem::Version 
+  version: 2.0.2
+platform: ruby
+authors: 
+- Vesov Ilya
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2009-11-01 00:00:00 +04:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: echoe
+  type: :development
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "0"
+    version: 
+description: strikeroff-simple-navigation
+email: strikeroff@gmail.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- CHANGELOG
+- lib/simple_navigation/configuration.rb
+- lib/simple_navigation/controller_methods.rb
+- lib/simple_navigation/helpers.rb
+- lib/simple_navigation/item.rb
+- lib/simple_navigation/item_container.rb
+- lib/simple_navigation/renderer/base.rb
+- lib/simple_navigation/renderer/list.rb
+- lib/simple_navigation.rb
+- README
+files: 
+- CHANGELOG
+- generators/navigation_config/navigation_config_generator.rb
+- generators/navigation_config/templates/config/navigation.rb
+- generators/navigation_config/USAGE
+- init.rb
+- install.rb
+- lib/simple_navigation/configuration.rb
+- lib/simple_navigation/controller_methods.rb
+- lib/simple_navigation/helpers.rb
+- lib/simple_navigation/item.rb
+- lib/simple_navigation/item_container.rb
+- lib/simple_navigation/renderer/base.rb
+- lib/simple_navigation/renderer/list.rb
+- lib/simple_navigation.rb
+- Manifest
+- rails/init.rb
+- Rakefile
+- README
+- spec/lib/simple_navigation/configuration_spec.rb
+- spec/lib/simple_navigation/controller_methods_spec.rb
+- spec/lib/simple_navigation/helpers_spec.rb
+- spec/lib/simple_navigation/item_container_spec.rb
+- spec/lib/simple_navigation/item_spec.rb
+- spec/lib/simple_navigation/renderer/base_spec.rb
+- spec/lib/simple_navigation/renderer/list_spec.rb
+- spec/lib/simple_navigation_spec.rb
+- spec/spec_helper.rb
+- strikeroff-simple-navigation.gemspec
+- uninstall.rb
+has_rdoc: true
+homepage: http://github.com/strikeroff
+licenses: []
+
+post_install_message: 
+rdoc_options: 
+- --line-numbers
+- --inline-source
+- --title
+- Strikeroff-simple-navigation
+- --main
+- README
+- -c utf-8
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "1.2"
+  version: 
+requirements: []
+
+rubyforge_project: strikeroff-simple-navigation
+rubygems_version: 1.3.5
+signing_key: 
+specification_version: 3
+summary: strikeroff-simple-navigation
+test_files: []
+