listy 0.0.5 → 0.0.6

data/README.md

@@ -1,6 +1,7 @@
 # Listy
 
 Listy is a Gem that contains a bunch of view helpers for use in Ruby on Rails to easily create different types of lists.
+
 I apologize for all the updates happening in 0.0.X. This started out as a test gem project with very bad code, and I'm refactoring and updating the code pretty frequently.
 I will do my best to keep this document up to date with the versions.
 
@@ -9,6 +10,15 @@ I will do my best to keep this document up to date with the versions.
 Listy is only compatible with Rails 3.1 and above.
 It leverages both the Asset Pipeline and the JQuery library.
 
+So either manually include your own version of JQuery, or ensure the bundled version is specified in your `app/assets/javascripts/application.js`
+
+```ruby
+	//= require jquery
+	//= require jquery_ujs
+```
+
+If you don't plan on using any of the Hiding/Collapsing of the lists - you don't have to include the JQuery stuff.
+
 ## Installation
 
 Add this line to your application's Gemfile:
@@ -27,74 +37,111 @@ Listy also includes some Javascript assets, so be sure to add the following line
 
 	//= require listy
 
+If you don't plan on using any of the Hiding/Collapsing of the lists - you don't have to include this.
+
 ## Usage
 
 There are a couple of helper methods including:
 
 ### listy_links
 
-	listy_links(collection, display_method_name, options={})
+	listy_links(collection, options={})
+
+This method creates a simple unordered list of links of the elements in the collection. This is suitable for Ruby on Rails models.
 
-This method creates a simple unordered list of the elements in the collection. This is suitable for Ruby on Rails models.
+* collection - Should be an ActiveRecord collection.
 
 Options you can pass in include
 
+* display_method - Symbol of method to be called on each record to generate what is displayed in the list. If you set is not specified, to_s will be called on the element to generate the display string.
 * :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 - If set to true, the list will display only the first 10 elements, and hide the rest and create a "Show More" link. Show more functionality requires JQuery and list.js - please read above.
 * :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
+#### Example Usage:
 
 ```ruby
-	<%= listy_links BlogPost.all, :title %>
+	<%= listy_links BlogPost.all %>  <!-- probably not that useful -->
+	
+	<%= listy_links BlogPost.all, :display_method => :title %>
 	
-	<%= listy_links User.all, :email, :show_more => true %>
+	<%= listy_links User.all, :display_method => :email, :show_more => true %>
 	
-	<%= listy_links Product.all, :part_number, :show_more => true, :show_more_limit => 100, :css_class => "products-list" %>
+	<%= listy_links Product.all, :display_method => :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={})
+	multi_column_listy_links(collection, number_of_columns, options={})
 
 This does the same thing as listy_links but presents it in the number of columns you specify.
 
+* collection - Should be an ActiveRecord collection.
+* number_of_columns - The number of columns you want the list split up into.
+
 Options you can pass in include:
 
+* display_method - Symbol of method to be called on each record to generate what is displayed in the list. If you set is not specified, to_s will be called on the element to generate the display string.
 * :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
+#### Example Usage:
 
 ```ruby
-	<%= listy_links BlogPost.all, :title %>
+	<%= multi_column_listy_links BlogPost.all, 3, :display_method => :title %>
 	
-	<%= listy_links User.all, :email, :show_more => true %>
+	<%= multi_column_listy_links User.all, 2, :display_method => :email %>
 	
