menu_helper 0.0.5 → 0.1.0

data/lib/menu_helper/menu_bar.rb

@@ -1,47 +1,107 @@
 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.
+    # 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 css class to apply for all menu bars
+      cattr_accessor :menu_bar_class
+      @@menu_bar_class = 'menubar'
+      
+      # The css class to apply when a sub-menu bar is selected
+      cattr_accessor :selected_class
+      @@selected_class = 'menubar-selected'
+      
+      # The request context in which this menu bar is being rendered
+      attr_reader :request_controller
+      
       # The menus within this menu bar
       attr_reader :menus
       
-      def initialize(request_controller, options = {}, html_options = {}, parent_menu = nil) #:nodoc:
+      # The configuration options for this menu bar
+      attr_reader :options
+      
+      def initialize(request_controller, options = {}, html_options = {}) #:nodoc:
         super(html_options)
         
-        options.assert_valid_keys(:auto_set_ids)
-        options.reverse_merge!(:auto_set_ids => true)
+        # Set up default options
+        options.assert_valid_keys(:parent_menu, :auto_set_ids, :attach_active_submenus, :content_for)
+        options.reverse_merge!(:auto_set_ids => true, :attach_active_submenus => true, :content_for => 'menu_bar')
         @options = options
+        
+        # Set context of the menu bar (the request and any parent)
         @request_controller = request_controller
-        @parent_menu = parent_menu
         
+        # No menus initially associated
         @menus = []
         
-        if @parent_menu
-          self[:id] ||= "#{@parent_menu[:id]}_menubar"
-        else
-          self[:id] ||= 'menubar'
-        end
+        # Set up default html options
+        self[:class] = "#{self[:class]} #{menu_bar_class} #{menu_bar_class}-#{level}".strip
         
         yield self if block_given?
       end
       
+      # Gets the nesting level of this menu bar.  The top-level menu bar will
+      # always have a nesting level of 1.
+      def level
+        @level ||= begin
+          level = 1
+          
+          # Keep walking up the tree, until first-level menus are encountered
+          menu = parent_menu
+          while menu
+            level += 1
+            menu = menu.parent_menu
+          end
+          
+          level
+        end
+      end
+      
+      # The menu in which this menu bar is being displayed.  This will be nil if
+      # this is the main menu bar.
+      def parent_menu
+        @options[:parent_menu]
+      end
+      
+      # Shoulds elements have default ids automatically applied to them?
+      def auto_set_ids?
+        @options[:auto_set_ids]
+      end
+      
+      # Should menu bars in sub-menus be attached to this menu bar?
+      def attach_active_submenus?
+        @options[:attach_active_submenus]
+      end
+      
+      # The instance variable to use when rendering the current active sub-menu
+      # bar
+      def content_for_variable
+        "@content_for_#{@options[:content_for]}_level_#{level}"
+      end
+      
+      # Is this menu bar selected?  A menu bar is considered selected if it has
+      # a parent menu and that parent menu is selected.
+      def selected?
+        parent_menu && menus.any? {|menu| menu.selected?}
+      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
+      # If you have named routes set up 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
+      # 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
+      # 1. home_contact_us_url
+      # 2. contact_us_url
       # 
       # Example routes.rb:
+      # 
       #   ActionController::Routing::Routes.draw do |map|
       #     map.with_options(:controller => 'home') do |home|
       #       home.home '', :action => 'index'
@@ -53,12 +113,11 @@ module PluginAWeek #:nodoc:
       #     end
       #   end
       # 
-      # Example menubar:
-      #   menu :home do |home|
-      #     menu :about_us
-      #       #=> Links to about_us_url
-      #     menu :search
-      #       #=> Links to home_search_url
+      # Example menu bar:
+      # 
+      #   menu_bar :home do |home|
+      #     home.menu :about_us   # => Links to about_us_url
+      #     home.menu :search     # => Links to home_search_url
       #   end
       # 
       # == URLs with url_for
@@ -73,27 +132,27 @@ module PluginAWeek #:nodoc:
       # 
       # To override the default controller being linked to, you can explicitly
       # define it like so:
