listify 0.1.0 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: e02be46eb90c0bf7f85e55772515b7c7aef935fa
-  data.tar.gz: a6296464e606c1da0752c64cf8a630f6920bcb14
+  metadata.gz: e9c8128654aa0b3ed2a9816520b8137360979433
+  data.tar.gz: cb4c0d3134dbdb0b22b491f87db505ef3373bbac
 SHA512:
-  metadata.gz: c704d3f2ba216dc479da151704082eb15351294e2ded2e6f98adefc46c1d2cc37fb21cb395e2dedc9efca6168de20b5d92fd2646c442366b43c6ee1b55672758
-  data.tar.gz: fed6d8b7d6c8a1d34e53f296364a08520b695d891e86f504ce59dac4a765078a4d93f222adbb3f58b90eef9c895c24000fec8d72393fce4d6d1807c44c7414e7
+  metadata.gz: 4f185be355bd9833cdd4514d0ecf78ece027e8145ba5b889f07f612e60a8e41e9881c8c2c24d3a41f8c8d6d032eab124841f1ea750b5177a02613fb1a1c7cf39
+  data.tar.gz: 0ffcd9fd3ae656eef7e714dde433b868b63950404c54807f262e16c0f6b2944b6f52223340148cc0f851bf9b2e0cd20fc3510df9aeb1173dfdc8829f36eb3c0a

data/README.md

@@ -1,4 +1,8 @@
 #Listify Rails Plugin
