menu_helper 0.0.1 → 0.0.4

data/lib/menu_helper/menu_bar.rb

@@ -1,142 +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
+module PluginAWeek #:nodoc:
+  module MenuHelper
+    # 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
+      
+      private
+        def tag_name
+          'ul'
+        end
+        
+        def content
+          @menus.inject('') do |html, menu|
+            html << menu.html(@menus.last == menu)
+          end
+        end
+    end
+  end
 end

data/lib/menu_helper.rb

@@ -2,77 +2,76 @@ 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
+module PluginAWeek #: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:
+    # * +auto_set_id+ - 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).html
+    end
+  end
+end
+
+ActionController::Base.class_eval do
+  helper PluginAWeek::MenuHelper
 end

data/test/app_root/log/in_memory.log

@@ -0,0 +1 @@
+# Logfile created on Sun May 11 12:49:09 -0400 2008

data/test/test_helper.rb

@@ -1,7 +1,5 @@
-$:.unshift("#{File.dirname(__FILE__)}/../../../ruby/hash/set_or_append/lib")
-
 # Load the plugin testing framework
-$:.unshift("#{File.dirname(__FILE__)}/../../../test/plugin_test_helper/lib")
+$:.unshift("#{File.dirname(__FILE__)}/../../plugin_test_helper/lib")
 require 'rubygems'
 require 'plugin_test_helper'
 

data/test/unit/html_element_test.rb

@@ -1,50 +1,74 @@
-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
+require File.dirname(__FILE__) + '/../test_helper'
+
+class HtmlElementByDefaultTest < Test::Unit::TestCase
+  def setup
+    @element = PluginAWeek::MenuHelper::HtmlElement.new
+  end
+  
+  def test_should_generate_an_empty_tag
+    assert_equal '<></>', @element.html
+  end
+  
+  def test_not_have_any_html_options
+    element = PluginAWeek::MenuHelper::HtmlElement.new
+    assert_nil element[:class]
+  end
+end
+
+class HtmlElementTest < Test::Unit::TestCase
+  class DivElement < PluginAWeek::MenuHelper::HtmlElement
+    def tag_name
+      'div'
+    end
+  end
+  
+  def test_should_set_html_options_on_initialization
+    element = PluginAWeek::MenuHelper::HtmlElement.new(:class => 'fancy')
+    assert_equal 'fancy', element[:class]
+  end
+  
+  def test_should_symbolize_html_options
+    element = PluginAWeek::MenuHelper::HtmlElement.new('class' => 'fancy')
+    assert_equal 'fancy', element[:class]
+  end
+  
+  def test_should_generate_entire_element_if_content_and_tag_name_specified
+    element = DivElement.new
+    element.instance_eval do
+      def content
+        'hello world'
+      end
+    end
+    
+    assert_equal '<div>hello world</div>', element.html
+  end
+  
+  def test_should_include_html_options_in_element_tag
+    element = DivElement.new
+    element[:class] = 'fancy'
+    
+    assert_equal '<div class="fancy"></div>', element.html
+  end
+  
+  def test_should_save_changes_in_html_options
+    element = PluginAWeek::MenuHelper::HtmlElement.new
+    element[:float] = 'left'
+    assert_equal 'left', element[:float]
+  end
+end
+
+class HtmlElementWithNoContentTest < Test::Unit::TestCase
+  class DivElement < PluginAWeek::MenuHelper::HtmlElement
+    def tag_name
+      'div'
+    end
+  end
+  
+  def setup
+    @element = DivElement.new
+  end
+  
+  def test_should_generate_empty_tags
+    assert_equal '<div></div>', @element.html
+  end
 end