dynamic_menu 1.0.2 → 2.0.0

data/Manifest

@@ -1,4 +1,4 @@
-README.rdoc
+README.md
 Rakefile
 lib/dynamic_menu.rb
 Manifest

data/README.md

@@ -0,0 +1,57 @@
+# Dynamic Menu
+
+This gem provides an easy way to generate a menu that changes according to the controller 
+action.  It stores everything in an array which can later be accessed via the view.
+
+#Getting Help
+
+*Email me directly at support@pessetto.com and I will see what I can do
+
+#Installation
+
+The latest version, and probably the best to use, is 2.0.0 which no longer requires you to
+manually declare the array.  To install just put the following in your Gemfile and run 
+bundle install or bundle update:
+
+```ruby
+gem 'dynamic_menu','~>2.0.0'
+```
+
+Note: This gem was developed for Rails 3 and will most not work with anything under Rails 3.
+
+##Getting Started
+
+This gem features an engine that will automatically load it into your controllers.  However,
+you will need to include in your views
+
+```erb
+<% @actionMenuItems.each do |menuitem|%>
+
+<%= menuitem %>
+
+<%end%>
+```
+
+Note: your array must be @actionMenuItems, do not define this in the controller, the Gem will
+do it automatically for you unless you are using a pre-2.0 release.
+
+To add a link in your menu from your controller it is just a matter of using newmenuitem()
+Example
+
+```ruby
+def index
+
+#...code here
+
+newmenuitem("New Thing",new_thing_path)
+
+#...code here
+```
+
+##Functions
+There is only one function, newmenuitem, that this gem currently has, but can have various
+values sent to it.
+
+* newmenuitem(<string>name,<string>link) provides a regular get link to to link and displays name on the menu
+* newmenuitem(<string>name,<string>link,:delete,<string>confirm) will send a delete request to link with the confirmation message of confirm
+* newmenuitem(<string>name,:submit) will create a link to submit the form on the page assumming you don't want the regular button and listen for an enter via JavaScript

data/dynamic_menu.gemspec

@@ -2,15 +2,15 @@
 
 Gem::Specification.new do |s|
   s.name = %q{dynamic_menu}
-  s.version = "1.0.2"
+  s.version = "2.0.0"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 1.2") if s.respond_to? :required_rubygems_version=
   s.authors = [%q{Travis Pessettto}]
   s.date = %q{2011-08-12}
   s.description = %q{Allow the creation of Menus}
   s.email = %q{travis@pessetto.com}
-  s.extra_rdoc_files = [%q{README.rdoc}, %q{lib/dynamic_menu.rb}]
-  s.files = [%q{README.rdoc}, %q{Rakefile}, %q{lib/dynamic_menu.rb},%q{lib/engine.rb}, %q{Manifest}, %q{dynamic_menu.gemspec}]
+  s.extra_rdoc_files = [%q{README.md}, %q{lib/dynamic_menu.rb}]
+  s.files = [%q{README.md}, %q{Rakefile}, %q{lib/dynamic_menu.rb},%q{lib/engine.rb}, %q{Manifest}, %q{dynamic_menu.gemspec}]
   s.homepage = %q{http://pessetto.com}
   s.rdoc_options = [%q{--line-numbers}, %q{--inline-source}, %q{--title}, %q{Dynamic_menu}, %q{--main}, %q{README.rdoc}]
   s.require_paths = [%q{lib}]

data/lib/dynamic_menu.rb

@@ -3,6 +3,9 @@ module DynamicMenu
   
   module MenuItems
     def newmenuitem(name,link,method=:get,confirm="Are you sure?")
+      if !defined?(@actionMenuItems)
+        @actionMenuItems = Array.new
+      end
       genlink = ""
       
       if method==:delete
@@ -31,10 +34,9 @@ module DynamicMenu
        else
           genlink = "<a href=\"#{link}\">#{name}</a>".html_safe
       end      
-      return genlink
+      @actionMenuItems << genlink
     end
     
     
-    
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: dynamic_menu
 version: !ruby/object:Gem::Version
-  version: 1.0.2
+  version: 2.0.0
   prerelease: 
 platform: ruby
 authors:
@@ -16,10 +16,10 @@ email: travis@pessetto.com
 executables: []
 extensions: []
 extra_rdoc_files:
-- README.rdoc
+- README.md
 - lib/dynamic_menu.rb
 files:
-- README.rdoc
+- README.md
 - Rakefile
 - lib/dynamic_menu.rb
 - lib/engine.rb

data/README.rdoc

@@ -1,30 +0,0 @@
-=DYNAMIC MENU
-
-Dynamic Menu is a Gem that provides a way to make it easy to create a menu that changes according
-to the controller action.  The controller passes in information into an array which is accessed by
-the view.
-
-==Installation
-While pre-1.0 releases exits we recommend not using them as the code in them is not the best
-and will not auto-load into your controller, they will not be commented on here.
-
-In your Gemfile make sure you have
-
-gem 'dynamic_menu','~>1.0.0'
-
-then run bundle install
-
-==How to use
-To use DynamicMenu you need to create an array such as @MenuItems and store items in it.
-So in your controller in each method you can do something like:
-
-@MenuItems = Array.new
-
-@MenuItems << newmenuitem("name","link")
-
-newmenuitem() is the method you need to use to add a menu-item.
-
-newmenuitem has the arguments of name, link, method, and confirm.  Method and confirm only
-need to be specified if you are using anything other than get.  Link may use :submit which
-will submit a form when clicked and add a JavaScript method to listen for the enter key to
-submit the form.  Name and Link are the only required fields and are both Strings...