xebec 2.0.0 → 2.1.0

data/README.md

@@ -62,6 +62,10 @@ If you only have one navigation bar on your site, you can leave off the name, li
 
     <%= nav_bar %>
     
+If you want to add extra HTML attributes to the root navigation bar element (say, for compatibility with existing CSS and Javascript), you can pass them to the `nav_bar` call:
+
+    <%= nav_bar :site, :id => 'sitenav' %>
+    
 Xebec will assign this navigation bar the name `:default` in case you need to refer to it elsewhere, but you probably won't.
 
 #### Populating a Navigation Bar ####

data/VERSION

@@ -1 +1 @@
-2.0.0
+2.1.0

data/lib/xebec/has_nav_bars.rb

@@ -11,15 +11,21 @@ module Xebec
     # Looks up the named nav bar, creates it if it
     # doesn't exist, and evaluates the the block, if
     # given, in the scope of +self+, yielding the nav bar.
-    def look_up_nav_bar_and_eval(name = nil, &block)
+    #
+    # @param [Symbol, String] name the name of the navigation bar to look up
+    # @param [Hash] html_attributes additional HTML attributes to add to the
+    #                               navigation bar
+    def look_up_nav_bar_and_eval(name = nil, html_attributes = {}, &block)
       name ||= Xebec::NavBar::DEFAULT_NAME
-      look_up_nav_bar(name).tap do |bar|
+      look_up_nav_bar(name, html_attributes).tap do |bar|
         block.bind(self).call(bar) if block_given?
       end
     end
     
-    def look_up_nav_bar(name)
-      nav_bars[name] ||= NavBar.new(name)
+    def look_up_nav_bar(name, html_attributes)
+      (nav_bars[name] ||= NavBar.new(name, html_attributes)).tap do |bar|
+        bar.html_attributes.merge!(html_attributes)
+      end
     end
     
     def nav_bars

data/lib/xebec/nav_bar.rb

@@ -8,13 +8,17 @@ module Xebec
     
     attr_reader :name
     attr_reader :items
+    attr_reader :html_attributes
     attr_accessor :current
     
     # Create a new NavBar object.
     #
     # @param [String] name the name of the navigation bar; defaults to :default
-    def initialize(name = nil)
+    # @param [Hash] html_attributes additional HTML attributes for the
+    #                               navigation bar, e.g. { :id => 'my-navbar' }
+    def initialize(name = nil, html_attributes = nil)
       @name = name || DEFAULT_NAME
+      @html_attributes = html_attributes || {}
       @items = []
       @current = nil
     end

data/lib/xebec/nav_bar_helper.rb

@@ -13,7 +13,7 @@ module Xebec
     # or "=navbar" in HAML), renders the navigation bar.
     #
     # @example
-    #   <%= navbar :tabs%>
+    #   <%= navbar :tabs %>
     #   # => <ul class="navbar tabs">...</ul>
     #
     # @see Xebec::NavBarProxy#to_s
@@ -31,8 +31,8 @@ module Xebec
     # @see Xebec::HasNavBars#nav_bar
     #
     # @return [Xebec::NavBarProxy]
-    def nav_bar(name = nil, &block)
-      look_up_nav_bar_and_eval name, &block
+    def nav_bar(name = nil, html_attributes = {}, &block)
+      look_up_nav_bar_and_eval name, html_attributes, &block
     end
     
     # Renders a navigation bar if and only if it contains any
@@ -40,8 +40,8 @@ module Xebec
     # accept a block.
     #
     # @return [String, Xebec::NavBarProxy]
-    def nav_bar_unless_empty(name = nil)
-      bar = look_up_nav_bar name
+    def nav_bar_unless_empty(name = nil, html_attributes = {})
+      bar = look_up_nav_bar name, html_attributes
       bar.empty? ? '' : bar
     end
     
@@ -63,8 +63,8 @@ EOS
     
     # Override HasNavBars#look_up_nav_bar to replace with a
     # proxy if necessary.
-    def look_up_nav_bar(name)
-      bar = super(name)
+    def look_up_nav_bar(name, html_attributes)
+      bar = super(name, html_attributes)
       if bar.kind_of?(Xebec::NavBar)
         bar = nav_bars[bar.name] = NavBarProxy.new(bar, self)
       end

data/lib/xebec/nav_bar_proxy.rb

@@ -70,19 +70,21 @@ module Xebec
     attr_reader :bar, :helper
     
     def root_navbar_element
-      klass = "#{bar.name}"
+      html_attributes = bar.html_attributes
+      html_attributes[:class] ||= ''
+      (html_attributes[:class] << " #{bar.name}").strip!
       if helper.user_agent_supports_html5?
-        return :nav, { :class => klass }
+        return :nav, html_attributes
       else
-        klass << ' navbar'
-        return :div, { :class => klass }
+        html_attributes[:class] << " navbar"
+        return :div, html_attributes
       end
     end
     
     def render_nav_item(item)
       text = text_for_nav_item item
       href = href_for_nav_item item
-      options = is_current_nav_item?(item, href) ? { :class => :current } : {}
+      options = is_current_nav_item?(item, href) ? { :class => Xebec.currently_selected_nav_item_class } : {}
       helper.content_tag :li, options do
         helper.link_to_unless_current text, href
       end

data/lib/xebec.rb

@@ -1,5 +1,14 @@
 module Xebec
   
+  class <<self
+    
+    # The CSS class that is added to navigation items that are
+    # "active." Defaults to "current."
+    attr_accessor :currently_selected_nav_item_class
+    
+  end
+  self.currently_selected_nav_item_class = :current
+  
   autoload :NavBarHelper,         'xebec/nav_bar_helper'
   autoload :ControllerSupport,    'xebec/controller_support'
   autoload :StylesheetGenerator,  'xebec/stylesheet_generator'

data/test/nav_bar_helper_test.rb

@@ -27,6 +27,11 @@ class NavBarHelperTest < Test::Unit::TestCase
       assert_equal desserts, @helper.nav_bar('desserts')
     end
     
+    should 'allow additional HTML attributes' do
+      salads = @helper.nav_bar(:salads, :id => 'salads-nav')
+      assert_equal 'salads-nav', @helper.nav_bar(:salads).html_attributes[:id]
+    end
+    
     should "evaluate a block in the helper's scope" do
       @helper.expects(:zoink!)
       @helper.nav_bar do

data/test/nav_bar_proxy_test.rb

@@ -33,6 +33,12 @@ class NavBarProxyTest < Test::Unit::TestCase
       assert_equal 'elephants', @proxy.name
     end
     
+    should 'support additional HTML properties' do
+      @bar.html_attributes.merge!(:id => 'salads-nav')
+      assert_equal({:id => 'salads-nav'}, @proxy.html_attributes)
+      assert_select_from @proxy.to_s, '#salads-nav'
+    end
+    
     should 'not respond to a method that the underlying NavBar does not' do
       assert !@proxy.respond_to?(:cromulize)
     end
@@ -89,6 +95,20 @@ class NavBarProxyTest < Test::Unit::TestCase
           assert_select 'li.current', 'Foo'
         end
       end
+      context 'when Xebec is configured to use a different "current" class' do
+        setup do
+          @old_class = Xebec.currently_selected_nav_item_class
+          Xebec.currently_selected_nav_item_class = 'active'
+        end
+        should 'use the configured CSS class' do
+          assert_select_from @proxy.to_s, 'ul' do
+            assert_select 'li.active', 'Foo'
+          end
+        end
+        teardown do
+          Xebec.currently_selected_nav_item_class = @old_class
+        end
+      end
     end
     
     context 'with a NavBar that has a navigation item not set as current' do

metadata

@@ -4,9 +4,9 @@ version: !ruby/object:Gem::Version
   prerelease: false
   segments: 
   - 2
+  - 1
   - 0
-  - 0
-  version: 2.0.0
+  version: 2.1.0
 platform: ruby
 authors: 
 - James A. Rosen