-      #   menu :contact, 'Contact Us', {}, :controller => 'about_us'
+      #   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'}
+      #     home.menu :about, 'About Us', :action => 'about_us'                       # => Links to {:controller => 'home', :action => 'about_us'}
+      #     home.menu :who_we_are                                                     # => Links to {:controller => 'home', :action => 'who_we_are'}
+      #     home.menu :contact_us, :controller => 'contact', :action => 'index'  # => Links to {:controller => 'contact', :action => 'index'}
+      #     home.menu :search                                                         # => Links to {:controller => 'search'}
       #   end
       # 
       # You can also link to an explicit URL like so:
-      #   menu :search, 'http://www.google.com'
+      # 
+      #   home.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
+      # If you don't want a menu to link to a URL, you can turn off linking like
+      # so:
+      # 
+      #   home.menu :contact_us, {}, :link => false
       # 
       # == Defining content and html attributes
       # 
@@ -101,41 +160,45 @@ module PluginAWeek #:nodoc:
       # 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>
+      #   home.menu :contact                                          # => <li id="contact"><a href="/contact">Contact</a></li>
+      #   home.menu :contact, 'Contact Us'                            # => <li id="contact"><a href="/contact">Contact Us</a></li>
+      #   home.menu :contact, {}, :class => 'pretty'                  # => <li id="contact" class="pretty"><a href="/contact">Contact</a></li>
+      #   home.menu :contact, 'Get in touch!', {}, :class => 'pretty' # => <li id="contact" class="pretty"><a href="/contact">Contact Us</a></li>
       # 
-      # == Submenus
+      # == Sub-menus
       # 
-      # 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.
+      # Menus can also have their own sub-menus by passing in a block.  You can
+      # create sub-menus in the same manner that the main menus are created.
       # For example,
       # 
-      #   menu :about do |about|
+      #   home.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)
+      def menu(id, content = nil, url_options = {}, html_options = {}, &block)
+        menu = Menu.new(self, id, content, url_options, html_options, &block)
         @menus << menu
         
         menu
       end
       
+      # Builds the actual html of the menu bar
+      def html
+        html_options = @html_options.dup
+        html_options[:class] = "#{html_options[:class]} #{selected_class}".strip if selected?
+        
+        content_tag(tag_name, content, html_options)
+      end
+      
       private
+        # Unordered list
         def tag_name
           'ul'
         end
         
+        # Generate the html for the menu bar
         def content
-          @menus.inject('') do |html, menu|
-            html << menu.html(@menus.last == menu)
-          end
+          @menus.inject('') {|html, menu| html << menu.html(@menus.last == menu)}
         end
     end
   end

data/test/app_root/config/routes.rb

@@ -1,15 +1,3 @@
 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/helpers/menu_helper_test.rb

@@ -0,0 +1,30 @@
+require File.expand_path(File.dirname(__FILE__) + '/../test_helper')
+
+class MenuHelperTest < ActionView::TestCase
+  tests PluginAWeek::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 menubar menubar-1">
+  <li><a href="http://test.host/home"><span>Home</span></a>
+    <ul class="menubar menubar-2">
+      <li><a href="http://test.host/home/browse"><span>Browse</span></a></li>
+      <li class="menubar-last"><a href="http://test.host/home/search"><span>Search</span></a></li>
+    </ul>
+  </li>
+  <li class="menubar-selected"><a href="http://test.host/contact"><span>Contact Us</span></a></li>
+  <li class="menubar-last"><a href="http://test.host/about_us"><span>About Us</span></a></li>
+</ul>
+eos
+    assert_equal expected.gsub(/\n\s*/, ''), menu_bar_html
+  end
+end

data/test/test_helper.rb

@@ -3,14 +3,19 @@ $:.unshift("#{File.dirname(__FILE__)}/../../plugin_test_helper/lib")
 require 'rubygems'
 require 'plugin_test_helper'
 
-class Test::Unit::TestCase
+Test::Unit::TestCase.class_eval do
   def setup
     request = ActionController::TestRequest.new
     request.request_uri = '/contact'
     request.path_parameters = {:action => 'index', :controller => 'contact'}
-    @controller = HomeController.new
+    
+    @controller = ContactController.new
     @controller.request = request
     @controller.instance_eval {@_params = request.path_parameters}
     @controller.send(:initialize_current_url)
   end
+  
+  def teardown
+    ActionController::Routing::Routes.load!
+  end
 end

