xebec 2.1.0 → 2.2.0

data/.gitignore

@@ -3,4 +3,3 @@
 doc/rdoc
 .yardoc
 pkg
-xebec.gemspec

data/VERSION

@@ -1 +1 @@
-2.1.0
+2.2.0

data/developer_tasks/gem.rake

@@ -18,9 +18,9 @@ namespace :gem do
     puts "Jeweler not available. Install it with [sudo] gem install jeweler -s http://gemscutter.org"
   end
   
-  task :push do
+  task :push => 'gem:build' do
     command = ('gem push')
-    command << " -p $#{ENV['http_proxy']}" if ENV['http_proxy']
+    command << " -p $#{ENV['http_proxy']}" if ENV['http_proxy'] && !ENV['http_proxy'].empty?
     command << " #{latest_gem}"
     puts "Pushing gem..."
     IO.popen(command) { |io| io.each { |line| puts '  ' + line } }

data/doc/example_app/app/controllers/application_controller.rb

@@ -2,9 +2,6 @@
 # many features of Xebec.
 class ApplicationController < ActionController::Base
   
-  # Add Xebec's view helper methods:
-  helper Xebec::NavBarHelper
-  
   # If you prefer to declare your navigation in your
   # controllers, start by including Xebec's controller support:
   include Xebec::ControllerSupport

data/lib/xebec.rb

@@ -1,3 +1,5 @@
+require 'xebec/nav_bar_renderer'
+
 module Xebec
   
   class <<self
@@ -6,8 +8,15 @@ module Xebec
     # "active." Defaults to "current."
     attr_accessor :currently_selected_nav_item_class
     
+    # The navigation bar renderer class. Defaults to
+    # Xebec::NavBarRenderer
+    #
+    # @see Xebec::NavBarRenderer
+    attr_accessor :renderer_class
+    
   end
   self.currently_selected_nav_item_class = :current
+  self.renderer_class = Xebec::NavBarRenderer
   
   autoload :NavBarHelper,         'xebec/nav_bar_helper'
   autoload :ControllerSupport,    'xebec/controller_support'

data/lib/xebec/nav_bar_helper.rb

@@ -1,5 +1,5 @@
 require 'xebec/nav_bar'
-require 'xebec/nav_bar_proxy'
+require 'xebec/nav_bar_renderer'
 require 'xebec/has_nav_bars'
 
 module Xebec
@@ -16,7 +16,7 @@ module Xebec
     #   <%= navbar :tabs %>
     #   # => <ul class="navbar tabs">...</ul>
     #
-    # @see Xebec::NavBarProxy#to_s
+    # @see Xebec::NavBarRenderer#to_s
     # 
     # If called with a block, yields the underlying NavBar for
     # modification.
@@ -30,7 +30,7 @@ module Xebec
     # @see Xebec::NavBar#nav_item
     # @see Xebec::HasNavBars#nav_bar
     #
-    # @return [Xebec::NavBarProxy]
+    # @return [Xebec::NavBarRenderer]
     def nav_bar(name = nil, html_attributes = {}, &block)
       look_up_nav_bar_and_eval name, html_attributes, &block
     end
@@ -39,7 +39,7 @@ module Xebec
     # navigation items. Unlike +nav_bar+, this method does not
     # accept a block.
     #
-    # @return [String, Xebec::NavBarProxy]
+    # @return [String, Xebec::NavBarRenderer]
     def nav_bar_unless_empty(name = nil, html_attributes = {})
       bar = look_up_nav_bar name, html_attributes
       bar.empty? ? '' : bar
@@ -62,11 +62,11 @@ EOS
     protected
     
     # Override HasNavBars#look_up_nav_bar to replace with a
-    # proxy if necessary.
+    # renderer if necessary.
     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)
+        bar = nav_bars[bar.name] = NavBarRenderer.new(bar, self)
       end
       bar
     end

data/lib/xebec/{nav_bar_proxy.rb → nav_bar_renderer.rb}

@@ -3,15 +3,15 @@ require 'xebec/html5'
 
 module Xebec
   
-  # A proxy for a Xebec::NavBar that knows how to turn the NavBar
+  # A renderer for a Xebec::NavBar that knows how to turn the NavBar
   # into an HTML list using ActionView helper methods.
-  class NavBarProxy
+  class NavBarRenderer
     
