simple-navigation 2.6.0 → 2.7.0

data/CHANGELOG

@@ -1,9 +1,15 @@
+*2.7.0
+
+* added new option :highlights_on to item definition in config-file. Specify a regexp which is matched against the current_uri to determine if an item is active or not. Replaces explicit highlighting in controllers.
+* deprecated explicit highlighting in the controllers.
+
+
 *2.6.0
 
 * added rendering option 'skip_if_empty' to Renderer::List to avoid rendering of empty ul-tags
 * added breadcrumbs renderer incl. specs. A big thanks to Markus Schirp.
 * added ability to register a renderer / specify your renderer as symbol in render_navigation
-* renderer can be specified in render_navigation. Credits to Andi Badi from Galaxy Cats.
+* renderer can be specified in render_navigation. Credits to Andi Bade from Galaxy Cats.
 
 *2.5.4
 

data/VERSION.yml

@@ -1,4 +1,4 @@
 --- 
 :major: 2
-:minor: 6
+:minor: 7
 :patch: 0

data/generators/navigation_config/templates/config/navigation.rb

@@ -28,6 +28,17 @@ SimpleNavigation::Configuration.run do |navigation|
     # name - will be displayed in the rendered navigation. This can also be a call to your I18n-framework.
     # url - the address that the generated item links to. You can also use url_helpers (named routes, restful routes helper, url_for etc.)
     # options - can be used to specify attributes that will be included in the rendered navigation item (e.g. id, class etc.)
+    #           some special options that can be set:
+    #           :if - Specifies a proc to call to determine if the item should
+    #                 be rendered (e.g. <tt>:if => Proc.new { current_user.admin? }</tt>). The
+    #                 proc should evaluate to a true or false value and is evaluated in the context of the view.
+    #           :unless - Specifies a proc to call to determine if the item should not
+    #                     be rendered (e.g. <tt>:unless => Proc.new { current_user.admin? }</tt>). The
+    #                     proc should evaluate to a true or false value and is evaluated in the context of the view.
+    #           :method - Specified the http-method for the generated link - default is :get.
+    #           :highlights_on - if autohighlighting is turned off and/or you want to explicitly specify 
+    #                            when the item should be highlighted, you can set a regexp which is matched 
+    #                            against the current URI.
     #
     primary.item :key_1, 'name', url, options
     

data/lib/simple_navigation/controller_methods.rb

@@ -56,6 +56,7 @@ module SimpleNavigation
       #
       # The specified symbol must match the keys for your navigation items in your config/navigation.rb file.  
       def navigation(*args)
+        ActiveSupport::Deprecation.warn("Setting the active navigation in the controllers has been deprecated. Please use the new :highlights_on option in the config file for explicit highlighting")
         self.class_eval do
           define_method :sn_set_navigation do
             current_navigation(*args)
@@ -72,6 +73,7 @@ module SimpleNavigation
       #
       # The specified symbol must match the keys for your navigation items in your config/navigation.rb file.
       def current_navigation(*args)
+        ActiveSupport::Deprecation.warn("Setting the active navigation in the controllers has been deprecated. Please use the new :highlights_on option in the config file for explicit highlighting")
         @sn_current_navigation_args = args
       end
     end

data/lib/simple_navigation/item.rb

@@ -2,7 +2,7 @@ module SimpleNavigation
   
   # Represents an item in your navigation. Gets generated by the item method in the config-file.
   class Item
-    attr_reader :key, :name, :url, :sub_navigation, :method
+    attr_reader :key, :name, :url, :sub_navigation, :method, :highlights_on
     attr_writer :html_options
     
     # see ItemContainer#item
@@ -14,6 +14,7 @@ module SimpleNavigation
       @method = options.delete(:method)
       @name = name
       @url = url
+      @highlights_on = options.delete(:highlights_on)
       @html_options = options
       if sub_nav_block || items
         @sub_navigation = ItemContainer.new(@container.level + 1)
@@ -63,7 +64,10 @@ module SimpleNavigation
 
     # Returns true if the item's url matches the request's current url.
     def selected_by_url?
-      if auto_highlight?
+      if highlights_on
+        raise ArgumentError, ':highlights_on must be a regexp' unless highlights_on.instance_of?(Regexp)
+        SimpleNavigation.template.request.request_uri =~ highlights_on
+      elsif auto_highlight?
         !!(root_path_match? || (SimpleNavigation.template && SimpleNavigation.template.current_page?(url)))
       else
         false

data/lib/simple_navigation/item_container.rb

@@ -22,13 +22,16 @@ module SimpleNavigation
     # The <tt>url</tt> is the address that the generated item points to. You can also use url_helpers (named routes, restful routes helper, url_for etc.) 
     #
     # The <tt>options</tt> can be used to specify the following things:
