listy 0.0.3 → 0.0.4

data/.rvmrc

@@ -0,0 +1,2 @@
+rvm use ruby-1.9.3-p125
+rvm gemset use listy

data/README.md

@@ -29,28 +29,75 @@ Listy also includes some Javascript assets, so be sure to add the following line
 
 There are a couple of helper methods including:
 
-	listy_links(collection, display_method_name, css_class, show_more_index=5, empty_message="")
+### listy_links
 
-This method creates a simple unordered list of the elements in the collection.
+	listy_links(collection, display_method_name, options={})
 
-	multi_column_listy_links(collection, display_method_name, css_class, number_of_columns)
+This method creates a simple unordered list of the elements in the collection. This is suitable for Ruby on Rails models.
+
+Options you can pass in include
+
+* :css_class - The class that is applied to the resulting ul list element
+* :empty_message - The message that is displayed if the collection is empty
+* :show_more - If set to true, the list will display only the first 10 elements, and hide the rest and create a "Show More" link. Be sure to have `//= require listy` in your application.js for the "Show More" link to work.
+* :show_more_limit - If you want more that the first 10 elements to show when show_more is set to true, then specify that limit here.
+
+Examples
+
+```ruby
+	<%= listy_links BlogPost.all, :title %>
+	
+	<%= listy_links User.all, :email, :show_more => true %>
+	
+	<%= listy_links Product.all, :part_number, :show_more => true, :show_more_limit => 100, :css_class => "products-list" %>
+```
+### multi_column_listy_links
+
+	multi_column_listy_links(collection, display_method_name, number_of_columns, options={})
 
 This does the same thing as listy_links but presents it in the number of columns you specify.
 
-	listy_tree(collection, spec, empty_message)
+Options you can pass in include:
+
+* :css_class - The class that is applied to the resulting ul list elements in each column
+* :empty_message - The message that is displayed if the collection is empty
+
+Examples
+
+```ruby
+	<%= listy_links BlogPost.all, :title %>
+	
+	<%= listy_links User.all, :email, :show_more => true %>
+	
+	<%= listy_links Product.all, :part_number, :show_more => true, :show_more_limit => 100, :css_class => "products-list" %>
+```
+
+### listy_tree
+
+	listy_tree(collection, spec, options={})
 
 This method is for creating a nested tree of unordered lists for a collection with nested collections. This is suitable for Rails models that have has_many relationships.
+The spec is basically instructions on how to create the nested tree. It is a nested hash where each child specifies how to create the nested list
 
 Example let's say we have the following
 
 * Country which has_many States
 * State which has_many Cities
 
-Typical usage would be:
+Examples:
 
-	listy_tree(Country.all, {:display_method_name => :name, :children => :states, :child => { :display_method_name => :name, :children => :cities, :child => {:display_method_name => :name, :children => nil, :child => nil}}}, "")
+```ruby
+	listy_tree(Country.all, 
+				{ :display_method_name => :name, 
+				  :children => :states, 
+				  :child => { :display_method_name => :name, 
+							  :children => :cities, 
+							  :child => { :display_method_name => :name }
+							}
+				 })
+```
 
-Be sure that the inner most child of the spec has :children => nil. This will stop the nesting.
+Be sure that the inner most child of the spec has :children => nil (or just leave it undefined). This will stop the nesting.
 
 
 ## Contributing

data/lib/listy/version.rb

@@ -1,3 +1,3 @@
 module Listy
-  VERSION = "0.0.3"
+  VERSION = "0.0.4"
 end

data/lib/listy/view_helpers.rb

@@ -1,54 +1,49 @@
 module Listy
   module ViewHelpers
  
-    def listy_tree(collection, spec, empty_message)
+    def listy_tree(collection, spec, options={})
       if collection.present?
         html = "<div class='listy-tree'>" + create_listy_tree(collection, spec, "", 0) + "</div>"
       else
         html = "There are no entries in this tree."
-        html = empty_message if !empty_message.nil?
+        html = options[:empty_message] if !options[:empty_message].nil?
       end
       raw html
     end
     
-    def create_listy_tree(collection, spec, html, level)
-      html += "<ul class='listy-tree-level-#{level}'>"
-      
-      collection.each do |element|
-        html += "<li>"
-        html += "<div class='listy-tree-list-header'>#{element.try(spec[:display_method_name])}</div>"
-        html = create_listy_tree(element.try(spec[:children]), spec[:child], html, level+1) if !spec[:children].nil?
-        html += "</li>"
-      end
-      
-      html += "</ul>"      
-    end
+    
  
-    def listy_links(collection, display_method_name, css_class, show_more_index=5, empty_message="")
+    def listy_links(collection, display_method_name, options={})
       if collection.present?
-        html = "<ul class='" + css_class + "'>"
-        show_more = false
+        html = "<ul class='" + options[:css_class] + "'>"
+        show_more_limit_reached = false
+
+        show_more_limit = options[:show_more_limit] || 10 if options[:show_more]
+
         collection.each_with_index do |element, index|
-          if index > show_more_index && !show_more
+
+          if options[:show_more] && (index+1) > show_more_limit && !show_more_limit_reached
             html += "<div class='listy-show-more-list' style='display:none'>" 
-            show_more = true
+            show_more_limit_reached = true
           end
           html += "<li>" + link_to(element.try(display_method_name), element) + "</li>"
         end
-        if show_more
+
+        if options[:show_more] && show_more_limit_reached
           html += "</div>" 
           html += link_to("Show More", "#", :class => "listy-show-more-link button orange-button")
         end 
+
         html += "</ul>"
       else
         html = "There are no entries in this list."
-        html = empty_message if !empty_message.nil?
+        html = options[:empty_message] if !options[:empty_message].nil?
       end
 
       raw html
     end
 
-    def multi_column_listy_links(collection, display_method_name, css_class, number_of_columns)
+    def multi_column_listy_links(collection, display_method_name, number_of_columns, options={})
       html = ""
       if collection.present?
         number_of_entries_per_column = collection.size/number_of_columns
@@ -61,7 +56,7 @@ module Listy
           end_index = (i+1) * number_of_entries_per_column
           end_index = collection.size if end_index > collection.size
 
-          html += list_of_links(collection[start_index..end_index], display_method_name, css_class, show_more_index=1000, "")
+          html += listy_links(collection[start_index..end_index], display_method_name, options)
 
           html += "</div>"
         end
@@ -70,10 +65,25 @@ module Listy
 
       else
         html = "There are no entries in this list."
+        html = options[:empty_message] if !options[:empty_message].nil?
       end
 
       raw html
     end
+    
+    private
+      def create_listy_tree(collection, spec, html, level)
+        html += "<ul class='listy-tree-level-#{level}'>"
+
+        collection.each do |element|
+          html += "<li>"
+          html += "<div class='listy-tree-list-header'>#{element.try(spec[:display_method_name])}</div>"
+          html = create_listy_tree(element.try(spec[:children]), spec[:child], html, level+1) if !spec[:children].nil?
+          html += "</li>"
+        end
+
+        html += "</ul>"      
+      end
  
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: listy
 version: !ruby/object:Gem::Version
-  version: 0.0.3
+  version: 0.0.4
   prerelease: 
 platform: ruby
 authors:
@@ -19,6 +19,7 @@ extensions: []
 extra_rdoc_files: []
 files:
 - .gitignore
+- .rvmrc
 - Gemfile
 - LICENSE
 - README.md