-    # Create a new NavBar proxy object. The proxy will pass all
+    # Create a new NavBar renderer object. The renderer will pass all
     # methods on to the NavBar except for +to_s+, which will 
     # render the NavBar as an HTML list.
     #
-    # @param [Xebec::NavBar] bar the navigation bar to proxy
+    # @param [Xebec::NavBar] bar the navigation bar to renderer
     # @param [#tag AND #content_tag AND #link_to] helper the ActionView helper
     def initialize(bar, helper)
       raise ArgumentError.new("#{bar || '<nil>'} is not a NavBar") unless bar.kind_of?(NavBar)
@@ -37,12 +37,12 @@ module Xebec
     #   defined, use that value
     # * else, use <tt>nav_item.name.titleize</tt>
     def to_s
-      root_element, options = *root_navbar_element
+      root_element, options = *root_navbar_tag
       if bar.empty?
         helper.tag(root_element, options, false)
       else
         helper.content_tag(root_element, options) do
-          helper.content_tag :ul do
+          helper.content_tag(*list_tag) do
             bar.items.map do |item|
               render_nav_item item
             end
@@ -69,7 +69,7 @@ module Xebec
     
     attr_reader :bar, :helper
     
-    def root_navbar_element
+    def root_navbar_tag
       html_attributes = bar.html_attributes
       html_attributes[:class] ||= ''
       (html_attributes[:class] << " #{bar.name}").strip!
@@ -81,6 +81,12 @@ module Xebec
       end
     end
     
+    # @return the first two arguments to a <tt>content_tag</tt> call --
+    #         the name and HTML properties of the tag
+    def list_tag
+      return :ul, {}
+    end
+    
     def render_nav_item(item)
       text = text_for_nav_item item
       href = href_for_nav_item item

data/lib/xebec/web_app_theme_renderer.rb

@@ -0,0 +1,22 @@
+require 'xebec/nav_bar_renderer'
+
+module Xebec
+  
+  # Replaces the default Xebec::NavBarRenderer with a version
+  # that includes the CSS classes used by WebAppThemes.
+  #
+  # @see Xebec::NavBarRenderer
+  # @see http://github.com/pilu/web-app-theme
+  class WebAppThemeRenderer < ::Xebec::NavBarRenderer
+    
+    protected
+    
+    def list_tag
+      return :ul, :class => 'wat-cf'
+    end
+    
+  end
+  
+end
+
+Xebec::renderer_class = Xebec::WebAppThemeRenderer

data/rails/init.rb

@@ -1,3 +1,10 @@
 require File.join(File.dirname(__FILE__), '..', 'init.rb')
 
 # do any Rails-specific initialization here:
+
+ActionController::Base.class_eval do
+
+  # Add Xebec's view helper methods:
+  helper Xebec::NavBarHelper
+
+end

data/test/nav_bar_helper_test.rb

@@ -9,8 +9,8 @@ class NavBarHelperTest < Test::Unit::TestCase
       @helper = new_nav_bar_helper
     end
     
-    should 'return a NavBar proxy' do
-      assert @helper.nav_bar.kind_of?(Xebec::NavBarProxy)
+    should 'return a NavBar renderer' do
+      assert @helper.nav_bar.kind_of?(Xebec::NavBarRenderer)
     end
     
     should 'return a NavBar with the given name' do
@@ -39,7 +39,7 @@ class NavBarHelperTest < Test::Unit::TestCase
       end
     end
     
-    should "yield the NavBar proxy to the given block" do
+    should "yield the NavBar renderer to the given block" do
       bar = @helper.nav_bar
       bar.expects :zoink!
       @helper.nav_bar do |nb|

data/test/{nav_bar_proxy_test.rb → nav_bar_renderer_test.rb}

@@ -1,58 +1,58 @@
 require File.join(File.dirname(__FILE__), 'test_helper')
 require 'xebec'
 
-class NavBarProxyTest < Test::Unit::TestCase
+class NavBarRendererTest < Test::Unit::TestCase
   
-  context 'creating a NavBar proxy' do
+  context 'creating a NavBar renderer' do
     should 'require a NavBar' do
       assert_raises(ArgumentError) do
-        Xebec::NavBarProxy.new('foobar', new_nav_bar_helper)
+        Xebec::NavBarRenderer.new('foobar', new_nav_bar_helper)
       end
     end
     should 'require a NavBarHelper' do
       assert_raises(ArgumentError) do
-        Xebec::NavBarProxy.new(Xebec::NavBar.new, 'baz')
+        Xebec::NavBarRenderer.new(Xebec::NavBar.new, 'baz')
       end
     end
   end
   
-  context 'a NavBar proxy' do
+  context 'a NavBar renderer' do
     
     setup do
       clear_translations!
       @bar = Xebec::NavBar.new('elephants')
       @helper = new_nav_bar_helper
-      @proxy = Xebec::NavBarProxy.new(@bar, @helper)
+      @renderer = Xebec::NavBarRenderer.new(@bar, @helper)
     end
     
     should 'respond to :name' do
-      assert @proxy.respond_to?(:name)
+      assert @renderer.respond_to?(:name)
     end
     
     should "return the NavBar's name when sent :name" do
-      assert_equal 'elephants', @proxy.name
+      assert_equal 'elephants', @renderer.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'
+      assert_equal({:id => 'salads-nav'}, @renderer.html_attributes)
+      assert_select_from @renderer.to_s, '#salads-nav'
     end
     
     should 'not respond to a method that the underlying NavBar does not' do
-      assert !@proxy.respond_to?(:cromulize)
+      assert !@renderer.respond_to?(:cromulize)
     end
     
     context 'for a browser that supports HTML5' do
-      setup { @proxy.stubs(:user_agent_supports_html5?).returns(true) }
+      setup { @renderer.stubs(:user_agent_supports_html5?).returns(true) }
       
       should "render a navigation bar with the bar's name" do
-        assert_select_from @proxy.to_s, "nav.elephants"
+        assert_select_from @renderer.to_s, "nav.elephants"
       end
       
       context 'with an empty NavBar' do
         should 'render an empty navigation bar' do
-          assert_select_from @proxy.to_s, 'nav', /$^/
+          assert_select_from @renderer.to_s, 'nav', /$^/
         end
       end
     end
@@ -61,12 +61,12 @@ class NavBarProxyTest < Test::Unit::TestCase
       setup { @helper.stubs(:user_agent_supports_html5?).returns(false) }
       
       should "render a div.navbar the bar's name" do
-        assert_select_from @proxy.to_s, "div.navbar.elephants"
+        assert_select_from @renderer.to_s, "div.navbar.elephants"
       end
       
       context 'with an empty NavBar' do
         should 'render an empty navigation bar' do
-          assert_select_from @proxy.to_s, 'div.navbar', /$^/
+          assert_select_from @renderer.to_s, 'div.navbar', /$^/
         end
       end
     end
@@ -77,7 +77,7 @@ class NavBarProxyTest < Test::Unit::TestCase
         @bar.nav_item :foo
       end
       should 'render a navigation bar with the appropriate items' do
-        assert_select_from @proxy.to_s, 'ul' do
+        assert_select_from @renderer.to_s, 'ul' do
           assert_select 'li' do
             assert_select 'a[href="/foo"]', 'Foo'
           end
@@ -91,7 +91,7 @@ class NavBarProxyTest < Test::Unit::TestCase
         @bar.current = :foo
       end
       should 'render a navigation bar with the item marked as current' do
-        assert_select_from @proxy.to_s, 'ul' do
+        assert_select_from @renderer.to_s, 'ul' do
           assert_select 'li.current', 'Foo'
         end
       end
@@ -101,7 +101,7 @@ class NavBarProxyTest < Test::Unit::TestCase
           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_from @renderer.to_s, 'ul' do
             assert_select 'li.active', 'Foo'
           end
         end
@@ -117,13 +117,13 @@ class NavBarProxyTest < Test::Unit::TestCase
         @bar.current = :baz
       end
       should 'render a navigation bar with the item not marked as current' do
-        assert_select_from @proxy.to_s, 'ul' do
+        assert_select_from @renderer.to_s, 'ul' do
           assert_select 'li', 'Foo'
           assert_select 'li.current', { :count => 0, :text=> 'Foo' }
         end
       end
       should 'not render an empty "class" attribute' do
