Module: ClassyEnum::ActiveRecord

Defined in:
lib/classy_enum/active_record.rb

Instance Method Summary collapse

Instance Method Details

#classy_enum_attr(attribute, options = {}) ⇒ Object

Class macro used to associate an enum with an attribute on an ActiveRecord model. This method is automatically added to all ActiveRecord models when the classy_enum gem is installed. Accepts an argument for the enum class to be associated with the model. ActiveRecord validation is automatically added to ensure that a value is one of its pre-defined enum members.

Example

# Associate an enum Priority with Alarm model's priority attribute
class Alarm < ActiveRecord::Base
  classy_enum_attr :priority
end

# Associate an enum Priority with Alarm model's alarm_priority attribute
classy_enum_attr :alarm_priority, :enum => 'Priority'

# Allow enum value to be nil
classy_enum_attr :priority, :allow_nil => true

# Allow enum value to be blank
classy_enum_attr :priority, :allow_blank => true



24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
 
# File 'lib/classy_enum/active_record.rb', line 24

def classy_enum_attr(attribute, options={})
  enum              = (options[:enum] || attribute).to_s.camelize.constantize
  allow_blank       = options[:allow_blank] || false
  allow_nil         = options[:allow_nil] || false
  serialize_as_json = options[:serialize_as_json] || false

  # Add ActiveRecord validation to ensure it won't be saved unless it's an option
  validates_inclusion_of attribute,
    :in          => enum,
    :allow_blank => allow_blank,
    :allow_nil   => allow_nil

  # Define getter method that returns a ClassyEnum instance
  define_method attribute do
    enum.build(read_attribute(attribute),
               :owner             => self,
               :serialize_as_json => serialize_as_json,
               :allow_blank       => (allow_blank || allow_nil)
              )
  end

  # Define setter method that accepts string, symbol, instance or class for member
  define_method "#{attribute}=" do |value|
    if value.class == Class && value < ClassyEnum::Base
      value = value.new
    elsif value.present?
      value = value.to_s
    end

    super(value)
  end
end