2014-04-07 21:52:21 -04:00
|
|
|
require 'active_support/core_ext/object/deep_dup'
|
|
|
|
|
2013-11-02 15:01:31 -04:00
|
|
|
module ActiveRecord
|
2013-12-30 11:47:11 -05:00
|
|
|
# Declare an enum attribute where the values map to integers in the database,
|
|
|
|
# but can be queried by name. Example:
|
2013-11-02 15:01:31 -04:00
|
|
|
#
|
|
|
|
# class Conversation < ActiveRecord::Base
|
2013-11-02 21:32:08 -04:00
|
|
|
# enum status: [ :active, :archived ]
|
2013-11-02 15:01:31 -04:00
|
|
|
# end
|
|
|
|
#
|
|
|
|
# # conversation.update! status: 0
|
|
|
|
# conversation.active!
|
|
|
|
# conversation.active? # => true
|
2013-11-06 04:49:22 -05:00
|
|
|
# conversation.status # => "active"
|
2013-11-02 16:08:36 -04:00
|
|
|
#
|
2013-11-02 15:01:31 -04:00
|
|
|
# # conversation.update! status: 1
|
|
|
|
# conversation.archived!
|
|
|
|
# conversation.archived? # => true
|
2013-11-06 04:49:22 -05:00
|
|
|
# conversation.status # => "archived"
|
2013-11-02 16:08:36 -04:00
|
|
|
#
|
2015-08-25 04:38:38 -04:00
|
|
|
# # conversation.status = 1
|
2013-11-06 04:49:22 -05:00
|
|
|
# conversation.status = "archived"
|
2013-11-02 15:01:31 -04:00
|
|
|
#
|
2013-12-20 07:12:59 -05:00
|
|
|
# conversation.status = nil
|
|
|
|
# conversation.status.nil? # => true
|
|
|
|
# conversation.status # => nil
|
|
|
|
#
|
2013-12-30 11:47:11 -05:00
|
|
|
# Scopes based on the allowed values of the enum field will be provided
|
2014-05-09 16:46:22 -04:00
|
|
|
# as well. With the above example:
|
|
|
|
#
|
|
|
|
# Conversation.active
|
|
|
|
# Conversation.archived
|
2013-12-30 11:47:11 -05:00
|
|
|
#
|
2015-04-23 06:39:48 -04:00
|
|
|
# Of course, you can also query them directly if the scopes don't fit your
|
2015-02-13 19:18:22 -05:00
|
|
|
# needs:
|
|
|
|
#
|
|
|
|
# Conversation.where(status: [:active, :archived])
|
2015-02-14 03:04:16 -05:00
|
|
|
# Conversation.where.not(status: :active)
|
2015-02-13 19:18:22 -05:00
|
|
|
#
|
2013-11-02 15:01:31 -04:00
|
|
|
# You can set the default value from the database declaration, like:
|
|
|
|
#
|
2013-11-02 16:08:36 -04:00
|
|
|
# create_table :conversations do |t|
|
2013-11-02 15:01:31 -04:00
|
|
|
# t.column :status, :integer, default: 0
|
|
|
|
# end
|
2013-11-02 16:08:36 -04:00
|
|
|
#
|
2013-11-02 15:01:31 -04:00
|
|
|
# Good practice is to let the first declared status be the default.
|
2013-11-02 21:32:08 -04:00
|
|
|
#
|
2013-12-05 03:41:09 -05:00
|
|
|
# Finally, it's also possible to explicitly map the relation between attribute and
|
2015-07-08 06:16:16 -04:00
|
|
|
# database integer with a hash:
|
2013-11-02 21:32:08 -04:00
|
|
|
#
|
|
|
|
# class Conversation < ActiveRecord::Base
|
|
|
|
# enum status: { active: 0, archived: 1 }
|
|
|
|
# end
|
2013-11-06 09:25:04 -05:00
|
|
|
#
|
2015-07-08 06:16:16 -04:00
|
|
|
# Note that when an array is used, the implicit mapping from the values to database
|
2013-12-05 03:41:09 -05:00
|
|
|
# integers is derived from the order the values appear in the array. In the example,
|
2013-12-06 14:21:12 -05:00
|
|
|
# <tt>:active</tt> is mapped to +0+ as it's the first element, and <tt>:archived</tt>
|
2013-12-05 03:41:09 -05:00
|
|
|
# is mapped to +1+. In general, the +i+-th element is mapped to <tt>i-1</tt> in the
|
|
|
|
# database.
|
|
|
|
#
|
|
|
|
# Therefore, once a value is added to the enum array, its position in the array must
|
|
|
|
# be maintained, and new values should only be added to the end of the array. To
|
2015-07-08 06:16:16 -04:00
|
|
|
# remove unused values, the explicit hash syntax should be used.
|
2013-12-05 03:41:09 -05:00
|
|
|
#
|
2013-11-06 09:25:04 -05:00
|
|
|
# In rare circumstances you might need to access the mapping directly.
|
2014-01-14 18:41:44 -05:00
|
|
|
# The mappings are exposed through a class method with the pluralized attribute
|
2015-02-13 19:22:20 -05:00
|
|
|
# name, which return the mapping in a +HashWithIndifferentAccess+:
|
2013-11-06 09:25:04 -05:00
|
|
|
#
|
2015-02-13 19:22:20 -05:00
|
|
|
# Conversation.statuses[:active] # => 0
|
|
|
|
# Conversation.statuses["archived"] # => 1
|
2013-11-06 09:25:04 -05:00
|
|
|
#
|
2015-02-14 03:04:16 -05:00
|
|
|
# Use that class method when you need to know the ordinal value of an enum.
|
|
|
|
# For example, you can use that when manually building SQL strings:
|
2015-02-13 19:50:08 -05:00
|
|
|
#
|
|
|
|
# Conversation.where("status <> ?", Conversation.statuses[:archived])
|
|
|
|
#
|
2015-07-23 08:27:09 -04:00
|
|
|
# You can use the +:_prefix+ or +:_suffix+ options when you need to define
|
|
|
|
# multiple enums with same values. If the passed value is +true+, the methods
|
2015-07-23 13:21:19 -04:00
|
|
|
# are prefixed/suffixed with the name of the enum. It is also possible to
|
|
|
|
# supply a custom value:
|
2015-04-19 05:25:09 -04:00
|
|
|
#
|
2015-07-23 13:21:19 -04:00
|
|
|
# class Conversation < ActiveRecord::Base
|
|
|
|
# enum status: [:active, :archived], _suffix: true
|
|
|
|
# enum comments_status: [:active, :inactive], _prefix: :comments
|
2015-04-19 05:25:09 -04:00
|
|
|
# end
|
|
|
|
#
|
2015-07-23 13:21:19 -04:00
|
|
|
# With the above example, the bang and predicate methods along with the
|
|
|
|
# associated scopes are now prefixed and/or suffixed accordingly:
|
2015-04-19 05:25:09 -04:00
|
|
|
#
|
2015-07-23 13:21:19 -04:00
|
|
|
# conversation.active_status!
|
|
|
|
# conversation.archived_status? # => false
|
2015-04-19 05:25:09 -04:00
|
|
|
#
|
2015-07-23 13:21:19 -04:00
|
|
|
# conversation.comments_inactive!
|
|
|
|
# conversation.comments_active? # => false
|
2015-02-13 19:50:08 -05:00
|
|
|
|
2013-11-02 15:01:31 -04:00
|
|
|
module Enum
|
2014-07-16 13:44:41 -04:00
|
|
|
def self.extended(base) # :nodoc:
|
2016-01-18 16:51:02 -05:00
|
|
|
base.class_attribute(:defined_enums, instance_writer: false)
|
2014-04-07 10:01:03 -04:00
|
|
|
base.defined_enums = {}
|
|
|
|
end
|
2014-01-20 18:59:20 -05:00
|
|
|
|
2014-07-16 13:44:41 -04:00
|
|
|
def inherited(base) # :nodoc:
|
2014-04-07 21:52:21 -04:00
|
|
|
base.defined_enums = defined_enums.deep_dup
|
|
|
|
super
|
2014-01-20 18:59:20 -05:00
|
|
|
end
|
|
|
|
|
2015-11-07 12:58:44 -05:00
|
|
|
class EnumType < Type::Value # :nodoc:
|
2016-01-23 10:42:40 -05:00
|
|
|
def initialize(name, mapping, subtype)
|
2015-02-11 16:56:26 -05:00
|
|
|
@name = name
|
|
|
|
@mapping = mapping
|
2016-01-23 10:42:40 -05:00
|
|
|
@subtype = subtype
|
2015-02-11 16:56:26 -05:00
|
|
|
end
|
|
|
|
|
2015-02-17 15:39:42 -05:00
|
|
|
def cast(value)
|
2015-02-11 16:56:26 -05:00
|
|
|
return if value.blank?
|
|
|
|
|
|
|
|
if mapping.has_key?(value)
|
|
|
|
value.to_s
|
|
|
|
elsif mapping.has_value?(value)
|
|
|
|
mapping.key(value)
|
|
|
|
else
|
2015-09-24 13:50:11 -04:00
|
|
|
assert_valid_value(value)
|
2015-02-11 16:56:26 -05:00
|
|
|
end
|
|
|
|
end
|
|
|
|
|
2015-02-17 13:29:51 -05:00
|
|
|
def deserialize(value)
|
2015-02-14 02:51:43 -05:00
|
|
|
return if value.nil?
|
2016-01-23 10:42:40 -05:00
|
|
|
mapping.key(subtype.deserialize(value))
|
2015-02-11 16:56:26 -05:00
|
|
|
end
|
|
|
|
|
2015-02-17 15:35:23 -05:00
|
|
|
def serialize(value)
|
2015-02-11 16:56:26 -05:00
|
|
|
mapping.fetch(value, value)
|
|
|
|
end
|
|
|
|
|
2015-09-24 13:50:11 -04:00
|
|
|
def assert_valid_value(value)
|
|
|
|
unless value.blank? || mapping.has_key?(value) || mapping.has_value?(value)
|
|
|
|
raise ArgumentError, "'#{value}' is not a valid #{name}"
|
|
|
|
end
|
|
|
|
end
|
|
|
|
|
2015-02-11 16:56:26 -05:00
|
|
|
protected
|
|
|
|
|
2016-01-23 10:42:40 -05:00
|
|
|
attr_reader :name, :mapping, :subtype
|
2015-02-11 16:56:26 -05:00
|
|
|
end
|
|
|
|
|
2013-11-02 15:01:31 -04:00
|
|
|
def enum(definitions)
|
2013-11-04 13:36:22 -05:00
|
|
|
klass = self
|
2015-07-23 08:27:09 -04:00
|
|
|
enum_prefix = definitions.delete(:_prefix)
|
|
|
|
enum_suffix = definitions.delete(:_suffix)
|
2013-11-02 15:01:31 -04:00
|
|
|
definitions.each do |name, values|
|
2014-01-14 06:58:22 -05:00
|
|
|
# statuses = { }
|
|
|
|
enum_values = ActiveSupport::HashWithIndifferentAccess.new
|
2013-11-04 18:55:29 -05:00
|
|
|
name = name.to_sym
|
2013-11-02 15:01:31 -04:00
|
|
|
|
2014-01-14 06:58:22 -05:00
|
|
|
# def self.statuses statuses end
|
2014-01-27 04:39:52 -05:00
|
|
|
detect_enum_conflict!(name, name.to_s.pluralize, true)
|
2014-01-14 06:58:22 -05:00
|
|
|
klass.singleton_class.send(:define_method, name.to_s.pluralize) { enum_values }
|
|
|
|
|
2015-02-11 16:56:26 -05:00
|
|
|
detect_enum_conflict!(name, name)
|
|
|
|
detect_enum_conflict!(name, "#{name}=")
|
|
|
|
|
2016-01-23 10:42:40 -05:00
|
|
|
decorate_attribute_type(name, :enum) do |subtype|
|
|
|
|
EnumType.new(name, enum_values, subtype)
|
|
|
|
end
|
2014-01-11 06:57:09 -05:00
|
|
|
|
2015-02-11 16:56:26 -05:00
|
|
|
_enum_methods_module.module_eval do
|
2013-11-04 13:36:22 -05:00
|
|
|
pairs = values.respond_to?(:each_pair) ? values.each_pair : values.each_with_index
|
|
|
|
pairs.each do |value, i|
|
2015-04-19 05:25:09 -04:00
|
|
|
if enum_prefix == true
|
|
|
|
prefix = "#{name}_"
|
|
|
|
elsif enum_prefix
|
|
|
|
prefix = "#{enum_prefix}_"
|
|
|
|
end
|
|
|
|
if enum_suffix == true
|
|
|
|
suffix = "_#{name}"
|
|
|
|
elsif enum_suffix
|
|
|
|
suffix = "_#{enum_suffix}"
|
|
|
|
end
|
|
|
|
|
|
|
|
value_method_name = "#{prefix}#{value}#{suffix}"
|
2013-11-06 09:25:04 -05:00
|
|
|
enum_values[value] = i
|
2013-11-02 15:01:31 -04:00
|
|
|
|
2013-12-22 06:53:39 -05:00
|
|
|
# def active?() status == 0 end
|
2015-04-19 05:25:09 -04:00
|
|
|
klass.send(:detect_enum_conflict!, name, "#{value_method_name}?")
|
|
|
|
define_method("#{value_method_name}?") { self[name] == value.to_s }
|
2013-11-02 15:01:31 -04:00
|
|
|
|
2013-12-23 10:18:06 -05:00
|
|
|
# def active!() update! status: :active end
|
2015-04-19 05:25:09 -04:00
|
|
|
klass.send(:detect_enum_conflict!, name, "#{value_method_name}!")
|
|
|
|
define_method("#{value_method_name}!") { update! name => value }
|
2014-01-27 04:39:52 -05:00
|
|
|
|
|
|
|
# scope :active, -> { where status: 0 }
|
2015-04-19 05:25:09 -04:00
|
|
|
klass.send(:detect_enum_conflict!, name, value_method_name, true)
|
2016-01-14 15:31:02 -05:00
|
|
|
klass.scope value_method_name, -> { where(name => value) }
|
2013-11-04 13:36:22 -05:00
|
|
|
end
|
2013-11-02 15:01:31 -04:00
|
|
|
end
|
2014-04-07 10:01:03 -04:00
|
|
|
defined_enums[name.to_s] = enum_values
|
2013-11-02 15:01:31 -04:00
|
|
|
end
|
|
|
|
end
|
2013-11-04 13:36:22 -05:00
|
|
|
|
2013-12-05 21:12:42 -05:00
|
|
|
private
|
|
|
|
def _enum_methods_module
|
|
|
|
@_enum_methods_module ||= begin
|
2015-02-11 16:56:26 -05:00
|
|
|
mod = Module.new
|
2013-12-05 21:12:42 -05:00
|
|
|
include mod
|
|
|
|
mod
|
|
|
|
end
|
2013-11-04 13:36:22 -05:00
|
|
|
end
|
2014-01-27 04:39:52 -05:00
|
|
|
|
|
|
|
ENUM_CONFLICT_MESSAGE = \
|
|
|
|
"You tried to define an enum named \"%{enum}\" on the model \"%{klass}\", but " \
|
|
|
|
"this will generate a %{type} method \"%{method}\", which is already defined " \
|
|
|
|
"by %{source}."
|
|
|
|
|
|
|
|
def detect_enum_conflict!(enum_name, method_name, klass_method = false)
|
|
|
|
if klass_method && dangerous_class_method?(method_name)
|
2015-09-18 11:46:11 -04:00
|
|
|
raise_conflict_error(enum_name, method_name, type: 'class')
|
2014-01-27 04:39:52 -05:00
|
|
|
elsif !klass_method && dangerous_attribute_method?(method_name)
|
2015-09-18 11:46:11 -04:00
|
|
|
raise_conflict_error(enum_name, method_name)
|
2014-01-27 04:39:52 -05:00
|
|
|
elsif !klass_method && method_defined_within?(method_name, _enum_methods_module, Module)
|
2015-09-18 11:46:11 -04:00
|
|
|
raise_conflict_error(enum_name, method_name, source: 'another enum')
|
2014-01-27 04:39:52 -05:00
|
|
|
end
|
|
|
|
end
|
2015-09-18 11:46:11 -04:00
|
|
|
|
|
|
|
def raise_conflict_error(enum_name, method_name, type: 'instance', source: 'Active Record')
|
|
|
|
raise ArgumentError, ENUM_CONFLICT_MESSAGE % {
|
|
|
|
enum: enum_name,
|
|
|
|
klass: self.name,
|
|
|
|
type: type,
|
|
|
|
method: method_name,
|
|
|
|
source: source
|
|
|
|
}
|
|
|
|
end
|
2013-11-02 15:01:31 -04:00
|
|
|
end
|
|
|
|
end
|