-    # * <tt>html_attributes</tt> - will be included in the rendered navigation item (e.g. id, class etc.)
+    # * <tt>any html_attributes</tt> - will be included in the rendered navigation item (e.g. id, class etc.)
     # * <tt>:if</tt> - Specifies a proc to call to determine if the item should
     #   be rendered (e.g. <tt>:if => Proc.new { current_user.admin? }</tt>). The
     #   proc should evaluate to a true or false value and is evaluated in the context of the view.
     # * <tt>:unless</tt> - Specifies a proc to call to determine if the item should not
     #   be rendered (e.g. <tt>:unless => Proc.new { current_user.admin? }</tt>). The
     #   proc should evaluate to a true or false value and is evaluated in the context of the view.
+    # * <tt>:method</tt> - Specified the http-method for the generated link - default is :get.
+    # * <tt>:highlights_on</tt> - if autohighlighting is turned off and/or you want to explicitly specify 
+    #   when the item should be highlighted, you can set a regexp which is matched againstthe current URI.
     #
     # The <tt>block</tt> - if specified - will hold the item's sub_navigation.
     def item(key, name, url, options={}, &block)

data/spec/lib/simple_navigation/controller_methods_spec.rb

@@ -41,8 +41,10 @@ describe SimpleNavigation::ControllerMethods do
     describe 'navigation' do
       
       def call_navigation(key1, key2=nil)
-        @controller.class_eval do
-          navigation key1, key2
+        ActiveSupport::Deprecation.silence do
+          @controller.class_eval do
+            navigation key1, key2
+          end
         end
       end
       
@@ -74,11 +76,11 @@ describe SimpleNavigation::ControllerMethods do
     
     describe 'current_navigation' do
       it "should set the sn_current_navigation_args as specified" do
-        @controller.current_navigation(:first)
+        ActiveSupport::Deprecation.silence {@controller.current_navigation(:first)}
         @controller.instance_variable_get(:@sn_current_navigation_args).should == [:first]
       end
       it "should set the sn_current_navigation_args as specified" do
-        @controller.current_navigation(:first, :second)
+        ActiveSupport::Deprecation.silence {@controller.current_navigation(:first, :second)}
         @controller.instance_variable_get(:@sn_current_navigation_args).should == [:first, :second]
       end
     end

data/spec/lib/simple_navigation/item_spec.rb

@@ -45,7 +45,7 @@ describe SimpleNavigation::Item do
         end
       end
     end
-    context 'method' do
+    context ':method option' do
       context 'defined' do
         before(:each) do
           @options = {:method => :delete}
@@ -65,6 +65,28 @@ describe SimpleNavigation::Item do
         end
       end
     end
+    
+    context ':highlights_on option' do
+      context 'defined' do
+        before(:each) do
+          @highlights_on = stub(:option)
+          @options = {:highlights_on => @highlights_on}
+          @item = SimpleNavigation::Item.new(@item_container, :my_key, 'name', 'url', @options)
+        end
+        it 'should set the method as instance_var' do
+          @item.highlights_on.should == @highlights_on
+        end
+        it 'should set the html-options without the method' do
+          @item.instance_variable_get(:@html_options).key?(:highlights_on).should be_false
+        end
+      end
+      
+      context 'undefined' do
+        it 'should set the instance-var to nil' do
+          @item.highlights_on.should be_nil
+        end
+      end
+    end
   end
   
   describe 'selected?' do
@@ -181,7 +203,7 @@ describe SimpleNavigation::Item do
           it {@item.html_options[:id].should == 'my_id'}
         end
       
-        context 'with no id definied in options (using default id)' do
+        context 'with no id defined in options (using default id)' do
           before(:each) do
             @item.html_options = {}
           end
@@ -257,6 +279,45 @@ describe SimpleNavigation::Item do
   end
 
   describe 'selected_by_url?' do
+    context ':highlights_on option is set' do
+      before(:each) do
+        @item.stub!(:highlights_on => /^\/current/)
+        @template = stub(:template, :request => stub(:request, :request_uri => '/current_url'))
+        SimpleNavigation.stub!(:template => @template)
+      end
+      it "should not check for autohighlighting" do
+        @item.should_not_receive(:auto_highlight?)
+        @item.send(:selected_by_url?)
+      end
+      context ':highlights_on is a regexp' do
+        context 'regexp matches current_url' do
+          it {@item.send(:selected_by_url?).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}
+        end
+      end
+      context ':highlights_on is not a regexp' 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)}
+        end
+      end
+    end
+    context ':highlights_on option is not set' do
+      before(:each) do
+        @item.stub!(:highlights_on => nil)
+      end
+      it "should check for autohighlighting" do
+        @item.should_receive(:auto_highlight?)
+        @item.send(:selected_by_url?)
+      end
+    end
     context 'auto_highlight is turned on' do
       before(:each) do
         @item.stub!(:auto_highlight? => true)

metadata

@@ -4,9 +4,9 @@ version: !ruby/object:Gem::Version
   prerelease: false
   segments: 
   - 2
-  - 6
+  - 7
   - 0
-  version: 2.6.0
+  version: 2.7.0
 platform: ruby
 authors: 
 - Andi Schacke
@@ -14,7 +14,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-06-19 00:00:00 +02:00
+date: 2010-07-30 00:00:00 +02:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency