ar-enums 0.3.0

data/.autotest

@@ -0,0 +1,2 @@
+require 'autotest/growl'
+require 'autotest/fsevent'

data/.document

@@ -0,0 +1,5 @@
+README.rdoc
+lib/**/*.rb
+bin/*
+features/**/*.feature
+LICENSE

data/.gitignore

@@ -0,0 +1,21 @@
+## MAC OS
+.DS_Store
+
+## TEXTMATE
+*.tmproj
+tmtags
+
+## EMACS
+*~
+\#*
+.\#*
+
+## VIM
+*.swp
+
+## PROJECT::GENERAL
+coverage
+rdoc
+pkg
+
+## PROJECT::SPECIFIC

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2009 Emma Nicolau
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.rdoc

@@ -0,0 +1,122 @@
+= ar-enums
+
+This is a simple solution for defining enumerations in your Rails models.
+
+== Description
+
+It provides two forms of enumerations: 
+* Internal, i.e. defined within the owner of the enum, for the simple cases.
+* External, i.e. defined on it's own class, for the complex ones.
+
+In both cases the enum values are stored in-memory. Let's see some examples of both kinds.
+
+== Internal enumerations
+
+Can be defined in three flavours:
+
+=== Array of values style
+
+This is the simplest and probably the most frecuent case:
+
+  class TrafficLight < ActiveRecord::Base
+    enum :state, %w[red green yellow]
+  end
+
+  tl = TrafficLight.new(:state => :green)
+  tl.state          # => #<TrafficLight::State @name="green", @id=2>
+  tl.state_id       # => 2
+  tl.state.green?   # => true    
+
+As you can see each enum value is an instance of a dinamically generated class (which inherits from ActiveRecord::Enum) and has an ordinal value, id, autogenerated staring on 1.
+
+The enumerations array is accessed with a class method:
+
+  TrafficLight.states  # => [#<TrafficLight::State @name="red", @id=1>, #<TrafficLight::State @name="green", @id=2>, ...]
+  
+By default when <tt>#to_s</tt> is called on a Enum instance it returns the name titleized, but this behaviour can be overrided. See Displaying Enums section below.
+
+=== Array of hashes style
+
+This allows you to define new columns in the Enum value. If the :id is not specified is generated for you.
+
+  class TrafficLight < ActiveRecord::Base
+    enum :state, [
+      { :name => :red, :stop_traffic => true, :rgb => 0xF00 },
+      { :name => :green, :stop_traffic => false, :rgb => 0x0F0 }
+    ]
+  end
+
+  tl = TrafficLight.new(:state => :green)
+  tl.state_id              # => 2    
+  tl.state.stop_traffic    # => false
+  tl.state.rgb             # => 0x0F0
+
+=== Block style
+
+  class TrafficLight < ActiveRecord::Base
+    enum :state do
+      red :stop_traffic => true, :rgb => 0xF00
+      green :stop_traffic => false, :rgb => 0x0F0
+    end
+  end
+
+== External enumerations
+
+When you have shared enumerations or just don't want to clutter the owner model with enums definitions, 
+the enumeration can be on it's own class, as the State enum in the following example:
+
+  class TrafficLight < ActiveRecord::Base
+    enum :state
+  end
+  
+  class State < ActiveRecord::Enum
+    enumeration do
+      red :stop_traffic => true, :rgb => 0xF00, :desc => 'Rojo'
+      green :stop_traffic => false, :rgb => 0x0F0, :desc => 'Verde'
+    end
+  end
+  
+  State[:red]         # => #<State @name="red", @id=1, ...>
+  State[:red].to_s    # => "Rojo"
+  
+Note the block style sintax is exactly the same as in the internal enumerations. In fact any of the 3 styles mencioned above can be used on external enumerations.
+
+Also note the <tt>#to_s</tt> by default return the value of the <tt>:desc</tt> column. Of course you can override the <tt>#to_s</tt> method as usual.
+  
+Then you can access the enumerations collection from both places:
+
+  TrafficLight.states  # => [#<State @name="red", @id=1, ...>, #<State @name="green", @id=2, ...>]
+  States.all           # => [#<State @name="red", @id=1, ...>, #<State @name="green", @id=2, ...>]
+
+The <tt>enum</tt> method accept a <tt>:class_method</tt> option similar to the one in <tt>belongs_to</tt> and others to specify the class of the enum. 
+
+== Displaying Enums
+
+In the array of values style the default is the name titleized but you can pass a <tt>:label</tt> options to override:
+
+  class TrafficLight < ActiveRecord::Base
+    enum :state, %w[red green yellow], :label => :upcase
+  end
+  
+  TrafficLight.states.map(&:to_s)   # => ["RED", "GREEN", "YELLOW"]
+
+If you use the block o array of hashes sintax and add a <tt>:desc</tt> column it will be used as <tt>#to_s</tt>, unless a <tt>:label</tt> option is passed.
+
+== TODO
+
+* Remove the dependency with ActiveRecord so it can be used outside Rails.
+* Allow to store enums in the database.
+
+== Note on Patches/Pull Requests
+ 
+* Fork the project.
+* Make your feature addition or bug fix.
+* Add tests for it. This is important so I don't break it in a
+  future version unintentionally.
+* Commit, do not mess with rakefile, version, or history.
+  (if you want to have your own version, that is fine but bump version in a commit by itself I can ignore when I pull)
+* Send me a pull request. Bonus points for topic branches.
+
+== Copyright
+
+Copyright (c) 2010 Emmanuel Nicolau. See LICENSE for details.

