@@ -1,7 +1,14 @@ $:.unshift File.dirname(__FILE__) require 'renum/enumerated_value_type_factory' +# Requiring 'renum' mixes the Renum module into both the main Object and +# Module, so it can be called from anywhere that you might reasonably +# define an enumeration with an implicit receiver. module Renum + + # Figures out whether the new enumeration will live in Object or the + # receiving Module, then delegates to EnumeratedValueTypeFactory#create for + # all the real work. def enum type_name, values = :defined_in_block, &block nest = self.is_a?(Module) ? self : Object EnumeratedValueTypeFactory.create(nest, type_name, values, &block) lib/renum.rb @@ -1,6 +1,11 @@ require 'forwardable' module Renum + + # This is the superclass of all enumeration classes. + # An enumeration class is Enumerable over its values and also delegates [] + # to the values array. + # Values are also comparable, sorting into the order in which they're declared. class EnumeratedValue class << self @@ -9,6 +14,7 @@ module Renum def_delegators :values, :each, :[] + # Returns an array of values in the order they're declared. def values @values ||= [] end @@ -25,10 +31,14 @@ module Renum self.class.values << self end + # Returns the fully qualified constant referring to this value. + # Don't override this if you're using Renum with the constantize_attribute + # plugin, which relies on this behavior. def to_s "#{self.class}::#{name}" end + # Sorts enumerated values into the order in which they're declared. def <=> other index <=> other.index end lib/renum/enumerated_value.rb 99650a6af10ef82942bb5bc27f2628809c2750a7 John D. Hume duelin.markers@gmail.com http://github.com/duelinmarkers/renum/commit/693e6d2115c53d2546826a07c237ba94a325f47d 693e6d2115c53d2546826a07c237ba94a325f47d 2009-09-01T16:39:42-07:00 2009-09-01T16:39:42-07:00 Add rdocs. 082ef39b95ecf95d744d7015bfb099abd086bf0f John D. Hume duelin.markers@gmail.com