listify 0.0.2 → 0.0.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: db56df7409febe4e7eca136242b96a5be612ae5e
-  data.tar.gz: 9a2e78bcb19ebaa5c1d100a1d56ece5edcd2dc5b
+  metadata.gz: 611378efc5e5daac73bb837a84cd67f59ef69a5b
+  data.tar.gz: daba1c279974a1429abc08204d35a4e49f9505ed
 SHA512:
-  metadata.gz: cc7e873191030fae9b8fa3a9afbe4f8200d9e901e823af3cafadc650efd67bacc6b49e567ac3bbae35f9063f898d67641d940eff644ca173fbfbdab3d8de0014
-  data.tar.gz: 0d30d81a4e18a1eb89018065c0743d139b945f7e550434e91318a113eab3dc95ca875d200152df0d9cbacfd4cd31194a618b3f40dee3e8d014886289a7ce41cd
+  metadata.gz: e02c284089d2d4ebbf69ff5a5bac0f8bde3e5d2846cf099474b6ed0ee8016046a868efe902f3057ed14902567b18e9271f19bc77922fa0977e9b940eb0699596
+  data.tar.gz: 6aca238fa49a097dfc814b0ba4b49373b3a4129c2b782d507ddac95976e00aba429c8650f55bfca94c20f31edea8ee58161e5e501e916936e02fbb101fc0ff8b

data/lib/listify.rb

@@ -2,6 +2,34 @@ 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
+    # @return ActiveSupport::SafeBuffer
+    #
+    # @example Simple List
+    #   listify( ['first item', 'second item', 'third item'] )
+    #   => "<ul>
+    #        <li>first item</li>
+    #        <li>second item</li>
+    #        <li>third item</li>
+    #      </ul>"
+    #
+    # @example Nested List
+    #   listify( {'First Category' => ['item one', 'item two'], 'Second Category' => ['item three', 'item four'] } )
+    #     => "<ul>
+    #           <li>First Category
+    #             <ul>
+    #               <li>item one</li>
+    #               <li>item two</li>
+    #             </ul>
+    #           </li>
+    #         <li>Second Category
+    #           <ul>
+    #             <li>item three</li>
+    #             <li>item four</li>
+    #           </ul>
+    #         </li>
+    #       </ul>"
     def listify(collection)
       content_tag :ul do
         concat list_items_for(collection)

data/lib/listify/version.rb

@@ -1,3 +1,3 @@
 module Listify
-  VERSION = "0.0.2"
+  VERSION = "0.0.3"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: listify
 version: !ruby/object:Gem::Version
-  version: 0.0.2
+  version: 0.0.3
 platform: ruby
 authors:
 - 'Byron Appelt '
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-08-11 00:00:00.000000000 Z
+date: 2013-08-12 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails