menu_helper 0.0.1

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2006-2007 Aaron Pfeifer & Neil Abraham
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README

@@ -0,0 +1,108 @@
+= menu_helper
+
+menu_helper adds a helper method for generating a menubar.
+
+== Resources
+
+API
+
+* http://api.pluginaweek.org/menu_helper
+
+Wiki
+
+* http://wiki.pluginaweek.org/Menu_helper
+
+Announcement
+
+* http://www.pluginaweek.org/
+
+Source
+
+* http://svn.pluginaweek.org/trunk/plugins/action_pack/menu_helper
+
+Development
+
+* http://dev.pluginaweek.org/browser/trunk/plugins/action_pack/menu_helper
+
+== Description
+
+The generation of a menubar's structure can often be a repetitive and unDRY
+process.  A standard using unordered lists is generally followed when creating
+a menubar.  menu_helper attempts to following this standard in addition to
+automatically adding ids, classes for selected menus, and default urls each
+menu is linked to (base on various information, such as the name of the menu).
+
+== Example
+
+routes.rb:
+  ActionController::Routing::Routes.draw do |map|
+    map.with_options(:controller => 'site') do |site|
+      site.home '', :action => 'index'
+    end
+    
+    map.with_options(:controller => 'about_us') do |about_us|
+      about_us.about_us     'about_us',             :action => 'index'
+      about_us.contact      'about_us/contact',     :action => 'contact'
+      about_us.who_we_are   'about_us/who_we_are',  :action => 'who_we_are'
+    end
+    
+    map.with_options(:controller => 'products') do |products|
+      products.products 'products', :action => 'index'
+    end
+    
+    map.with_options(:controller => 'services') do |services|
+      services.services 'services', :action => 'index'
+    end
+  end
+
+_menubar.rhtml:
+  <%=
+    menu_bar do |main|
+      main.menu :home
+      main.menu :products
+      main.menu :services
+      main.menu :about_us do |about_us|
+        about_us.menu :overview, 'Overview', about_us_url
+        about_us.menu :who_we_are
+        about_us.menu :contact, 'Contact Us'
+      end
+      main.menu :search, 'Search!', 'http://www.google.com', :class => 'ir'
+    end
+  %>
+
+Output (formatted for sanity):
+  <ul id="menubar">
+    <li id="home"><a href="http://example.com/">Home</a></li>
+    <li id="products"><a href="http://example.com/products">Products</a></li>
+    <li id="services"><a href="http://example.com/services">Services</a></li>
+    <li class="selected" id="about_us"><a href="http://example.com/about_us">About Us</a>
+      <ul id="about_us_menubar">
+        <li id="overview"><a href="http://example.com/about_us">Overview</a></li>
+        <li class="selected" id="who_we_are"><a href="http://example.com/about_us/who_we_are">Who We Are</a></li>
+        <li class="last" id="contact"><a href="http://example.com/about_us/contact">Contact Us</a></li>
+      </ul>
+    <li class="search ir" id="search"><a href="http://www.google.com">Search!</a></li>
+  </ul>
+
+== Using this plugin
+
+Remember one of the basic principles of programming: KISS.  There's no need to
+use this plugin if you're writing a very, very simple menubar.  The advantages
+of this helper are consistency, DRYness, and decreased complexity if you have
+lots of submenus.
+
+I wrote this plugin half as an experiment and half to actually use in a
+production application.  I recommend trying it out and seeing if it actually
+fits the needs of your application before committing to using it.
+
+== Testing
+
+This plugin requires that the plugin_test_helper gem be installed in order to
+run the unit tests.  To install this gem:
+
+  gem install plugin_test_helper
+
+== Dependencies
+
+This plugin depends on the presence of the following plugins:
+# set_or_append - http://wiki.pluginaweek.org/Set_or_append

data/Rakefile

@@ -0,0 +1,79 @@
+require 'rake/testtask'
+require 'rake/rdoctask'
+require 'rake/gempackagetask'
+require 'rake/contrib/sshpublisher'
+
+PKG_NAME           = 'menu_helper'
+PKG_VERSION        = '0.0.1'
+PKG_FILE_NAME      = "#{PKG_NAME}-#{PKG_VERSION}"
+RUBY_FORGE_PROJECT = 'pluginaweek'
+
+desc 'Default: run unit tests.'
+task :default => :test
+
+desc 'Test the menu_helper plugin.'
+Rake::TestTask.new(:test) do |t|
+  t.libs << 'lib'
+  t.pattern = 'test/**/*_test.rb'
+  t.verbose = true
+end
+
+desc 'Generate documentation for the menu_helper plugin.'
+Rake::RDocTask.new(:rdoc) do |rdoc|
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title    = 'MenuHelper'
+  rdoc.options << '--line-numbers' << '--inline-source'
+  rdoc.rdoc_files.include('README')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end
+
+spec = Gem::Specification.new do |s|
+  s.name            = PKG_NAME
+  s.version         = PKG_VERSION
+  s.platform        = Gem::Platform::RUBY
+  s.summary         = 'Adds a helper method for generating a menubar'
+  
+  s.files           = FileList['{lib,tasks,test}/**/*'].to_a + %w(init.rb MIT-LICENSE Rakefile README)
+  s.require_path    = 'lib'
+  s.autorequire     = 'menu_helper'
+  s.has_rdoc        = true
+  s.test_files      = Dir['test/**/*_test.rb']
+  
+  s.author          = 'Aaron Pfeifer, Neil Abraham'
+  s.email           = 'info@pluginaweek.org'
+  s.homepage        = 'http://www.pluginaweek.org'
+end
+  
+Rake::GemPackageTask.new(spec) do |p|
+  p.gem_spec = spec
+  p.need_tar = true
+  p.need_zip = true
+end
+
+desc 'Publish the beta gem'
+task :pgem => [:package] do
+  Rake::SshFilePublisher.new('pluginaweek@pluginaweek.org', '/home/pluginaweek/gems.pluginaweek.org/gems', 'pkg', "#{PKG_FILE_NAME}.gem").upload
+end
+
+desc 'Publish the API documentation'
+task :pdoc => [:rdoc] do
+  Rake::SshDirPublisher.new('pluginaweek@pluginaweek.org', "/home/pluginaweek/api.pluginaweek.org/#{PKG_NAME}", 'rdoc').upload
+end
+
+desc 'Publish the API docs and gem'
+task :publish => [:pdoc, :release]
+
+desc 'Publish the release files to RubyForge.'
+task :release => [:gem, :package] do
+  require 'rubyforge'
+  
+  ruby_forge = RubyForge.new
+  ruby_forge.login
+  
+  %w( gem tgz zip ).each do |ext|
+    file = "pkg/#{PKG_FILE_NAME}.#{ext}"
+    puts "Releasing #{File.basename(file)}..."
+    
+    ruby_forge.add_release(RUBY_FORGE_PROJECT, PKG_NAME, PKG_VERSION, file)
+  end
+end

data/init.rb

@@ -0,0 +1 @@
+require 'menu_helper'

data/lib/menu_helper/html_element.rb

@@ -0,0 +1,48 @@
+module PluginAWeek #:nodoc:
+  module Helpers #:nodoc:
+    module MenuHelper #:nodoc:
+      # Represents an HTML element
+      # 
+      # == Modifying HTML options
+      # 
+      # HTML options can normally be specified when creating the element.
+      # However, if they need to be modified after the element has been created,
+      # you can access the properties like so:
+      # 
+      #   m = Menu.new
+      #   m[:style] = 'display: none;'
+      # 
+      # or for a menu bar:
+      # 
+      #   b = MenuBar.new
+      #   b[:style] = 'display: none;'
+      class HtmlElement
+        include ActionView::Helpers::TagHelper
+        
+        delegate    :[],
+                    :[]=,
+                      :to => '@html_options'
+        
+        def initialize(html_options = {}) #:nodoc:
+          @html_options = html_options.symbolize_keys
+        end
+        
+        # Generates the html representing this element
+        def html
+          content_tag(tag_name, content, @html_options)
+        end
+        
+        private
+        # The name of the element tag to use (e.g. td, th, tr, etc.)
+        def tag_name
+          ''
+        end
+        
+        # The content that will be displayed inside of the tag
+        def content
+          ''
+        end
+      end
+    end
+  end
+end

data/lib/menu_helper/menu.rb

@@ -0,0 +1,101 @@
+require 'set_or_append'
+
+module PluginAWeek #:nodoc:
+  module Helpers #:nodoc:
+    module MenuHelper #:nodoc:
+      # Represents a single menu within a menu bar
+      class Menu < HtmlElement
+        include ActionView::Helpers::UrlHelper
+        
+        # The url where this menu is linked to
+        attr_reader :url_options
+        
+        # If there are submenus under this menu, they are stored in here
+        attr_reader :menu_bar
+        
+        # Allow submenus to be created
+        delegate    :menu,
+                      :to => :menu_bar
+        
+        def initialize(id, request_controller, parent = nil, *args) #:nodoc
+          id = id.to_s
+          @controller = @request_controller = request_controller
+          @parent = parent
+          @content = args.first.is_a?(String) ? args.shift : id.underscore.titleize
+          @url_options = args.shift || {}
+          super(args.shift || {})
+          
+          # Set the default html options
+          @html_options[:id] ||= id
+          
+          @menu_bar = MenuBar.new(@request_controller, {}, {:id => "#{self[:id]}_menubar"}, self)
+          
+          # Build the url for the menu
+          url, @url_options = build_url(@url_options)
+          @content = link_to(@content, url) if auto_link?
+          
+          yield self if block_given?
+        end
+        
+        # Should we try to automatically generate the link?
+        def auto_link?
+          !@url_options.is_a?(Hash) || !@url_options.include?(:auto_link)
+        end
+        
+        # Is this menu selected?  A menu is considered selected if it or any of
+        # its submenus are selected
+        def selected?
+          current_page?(@url_options) || @menu_bar.menus.any? {|menu| menu.selected?}
+        end
+        
+        # Builds the actual html of the menu
+        def build(last = false)
+          html = @content + @menu_bar.build
+          html_options = @html_options.dup
+          html_options.set_or_prepend(:class, 'selected') if selected?
+          html_options.set_or_prepend(:class, 'last') if last
+          
+          content_tag('li', html, html_options)
+        end
+        
+        private
+        # Builds the url based on the options provided in the construction of
+        # the menu
+        def build_url(options = {})
+          # Check if the name given for the menu is a named route
+          if options.blank? && route_options = (named_route(self[:id], @parent) || named_route(self[:id]))
+            options = route_options
+          elsif options.is_a?(Hash)
+            options[:controller] ||= find_controller(options)
+            options[:action] ||= self[:id] unless options[:controller] == self[:id]
+            options[:only_path] ||= false
+          end
+          
+          url = options.is_a?(Hash) ? url_for(options) : options
+          return url, options
+        end
+        
+        # Finds the most likely controller that this menu should link to, in
+        # order of:
+        # 1. The specified controller in the menu link options
+        # 2. The name of the menu (e.g. products = ProductsController)
+        # 3. The parent's controller
+        # 4. The request controller
+        def find_controller(options)
+          options[:controller] ||
+          (begin; "#{self[:id].camelize}Controller".constantize.controller_path; rescue; nil; end) ||
+          @parent && @parent.url_options[:controller] ||
+          @request_controller.params[:controller]
+        end
+        
+        # Finds the named route that is being linked to (if that route exists)
+        def named_route(name, parent = nil)
+          name = "#{parent[:id]}_#{name}" if parent
+          method_name = "hash_for_#{name}_url"
+          
+          @request_controller.send(method_name) if @request_controller.respond_to?(method_name)
+        end
+      end
+    end
+  end
+end

data/lib/menu_helper/menu_bar.rb

@@ -0,0 +1,142 @@
+module PluginAWeek #:nodoc:
+  module Helpers #:nodoc:
+    module MenuHelper #:nodoc:
+      # Represents a group of menus.  A menu bar can either be the main menu
+      # bar or a menu bar nested within a menu.
+      class MenuBar < HtmlElement
+        # The menus within this menu bar
+        attr_reader :menus
+        
+        def initialize(request_controller, options = {}, html_options = {}, parent_menu = nil) #:nodoc:
+          super(html_options)
+          
+          options.assert_valid_keys(:auto_set_ids)
+          options.reverse_merge!(:auto_set_ids => true)
+          @options = options
+          @request_controller = request_controller
+          @parent_menu = parent_menu
+          
+          @menus = []
+          
+          if @parent_menu
+            self[:id] ||= "#{@parent_menu[:id]}_menubar"
+          else
+            self[:id] ||= 'menubar'
+          end
+          
+          yield self if block_given?
+        end
+        
+        # Creates a new menu in this bar with the given id.  The content
+        # within the menu is, by default, set to a humanized version of the id.
+        # 
+        # == URLs with routes
+        # 
+        # If you have named routes setup in the application, the menu attempts
+        # to automatically figure out what URL you're trying to link to.  It
+        # does this by looking at the id of the menu and the id of its parent.
+        # 
+        # For example, a menu_bar with the id 'home' and a menu with the id
+        # 'contact_us' will attempt to look for the following named routes as
+        # the URL to link to (in order of priority):
+        # 1. contact_us_url
+        # 2. home_contact_us_url
+        # 
+        # Example routes.rb:
+        #   ActionController::Routing::Routes.draw do |map|
+        #     map.with_options(:controller => 'home') do |home|
+        #       home.home '', :action => 'index'
+        #       home.home_search 'search', :action => 'search'
+        #     end
+        #     
+        #     map.with_options(:controller => 'about_us') do |about_us|
+        #       about_us.about_us 'about_us', :action => 'index'
+        #     end
+        #   end
+        # 
+        # Example menubar:
+        #   menu :home do |home|
+        #     menu :about_us
+        #       #=> Links to about_us_url
+        #     menu :search
+        #       #=> Links to home_search_url
+        #   end
+        # 
+        # == URLs with url_for
+        # 
+        # If neither of these named routes are being used, the url will be based
+        # on the options passed into the menu.  The url_options takes the same
+        # values as +url_for+.  By default, the name of the controller will be
+        # guessed in the following order:
+        # 1. The id of the menu ('contact_us' => ContactUsController)
+        # 2. The controller of the parent menu/menu bar
+        # 3. The request controller
+        # 
+        # To override the default controller being linked to, you can explicitly
+        # define it like so:
+        #   menu :contact, 'Contact Us', {}, :controller => 'about_us'
+        # 
+        # Examples:
+        #   menu :home do |home|
+        #     menu :about, 'About Us', :action => 'about_us'
+        #       #=> Links to {:controller => 'home', :action => 'about_us'}
+        #     menu :who_we_are
+        #       #=> Links to {:controller => 'home', :action => 'who_we_are'}
+        #     menu :contact_us, 'Contact Us', :controller => 'contact', :action => 'index'
+        #       #=> Links to {:controller => 'contact', :action => 'index'}
+        #     menu :search
+        #       #=> Links to {:controller => 'search'}
+        #   end
+        # 
+        # You can also link to an explicit URL like so:
+        #   menu :search, 'http://www.google.com'
+        # 
+        # == Turning off links
+        # 
+        # If you don't want a menu to link to a URL, you can turn off linking like so:
+        #   menu :contact_us, 'Contact Us', {}, :auto_link => false
+        # 
+        # == Defining content and html attributes
+        # 
+        # By default, the content within a menu will be set as a humanized
+        # version of the menu's id.  Examples of menus which customize the
+        # content and/or html attributes are below:
+        # 
+        #   menu :contact
+        #     #=> <li id="contact"><a href="/contact">Contact</a></li>
+        #   menu :contact, 'Contact Us'
+        #     #=> <li id="contact"><a href="/contact">Contact Us</a></li>
+        #   menu :contact, :class => 'pretty'
+        #     #=> <li id="contact" class="pretty"><a href="/contact">Contact</a></li>
+        #   menu :contact, 'Contact Us', :class => 'pretty'
+        #     #=> <li id="contact" class="pretty"><a href="/contact">Contact Us</a></li>
+        # 
+        # == Submenus
+        # 
+        # Menus can also have their own submenus by passing in a block.  You can
+        # create submenus in the same manner that the main menus are created.
+        # For example,
+        # 
+        #   menu :about do |about|
+        #     about.menu :who_we_are
+        #     about.menu :contact_us
+        #   end
+        def menu(id, *args, &block)
+          menu = Menu.new(id, @request_controller, @parent_menu, *args, &block)
+          @menus << menu
+          
+          menu
+        end
+        
+        # Builds the actual html for the menu bar
+        def build
+          html = @menus.inject('') do |html, menu|
+            html << menu.build(@menus.last == menu)
+          end
+          
+          html.blank? ? html : content_tag('ul', html, @html_options)
+        end
+      end
+    end
+  end
+end

data/lib/menu_helper.rb

@@ -0,0 +1,78 @@
+require 'menu_helper/html_element'
+require 'menu_helper/menu_bar'
+require 'menu_helper/menu'
+
+module PluginAWeek #:nodoc:
+  module Helpers #:nodoc:
+    # Provides a builder for generating html menubars.  The structure of the
+    # menubars/menus is based on lists and should be styled using css. 
+    module MenuHelper
+      # Creates a new 1st-level menu bar.  The first parameter is the menubar's
+      # configuration options.  The second parameter is the menubar's html
+      # options.  Both of these parameters are optional.
+      # 
+      # Configuration options:
+      # * <tt>auto_set_id</tt> - Whether or not to automatically add ids to each menu.
+      # 
+      # Examples:
+      #   menu_bar {}, :id => 'menus', :class => 'pretty' do |main|
+      #     main.menu :home
+      #     main.menu :about_us do |about_us|
+      #       about_us.who_we_are
+      #       about_us.what_we_do
+      #       about_us.where_we_are
+      #       about_us.contact, 'Contact', 'mailto:contact@us.com'
+      #     end
+      #   end
+      #   #=>
+      #   <ul id="menus" class="pretty">
+      #     <li id="about_us">About Us
+      #       <ul id="about_us_menubar">
+      #         <li id="who_we_are"><a href="/about_us/who_we_are">Who We Are</a></li>
+      #         <li id="what_we_do"><a href="/about_us/what_we_do">What We Do</a></li>
+      #         <li id="contact"><a href="mailto:contact@us.com">Contact</a></li>
+      #       </ul>
+      #     </li>
+      #   </ul>
+      # 
+      # == Menu Selection
+      # 
+      # The currently selected menu is based on the current page that the user
+      # is currently on.  If the url that the menu links to is the same as the
+      # current page, then that menu will be selected.  This menu uses
+      # ActionView::Helpers::UrlHelper#current_page? to determine whether or not
+      # it is the currently selected menu.
+      # 
+      # If the menu that is selected is nested within another menu, then those
+      # menus will be selected as well.
+      # 
+      # A "selected" menu is indicated by an additional class html attribute
+      # that is added to the list item.
+      # 
+      # For example, if a submenu is selected, the html generated from the
+      # above full example would look like so:
+      # 
+      #   <ul id="menus" class="pretty">
+      #     <li id="about_us" class="selected">About Us
+      #       <ul id="about_us_menubar">
+      #         <li id="who_we_are" class="selected"><a href="/about_us/who_we_are">Who We Are</a></li>
+      #         <li id="what_we_do"><a href="/about_us/what_we_do">What We Do</a></li>
+      #         <li id="contact"><a href="mailto:contact@us.com">Contact</a></li>
+      #       </ul>
+      #     </li>
+      #   </ul>
+      # 
+      # == Menu Creation
+      # 
+      # For more information about how menus are created, see the documentation
+      # for MenuBar#menu.
+      def menu_bar(*args, &block)
+        MenuBar.new(@controller, *args, &block).build
+      end
+    end
+  end
+end
+
+ActionController::Base.class_eval do
+  helper PluginAWeek::Helpers::MenuHelper
+end

data/test/app_root/app/controllers/about_us_controller.rb

@@ -0,0 +1,2 @@
+class AboutUsController < ApplicationController
+end

data/test/app_root/app/controllers/contact_controller.rb

@@ -0,0 +1,2 @@
+class ContactController < ApplicationController
+end

data/test/app_root/app/controllers/home_controller.rb

@@ -0,0 +1,2 @@
+class HomeController < ApplicationController
+end

data/test/app_root/config/routes.rb

@@ -0,0 +1,15 @@
+ActionController::Routing::Routes.draw do |map|
+  # Home
+  map.with_options(:controller => 'home') do |home|
+    home.home '', :action => 'index'
+    home.home_search 'search_stuff', :action => 'search'
+  end
+  
+  # Contact
+  map.with_options(:controller => 'contact') do |contact|
+    contact.contact 'contact', :action => 'index'
+  end
+  
+  map.connect ':controller/:action/:id.:format'
+  map.connect ':controller/:action/:id'
+end

data/test/test_helper.rb

@@ -0,0 +1,18 @@
+$:.unshift("#{File.dirname(__FILE__)}/../../../ruby/hash/set_or_append/lib")
+
+# Load the plugin testing framework
+$:.unshift("#{File.dirname(__FILE__)}/../../../test/plugin_test_helper/lib")
+require 'rubygems'
+require 'plugin_test_helper'
+
+class Test::Unit::TestCase
+  def setup
+    request = ActionController::TestRequest.new
+    request.request_uri = '/contact'
+    request.path_parameters = {:action => 'index', :controller => 'contact'}
+    @controller = HomeController.new
+    @controller.request = request
+    @controller.instance_eval {@_params = request.path_parameters}
+    @controller.send(:initialize_current_url)
+  end
+end

data/test/unit/html_element_test.rb