data/test/unit/html_element_test.rb

@@ -1,4 +1,4 @@
-require File.dirname(__FILE__) + '/../test_helper'
+require File.expand_path(File.dirname(__FILE__) + '/../test_helper')
 
 class HtmlElementByDefaultTest < Test::Unit::TestCase
   def setup

data/test/unit/menu_bar_test.rb

@@ -1,72 +1,315 @@
-require File.dirname(__FILE__) + '/../test_helper'
+require File.expand_path(File.dirname(__FILE__) + '/../test_helper')
 
 class MenuBarByDefaultTest < Test::Unit::TestCase
   def setup
     super
+    
     @menu_bar = PluginAWeek::MenuHelper::MenuBar.new(@controller)
   end
   
-  def test_should_have_no_menus_by_default
+  def test_should_have_no_menus
     assert_equal [], @menu_bar.menus
   end
   
-  def test_should_set_default_id_if_no_parent_specified
-    assert_equal 'menubar', @menu_bar[:id]
+  def test_should_have_a_request_controller
+    assert_equal @controller, @menu_bar.request_controller
+  end
+  
+  def test_should_have_options
+    expected = {
+      :auto_set_ids => true,
+      :attach_active_submenus => true,
+      :content_for => 'menu_bar'
+    }
+    assert_equal expected, @menu_bar.options
+  end
+  
+  def test_should_have_a_level
+    assert_equal 1, @menu_bar.level
+  end
+  
+  def test_should_not_have_a_parent_menu
+    assert_nil @menu_bar.parent_menu
+  end
+  
+  def test_should_auto_set_ids
+    assert @menu_bar.auto_set_ids?
+  end
+  
+  def test_should_attach_active_submenus
+    assert @menu_bar.attach_active_submenus?
+  end
+  
+  def test_should_have_a_content_for_variable
+    assert_equal '@content_for_menu_bar_level_1', @menu_bar.content_for_variable
+  end
+  
+  def test_should_not_be_selected
+    assert !@menu_bar.selected?
+  end
+  
+  def test_should_set_css_classes
+    assert_equal 'menubar menubar-1', @menu_bar[:class]
+  end
+  
+  def test_should_allow_css_classes_to_be_customized
+    @original_menu_bar_class = PluginAWeek::MenuHelper::MenuBar.menu_bar_class
+    PluginAWeek::MenuHelper::MenuBar.menu_bar_class = 'menus'
+    
+    menu_bar = PluginAWeek::MenuHelper::MenuBar.new(@controller)
+    assert_equal 'menus menus-1', menu_bar[:class]
+  ensure
+    PluginAWeek::MenuHelper::MenuBar.menu_bar_class = @original_menu_bar_class
+  end
+  
+  def test_should_not_set_id
+    assert_nil @menu_bar[:id]
   end
 end
 
 class MenuBarTest < Test::Unit::TestCase
+  def setup
+    super
+    
+    @menu_bar = PluginAWeek::MenuHelper::MenuBar.new(@controller)
+  end
+  
   def test_should_raise_exception_if_invalid_option_specified
-    assert_raise(ArgumentError) {create_menu_bar(:invalid => true)}
+    assert_raise(ArgumentError) {PluginAWeek::MenuHelper::MenuBar.new(@controller, :invalid => true)}
   end
   
   def test_should_accept_block
     in_block = false
-    menu_bar = create_menu_bar do |main_menu|
+    menu_bar = PluginAWeek::MenuHelper::MenuBar.new(@controller) do |menu_bar|
       in_block = true
     end
     
     assert in_block
   end
   
