simple-navigation 3.3.3 → 3.3.4

data/CHANGELOG

@@ -1,3 +1,7 @@
+*3.3.4
+
+* modified :highlights_on option to accept a Proc (as well as the existing Regexp form). This can be used to provide specific highlighting conditions inline. Thanks to superlou for sparking the idea for the concept.
+
 *3.3.3
 
 * Bugfix in Adapters::Sinatra#current_url? (compares unencoded URIs). Thanks to Matthew Gast.

data/README

@@ -10,7 +10,7 @@ Documentation:
   http://wiki.github.com/andi/simple-navigation
 
 RDoc:
-  http://andi.rubyforge.org/simple-navigation
+  Please checkout the repository and execute 'rake rdoc'.
 
 Online Demo:
   http://simple-navigation-demo.andischacke.com
@@ -18,5 +18,5 @@ Online Demo:
 Discussion Group for Feedback and Questions
   http://groups.google.com/group/simple-navigation
 
-Copyright (c) 2010 Andi Schacke, released under the MIT license
+Copyright (c) 2011 Andi Schacke, released under the MIT license
 

data/VERSION

@@ -1 +1 @@
-3.3.3
+3.3.4

data/lib/simple_navigation/core/item.rb

@@ -45,7 +45,7 @@ module SimpleNavigation
     # * its url matches the url of the current request (auto highlighting)
     #
     def selected?
-      @selected = @selected || selected_by_config? || selected_by_subnav? || selected_by_url?
+      @selected = @selected || selected_by_config? || selected_by_subnav? || selected_by_condition?
     end
 
     # Returns the html-options hash for the item, i.e. the options specified for this item in the config-file.
@@ -76,10 +76,16 @@ module SimpleNavigation
     end
 
     # Returns true if the item's url matches the request's current url.
-    def selected_by_url?
+    def selected_by_condition?
       if highlights_on
-        raise ArgumentError, ':highlights_on must be a regexp' unless highlights_on.instance_of?(Regexp)
-        SimpleNavigation.request_uri =~ highlights_on
+        case highlights_on
+        when Regexp
+          SimpleNavigation.request_uri =~ highlights_on
+        when Proc
+          highlights_on.call
+        else
+          raise ArgumentError, ':highlights_on must be a Regexp or Proc'
+        end
       elsif auto_highlight?
         !!(root_path_match? || SimpleNavigation.current_page?(url_without_anchor))
       else
@@ -112,4 +118,4 @@ module SimpleNavigation
     end
 
   end
-end
+end

data/spec/lib/simple_navigation/core/item_spec.rb

@@ -138,7 +138,7 @@ describe SimpleNavigation::Item do
       it {@item.should be_selected}
       it "should not evaluate the subnav or urls" do
         @item.should_not_receive(:selected_by_subnav?)
-        @item.should_not_receive(:selected_by_url?)
+        @item.should_not_receive(:selected_by_condition?)
         @item.selected?
       end
     end
@@ -156,15 +156,15 @@ describe SimpleNavigation::Item do
         before(:each) do
            @item.stub!(:selected_by_subnav? => false)
         end
-        context 'selected by url' do
+        context 'selected by condition' do
           before(:each) do
-             @item.stub!(:selected_by_url? => true)
+             @item.stub!(:selected_by_condition? => true)
           end
           it {@item.should be_selected}
         end
-        context 'not selected by url' do
+        context 'not selected by condition' do
           before(:each) do
-            @item.stub!(:selected_by_url? => false)
+            @item.stub!(:selected_by_condition? => false)
           end
           it {@item.should_not be_selected}
         end
@@ -300,7 +300,7 @@ describe SimpleNavigation::Item do
     end
   end
 
-  describe 'selected_by_url?' do
+  describe 'selected_by_condition?' do
     context ':highlights_on option is set' do
       before(:each) do
         @item.stub!(:highlights_on => /^\/current/)
@@ -308,25 +308,39 @@ describe SimpleNavigation::Item do
       end
       it "should not check for autohighlighting" do
         @item.should_not_receive(:auto_highlight?)
-        @item.send(:selected_by_url?)
+        @item.send(:selected_by_condition?)
       end
       context ':highlights_on is a regexp' do
         context 'regexp matches current_url' do
-          it {@item.send(:selected_by_url?).should be_true}
+          it {@item.send(:selected_by_condition?).should be_true}
         end
         context 'regexp does not match current_url' do
           before(:each) do
             @item.stub!(:highlights_on => /^\/no_match/)
           end
-          it {@item.send(:selected_by_url?).should be_false}
+          it {@item.send(:selected_by_condition?).should be_false}
         end
       end
-      context ':highlights_on is not a regexp' do
+      context ':highlights_on is a lambda' do
+        context 'truthy lambda results in selection' do
+          before(:each) do
+            @item.stub!(:highlights_on => lambda{true})
+          end
+          it {@item.send(:selected_by_condition?).should be_true}
+        end
+        context 'falsey lambda results in no selection' do
+          before(:each) do
+            @item.stub!(:highlights_on => lambda{false})
+          end
+          it {@item.send(:selected_by_condition?).should be_false}
+        end
+      end
+      context ':highlights_on is not a regexp or a proc' do
         before(:each) do
           @item.stub!(:highlights_on => "not a regexp")
         end
         it "should raise an error" do
-          lambda {@item.send(:selected_by_url?).should raise_error(ArgumentError)}
+          lambda {@item.send(:selected_by_condition?).should raise_error(ArgumentError)}
         end
       end
     end
@@ -336,7 +350,7 @@ describe SimpleNavigation::Item do
       end
       it "should check for autohighlighting" do
         @item.should_receive(:auto_highlight?)
-        @item.send(:selected_by_url?)
+        @item.send(:selected_by_condition?)
       end
     end
     context 'auto_highlight is turned on' do
@@ -347,7 +361,7 @@ describe SimpleNavigation::Item do
         before(:each) do
           @item.stub!(:root_path_match? => true)
         end
-        it {@item.send(:selected_by_url?).should be_true}
+        it {@item.send(:selected_by_condition?).should be_true}
       end
       context 'root path does not match' do
         before(:each) do
@@ -359,20 +373,20 @@ describe SimpleNavigation::Item do
           end
           it "should test with the item's url" do
             @adapter.should_receive(:current_page?).with('url')
-            @item.send(:selected_by_url?)
+            @item.send(:selected_by_condition?)
           end
           it "should remove anchors before testing the item's url" do
             @item.stub!(:url => 'url#anchor')
             @adapter.should_receive(:current_page?).with('url')
-            @item.send(:selected_by_url?)
+            @item.send(:selected_by_condition?)
           end
-          it {@item.send(:selected_by_url?).should be_true}
+          it {@item.send(:selected_by_condition?).should be_true}
         end
         context 'no match' do
           before(:each) do
             @adapter.stub!(:current_page? => false)
           end
-          it {@item.send(:selected_by_url?).should be_false}
+          it {@item.send(:selected_by_condition?).should be_false}
         end
       end
     end
@@ -380,7 +394,7 @@ describe SimpleNavigation::Item do
       before(:each) do
         @item.stub!(:auto_highlight? => false)
       end
-      it {@item.send(:selected_by_url?).should be_false}
+      it {@item.send(:selected_by_condition?).should be_false}
     end
   end
 

metadata

@@ -1,49 +1,50 @@
---- !ruby/object:Gem::Specification 
+--- !ruby/object:Gem::Specification
 name: simple-navigation
-version: !ruby/object:Gem::Version 
+version: !ruby/object:Gem::Version
+  version: 3.3.4
   prerelease: 
-  version: 3.3.3
 platform: ruby
-authors: 
+authors:
 - Andi Schacke
 - Mark J. Titorenko
 autorequire: 
 bindir: bin
 cert_chain: []
-
-date: 2011-06-29 00:00:00 Z
-dependencies: 
-- !ruby/object:Gem::Dependency 
+date: 2011-07-11 00:00:00.000000000 +01:00
+default_executable: 
+dependencies:
+- !ruby/object:Gem::Dependency
   name: rspec
-  prerelease: false
-  requirement: &id001 !ruby/object:Gem::Requirement 
+  requirement: &2152960620 !ruby/object:Gem::Requirement
     none: false
-    requirements: 
-    - - ">="
-      - !ruby/object:Gem::Version 
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
         version: 2.0.1
   type: :development
-  version_requirements: *id001
-- !ruby/object:Gem::Dependency 
-  name: activesupport
   prerelease: false
-  requirement: &id002 !ruby/object:Gem::Requirement 
+  version_requirements: *2152960620
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: &2152959780 !ruby/object:Gem::Requirement
     none: false
-    requirements: 
-    - - ">="
-      - !ruby/object:Gem::Version 
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
         version: 2.3.2
   type: :runtime
-  version_requirements: *id002
-description: With the simple-navigation gem installed you can easily create multilevel navigations for your Rails, Sinatra or Padrino applications. The navigation is defined in a single configuration file. It supports automatic as well as explicit highlighting of the currently active navigation through regular expressions.
+  prerelease: false
+  version_requirements: *2152959780
+description: With the simple-navigation gem installed you can easily create multilevel
+  navigations for your Rails, Sinatra or Padrino applications. The navigation is defined
+  in a single configuration file. It supports automatic as well as explicit highlighting
+  of the currently active navigation through regular expressions.
 email: andreas.schacke@gmail.com
 executables: []
-
 extensions: []
-
-extra_rdoc_files: 
+extra_rdoc_files:
 - README
-files: 
+files:
 - CHANGELOG
 - README
 - Rakefile
@@ -91,33 +92,32 @@ 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: []
-
 post_install_message: 
-rdoc_options: 
+rdoc_options:
 - --inline-source
 - --charset=UTF-8
-require_paths: 
+require_paths:
 - lib
-required_ruby_version: !ruby/object:Gem::Requirement 
+required_ruby_version: !ruby/object:Gem::Requirement
   none: false
-  requirements: 
-  - - ">="
-    - !ruby/object:Gem::Version 
-      version: "0"
-required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
-  requirements: 
-  - - ">="
-    - !ruby/object:Gem::Version 
-      version: "0"
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
 requirements: []
-
 rubyforge_project: andi
-rubygems_version: 1.8.5
+rubygems_version: 1.6.2
 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.
+summary: simple-navigation is a ruby library for creating navigations (with multiple
+  levels) for your Rails2, Rails3, Sinatra or Padrino application.
 test_files: []
-