@@ -0,0 +1,50 @@
+require File.dirname(__FILE__) + '/../test_helper'
+
+class HtmlElementTest < Test::Unit::TestCase
+  class DivElement < PluginAWeek::Helpers::MenuHelper::HtmlElement
+    def tag_name
+      'div'
+    end
+  end
+  
+  def test_html_options_on_initialization
+    e = PluginAWeek::Helpers::MenuHelper::HtmlElement.new('class' => 'fancy')
+    assert_equal 'fancy', e[:class]
+    
+    e = PluginAWeek::Helpers::MenuHelper::HtmlElement.new(:class => 'fancy')
+    assert_equal 'fancy', e[:class]
+  end
+  
+  def test_html_no_content
+    assert_equal '<></>', PluginAWeek::Helpers::MenuHelper::HtmlElement.new.html
+  end
+  
+  def test_html_with_content
+    e = DivElement.new
+    e.instance_eval do
+      def content
+        'hello world'
+      end
+    end
+    
+    assert_equal '<div>hello world</div>', e.html
+  end
+  
+  def test_html_with_html_options
+    e = DivElement.new
+    e[:class] = 'fancy'
+    
+    assert_equal '<div class="fancy"></div>', e.html
+  end
+  
+  def test_get_html_option
+    e = PluginAWeek::Helpers::MenuHelper::HtmlElement.new
+    assert_nil e[:class]
+  end
+  
+  def test_set_html_option
+    e = PluginAWeek::Helpers::MenuHelper::HtmlElement.new
+    e[:float] = 'left'
+    assert_equal 'left', e[:float]
+  end
+end

data/test/unit/menu_bar_test.rb

@@ -0,0 +1,60 @@
+require File.dirname(__FILE__) + '/../test_helper'
+
+class MenuBarTest < Test::Unit::TestCase
+  def test_should_raise_exception_if_invalid_option_specified
+    assert_raise(ArgumentError) {create_menu_bar(:invalid => true)}
+  end
+  
+  def test_should_have_no_menus_by_default
+    menu_bar = create_menu_bar
+    assert_equal [], menu_bar.menus
+  end
+  
+  def test_should_set_default_id_if_no_parent_specified
+    menu_bar = create_menu_bar
+    assert_equal 'menubar', menu_bar[:id]
+  end
+  
+  def test_should_set_default_id_based_on_parent_if_parent_specified
+    menu_bar = create_menu_bar({}, {}, PluginAWeek::Helpers::MenuHelper::Menu.new(:home, @controller))
+    assert_equal 'home_menubar', menu_bar[:id]
+  end
+  
+  def test_should_accept_block
+    in_block = false
+    menu_bar = create_menu_bar do |main_menu|
+      in_block = true
+    end
+    
+    assert in_block
+  end
+  
+  def test_should_create_menus
+    menu_bar = create_menu_bar do |main|
+      main.menu :home
+      main.menu :contact
+    end
+    
+    assert_equal 2, menu_bar.menus.size
+  end
+  
+  def test_should_build_menu_bar_and_menus
+    menu_bar = create_menu_bar do |main|
+      main.menu :home
+      main.menu :contact, 'Contact Us'
+    end
+    
+    expected = <<-eos
+<ul id="menubar">
+  <li id="home"><a href="http://test.host/">Home</a></li>
+  <li class="last selected" id="contact"><a href="http://test.host/contact">Contact Us</a></li>
+</ul>
+eos
+    assert_equal expected.gsub(/\n\s*/, ''), menu_bar.build
+  end
+  
+  private
+  def create_menu_bar(*args, &block)
+    PluginAWeek::Helpers::MenuHelper::MenuBar.new(@controller, *args, &block)
+  end
+end

data/test/unit/menu_helper_test.rb

@@ -0,0 +1,30 @@
+require File.dirname(__FILE__) + '/../test_helper'
+
+class MenuHelperTest < Test::Unit::TestCase
+  include PluginAWeek::Helpers::MenuHelper
+  
+  def test_should_build_menu_bar
+    menu_bar_html = menu_bar({}, :class => 'pretty') do |main|
+      main.menu :home do |home|
+        home.menu :browse
+        home.menu :search
+      end
+      main.menu :contact, 'Contact Us'
+      main.menu :about_us
+    end
+    
+    expected = <<-eos
+<ul class="pretty" id="menubar">
+  <li id="home"><a href="http://test.host/">Home</a>
+    <ul id="home_menubar">
+      <li id="browse"><a href="http://test.host/home/browse">Browse</a></li>
+      <li class="last" id="search"><a href="http://test.host/search_stuff">Search</a></li>
+    </ul>
+  </li>
+  <li class="selected" id="contact"><a href="http://test.host/contact">Contact Us</a></li>
+  <li class="last" id="about_us"><a href="http://test.host/about_us">About Us</a></li>
+</ul>
+eos
+    assert_equal expected.gsub(/\n\s*/, ''), menu_bar_html
+  end
+end

data/test/unit/menu_test.rb

@@ -0,0 +1,172 @@
+require File.dirname(__FILE__) + '/../test_helper'
+
+class MenuTest < Test::Unit::TestCase
+  def test_default_content_should_be_humanized_id
+    menu = create_menu(:home)
+    assert_equal '<li id="home"><a href="http://test.host/">Home</a></li>', menu.build
+  end
+  
+  def test_default_html_id_should_be_id
+    menu = create_menu(:home)
+    assert_equal 'home', menu[:id]
+  end
+  
+  def test_should_not_linkify_if_not_auto_linking
+    menu = create_menu(:home, nil, :auto_link => false)
+    assert_equal '<li id="home">Home</li>', menu.build
+  end
+  
+  def test_default_menubar_id_should_use_menu_id
+    menu = create_menu(:home, nil)
+    assert_equal 'home_menubar', menu.menu_bar[:id]
+  end
+  
+  def test_should_not_auto_link_if_auto_link_is_false
+    menu = create_menu(:home, nil, :auto_link => false)
+    assert !menu.auto_link?
+  end
+  
+  def test_should_auto_link_if_url_options_is_string
+    menu = create_menu(:home, nil, 'http://www.google.com')
+    assert menu.auto_link?
+  end
+  
+  def test_should_auto_link_if_url_options_is_hash_without_auto_link
+    menu = create_menu(:home, nil, {})
+    assert menu.auto_link?
+  end
+  
+  def test_should_be_selected_if_url_is_current_page
+    menu = create_menu(:contact)
+    assert menu.selected?
+  end
+  
+  def test_should_be_selected_if_submenu_is_selected
+    menu = create_menu(:home) do |home|
+      home.menu :contact
+    end
+    assert menu.selected?
+  end
+  
+  def test_should_be_selected_if_submenu_of_submenu_is_selected
+    menu = create_menu(:home) do |home|
+      home.menu :about_us do |about_us|
+        about_us.menu :contact
+      end
+    end
+    assert menu.selected?
+  end
+  
+  def test_should_not_be_selected_if_url_is_not_current_page
+    menu = create_menu(:home)
+    assert !menu.selected?
+  end
+  
+  def test_should_build_url_from_named_route_if_id_named_route_exists
+    menu = create_menu(:home)
+    expected = {:controller => 'home', :action => 'index', :only_path => false, :use_route => :home}
+    assert_equal expected, menu.url_options
+  end
+  
+  def test_should_build_url_from_named_route_if_id_and_parent_named_route_exists
+    parent = create_menu(:home)
+    menu = create_menu(:search, parent)
+    expected = {:controller => 'home', :action => 'search', :only_path => false, :use_route => :home_search}
+    assert_equal expected, menu.url_options
+  end
+  
+  def test_should_use_id_as_default_controller_if_controller_exists
+    menu = create_menu(:about_us)
+    expected = {:controller => 'about_us', :only_path => false}
+    assert_equal expected, menu.url_options
+  end
+  
+  def test_should_use_parent_controller_as_default_controller_if_id_controller_does_not_exist
+    create_menu(:home) do |home|
+      menu = home.menu :privacy_policy
+      expected = {:controller => 'home', :action => 'privacy_policy', :only_path => false}
+      assert_equal expected, menu.url_options
+    end
+  end
+  
+  def test_should_use_request_controller_as_default_controller_if_parent_and_id_controller_does_not_exist
+    menu = create_menu(:investors)
+    expected = {:controller => 'contact', :action => 'investors', :only_path => false}
+    assert_equal expected, menu.url_options
+  end
+  
+  def test_should_use_custom_value_if_controller_is_specified
+    menu = create_menu(:privacy_policy, nil, :controller => 'home')
+    expected = {:controller => 'home', :action => 'privacy_policy', :only_path => false}
+    assert_equal expected, menu.url_options
+  end
+  
+  def test_should_not_use_id_as_default_action_if_same_as_controller
+    menu = create_menu(:about_us, nil, :controller => 'about_us')
+    expected = {:controller => 'about_us', :only_path => false}
+    assert_equal expected, menu.url_options
+  end
+  
+  def test_should_use_custom_value_if_action_is_specified
+    menu = create_menu(:privacy_policy, nil, :controller => 'home', :action => 'privacy')
+    expected = {:controller => 'home', :action => 'privacy', :only_path => false}
+    assert_equal expected, menu.url_options
+  end
+  
+  def test_should_allow_string_urls
+    menu = create_menu(:search, nil, 'Search', 'http://www.google.com')
+    assert_equal 'http://www.google.com', menu.url_options
+  end
+  
+  def test_should_include_selected_class_in_html_if_selected
+    menu = create_menu(:contact)
+    assert_equal '<li class="selected" id="contact"><a href="http://test.host/contact">Contact</a></li>', menu.build
+  end
+  
+  def test_should_prepend_selected_class_if_class_attribute_already_exists
+    menu = create_menu(:contact, nil, {}, :class => 'pretty')
+    assert_equal '<li class="selected pretty" id="contact"><a href="http://test.host/contact">Contact</a></li>', menu.build
+  end
+  
+  def test_should_include_last_class_in_html_if_last_menu
+    menu = create_menu(:home)
+    assert_equal '<li class="last" id="home"><a href="http://test.host/">Home</a></li>', menu.build(true)
+  end
+  
+  def test_should_prepend_last_class_if_class_attribute_already_exists
+    menu = create_menu(:home, nil, {}, :class => 'pretty')
+    assert_equal '<li class="last pretty" id="home"><a href="http://test.host/">Home</a></li>', menu.build(true)
+  end
+  
+  def test_should_not_modify_html_options_after_building_menu
+    menu = create_menu(:home)
+    menu.build
+    assert_nil menu[:class]
+  end
+  
+  def test_should_include_submenus_if_submenus_exist
+    menu = create_menu(:home) do |home|
+      home.menu :about_us do |about_us|
+        about_us.menu :contact
+      end
+    end
+    
+    expected = <<-eos
+<li class="selected" id="home"><a href="http://test.host/">Home</a>
+  <ul id="home_menubar">
+    <li class="last selected" id="about_us"><a href="http://test.host/about_us">About Us</a>
+      <ul id="about_us_menubar">
+        <li class="last selected" id="contact"><a href="http://test.host/contact">Contact</a></li>
+      </ul>
+    </li>
+  </ul>
+</li>
+eos
+    assert_equal expected.gsub(/\n\s*/, ''), menu.build
+  end
+  
+  private
+  def create_menu(id, parent = nil, *args, &block)
+    PluginAWeek::Helpers::MenuHelper::Menu.new(id, @controller, parent, *args, &block)
+  end
+end

