menu_helper 0.0.1 → 0.0.4

data/CHANGELOG

@@ -0,0 +1,31 @@
+*SVN*
+
+*0.0.4* (June 1st, 2008)
+
+* Remove dependency on set_or_append
+
+*0.0.3* (May 5th, 2008)
+
+* Updated documentation
+
+*0.0.2* (September 26th, 2007)
+
+* Add gem dependency on set_or_append
+
+* Convert dos newlines to unix newlines
+
+* Fix too many :nodoc: tags so that rdocs are generated properly
+
+*0.0.1* (August 16th, 2007)
+
+* Add README documentation
+
+* Add api documentation
+
+* Add dependency on plugin_test_helper in order to simplify the test setup code
+
+* Remove MainMenuBar in favor of providing a default id for MenuBar
+
+* Refactor helper classes into individual files
+
+* Add unit tests

data/MIT-LICENSE

@@ -1,4 +1,4 @@
-Copyright (c) 2006-2007 Aaron Pfeifer & Neil Abraham
+Copyright (c) 2006-2008 Aaron Pfeifer
 
 Permission is hereby granted, free of charge, to any person obtaining
 a copy of this software and associated documentation files (the
@@ -17,4 +17,4 @@ 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.
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README

@@ -1,29 +1,25 @@
 = menu_helper
 
-menu_helper adds a helper method for generating a menubar.
++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
+API
 
-* http://svn.pluginaweek.org/trunk/plugins/action_pack/menu_helper
+* http://api.pluginaweek.org/menu_helper
 
 Development
 
 * http://dev.pluginaweek.org/browser/trunk/plugins/action_pack/menu_helper
 
+Source
+
+* http://svn.pluginaweek.org/trunk/plugins/action_pack/menu_helper
+
 == Description
 
 The generation of a menubar's structure can often be a repetitive and unDRY
@@ -32,7 +28,7 @@ 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
+== Usage
 
 routes.rb:
   ActionController::Routing::Routes.draw do |map|
@@ -55,19 +51,19 @@ routes.rb:
     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'
+_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
+      main.menu :search, 'Search!', 'http://www.google.com', :class => 'ir'
+    end
   %>
 
 Output (formatted for sanity):
@@ -84,25 +80,26 @@ Output (formatted for sanity):
     <li class="search ir" id="search"><a href="http://www.google.com">Search!</a></li>
   </ul>
 
-== Using this plugin
+=== Caveat Emptor
 
 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.
+I wrote this plugin mostly as an educational/experimental piece, so I don't using
+this in a production application, but rather a prototype.
 
 == Testing
 
-This plugin requires that the plugin_test_helper gem be installed in order to
-run the unit tests.  To install this gem:
+To test this plugin, the following gems must be installed:
+* plugin_test_helper[http://wiki.pluginaweek.org/Plugin_test_helper]
+
+To run against a specific version of Rails:
 
-  gem install plugin_test_helper
+  rake test RAILS_FRAMEWORK_ROOT=/path/to/rails
 
 == Dependencies
 
-This plugin depends on the presence of the following plugins:
-# set_or_append - http://wiki.pluginaweek.org/Set_or_append
+* Rails 2.0 or later
+* set_or_append[http://wiki.pluginaweek.org/Set_or_append]

data/Rakefile

@@ -4,7 +4,7 @@ require 'rake/gempackagetask'
 require 'rake/contrib/sshpublisher'
 
 PKG_NAME           = 'menu_helper'
-PKG_VERSION        = '0.0.1'
+PKG_VERSION        = '0.0.4'
 PKG_FILE_NAME      = "#{PKG_NAME}-#{PKG_VERSION}"
 RUBY_FORGE_PROJECT = 'pluginaweek'
 
@@ -22,6 +22,7 @@ desc 'Generate documentation for the menu_helper plugin.'
 Rake::RDocTask.new(:rdoc) do |rdoc|
   rdoc.rdoc_dir = 'rdoc'
   rdoc.title    = 'MenuHelper'
+  rdoc.template = '../rdoc_template.rb'
   rdoc.options << '--line-numbers' << '--inline-source'
   rdoc.rdoc_files.include('README')
   rdoc.rdoc_files.include('lib/**/*.rb')
@@ -33,14 +34,14 @@ spec = Gem::Specification.new do |s|
   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.files           = FileList['{lib,test}/**/*'].to_a + %w(CHANGELOG 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.author          = 'Aaron Pfeifer'
+  s.email           = 'aaron@pluginaweek.org'
   s.homepage        = 'http://www.pluginaweek.org'
 end
   
@@ -52,22 +53,22 @@ 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
+  Rake::SshFilePublisher.new('aaron@pluginaweek.org', '/home/aaron/gems.pluginaweek.org/public/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
+  Rake::SshDirPublisher.new('aaron@pluginaweek.org', "/home/aaron/api.pluginaweek.org/public/#{PKG_NAME}", 'rdoc').upload
 end
 
 desc 'Publish the API docs and gem'
-task :publish => [:pdoc, :release]
+task :publish => [:pgem, :pdoc, :release]
 
 desc 'Publish the release files to RubyForge.'
 task :release => [:gem, :package] do
   require 'rubyforge'
   
-  ruby_forge = RubyForge.new
+  ruby_forge = RubyForge.new.configure
   ruby_forge.login
   
   %w( gem tgz zip ).each do |ext|

data/lib/menu_helper/html_element.rb

@@ -1,48 +1,46 @@
-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
+module PluginAWeek #:nodoc:
+  module MenuHelper
+    # 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

data/lib/menu_helper/menu.rb

@@ -1,101 +1,106 @@
-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
+module PluginAWeek #:nodoc:
+  module MenuHelper
+    # 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) || @url_options[: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 html(last = false)
+        html_options = @html_options.dup
+        html_options[:class] = (html_options[:class].to_s + ' selected').strip if selected?
+        html_options[:class] = (html_options[:class].to_s + ' last').strip if last
+        
+        content_tag(tag_name, content, html_options)
+      end
+      
+      private
+        def tag_name
+          'li'
+        end
+        
+        def content
+          content = @content
+          content << @menu_bar.html if @menu_bar.menus.any?
+          content
+        end
         
-        # 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
+        # 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[: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
+          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