simple-navigation 3.2.0 → 3.3.0

data/CHANGELOG

@@ -1,3 +1,13 @@
+*3.3.0
+
+* add a new method active_navigation_item_key which returns the symbol for the currently selected navigation item in a similar way to active_navigation_item_name does for the name (useful for CSS class styling for eg.)
+* open up the helper API to provide active_navigation_item and active_navigation_item_container methods to make it easy to access the items/containers should it be necessary (came for free with the above refactoring)
+* isolate the apply_defaults and load_config private methods from ActionController mixin leakage by refactoring to module class instance methods
+* addition of test coverage for the added helpers within helpers_spec.rb
+* inclusion of new helpers within the rails adapter and minor refactoring to DRY up the helper_method invocations
+* addition of test coverage for the newly included helpers
+* Credits to Mark J. Titorenko for all the changes in this release! Thanks.
+
 *3.2.0
 
 * Added Renderer::Text for rendering selected navigation items without markup (useful for dynamic page titles). Credits to Tim Cowlishaw.

data/VERSION

@@ -1 +1 @@
-3.2.0
+3.3.0

data/lib/simple_navigation/adapters/rails.rb

@@ -7,8 +7,9 @@ module SimpleNavigation
       def self.register
         SimpleNavigation.set_env(rails_root, rails_env)        
         ActionController::Base.send(:include, SimpleNavigation::Helpers)
-        ActionController::Base.send(:helper_method, :render_navigation)
-        ActionController::Base.send(:helper_method, :active_navigation_item_name)
+        SimpleNavigation::Helpers.instance_methods.each do |m|
+          ActionController::Base.send(:helper_method, m.to_sym)
+        end
       end
       
       def initialize(context)
@@ -91,4 +92,4 @@ if defined?(Rails) && Rails::VERSION::MAJOR == 3
       end                                                                                                                
     end                                                                                                                  
   end
-end
+end

data/lib/simple_navigation/rendering/helpers.rb

@@ -32,14 +32,29 @@ module SimpleNavigation
     # * <tt>:items</tt> - you can specify the items directly (e.g. if items are dynamically generated from database). See SimpleNavigation::ItemsProvider for documentation on what to provide as items.
     # * <tt>:renderer</tt> - specify the renderer to be used for rendering the navigation. Either provide the Class or a symbol matching a registered renderer. Defaults to :list (html list renderer).
     def render_navigation(options={})
-      options = apply_defaults(options)
-      load_config(options)
-      active_item_container = SimpleNavigation.active_item_container_for(options[:level])
-      active_item_container.render(options) unless active_item_container.nil?
+      active_navigation_item_container(options) { |container| container && container.render(options) }
     end
 
     # Returns the name of the currently active navigation item belonging to the specified level.
     #
+    # See Helpers#active_navigation_item for supported options.
+    #
+    # Returns an empty string if no active item can be found for the specified options
+    def active_navigation_item_name(options={})
+      active_navigation_item(options,'') { |item| item.name(:apply_generator => false) }
+    end
+
+    # Returns the key of the currently active navigation item belonging to the specified level.
+    #
+    # See Helpers#active_navigation_item for supported options.
+    #
+    # Returns <tt>nil</tt> if no active item can be found for the specified options
+    def active_navigation_item_key(options={})
+      active_navigation_item(options) { |item| item.key }
+    end
+
+    # Returns the currently active navigation item belonging to the specified level.
+    #
     # The following options are supported:
     # * <tt>:level</tt> - defaults to :all which returns the most specific/deepest selected item (the leaf).
     #   Specify a specific level to only look for the selected item in the specified level of navigation (e.g. :level => 1 for primary_navigation etc...).
@@ -48,35 +63,53 @@ module SimpleNavigation
     #   will be loaded and used for searching the active item.
     # * <tt>:items</tt> - you can specify the items directly (e.g. if items are dynamically generated from database). See SimpleNavigation::ItemsProvider for documentation on what to provide as items.
     #
-    # Returns an empty string if no active item can be found for the specified options
-    def active_navigation_item_name(options={})
-      options = apply_defaults(options)
-      load_config(options)
-      options[:level] = :leaves if options[:level] == :all
-      active_item_container = SimpleNavigation.active_item_container_for(options[:level])
-      if active_item_container && !active_item_container.selected_item.nil?
-        active_item_container.selected_item.name(:apply_generator => false)
-      else
-        ''
+    # Returns the supplied <tt>value_for_nil</tt> object (<tt>nil</tt>
+    # by default) if no active item can be found for the specified
+    # options
+    def active_navigation_item(options={},value_for_nil = nil)
+      options[:level] = :leaves if options[:level].nil? || options[:level] == :all
+      active_navigation_item_container(options) do |container|
+        if container && (item = container.selected_item)
+          block_given? ? yield(item) : item
+        else
+          value_for_nil
+        end
       end
     end
 
-    private
-
-    def load_config(options)
-      ctx = options.delete(:context)
-      SimpleNavigation.init_adapter_from self
-      SimpleNavigation.load_config(ctx) 
-      SimpleNavigation::Configuration.eval_config(ctx) 
-      SimpleNavigation.config.items(options[:items]) if options[:items]
-      SimpleNavigation.handle_explicit_navigation if SimpleNavigation.respond_to?(:handle_explicit_navigation)
-      raise "no primary navigation defined, either use a navigation config file or pass items directly to render_navigation" unless SimpleNavigation.primary_navigation
+    # Returns the currently active item container belonging to the specified level.
+    #
+    # The following options are supported:
+    # * <tt>:level</tt> - defaults to :all which returns the least specific/shallowest selected item.
+    #   Specify a specific level to only look for the selected item in the specified level of navigation (e.g. :level => 1 for primary_navigation etc...).
+    # * <tt>:context</tt> - specifies the context for which you would like to find the active navigation item. Defaults to :default which loads the default navigation.rb (i.e. config/navigation.rb).
+    #   If you specify a context then the plugin tries to load the configuration file for that context, e.g. if you call <tt>active_navigation_item_name(:context => :admin)</tt> the file config/admin_navigation.rb
+    #   will be loaded and used for searching the active item.
+    # * <tt>:items</tt> - you can specify the items directly (e.g. if items are dynamically generated from database). See SimpleNavigation::ItemsProvider for documentation on what to provide as items.
+    #
+    # Returns <tt>nil</tt> if no active item container can be found
+    def active_navigation_item_container(options={})
+      options = SimpleNavigation::Helpers::apply_defaults(options)
+      SimpleNavigation::Helpers::load_config(options,self)
+      container = SimpleNavigation.active_item_container_for(options[:level])
+      block_given? ? yield(container) : container
     end
 
-    def apply_defaults(options)
-      options[:level] = options.delete(:levels) if options[:levels]
-      {:context => :default, :level => :all}.merge(options)
-    end
+    class << self
+      def load_config(options,includer)
+        ctx = options.delete(:context)
+        SimpleNavigation.init_adapter_from includer
+        SimpleNavigation.load_config(ctx)
+        SimpleNavigation::Configuration.eval_config(ctx) 
+        SimpleNavigation.config.items(options[:items]) if options[:items]
+        SimpleNavigation.handle_explicit_navigation if SimpleNavigation.respond_to?(:handle_explicit_navigation)
+        raise "no primary navigation defined, either use a navigation config file or pass items directly to render_navigation" unless SimpleNavigation.primary_navigation
+      end
 
+      def apply_defaults(options)
+        options[:level] = options.delete(:levels) if options[:levels]
+        {:context => :default, :level => :all}.merge(options)
+      end
+    end
   end
 end

data/spec/lib/simple_navigation/adapters/rails_spec.rb

@@ -30,6 +30,9 @@ describe SimpleNavigation::Adapters::Rails do
     it "should install the helper methods in the controller" do
       ActionController::Base.should_receive(:helper_method).with(:render_navigation)
       ActionController::Base.should_receive(:helper_method).with(:active_navigation_item_name)