metadata

@@ -0,0 +1,71 @@
+--- !ruby/object:Gem::Specification 
+rubygems_version: 0.9.0
+specification_version: 1
+name: menu_helper
+version: !ruby/object:Gem::Version 
+  version: 0.0.1
+date: 2007-08-16 00:00:00 -04:00
+summary: Adds a helper method for generating a menubar
+require_paths: 
+- lib
+email: info@pluginaweek.org
+homepage: http://www.pluginaweek.org
+rubyforge_project: 
+description: 
+autorequire: menu_helper
+default_executable: 
+bindir: bin
+has_rdoc: true
+required_ruby_version: !ruby/object:Gem::Version::Requirement 
+  requirements: 
+  - - ">"
+    - !ruby/object:Gem::Version 
+      version: 0.0.0
+  version: 
+platform: ruby
+signing_key: 
+cert_chain: 
+post_install_message: 
+authors: 
+- Aaron Pfeifer, Neil Abraham
+files: 
+- lib/menu_helper.rb
+- lib/menu_helper
+- lib/menu_helper/html_element.rb
+- lib/menu_helper/menu_bar.rb
+- lib/menu_helper/menu.rb
+- test/test_helper.rb
+- test/app_root
+- test/unit
+- test/app_root/config
+- test/app_root/app
+- test/app_root/config/routes.rb
+- test/app_root/app/controllers
+- test/app_root/app/controllers/contact_controller.rb
+- test/app_root/app/controllers/about_us_controller.rb
+- test/app_root/app/controllers/home_controller.rb
+- test/unit/html_element_test.rb
+- test/unit/menu_test.rb
+- test/unit/menu_helper_test.rb
+- test/unit/menu_bar_test.rb
+- init.rb
+- MIT-LICENSE
+- Rakefile
+- README
+test_files: 
+- test/unit/html_element_test.rb
+- test/unit/menu_test.rb
+- test/unit/menu_helper_test.rb
+- test/unit/menu_bar_test.rb
+rdoc_options: []
+
+extra_rdoc_files: []
+
+executables: []
+
+extensions: []
+
+requirements: []
+
+dependencies: []
+