+[![Gem Version](https://badge.fury.io/rb/listify.png)](http://badge.fury.io/rb/listify)
+[![Build Status](https://travis-ci.org/bappelt/listify.png)](https://travis-ci.org/bappelt/listify)
+[![Coverage Status](https://coveralls.io/repos/bappelt/listify/badge.png?branch=master)](https://coveralls.io/r/bappelt/listify?branch=master)
+[![Code Climate](https://codeclimate.com/github/bappelt/listify.png)](https://codeclimate.com/github/bappelt/listify)
 
 The Listify rails plugin provides a simple method to use in views and helpers to render an HTML list from a ruby array or hash.
 
@@ -58,6 +62,26 @@ listify( {'First Category' => ['item one', 'item two'], 'Second Category' => ['i
       </ul>"
 ```
 
+###Multi-Column lists
+
+If you specify a number of columns > 1, the list will be broken up into multiple unordered lists intended for use as separate columns
+```
+listify( %w[first second third fourth fifth sixth seventh], columns: 3 )
+ => "<ul>
+       <li>first</li>
+       <li>second</li>
+     </ul>
+     <ul>
+       <li>third</li>
+       <li>fourth</li>
+     </ul>
+     <ul>
+       <li>fifth</li>
+       <li>sixth</li>
+       <li>seventh</li>
+     </ul>"
+```
+
 ###Complex lists
 
 And you can get more complex, though maybe you shouldn't:
@@ -104,5 +128,3 @@ listify( {'First-Category' => ['item-one', 'item-two'],
         <li>Fourth-Item</li>
       </ul>"
 ```
-
-[![Code Climate](https://codeclimate.com/github/bappelt/listify.png)](https://codeclimate.com/github/bappelt/listify)

data/lib/columnizer.rb

@@ -0,0 +1,112 @@
+class Columnizer
+
+  def initialize(list, number_of_columns)
+    @list = Columnizer.convert_to_array(list)
+    @column_count = number_of_columns
+    @items_by_column = []
+    columnize!
+  end
+
+  def columnize!
+    (1..@column_count).each do |column_number|
+      @items_by_column[column_number] = find_items_for_column(column_number)
+    end
+  end
+
+  def items_for_column(column_number)
+    @items_by_column[column_number]
+  end
+
+  def find_items_for_column(column_number)
+    zero_based_column_number = column_number-1
+    return [] if item_count_by_column[zero_based_column_number]==0
+    first_item_index = 0 if zero_based_column_number==0
+    first_item_index ||= (item_count_by_column[0..zero_based_column_number-1]).inject(:+)
+    last_item_index = first_item_index+item_count_by_column[zero_based_column_number]-1
+    Columnizer.truncate_list(@list, first_item_index..last_item_index)
+  end
+
+  def item_count_by_column
+    item_count_by_column = []
+    total_item_count = total_item_count_for_collection(@list)
+    balanced_item_count = total_item_count / @column_count
+    unbalanced_item_count = total_item_count % @column_count
+    @column_count.times { item_count_by_column << balanced_item_count }
+    item_count_by_column[-unbalanced_item_count..-1] = item_count_by_column[-unbalanced_item_count..-1].collect { |n| n+1 } if unbalanced_item_count > 0
+    item_count_by_column
+  end
+
+  def total_item_count_for_collection(list)
+    item_count = 0
+    list.each do |item|
+      if item.is_a?(Enumerable)
+        item_count += total_item_count_for_collection(item)
+      else
+        item_count += 1
+      end
+    end
+    item_count
+  end
+
+  def self.truncate_list(list, range)
+
+    list = convert_to_array(list)
+
+    first_index, last_index = range.begin, range.end
+    first_item, last_item = list.flatten[first_index], list.flatten[last_index]
+
+    list.each { |o| o.extend(IsOrIncludes) }
+    list.flatten(1).each { |o| o.extend(IsOrIncludes) }
+    list.flatten(2).each { |o| o.extend(IsOrIncludes) }
+
+    first_item_index = list.index { |o| o.is_or_includes?(first_item) }
+    last_item_index = list.index { |o| o.is_or_includes?(last_item) }
+
+    last_item_container = list[last_item_index]
+    if last_item_container.is_a?(Array)
+       unless last_item_container[1].eql?(last_item) || last_item_container[1].last.eql?(last_item) || last_item_container[1].empty?
+          last_item_index -= 1
+       end
+    end
+
+    list[first_item_index..last_item_index]
+
+  end
+
+  def self.convert_to_array(list)
+    truncated_list = []
+    if list.respond_to?(:keys)
+      keys = list.keys
+      keys.each do |key|
+        list[key.to_s] = list.delete(key)
+      end
+      list.each do |key, value|
+        validate_depth(value)
+        truncated_list << [key.dup, value]
+      end
+    else
+      truncated_list = list
+    end
+    truncated_list
+  end
+
+  def self.validate_depth(value)
+    if value.respond_to?(:each) then
+      value.each { |item| raise "Columns not supported for lists nested more than one level" if item.respond_to?(:keys) }
+    end
+  end
+
+
+end
+
+module IsOrIncludes
+
+  def is_or_includes?(object)
+    if self.is_a?(Array)
+      return self.index { |o| o.is_or_includes?(object) }
+    else
+      return object.equal?(self)
+    end
+  end
+
+end

data/lib/listify.rb

@@ -1,14 +1,19 @@
+require_relative 'columnizer'
+
 module Listify
 
   module Helper
 
     # Generate an HTML list from a ruby collection
     # @param [Array, Hash{sublist_name => sublist[Array, Hash]}] collection the collection to render as a list
+    # @param [Hash] options
+    # @option options [String] :class HTML class to apply to the <ul> elements
+    # @option options [Integer] :columns (1) When specified, break list into multiple lists. Breaks will occur at top level only if list is nested. Not supported for lists nested more than one level deep.
     # @return ActiveSupport::SafeBuffer
     #
     # @example Simple List
-    #   listify( ['first item', 'second item', 'third item'] )
-    #   => "<ul>
+    #   listify( ['first item', 'second item', 'third item'], class: 'parts-list' )
+    #   => "<ul class='parts-list'>
     #        <li>first item</li>
     #        <li>second item</li>
     #        <li>third item</li>
@@ -30,10 +35,44 @@ module Listify
     #           </ul>
     #         </li>
     #       </ul>"
+    #
+    # @example Multiple Column List
+    #   listify( ['first item', 'second item', 'third item', 'fourth item', 'fifth item'], columns: 2 )
+    #   => "<ul>
+    #        <li>first item</li>
+    #        <li>second item</li>
+    #      </ul>
+    #      <ul>
+    #        <li>third item</li>
+    #        <li>fourth item</li>
+    #        <li>fifth item</li>
+    #      </ul>"
     def listify(collection, options = {})
-      content_tag :ul, options do
-        list_items_for(collection)
+      number_of_columns = options.fetch(:columns, 1)
+
+      if number_of_columns > 1
+        options.delete(:columns)
+        columnizer = Columnizer.new(collection, number_of_columns)
+
+        elements = []
+        (1..number_of_columns).each do |column|
+          items_for_column = columnizer.items_for_column(column)
+          next if items_for_column.empty?
+          column_element = content_tag :ul, options do
+            list_items_for(items_for_column)
+          end
+          elements << column_element
+        end
+
+
+        return elements.inject(:+)
+
+      else
+        content_tag :ul, options do
+          list_items_for(collection)
+        end
       end
+
     end
 
     private

data/lib/listify/version.rb

@@ -1,3 +1,3 @@
 module Listify
-  VERSION = "0.1.0"
+  VERSION = "0.2.0"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: listify
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors:
 - 'Byron Appelt '
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-08-13 00:00:00.000000000 Z
+date: 2013-09-30 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -31,6 +31,7 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- lib/columnizer.rb
 - lib/listify/version.rb
 - lib/listify.rb
 - MIT-LICENSE