data/Rakefile

@@ -0,0 +1,45 @@
+require 'rubygems'
+require 'rake'
+
+begin
+  require 'jeweler'
+  Jeweler::Tasks.new do |gem|
+    gem.name = "ar-enums"
+    gem.summary = %Q{Enumerations for ActiveRecord models}
+    gem.description = %Q{Provides a simple way for defining enumerations in ActiveRecord models}
+    gem.email = "emmanicolau@gmail.com"
+    gem.homepage = "http://github.com/eeng/ar-enums"
+    gem.authors = ["Emmanuel Nicolau"]
+    gem.add_development_dependency "rspec", ">= 1.2.9"
+    # gem is a Gem::Specification... see http://www.rubygems.org/read/chapter/20 for additional settings
+  end
+  Jeweler::GemcutterTasks.new
+rescue LoadError
+  puts "Jeweler (or a dependency) not available. Install it with: gem install jeweler"
+end
+
+require 'spec/rake/spectask'
+Spec::Rake::SpecTask.new(:spec) do |spec|
+  spec.libs << 'lib' << 'spec'
+  spec.spec_files = FileList['spec/**/*_spec.rb']
+end
+
+Spec::Rake::SpecTask.new(:rcov) do |spec|
+  spec.libs << 'lib' << 'spec'
+  spec.pattern = 'spec/**/*_spec.rb'
+  spec.rcov = true
+end
+
+task :spec => :check_dependencies
+
+task :default => :spec
+
+require 'rake/rdoctask'
+Rake::RDocTask.new do |rdoc|
+  version = File.exist?('VERSION') ? File.read('VERSION') : ""
+
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title = "ar-enums #{version}"
+  rdoc.rdoc_files.include('README*')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end

data/VERSION

@@ -0,0 +1 @@
+0.3.0

data/ar-enums.gemspec

