@@ -24,14 +24,14 @@ irb> Melons::Order You can also use an array of strings to construct an Enumeration: <pre><code> - irb> Colors = Enumeration.of %w{fuschia red bondi cerulean carnelian} - - irb> Colors::BONDI - => :bondi +irb> Colors = Enumeration.of %w{fuschia red bondi cerulean carnelian} + +irb> Colors::BONDI +=> :bondi </code></pre> - + h3. Author: * "Karlin Fox":http://www.atomicobject.com/pages/Karlin+Fox -* "Atomic Object":http://atomicobject.com +* Atomic Object * "http://atomicobject.com":http://atomicobject.com README.textile @@ -1,5 +1,41 @@ +# = Enumeration +# +# Between string and symbol array literals, hash literals, and constants in +# modules or classes, Ruby users have plenty of options for enumeration +# constructs. If you need more, try Enumeration. +# +# irb> Melons = Enumeration.of :watermelon, :honeydew, :cantelope +# +# irb> Melons::HONEYDEW +# => :honeydew +# +# irb> Melons.enum +# => [:watermelon, :honeydew, :cantelope] +# +# irb> Melons.to_s +# => ["watermelon", "honeydew", "cantelope"] +# +# irb> Melons::Order +# => {:cantelope=>2, :watermelon=>0, :honeydew=>1} +# +# You can also use an array of strings to construct an Enumeration: +# +# irb> Colors = Enumeration.of %w{fuschia red bondi cerulean carnelian} +# +# irb> Colors::BONDI +# => :bondi +# +# +# == Author: +# +# Karlin Fox +# +# Atomic Object, http://atomicobject.com +# module Enumeration - def self.of(*values) + + # Create an enumeration module. You can provide a list of strings or symbols, as arguments or in an array. + def self.of(*values) if values[0].is_a? Array values = values[0] end @@ -26,10 +62,12 @@ module Enumeration klass end + # Enumerate the values of an Enumeration as an array of symbols in definition order. def enum self.const_get(:Order).keys.sort_by {|x| self.const_get(:Order)[x]} end + # Enumerate the values of an Enumeration as an array of strings in definition order. def to_s self.enum.map {|x| x.to_s} end lib/enumeration.rb README.rdoc 1b4bb6b42a27c8e6be4abdefbdd33da6655b6611 karlin karlin@atomicobject.com http://github.com/karlin/enumeration/commit/1d0f1e907b2fe7429a2dfb92c009c9f7eb0b5b35 1d0f1e907b2fe7429a2dfb92c009c9f7eb0b5b35 2009-06-24T12:13:12-07:00 2009-06-24T12:13:12-07:00 updated README and rdoc eef75e02cc463c7220b066f024d6f52f79a85045 karlin karlin@atomicobject.com