-  def test_should_create_menus
-    menu_bar = create_menu_bar do |main|
+  def test_should_not_modify_html_options_after_building_hml
+    @menu_bar.html
+    assert_equal 'menubar menubar-1', @menu_bar[:class]
+  end
+  
+  def test_should_allow_menus_to_be_created
+    @menu = @menu_bar.menu(:home) do |menu_bar|
+      @sub_menu_bar = menu_bar
+    end
+    
+    assert_equal @menu, @sub_menu_bar.parent_menu
+    assert_equal [@menu], @menu_bar.menus
+  end
+end
+
+class MenuBarWithoutMenusTest < Test::Unit::TestCase
+  def setup
+    super
+    
+    @menu_bar = PluginAWeek::MenuHelper::MenuBar.new(@controller)
+  end
+  
+  def test_should_not_have_any_menus
+    assert @menu_bar.menus.empty?
+  end
+  
+  def test_should_not_be_selected
+    assert !@menu_bar.selected?
+  end
+  
+  def test_should_not_render_menus
+    assert_equal '<ul class="menubar menubar-1"></ul>', @menu_bar.html
+  end
+end
+
+class MenuBarWithCustomHtmlOptionsTest < Test::Unit::TestCase
+  def setup
+    super
+    
+    @menu_bar = PluginAWeek::MenuHelper::MenuBar.new(@controller, {}, :id => 'menus', :class => 'pretty')
+  end
+  
+  def test_should_render_with_custom_options
+    assert_equal '<ul class="pretty menubar menubar-1" id="menus"></ul>', @menu_bar.html
+  end
+end
+
+class MenuBarWithCustomContentForTest < Test::Unit::TestCase
+  def setup
+    super
+    
+    @menu_bar = PluginAWeek::MenuHelper::MenuBar.new(@controller, :content_for => 'menus')
+  end
+  
+  def test_should_have_a_content_for_variable_based_on_options
+    assert_equal '@content_for_menus_level_1', @menu_bar.content_for_variable
+  end
+end
+
+class MenuBarWithMenusTest < Test::Unit::TestCase
+  def setup
+    super
+    
+    @menu_bar = PluginAWeek::MenuHelper::MenuBar.new(@controller, {}, :id => 'menus') do |main|
       main.menu :home
-      main.menu :contact
+      main.menu :about_us, 'About'
     end
+  end
+  
+  def test_should_render_menus
+    expected = <<-eos
+<ul class="menubar menubar-1" id="menus">
+  <li id="menus-home"><a href="http://test.host/home"><span>Home</span></a></li>
+  <li class="menubar-last" id="menus-about_us"><a href="http://test.host/about_us"><span>About</span></a></li>
+</ul>
+eos
+    assert_equal expected.gsub(/\n\s*/, ''), @menu_bar.html
+  end
+end
+
+class MenuBarWithSelectedMenuTest < Test::Unit::TestCase
+  def setup
+    super
     
-    assert_equal 2, menu_bar.menus.size
+    @menu_bar = PluginAWeek::MenuHelper::MenuBar.new(@controller) do |main|
+      main.menu :contact
+    end
+  end
+  
+  def test_should_not_be_selected
+    assert !@menu_bar.selected?
   end
   
-  def test_should_build_menu_bar_and_menus
-    menu_bar = create_menu_bar do |main|
+  def test_should_not_include_selected_css_class_in_html
+    expected = <<-eos
+<ul class="menubar menubar-1">
+  <li class="menubar-selected menubar-last"><a href="http://test.host/contact"><span>Contact</span></a></li>
+</ul>
+eos
+    assert_equal expected.gsub(/\n\s*/, ''), @menu_bar.html
+  end
+end
+
+class MenuBarWithoutAutoIdSettingTest < Test::Unit::TestCase
+  def setup
+    super
+    
+    @menu_bar = PluginAWeek::MenuHelper::MenuBar.new(@controller, {:auto_set_ids => false}, :id => 'menus') do |main|
       main.menu :home
-      main.menu :contact, 'Contact Us'
     end
+  end
+  
+  def test_should_not_set_default_id_for_menus
+    expected = <<-eos
+<ul class="menubar menubar-1" id="menus">
+  <li class="menubar-last"><a href="http://test.host/home"><span>Home</span></a></li>
+</ul>
+eos
+    assert_equal expected.gsub(/\n\s*/, ''), @menu_bar.html
+  end
+end
+
+class MenuBarUnselectedWithDetachedActiveSubmenus < Test::Unit::TestCase
+  def setup
+    super
     
+    @menu_bar = PluginAWeek::MenuHelper::MenuBar.new(@controller, :attach_active_submenus => false) do |main|
+      main.menu :home do |home|
+        home.menu :about_us
+      end
+    end
+  end
+  
+  def test_should_render_sub_menu_bars
     expected = <<-eos
-<ul id="menubar">
-  <li id="home"><a href="http://test.host/">Home</a></li>
-  <li class="selected last" id="contact"><a href="http://test.host/contact">Contact Us</a></li>
+<ul class="menubar menubar-1">
+  <li class="menubar-last"><a href="http://test.host/home"><span>Home</span></a>
+    <ul class="menubar menubar-2">
+      <li class="menubar-last"><a href="http://test.host/about_us"><span>About Us</span></a></li>
+    </ul>
+  </li>
 </ul>
 eos
-    assert_equal expected.gsub(/\n\s*/, ''), menu_bar.html
+    assert_equal expected.gsub(/\n\s*/, ''), @menu_bar.html
   end
   
-  private
-    def create_menu_bar(*args, &block)
-      PluginAWeek::MenuHelper::MenuBar.new(@controller, *args, &block)
+  def test_should_not_store_a_menu_bar_in_content_variable
+    assert !@controller.instance_variable_defined?('@content_for_menu_bar_level_2')
+  end
+end
+
+class MenuBarSelectedWithDetachedActiveSubmenus < Test::Unit::TestCase
+  def setup
+    super
+    
+    @menu_bar = PluginAWeek::MenuHelper::MenuBar.new(@controller, :attach_active_submenus => false) do |main|
+      main.menu :contact do |contact|
+        contact.menu :investors
+      end
     end
+  end
+  
+  def test_should_not_render_sub_menu_bars
+    expected = <<-eos
+<ul class="menubar menubar-1">
+  <li class="menubar-selected menubar-last"><a href="http://test.host/contact"><span>Contact</span></a></li>
+</ul>
+eos
+    assert_equal expected.gsub(/\n\s*/, ''), @menu_bar.html
+  end
+  
+  def test_should_store_a_menu_bar_in_content_variable
+    # Generate the html to store it in the variable
+    @menu_bar.html
+    
+    expected = <<-eos
+<ul class="menubar menubar-2">
+  <li class="menubar-last"><a href="http://test.host/contact/investors"><span>Investors</span></a></li>
+</ul>
+eos
+    assert_equal expected.gsub(/\n\s*/, ''), @controller.instance_variable_get('@content_for_menu_bar_level_2')
+  end
 end
 
-class MenuBarWithParentTest < Test::Unit::TestCase
+class MenuBarWithParentMenuTest < Test::Unit::TestCase
   def setup
     super
-    parent = PluginAWeek::MenuHelper::Menu.new(:home, @controller)
-    @menu_bar = PluginAWeek::MenuHelper::MenuBar.new(@controller, {}, {}, parent)
+    
+    @parent_menu_bar = PluginAWeek::MenuHelper::MenuBar.new(@controller)
+    @parent_menu = PluginAWeek::MenuHelper::Menu.new(@parent_menu_bar, :home) 
+    @menu_bar = PluginAWeek::MenuHelper::MenuBar.new(@controller, :parent_menu => @parent_menu)
+  end
+  
+  def test_should_have_a_parent_menu
+    assert_equal @parent_menu, @menu_bar.parent_menu
   end
   
-  def test_should_set_default_id_based_on_parent
-    assert_equal 'home_menubar', @menu_bar[:id]
+  def test_should_have_level
+    assert_equal 2, @menu_bar.level
+  end
+end
+
+class MenuBarWithParentMenuAndSelectedMenuTest < Test::Unit::TestCase
+  def setup
+    super
+    
+    @parent_menu_bar = PluginAWeek::MenuHelper::MenuBar.new(@controller)
+    @parent_menu = PluginAWeek::MenuHelper::Menu.new(@parent_menu_bar, :about_us) 
+    @menu_bar = PluginAWeek::MenuHelper::MenuBar.new(@controller, :parent_menu => @parent_menu) do |about_us|
+      about_us.menu :contact
+    end
+  end
+  
+  def test_should_be_selected
+    assert @menu_bar.selected?
+  end
+  
+  def test_should_include_selected_css_class_in_html
+    expected = <<-eos
+<ul class="menubar menubar-2 menubar-selected">
+  <li class="menubar-selected menubar-last"><a href="http://test.host/contact"><span>Contact</span></a></li>
+</ul>
+eos
+    assert_equal expected.gsub(/\n\s*/, ''), @menu_bar.html
   end
 end