-	<%= listy_links Product.all, :part_number, :show_more => true, :show_more_limit => 100, :css_class => "products-list" %>
+	<%= multi_column_listy_links Product.all, 4, :display_method => :part_number, :css_class => "products-list", :empty_message => "There are no products" %>
 ```
 
 ### 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.
+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 lists will be collapsable if you click on the parent elements (requires JQuery and listy.js, please read above).
+
 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
+
+#### Spec Explanation
+
+The spec is a nested hash that contains the following elements:
+
+* display_method - Symbol of method to be called on each record to generate what is displayed in the list. If you set is not specified, to_s will be called on the element to generate the display string.
+* :children - The name of the method (typically the has_many relationship) to call to get the nested collection (leave unspecified or nil if this is the leaf node)
+* :child - The spec for the elements of the children (leave unspecified or nil if this is the leaf node)
+
+Here's a sample spec
+
+Let's say we have the following
 
 * Country which has_many States
 * State which has_many Cities
 
-Examples:
+
+```ruby
+	spec = { :display_method => :name, 
+	  			:children => :states, 
+	  			:child => { :display_method => :name, 
+				  			:children => :cities, 
+				  			:child => { :display_method => :name }
+						   }
+	 		}
+```
+
+
+
+#### Example Usage:
 
 ```ruby
 	listy_tree(Country.all, 
-				{ :display_method_name => :name, 
+				{ :display_method => :name, 
 				  :children => :states, 
-				  :child => { :display_method_name => :name, 
+				  :child => { :display_method => :name, 
 							  :children => :cities, 
-							  :child => { :display_method_name => :name }
+							  :child => { :display_method => :name }
 							}
 				 })
 ```

data/lib/listy/version.rb

@@ -1,3 +1,3 @@
 module Listy
-  VERSION = "0.0.5"
+  VERSION = "0.0.6"
 end

data/lib/listy/view_helpers.rb

@@ -5,17 +5,17 @@ module Listy
       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 = options[:empty_message] if !options[:empty_message].nil?
+        html = options[:empty_message] || "There are no entries in this list."
       end
       raw html
     end
     
     
  
-    def listy_links(collection, display_method_name, options={})
+    def listy_links(collection, options={})
       if collection.present?
-        html = "<ul class='" + options[:css_class] + "'>"
+        css_class = options[:css_class] || ""
+        html = "<ul class='" + css_class + "'>"
         show_more_limit_reached = false
 
         show_more_limit = options[:show_more_limit] || 10 if options[:show_more]
@@ -26,7 +26,8 @@ module Listy
             html += "<div class='listy-show-more-list' style='display:none'>" 
             show_more_limit_reached = true
           end
-          html += "<li>" + link_to(element.try(display_method_name), element) + "</li>"
+          display = options[:display_method].nil? ? element.to_s : element.try(options[:display_method])
+          html += "<li>" + link_to(display, element) + "</li>"
         end
 
         if options[:show_more] && show_more_limit_reached
@@ -36,27 +37,26 @@ module Listy
 
         html += "</ul>"
       else
-        html = "There are no entries in this list."
-        html = options[:empty_message] if !options[:empty_message].nil?
+        html = options[:empty_message] || "There are no entries in this list."
       end
 
       raw html
     end
 
-    def multi_column_listy_links(collection, display_method_name, number_of_columns, options={})
+    def multi_column_listy_links(collection, number_of_columns, options={})
       html = ""
       if collection.present?
-        number_of_entries_per_column = collection.size/number_of_columns
+        number_of_entries_per_column = (Float(collection.size)/Float(number_of_columns)).ceil
         percentage_width_of_column = 100 / number_of_columns
         Rails.logger.info(collection.size.to_s + " " + number_of_entries_per_column.to_s)
         (0..number_of_columns-1).each do |i|
           html += "<div style='float:left;width:" + percentage_width_of_column.to_s + "%'>"
 
           start_index = i * number_of_entries_per_column
-          end_index = (i+1) * number_of_entries_per_column
+          end_index = (i+1) * number_of_entries_per_column - 1
           end_index = collection.size if end_index > collection.size
 
-          html += listy_links(collection[start_index..end_index], display_method_name, options)
+          html += listy_links(collection[start_index..end_index], options)
 
           html += "</div>"
         end
@@ -64,8 +64,7 @@ module Listy
         html += "<div style='clear:both'></div>"
 
       else
-        html = "There are no entries in this list."
-        html = options[:empty_message] if !options[:empty_message].nil?
+        html = options[:empty_message] || "There are no entries in this list."
       end
 
       raw html
@@ -77,7 +76,8 @@ module Listy
 
         collection.each do |element|
           html += "<li>"
-          html += "<div class='listy-tree-list-header'>#{element.try(spec[:display_method_name])}</div>"
+          display = spec[:display_method].nil? ? element.to_s : element.try(spec[:display_method])
+          html += "<div class='listy-tree-list-header'>#{display}</div>"
           html = create_listy_tree(element.try(spec[:children]), spec[:child], html, level+1) if !spec[:children].nil?
           html += "</li>"
         end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: listy
 version: !ruby/object:Gem::Version
-  version: 0.0.5
+  version: 0.0.6
   prerelease: 
 platform: ruby
 authors: