xebec 2.4.0 → 2.5.0

data/VERSION

@@ -1 +1 @@
-2.4.0
+2.5.0

data/lib/xebec/nav_bar_renderer.rb

@@ -93,7 +93,7 @@ module Xebec
       is_current = is_current_nav_item?(item, href)
       klass = item.name.to_s
       klass << " #{Xebec.currently_selected_nav_item_class}" if is_current
-      helper.content_tag :li, :class => klass do
+      helper.content_tag(*list_item_tag(item, klass, text, href, is_current)) do
         if is_current
           helper.content_tag :span, text
         else  
@@ -102,6 +102,18 @@ module Xebec
       end
     end
     
+    # @param [Xebec::NavItem] item the navigation item
+    # @param [String] klass the HTML class attribute generated (including
+    #                       the "current" class if applicable)
+    # @param [String] text
+    # @param [String] href
+    # @param [true, false] is_current
+    # @return the first two arguments to a <tt>content_tag</tt> call --
+    #         the name and HTML properties of the tag
+    def list_item_tag(item, klass, text, href, is_current)
+      return :li, :class => klass
+    end
+    
     def text_for_nav_item(item)
       item_name = item.name
       I18n.t "navbar.#{bar.name}.#{item_name}", :default => item_name.to_s.titleize

data/lib/xebec/title_enhanced_nav_bar_renderer.rb

@@ -0,0 +1,36 @@
+require 'xebec/nav_bar_renderer'
+
+module Xebec
+  
+  # Replaces the default Xebec::NavBarRenderer with a version
+  # that supports separate "text" and "title" internationalization
+  # options for each navigation item. Instead of
+  # "navbar.#{bar.name}.#{item_name}" for the text, use
+  # "navbar.#{bar.name}.#{item_name}.text". Additionally,
+  # use "navbar.#{bar.name}.#{item_name}.title" for a separate
+  # title. The title will default to the text if not specified.
+  #
+  # @see Xebec::NavBarRenderer
+  class TitleEnhancedNavBarRenderer < ::Xebec::NavBarRenderer
+    
+    protected
+    
+    def list_item_tag(item, klass, text, href, is_current)
+      return :li, :class => klass, :title => title_for_nav_item(item, text)
+    end
+
+    def text_for_nav_item(item)
+      item_name = item.name
+      I18n.t "navbar.#{bar.name}.#{item_name}.text",  :default => item_name.to_s.titleize
+    end
+    
+    def title_for_nav_item(item, text)
+      item_name = item.name
+      I18n.t "navbar.#{bar.name}.#{item_name}.title", :default => text
+    end
+    
+  end
+  
+end
+
+Xebec::renderer_class = Xebec::TitleEnhancedNavBarRenderer

data/test/title_enhanced_nav_bar_renderer_test.rb

@@ -0,0 +1,85 @@
+require File.join(File.dirname(__FILE__), 'test_helper')
+require 'xebec'
+
+class TitleEnhancedNavBarRendererTest < Test::Unit::TestCase
+  
+  def setup
+    @old_renderer_class = Xebec::renderer_class
+    load 'xebec/title_enhanced_nav_bar_renderer.rb'
+    clear_translations!
+    @bar = Xebec::NavBar.new('elements')
+    @helper = new_nav_bar_helper
+    @renderer = Xebec::renderer_class.new(@bar, @helper)
+    @bar.nav_item :zn, '/elements/zn'
+  end
+  
+  def teardown
+    Xebec::renderer_class = @old_renderer_class
+  end
+  
+  context 'using the title-enhanced renderer' do
+    
+    should 'replace the default renderer class automatically' do
+      assert_equal Xebec::TitleEnhancedNavBarRenderer, Xebec::renderer_class
+    end
+    
+    context 'with neither text nor a title translation specified' do
+      should "use the nav item's name titleized for the link text" do
+        assert_select_from @renderer.to_s, 'ul li.zn' do
+          assert_select 'a', 'Zn'
+        end
+      end
+      should "use the nav item's name titleized for the <li>'s title" do
+        assert_select_from @renderer.to_s, 'ul li.zn[title="Zn"]'
+      end
+    end
+    
+    context 'with a text but not a title translation specified' do
+      setup do
+        define_translation 'navbar.elements.zn.text', 'Zinc'
+        @bar.nav_item :zn, '/zn'
+      end
+      should "use the text translation for the link text" do
+        assert_select_from @renderer.to_s, 'ul li.zn' do
+          assert_select 'a', 'Zinc'
+        end
+      end
+      should "use the text translation for the <li>'s title" do
+        assert_select_from @renderer.to_s, 'ul li.zn[title="Zinc"]'
+      end
+    end
+    
+    context 'with a title but no text translation specified' do
+      setup do
+        define_translation 'navbar.elements.zn.title', 'Zinc'
+        @bar.nav_item :zn, '/zn'
+      end
+      should "use the nav item's name titleized for the link text" do
+        assert_select_from @renderer.to_s, 'ul li.zn' do
+          assert_select 'a', 'Zn'
+        end
+      end
+      should "use the title translation for the <li>'s title" do
+        assert_select_from @renderer.to_s, 'ul li.zn[title="Zinc"]'
+      end
+    end
+    
+    context 'with both a title and a text translation specified' do
+      setup do
+        define_translation 'navbar.elements.zn.text',  'Zinc'
+        define_translation 'navbar.elements.zn.title', '30: Zinc'
+        @bar.nav_item :zn, '/zn'
+      end
+      should "use the text translation for the link text" do
+        assert_select_from @renderer.to_s, 'ul li.zn' do
+          assert_select 'a', 'Zinc'
+        end
+      end
+      should "use the title translation for the <li>'s title" do
+        assert_select_from @renderer.to_s, 'ul li.zn[title="30: Zinc"]'
+      end
+    end
+    
+  end
+  
+end

data/test/web_app_theme_renderer_test.rb

@@ -1,16 +1,21 @@
 require File.join(File.dirname(__FILE__), 'test_helper')
 require 'xebec'
-require 'xebec/web_app_theme_renderer'
 
 class WebAppThemeRendererTest < Test::Unit::TestCase
   
   def setup
+    @old_renderer_class = Xebec::renderer_class
+    load 'xebec/web_app_theme_renderer.rb'
     @bar = Xebec::NavBar.new('plants')
     @helper = new_nav_bar_helper
     @renderer = Xebec::renderer_class.new(@bar, @helper)
     @bar.nav_item :baz, '/baz'
   end
   
+  def teardown
+    Xebec::renderer_class = @old_renderer_class
+  end
+  
   context 'using the Web-App-Theme support' do
     should 'replace the default renderer class automatically' do
       assert_equal Xebec::WebAppThemeRenderer, Xebec::renderer_class

data/xebec.gemspec

@@ -5,7 +5,7 @@
 
 Gem::Specification.new do |s|
   s.name = %q{xebec}
-  s.version = "2.4.0"
+  s.version = "2.5.0"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["James A. Rosen"]
@@ -55,6 +55,7 @@ Gem::Specification.new do |s|
      "lib/xebec/nav_bar_renderer.rb",
      "lib/xebec/nav_item.rb",
      "lib/xebec/stylesheet_generator.rb",
+     "lib/xebec/title_enhanced_nav_bar_renderer.rb",
      "lib/xebec/web_app_theme_renderer.rb",
      "rails/init.rb",
      "tasks/README.md",
@@ -64,6 +65,7 @@ Gem::Specification.new do |s|
      "test/nav_bar_renderer_test.rb",
      "test/nav_bar_test.rb",
      "test/test_helper.rb",
+     "test/title_enhanced_nav_bar_renderer_test.rb",
      "test/web_app_theme_renderer_test.rb",
      "xebec.gemspec"
   ]
@@ -79,6 +81,7 @@ Gem::Specification.new do |s|
      "test/nav_bar_renderer_test.rb",
      "test/nav_bar_test.rb",
      "test/test_helper.rb",
+     "test/title_enhanced_nav_bar_renderer_test.rb",
      "test/web_app_theme_renderer_test.rb"
   ]
 

metadata

@@ -4,9 +4,9 @@ version: !ruby/object:Gem::Version
   prerelease: false
   segments: 
   - 2
-  - 4
+  - 5
   - 0
-  version: 2.4.0
+  version: 2.5.0
 platform: ruby
 authors: 
 - James A. Rosen
@@ -107,6 +107,7 @@ files:
 - lib/xebec/nav_bar_renderer.rb
 - lib/xebec/nav_item.rb
 - lib/xebec/stylesheet_generator.rb
+- lib/xebec/title_enhanced_nav_bar_renderer.rb
 - lib/xebec/web_app_theme_renderer.rb
 - rails/init.rb
 - tasks/README.md
@@ -116,6 +117,7 @@ files:
 - test/nav_bar_renderer_test.rb
 - test/nav_bar_test.rb
 - test/test_helper.rb
+- test/title_enhanced_nav_bar_renderer_test.rb
 - test/web_app_theme_renderer_test.rb
 - xebec.gemspec
 has_rdoc: true
@@ -160,4 +162,5 @@ test_files:
 - test/nav_bar_renderer_test.rb
 - test/nav_bar_test.rb
 - test/test_helper.rb
+- test/title_enhanced_nav_bar_renderer_test.rb
 - test/web_app_theme_renderer_test.rb