+      ActionController::Base.should_receive(:helper_method).with(:active_navigation_item_key)
+      ActionController::Base.should_receive(:helper_method).with(:active_navigation_item)
+      ActionController::Base.should_receive(:helper_method).with(:active_navigation_item_container)
       SimpleNavigation.register
     end
     
@@ -281,4 +284,4 @@ describe SimpleNavigation::Adapters::Rails do
     end
   end
   
-end
+end

data/spec/lib/simple_navigation/rendering/helpers_spec.rb

@@ -7,10 +7,13 @@ describe SimpleNavigation::Helpers do
 
   def blackbox_setup()
     @controller = ControllerMock.new
-    @controller.stub!(:load_config)
+    SimpleNavigation.stub!(:load_config)
+    SimpleNavigation::Configuration.stub!(:eval_config)
     setup_adapter_for :rails
-    primary_navigation = primary_container
-    SimpleNavigation.stub!(:primary_navigation => primary_navigation)
+    @primary_container, @subnav_container = containers
+    @subnav1_item = sub_item(:subnav1)
+    @invoices_item = primary_item(:invoices)
+    SimpleNavigation.stub!(:primary_navigation => @primary_container)
   end
 
   def whitebox_setup
@@ -54,6 +57,76 @@ describe SimpleNavigation::Helpers do
     end
   end
 
+  describe 'active_navigation_item_key' do
+    before(:each) do
+      blackbox_setup
+    end
+    context 'active item_container for desired level exists' do
+      context 'container has selected item' do
+        before(:each) do
+          select_item(:subnav1)
+        end
+        it {@controller.active_navigation_item_key(:level => 2).should == :subnav1}
+        it {@controller.active_navigation_item_key.should == :subnav1}
+        it {@controller.active_navigation_item_key(:level => 1).should == :invoices}
+        it {@controller.active_navigation_item_key(:level => :all).should == :subnav1}
+      end
+      context 'container does not have selected item' do
+        it {@controller.active_navigation_item_key.should == nil}
+      end
+    end
+    context 'no active item_container for desired level' do
+      it {@controller.active_navigation_item_key(:level => 5).should == nil}
+    end
+  end
+
+  describe 'active_navigation_item' do
+    before(:each) do
+      blackbox_setup
+    end
+    context 'active item_container for desired level exists' do
+      context 'container has selected item' do
+        before(:each) do
+          select_item(:subnav1)
+        end
+        it {@controller.active_navigation_item(:level => 2).should == @subnav1_item}
+        it {@controller.active_navigation_item.should == @subnav1_item}
+        it {@controller.active_navigation_item(:level => 1).should == @invoices_item}
+        it {@controller.active_navigation_item(:level => :all).should == @subnav1_item}
+      end
+      context 'container does not have selected item' do
+        context 'return value defaults to nil' do
+          it {@controller.active_navigation_item.should == nil}
+        end
+        context 'return value reflects passed in value' do
+          it {@controller.active_navigation_item({},'none').should == 'none'}
+          it {@controller.active_navigation_item({},@invoices_item).should == @invoices_item}
+        end
+      end
+    end
+    context 'no active item_container for desired level' do
+      it {@controller.active_navigation_item(:level => 5).should == nil}
+    end
+  end
+
+  describe 'active_navigation_item_container' do
+    before(:each) do
+      blackbox_setup
+    end
+    context 'active item_container for desired level exists' do
+      before(:each) do
+        select_item(:subnav1)
+      end
+      it {@controller.active_navigation_item_container(:level => 2).should == @subnav_container}
+      it {@controller.active_navigation_item_container.should == @primary_container}
+      it {@controller.active_navigation_item_container(:level => 1).should == @primary_container}
+      it {@controller.active_navigation_item_container(:level => :all).should == @primary_container}
+    end
+    context 'no active item_container for desired level' do
+      it {@controller.active_navigation_item_container(:level => 5).should == nil}
+    end
+  end
+
   describe 'render_navigation' do
   
     before(:each) do
@@ -189,4 +262,4 @@ describe SimpleNavigation::Helpers do
     end
   end
 
-end
+end

data/spec/spec_helper.rb

@@ -48,18 +48,28 @@ def primary_items
 end
 
 def primary_container
+  containers.first
+end
+
+def containers
   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
+  sub_container = subnav_container
+  primary_item(:invoices) {|item| item.instance_variable_set(:@sub_navigation, sub_container)}
+  [container,sub_container]
 end
 
 def primary_item(key)
-  yield @items.find {|i| i.key == key}
+  item = @items.find {|i| i.key == key}
+  block_given? ? yield(item) : item
+end
+
+def sub_item(key)
+  primary_item(:invoices).instance_variable_get(:@sub_navigation).items.find { |i| i.key == key}
 end
 
 def select_item(key)

metadata

@@ -1,13 +1,8 @@
 --- !ruby/object:Gem::Specification 
 name: simple-navigation
 version: !ruby/object:Gem::Version 
-  hash: 15
-  prerelease: false
-  segments: 
-  - 3
-  - 2
-  - 0
-  version: 3.2.0
+  prerelease: 
+  version: 3.3.0
 platform: ruby
 authors: 
 - Andi Schacke
@@ -15,8 +10,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2011-02-09 00:00:00 +01:00
-default_executable: 
+date: 2011-06-14 00:00:00 Z
 dependencies: 
 - !ruby/object:Gem::Dependency 
   name: rspec
@@ -26,11 +20,6 @@ dependencies:
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
-        hash: 13
-        segments: 
-        - 2
-        - 0
-        - 1
         version: 2.0.1
   type: :development
   version_requirements: *id001
@@ -42,11 +31,6 @@ dependencies:
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
-        hash: 7
-        segments: 
-        - 2
-        - 3
-        - 2
         version: 2.3.2
   type: :runtime
   version_requirements: *id002
@@ -106,7 +90,6 @@ files:
 - spec/lib/simple_navigation/rendering/renderer/text_spec.rb
 - spec/lib/simple_navigation_spec.rb
 - spec/spec_helper.rb
-has_rdoc: true
 homepage: http://github.com/andi/simple-navigation
 licenses: []
 
@@ -121,41 +104,19 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
-      hash: 3
-      segments: 
-      - 0
       version: "0"
 required_rubygems_version: !ruby/object:Gem::Requirement 
   none: false
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
-      hash: 3
-      segments: 
-      - 0
       version: "0"
 requirements: []
 
 rubyforge_project: andi
-rubygems_version: 1.3.7
+rubygems_version: 1.8.5
 signing_key: 
 specification_version: 3
 summary: simple-navigation is a ruby library for creating navigations (with multiple levels) for your Rails2, Rails3, Sinatra or Padrino application.
-test_files: 
-- spec/lib/simple_navigation/adapters/padrino_spec.rb
-- spec/lib/simple_navigation/adapters/rails_spec.rb
-- spec/lib/simple_navigation/adapters/sinatra_spec.rb
-- spec/lib/simple_navigation/core/configuration_spec.rb
-- spec/lib/simple_navigation/core/item_adapter_spec.rb
-- spec/lib/simple_navigation/core/item_container_spec.rb
-- spec/lib/simple_navigation/core/item_spec.rb
-- spec/lib/simple_navigation/core/items_provider_spec.rb
-- spec/lib/simple_navigation/rails_controller_methods_spec.rb
-- spec/lib/simple_navigation/rendering/helpers_spec.rb
-- spec/lib/simple_navigation/rendering/renderer/base_spec.rb
-- spec/lib/simple_navigation/rendering/renderer/breadcrumbs_spec.rb
-- spec/lib/simple_navigation/rendering/renderer/links_spec.rb
-- spec/lib/simple_navigation/rendering/renderer/list_spec.rb
-- spec/lib/simple_navigation/rendering/renderer/text_spec.rb
-- spec/lib/simple_navigation_spec.rb
-- spec/spec_helper.rb
+test_files: []
+