@@ -0,0 +1,71 @@
+# Generated by jeweler
+# DO NOT EDIT THIS FILE DIRECTLY
+# Instead, edit Jeweler::Tasks in Rakefile, and run the gemspec command
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = %q{ar-enums}
+  s.version = "0.3.0"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.authors = ["Emmanuel Nicolau"]
+  s.date = %q{2010-02-11}
+  s.description = %q{Provides a simple way for defining enumerations in ActiveRecord models}
+  s.email = %q{emmanicolau@gmail.com}
+  s.extra_rdoc_files = [
+    "LICENSE",
+     "README.rdoc"
+  ]
+  s.files = [
+    ".autotest",
+     ".document",
+     ".gitignore",
+     "LICENSE",
+     "README.rdoc",
+     "Rakefile",
+     "VERSION",
+     "ar-enums.gemspec",
+     "examples/internal_enums.rb",
+     "lib/ar-enums.rb",
+     "lib/enum.rb",
+     "lib/enum_block.rb",
+     "lib/enum_definition.rb",
+     "lib/enum_field.rb",
+     "lib/factory.rb",
+     "lib/metaprogramming_extensions.rb",
+     "lib/options_helper.rb",
+     "spec/enum_definition_spec.rb",
+     "spec/enum_spec.rb",
+     "spec/factory_spec.rb",
+     "spec/schema.rb",
+     "spec/spec.opts",
+     "spec/spec_helper.rb"
+  ]
+  s.homepage = %q{http://github.com/eeng/ar-enums}
+  s.rdoc_options = ["--charset=UTF-8"]
+  s.require_paths = ["lib"]
+  s.rubygems_version = %q{1.3.5}
+  s.summary = %q{Enumerations for ActiveRecord models}
+  s.test_files = [
+    "spec/enum_definition_spec.rb",
+     "spec/enum_spec.rb",
+     "spec/factory_spec.rb",
+     "spec/schema.rb",
+     "spec/spec_helper.rb",
+     "examples/internal_enums.rb"
+  ]
+
+  if s.respond_to? :specification_version then
+    current_version = Gem::Specification::CURRENT_SPECIFICATION_VERSION
+    s.specification_version = 3
+
+    if Gem::Version.new(Gem::RubyGemsVersion) >= Gem::Version.new('1.2.0') then
+      s.add_development_dependency(%q<rspec>, [">= 1.2.9"])
+    else
+      s.add_dependency(%q<rspec>, [">= 1.2.9"])
+    end
+  else
+    s.add_dependency(%q<rspec>, [">= 1.2.9"])
+  end
+end
+

data/examples/internal_enums.rb

@@ -0,0 +1,27 @@
+require 'rubygems'
+require 'active_record'
+require 'ar-enums'
+
+ActiveRecord::Base.establish_connection(:adapter => "sqlite3", :database => ":memory:")
+load(File.dirname(__FILE__) + "/../spec/schema.rb")
+
+class TrafficLight < ActiveRecord::Base
+  enum :state, %w[red green yellow]
+end
+
+tl = TrafficLight.new(:state => :green)
+p tl.state      # => #<TrafficLight::State @name="green", @id=2>
+p tl.state_id   # => 2    
+p TrafficLight.states.map(&:to_s)
+
+# class TrafficLight < ActiveRecord::Base
+#   enum :state, [
+#     { :name => :red, :stop_traffic => true, :rgb => 0xF00 },
+#     { :name => :green, :stop_traffic => false, :rgb => 0x0F0 }
+#   ]
+# end
+# 
+# tl = TrafficLight.new(:state => :green)
+# p tl.state_id       # => 2    
+# p tl.state.stop_traffic   # => false
+# p tl.state.rgb            # => 0x0F0

data/lib/ar-enums.rb

@@ -0,0 +1,4 @@
+require 'active_record'
+%w[metaprogramming_extensions options_helper enum enum_block enum_field factory enum_definition].each do |f|
+  require f
+end

data/lib/enum.rb

@@ -0,0 +1,57 @@
+module ActiveRecord
+  class Enum
+    extend ActiveRecord::Enumerations::OptionsHelper
+    
+    attr_reader :id, :name, :extra_columns
+    class_inheritable_accessor :label_method
+    
+    def initialize attrs = {}
+      @id = attrs.delete(:id).to_i
+      @name = attrs.delete(:name).to_s
+      @extra_columns = attrs.reject { |k, _| [:enum_class, :on_style_not_matched].include?(k) }
+    end
+    
+    def self.create_from value, values, options
+      required_attrs = case value
+      when String, Symbol
+        { :name => value }
+      else
+        value
+      end
+      required_attrs[:id] ||= values.index(value) + 1
+      new options.merge(required_attrs)
+    end
+    
+    def == other
+      return id == other.id if other.is_a?(Enum)
+      [id.to_s, name].include?(other.to_s)
+    end
+    
+    def to_s
+      try_labelize(self, :desc) || try_labelize(name, :titleize)
+    end
+    
+    def to_sym
+      name.to_sym
+    end
+    
+    def self.enumeration *config, &block
+      add_option config, :enum_class => self
+      define_enums_getter ActiveRecord::Enumerations::Factory.make_enums(*config, &block)
+    end
+    
+    def self.[] name_or_id
+      all.detect { |enum| enum == name_or_id }
+    end
+    
+    private
+    def self.define_enums_getter enums
+      cattr_accessor :all
+      self.all = enums
+    end
+    
+    def try_labelize object, default_method
+      object.respond_to?(label_method) && object.send(label_method) or object.respond_to?(default_method) && object.send(default_method)
+    end
+  end
+end

data/lib/enum_block.rb

@@ -0,0 +1,17 @@
+module ActiveRecord
+  module Enumerations
+    class EnumBlock    
+      def initialize options = {}
+        @enums = []
+        @last_id = 0
+        @options = options
+      end
+    
+      def method_missing method, args = {}
+        attrs = @options.merge(args).merge(:name => method)
+        attrs[:id] ||= @last_id += 1
+        @enums << @options[:enum_class].new(attrs)
+      end
+    end
+  end
+end

data/lib/enum_definition.rb

@@ -0,0 +1,42 @@
+module ActiveRecord
+  module Enumerations
+    def self.included(base)
+      base.send :extend, ClassMethods
+    end
+  
+    module ClassMethods
+      include ActiveRecord::Enumerations::OptionsHelper
+      
+      def enum field_name, *config, &block
+        field = EnumField.new field_name
+        enum_class = Class.new Enum
+        const_set field.name.camelize, enum_class
+        add_options config, :enum_class => enum_class, :on_style_not_matched => asume_external_style(field)
+        enums = Factory.new.make_enums *config, &block
+        define_enums_getter field, enums
+        define_enum_getter_and_setter field, enums      
+      end
+    
+      private
+      def asume_external_style field
+        lambda { |options| field.external_class(options).all }
+      end
+    
+      def define_enums_getter field, enums
+        define_class_method(field.enums_getter) { enums }
+      end
+    
+      def define_enum_getter_and_setter field, enums
+        define_method field.name do
+          enums.detect { |enum| enum.id == read_attribute(field.foreign_key) }    
+        end                                                                       
+      
+        define_method "#{field.name}=" do |value|
+          write_attribute field.foreign_key, enums.detect { |enum| enum == value }.try(:id)
+        end
+      end
+    end
+  end
+end
+
+ActiveRecord::Base.send :include, ActiveRecord::Enumerations

data/lib/enum_field.rb

@@ -0,0 +1,27 @@
+module ActiveRecord
+  module Enumerations
+    class EnumField
+      attr_reader :name
+  
+      def initialize name
+        @name = name.to_s
+      end
+  
+      def enums_getter
+        name.pluralize
+      end
+  
+      def enums_setter
+        "#{enums_getter}="
+      end
+  
+      def foreign_key
+        "#{name}_id"
+      end
+    
+      def external_class options = {}
+        (options.delete(:class_name) || name).camelize.constantize
+      end
+    end
+  end
+end

data/lib/factory.rb

@@ -0,0 +1,60 @@
+module ActiveRecord
+  module Enumerations
+    class Factory
+      include OptionsHelper
+      
+      def self.make_enums *config, &block
+        new.make_enums *config, &block
+      end
+    
+      def make_enums *config, &block
+        values, options = extract_values_and_options config
+        options[:enum_class].label_method = options.delete(:label) || :desc
+        create_enums(values, options, &block).tap do |enums|
+          define_question_methods options[:enum_class], enums
+          define_extra_columns_methods options[:enum_class], enums
+        end
+      end
+    
+      private
+      def create_enums values, options, &block
+        enums = if block_given?
+          block_style options, &block
+        elsif values.any?
+          array_of_values_or_hashes_style values, options
+        elsif options[:on_style_not_matched]
+          options[:on_style_not_matched].call options
+        end
+      end
+    
+      def block_style options, &block
+        EnumBlock.new(options).instance_eval(&block)
+      end
+    
+      def array_of_values_or_hashes_style values, options
+        values.map { |value| options[:enum_class].create_from(value, values, options) }
+      end
+      
+      def define_question_methods enum_class, enums
+        enums.each do |e|
+          enum_class.class_eval %Q{
+            def #{e.name}?
+              self == :#{e.name}
+            end
+          }
+        end
+      end
+      
+      def define_extra_columns_methods enum_class, enums
+        extra_columns_names = enums.map(&:extra_columns).map(&:keys).flatten.uniq
+        extra_columns_names.each do |ecn|
+          enum_class.class_eval %Q{
+            def #{ecn}
+              extra_columns[:#{ecn}]
+            end
+          }
+        end
+      end
+    end
+  end
+end

data/lib/metaprogramming_extensions.rb

@@ -0,0 +1,22 @@
+class Object
+  # The hidden singleton lurks behind everyone
+  def metaclass; class << self; self; end; end
+  def meta_eval &blk; metaclass.instance_eval &blk; end
+
+  # Adds methods to a metaclass
+  def meta_def name, &blk
+    meta_eval { define_method name, &blk }
+  end
+
+  # Defines an instance method within a class
+  def class_def name, &blk
+    class_eval { define_method name, &blk }
+  end
+
+  # Defines a class method
+  def define_class_method name, &blk
+    self.class.instance_eval do
+      define_method name, &blk
+    end
+  end
+end

data/lib/options_helper.rb

@@ -0,0 +1,23 @@
+module ActiveRecord
+  module Enumerations
+    module OptionsHelper
+      def add_option config, option
+        new_config = if config.first.is_a?(Array)
+          [config[0], (config[1] || {}).merge(option)]
+        else
+          [(config[0] || {}).merge(option)]
+        end
+        config.replace new_config
+      end
+      alias_method :add_options, :add_option
+      
+      def extract_values_and_options config
+        if config.first.is_a?(Array)
+          [config[0], config[1] || {}]
+        else
+          [[], config[0] || {}]
+        end
+      end
+    end
+  end
+end

data/spec/enum_definition_spec.rb

@@ -0,0 +1,132 @@
+require File.expand_path(File.dirname(__FILE__) + '/spec_helper')
+
+describe "Internal enumerations" do
+  def define_traffic_light *options
+    define_model_class 'TrafficLight' do
+      enum *options
+    end
+  end
+
+  before do
+    define_traffic_light :state, %w[red green yellow]
+  end
+  
+  context "getter and setter" do
+    it "getter should return an Enum" do
+      TrafficLight.new(:state_id => 3).state.should be_enum_with(:id => 3, :name => 'yellow')
+    end
+
+    it "should store ordinal by default as foreign key" do
+      TrafficLight.new(:state => :green).state_id.should == 2
+    end
+
+    it "should store nil if enum doesn't exists" do
+      TrafficLight.new(:state => :black).state_id.should be_nil
+    end
+
+    it "should allow to set enum with symbol" do
+      TrafficLight.new(:state => :red).state.should == :red
+      TrafficLight.new(:state => :green).state.should == :green
+    end
+
+    it "should allow to set enum with string" do
+      TrafficLight.new(:state => 'red').state.should == :red
+      TrafficLight.new(:state => 'green').state.should == :green
+    end
+
+    it "should allow to set enum with ordinal" do
+      TrafficLight.new(:state_id => 1).state.should == :red
+      TrafficLight.new(:state_id => 2).state.should == :green
+    end    
+  end
+  
+  context "options" do
+    it "should pass the options to the factory" do
+      define_traffic_light :state, %w[green red], :label => :upcase
+      TrafficLight.new(:state => :green).state.to_s.should == 'GREEN'
+      TrafficLight.new(:state => :red).state.to_s.should == 'RED'
+    end
+  end
+  
+  context "question methods" do
+    before do
+      define_traffic_light :state, %w[green red]
+    end
+    
+    it "should provide question method" do
+      TrafficLight.new(:state => :green).state.should be_green
+      TrafficLight.new(:state => :green).state.should_not be_red
+      TrafficLight.new(:state => :red).state.should_not be_green
+      TrafficLight.new(:state => :red).state.should be_red
+    end
+    
+    it "should raise error if tested with inexistant enum" do
+      lambda { TrafficLight.new(:state => :green).state.blue? }.should raise_error(NameError)
+    end
+    
+    it "block style should also provide question method" do
+      define_model_class 'TrafficLight' do
+        enum :state do
+          green
+          red
+        end
+      end
+      TrafficLight.new(:state => :green).state.should be_green
+      TrafficLight.new(:state => :green).state.should_not be_red
+    end
+  end
+  
+  it "should be instances of a new subclass of Enum" do
+    TrafficLight.states.first.should be_a(TrafficLight::State)
+  end
+end
+
+describe "External enumerations" do
+  before do
+    define_model_class 'State', 'ActiveRecord::Enum' do
+      enumeration do
+        green :rgb => 0x0F0
+        red :rgb => 0xF00
+      end
+    end    
+    
+    define_model_class 'TrafficLight' do
+      enum :state
+    end
+  end
+  
+  context "enums creation" do
+    it "should allow to define enumerations on it's own class" do
+      TrafficLight.new(:state => :red).state.should be_enum_with(:name => 'red', :rgb => 0xF00, :id => 2)
+    end
+
+    it "should be posible to access all enums from withing the owner" do
+      TrafficLight.states.should equal(State.all)
+    end
+
+    it "should accept :class_name options to override de class of the external enum" do
+      define_model_class 'TrafficLight' do
+        enum :state_on_weekdays, :class_name => 'State'
+        enum :state_on_weekends, :class_name => 'State'
+      end
+      TrafficLight.state_on_weekdays.should equal(State.all)
+      TrafficLight.state_on_weekends.should equal(State.all)
+    end    
+    
+    it "external enums should be instances of the subclass of Enum" do
+      State.all.each { |s| s.should be_a(State) }
+    end
+    
+    it "should be posible to define new methods in Enum subclass" do
+      define_model_class 'State', 'ActiveRecord::Enum' do
+        enumeration do
+          green :factor => 1
+          red :factor => 2
+        end
+        
+        def double_factor() factor * 2 end
+      end    
+      State.all.map(&:double_factor).should == [2, 4]
+    end    
+  end
+end

data/spec/enum_spec.rb

@@ -0,0 +1,42 @@
+require File.expand_path(File.dirname(__FILE__) + '/spec_helper')
+
+describe "Enum" do
+  it "should provide :to_sym method returning name as symbols" do
+    ActiveRecord::Enum.new(:name => :green).to_sym.should == :green
+  end
+  
+  it "should store extra columns as a hash without the :enum_class that is passed from other classes" do
+    ActiveRecord::Enum.new(:name => :green, :factor => 1.5, :enum_class => Class.new).extra_columns.should == { :factor => 1.5 }
+  end
+
+  context "External enums" do
+    before do
+      define_model_class 'Color', 'ActiveRecord::Enum' do
+        enumeration do
+          red :rgb => 0xF00
+          green :rgb => 0x0F0
+        end
+      end    
+
+      define_model_class 'State', 'ActiveRecord::Enum' do
+        enumeration do
+          on :id => 80
+          off :id => 90
+        end
+      end    
+    end
+    
+    it "should provide :all method to access the enums" do
+      Color.all[0].should be_enum_with(:name => 'red', :rgb => 0xF00)
+      Color.all[1].should be_enum_with(:name => 'green', :rgb => 0x0F0)
+      State.all[0].should be_enum_with(:name => 'on', :id => 80)
+      State.all[1].should be_enum_with(:name => 'off', :id => 90)
+    end
+    
+    it "should provide [] method to access the enums" do
+      Color[:red].should be_enum_with(:name => 'red')
+      Color['green'].should be_enum_with(:name => 'green')
+      Color[2].should be_enum_with(:name => 'green')
+    end
+  end
+end

data/spec/factory_spec.rb

@@ -0,0 +1,100 @@
+require File.dirname(__FILE__) + '/spec_helper'
+
+describe "Enums creation styles" do
+  include ActiveRecord::Enumerations::OptionsHelper
+
+  def make_enums *config, &block
+    add_option config, :enum_class => ActiveRecord::Enum
+    ActiveRecord::Enumerations::Factory.make_enums *config, &block
+  end
+  
+  context "array of values style" do
+    it "should generate ids" do
+      enums = make_enums %w[red green blue]
+      enums[0].should be_enum_with(:id => 1, :name => 'red')
+      enums[1].should be_enum_with(:id => 2, :name => 'green')
+      enums[2].should be_enum_with(:id => 3, :name => 'blue')
+    end
+    
+    it "default to_s should be name titleized" do
+      make_enums(%w[green red]).map(&:to_s).should == %w[Green Red]      
+    end
+
+    it "should override default to_s" do
+      make_enums(%w[green red], :label => :upcase).map(&:to_s).should == %w[GREEN RED]
+    end
+  end
+  
+  context "array of hashes style" do
+    it "should accept ids if provided" do
+      enums = make_enums [{ :id => 20, :name => :red }, { :id => 10, :name => :green }]
+      enums[0].should be_enum_with(:id => 20, :name => 'red')
+      enums[1].should be_enum_with(:id => 10, :name => 'green')
+    end
+    
+    it "should generate ids if not provided" do
+      enums = make_enums [{ :name => :red }, { :name => :green }]
+      enums[0].should be_enum_with(:id => 1, :name => 'red')
+      enums[1].should be_enum_with(:id => 2, :name => 'green')
+    end
+
+    it "default to_s should be :desc column" do
+      enums = make_enums [{ :name => :red, :desc => 'Rojo' }, { :name => :green, :desc => 'Verde' }]
+      enums.map(&:to_s).should == %w[Rojo Verde]
+    end      
+    
+    it ":label options can be a method to call on name" do
+      enums = make_enums [{ :name => :red }, { :name => :green }], :label => :upcase
+      enums.map(&:to_s).should == %w[RED GREEN]
+    end   
+       
+    it ":label option can be a enum column" do
+      enums = make_enums [{ :name => :red, :title => 'Rojo' }, { :name => :green, :title => 'Verde' }], :label => :title
+      enums.map(&:to_s).should == %w[Rojo Verde]
+    end      
+    
+    it "should accept extra columns" do
+      enums = make_enums [
+        { :name => :red, :factor => 1.5, :stop_traffic => true },
+        { :name => :green, :factor => 2.5, :stop_traffic => false }
+      ]
+      enums.map(&:factor).should == [1.5, 2.5]
+      enums.map(&:stop_traffic).should == [true, false]
+    end
+  end
+  
+  context "block style" do
+    it "can be created with a block" do
+      enums = make_enums do
+        red :rgb => 0xF00
+        green :rgb => 0x0F0
+      end
+      enums[0].should be_enum_with(:id => 1, :name => 'red', :rgb => 0xF00)
+      enums[1].should be_enum_with(:id => 2, :name => 'green', :rgb => 0x0F0)
+    end    
+    
+    it "should accept :label option" do
+      enums = make_enums :label => :title do
+        red :title => 'Rojo'
+        green :title => 'Verde'
+      end
+      enums.map(&:to_s).should == %w[Rojo Verde]
+    end
+    
+    it "should accept extra columns" do
+      enums = make_enums do
+        red :factor => 1.5
+        green :factor => 2.5
+      end
+      enums.map(&:factor).should == [1.5, 2.5]
+    end
+
+    it "when extra column is empty should return nil" do
+      enums = make_enums do
+        red :factor => 1.5
+        green
+      end
+      enums.map(&:factor).should == [1.5, nil]
+    end
+  end
+end

data/spec/schema.rb

@@ -0,0 +1,5 @@
+ActiveRecord::Schema.define(:version => 0) do
+  create_table "traffic_lights", :force => true do |t|
+    t.integer "state_id"
+  end
+end

data/spec/spec.opts

@@ -0,0 +1,2 @@
+--color
+--debugger

data/spec/spec_helper.rb

@@ -0,0 +1,29 @@
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+require 'rubygems'
+require 'ar-enums'
+require 'spec'
+require 'spec/autorun'
+
+Spec::Runner.configure do |config|
+  config.before :suite do
+    ActiveRecord::Base.establish_connection(:adapter => "sqlite3", :database => ":memory:")
+    load(File.dirname(__FILE__) + "/schema.rb")
+  end
+  
+  def define_model_class(name = "TestClass", parent_class_name = "ActiveRecord::Base", &block)
+  	Object.send(:remove_const, name) rescue nil
+  	eval("class #{name} < #{parent_class_name}; end", TOPLEVEL_BINDING)
+  	klass = eval(name, TOPLEVEL_BINDING)
+  	klass.class_eval(&block) if block_given?
+  end
+end
+
+Spec::Matchers.define :be_enum_with do |expected_attrs|
+  match do |enum|
+    enum.should be_a(ActiveRecord::Enum)
+    expected_attrs.each do |atrib, expected_value|
+      enum.send(atrib).should == expected_value
+    end
+  end
+end

metadata

@@ -0,0 +1,92 @@
+--- !ruby/object:Gem::Specification 
+name: ar-enums
+version: !ruby/object:Gem::Version 
+  version: 0.3.0
+platform: ruby
+authors: 
+- Emmanuel Nicolau
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2010-02-11 00:00:00 -02:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: rspec
+  type: :development
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: 1.2.9
+    version: 
+description: Provides a simple way for defining enumerations in ActiveRecord models
+email: emmanicolau@gmail.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- LICENSE
+- README.rdoc
+files: 
+- .autotest
+- .document
+- .gitignore
+- LICENSE
+- README.rdoc
+- Rakefile
+- VERSION
+- ar-enums.gemspec
+- examples/internal_enums.rb
+- lib/ar-enums.rb
+- lib/enum.rb
+- lib/enum_block.rb
+- lib/enum_definition.rb
+- lib/enum_field.rb
+- lib/factory.rb
+- lib/metaprogramming_extensions.rb
+- lib/options_helper.rb
+- spec/enum_definition_spec.rb
+- spec/enum_spec.rb
+- spec/factory_spec.rb
+- spec/schema.rb
+- spec/spec.opts
+- spec/spec_helper.rb
+has_rdoc: true
+homepage: http://github.com/eeng/ar-enums
+licenses: []
+
+post_install_message: 
+rdoc_options: 
+- --charset=UTF-8
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.3.5
+signing_key: 
+specification_version: 3
+summary: Enumerations for ActiveRecord models
+test_files: 
+- spec/enum_definition_spec.rb
+- spec/enum_spec.rb
+- spec/factory_spec.rb
+- spec/schema.rb
+- spec/spec_helper.rb
+- examples/internal_enums.rb