-        assert(!(/class\s*=\s*["']\s*["']/ === @proxy.to_s))
+        assert(!(/class\s*=\s*["']\s*["']/ === @renderer.to_s))
       end
     end
     
@@ -132,7 +132,7 @@ class NavBarProxyTest < Test::Unit::TestCase
         @bar.nav_item :foo, 'http://foo.com'
       end
       should 'render a navigation bar with the appropriate items' do
-        assert_select_from @proxy.to_s, 'ul' do
+        assert_select_from @renderer.to_s, 'ul' do
           assert_select 'li' do
             assert_select 'a[href="http://foo.com"]', 'Foo'
           end
@@ -147,21 +147,21 @@ class NavBarProxyTest < Test::Unit::TestCase
         @bar.nav_item :sign_up, '/sign_up'
       end
       should 'render a non-link navigation item' do
-        assert_select_from @proxy.to_s, 'ul' do
+        assert_select_from @renderer.to_s, 'ul' do
           assert_select 'li', 'Home' do
             assert_select 'a', 0
           end
         end
       end
       should 'render other items as links' do
-        assert_select_from @proxy.to_s, 'ul' do
+        assert_select_from @renderer.to_s, 'ul' do
           assert_select 'li' do
             assert_select 'a[href="/sign_up"]', 'Sign Up'
           end
         end
       end
       should 'add the "current" class to the current item' do
-        assert_select_from @proxy.to_s, 'ul' do
+        assert_select_from @renderer.to_s, 'ul' do
           assert_select 'li.current', 'Home'
         end
       end
@@ -174,7 +174,7 @@ class NavBarProxyTest < Test::Unit::TestCase
         @bar.nav_item :foo
       end
       should 'render a navigation bar using the internationalized text' do
-        assert_select_from @proxy.to_s, 'ul' do
+        assert_select_from @renderer.to_s, 'ul' do
           assert_select 'li' do
             assert_select 'a', 'My Foos'
           end

data/test/web_app_theme_renderer_test.rb

@@ -0,0 +1,24 @@
+require File.join(File.dirname(__FILE__), 'test_helper')
+require 'xebec'
+require 'xebec/web_app_theme_renderer'
+
+class WebAppThemeRendererTest < Test::Unit::TestCase
+  
+  def setup
+    @bar = Xebec::NavBar.new('plants')
+    @helper = new_nav_bar_helper
+    @renderer = Xebec::renderer_class.new(@bar, @helper)
+    @bar.nav_item :baz, '/baz'
+  end
+  
+  context 'using the Web-App-Theme support' do
+    should 'replace the default renderer class automatically' do
+      assert_equal Xebec::WebAppThemeRenderer, Xebec::renderer_class
+    end
+    
+    should 'render navigation <ul>s with wat-cf' do
+      assert_select_from @renderer.to_s, 'ul.wat-cf'
+    end
+  end
+  
+end

data/xebec.gemspec

@@ -0,0 +1,103 @@
+# Generated by jeweler
+# DO NOT EDIT THIS FILE
+# Instead, edit Jeweler::Tasks in Rakefile, and run `rake gemspec`
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = %q{xebec}
+  s.version = "2.2.0"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.authors = ["James A. Rosen"]
+  s.date = %q{2010-03-13}
+  s.description = %q{Helpers for generating navigation bars}
+  s.email = %q{james.a.rosen@gmail.com}
+  s.extra_rdoc_files = [
+    "README.md"
+  ]
+  s.files = [
+    ".gitignore",
+     "README.md",
+     "Rakefile",
+     "VERSION",
+     "developer_tasks/doc.rake",
+     "developer_tasks/gem.rake",
+     "developer_tasks/test.rake",
+     "doc/example_app/Gemfile",
+     "doc/example_app/README.md",
+     "doc/example_app/app/controllers/application_controller.rb",
+     "doc/example_app/app/controllers/pages_controller.rb",
+     "doc/example_app/app/controllers/projects_controller.rb",
+     "doc/example_app/app/views/layouts/_site_nav_bar.html.erb",
+     "doc/example_app/app/views/layouts/application.html.erb",
+     "doc/example_app/app/views/pages/about_us.html.erb",
+     "doc/example_app/app/views/pages/faq.html.erb",
+     "doc/example_app/app/views/pages/feedback.html.erb",
+     "doc/example_app/app/views/pages/home.html.erb",
+     "doc/example_app/app/views/pages/privacy_policy.html.erb",
+     "doc/example_app/app/views/projects/budget.html.erb",
+     "doc/example_app/app/views/projects/edit.html.erb",
+     "doc/example_app/app/views/projects/history.html.erb",
+     "doc/example_app/app/views/projects/index.html.erb",
+     "doc/example_app/app/views/projects/show.html.erb",
+     "doc/example_app/config/environment.rb",
+     "doc/example_app/config/locales/en.yml",
+     "doc/example_app/config/routes.rb",
+     "generators/xebec_stylesheet/templates/xebec.css.erb",
+     "generators/xebec_stylesheet/xebec_stylesheet_generator.rb",
+     "init.rb",
+     "lib/xebec.rb",
+     "lib/xebec/controller_support.rb",
+     "lib/xebec/has_nav_bars.rb",
+     "lib/xebec/html5.rb",
+     "lib/xebec/nav_bar.rb",
+     "lib/xebec/nav_bar_helper.rb",
+     "lib/xebec/nav_bar_renderer.rb",
+     "lib/xebec/nav_item.rb",
+     "lib/xebec/stylesheet_generator.rb",
+     "lib/xebec/web_app_theme_renderer.rb",
+     "rails/init.rb",
+     "tasks/README.md",
+     "test/controller_support_test.rb",
+     "test/html5_test.rb",
+     "test/nav_bar_helper_test.rb",
+     "test/nav_bar_renderer_test.rb",
+     "test/nav_bar_test.rb",
+     "test/test_helper.rb",
+     "test/web_app_theme_renderer_test.rb",
+     "xebec.gemspec"
+  ]
+  s.homepage = %q{http://github.com/jamesarosen/xebec}
+  s.rdoc_options = ["--line-numbers", "--inline-source", "--title", "Xebec Documentation", "--charset", "utf-8"]
+  s.require_paths = ["lib"]
+  s.rubygems_version = %q{1.3.6}
+  s.summary = %q{Navigation helpers}
+  s.test_files = [
+    "test/controller_support_test.rb",
+     "test/html5_test.rb",
+     "test/nav_bar_helper_test.rb",
+     "test/nav_bar_renderer_test.rb",
+     "test/nav_bar_test.rb",
+     "test/test_helper.rb",
+     "test/web_app_theme_renderer_test.rb"
+  ]
+
+  if s.respond_to? :specification_version then
+    current_version = Gem::Specification::CURRENT_SPECIFICATION_VERSION
+    s.specification_version = 3
+
+    if Gem::Version.new(Gem::RubyGemsVersion) >= Gem::Version.new('1.2.0') then
+      s.add_development_dependency(%q<shoulda>, ["~> 2.10.3"])
+      s.add_development_dependency(%q<mocha>, ["~> 0.9.8"])
+      s.add_development_dependency(%q<redgreen>, ["~> 1.2.2"])
+    else
+      s.add_dependency(%q<shoulda>, ["~> 2.10.3"])
+      s.add_dependency(%q<mocha>, ["~> 0.9.8"])
+      s.add_dependency(%q<redgreen>, ["~> 1.2.2"])
+    end
+  else
+    s.add_dependency(%q<shoulda>, ["~> 2.10.3"])
+    s.add_dependency(%q<mocha>, ["~> 0.9.8"])
+    s.add_dependency(%q<redgreen>, ["~> 1.2.2"])
+  end
+end

metadata

@@ -4,9 +4,9 @@ version: !ruby/object:Gem::Version
   prerelease: false
   segments: 
   - 2
-  - 1
+  - 2
   - 0
-  version: 2.1.0
+  version: 2.2.0
 platform: ruby
 authors: 
 - James A. Rosen
@@ -104,17 +104,20 @@ files:
 - lib/xebec/html5.rb
 - lib/xebec/nav_bar.rb
 - lib/xebec/nav_bar_helper.rb
-- lib/xebec/nav_bar_proxy.rb
+- lib/xebec/nav_bar_renderer.rb
 - lib/xebec/nav_item.rb
 - lib/xebec/stylesheet_generator.rb
+- lib/xebec/web_app_theme_renderer.rb
 - rails/init.rb
 - tasks/README.md
 - test/controller_support_test.rb
 - test/html5_test.rb
 - test/nav_bar_helper_test.rb
-- test/nav_bar_proxy_test.rb
+- test/nav_bar_renderer_test.rb
 - test/nav_bar_test.rb
 - test/test_helper.rb
+- test/web_app_theme_renderer_test.rb
+- xebec.gemspec
 has_rdoc: true
 homepage: http://github.com/jamesarosen/xebec
 licenses: []
@@ -154,6 +157,7 @@ test_files:
 - test/controller_support_test.rb
 - test/html5_test.rb
 - test/nav_bar_helper_test.rb
-- test/nav_bar_proxy_test.rb
+- test/nav_bar_renderer_test.rb
 - test/nav_bar_test.rb
 - test/test_helper.rb
+- test/web_app_theme_renderer_test.rb