модуль ActiveRecord::Enum

Объявляйте атрибут перечисления, значения которого сопоставляются с целыми числами в базе данных, но могут быть запрошены по имени. Пример:

class Conversation < ActiveRecord::Base
  enum status: [ :active, :archived ]
end

# conversation.update! status: 0
conversation.active!
conversation.active? # => true
conversation.status  # => "active"

# conversation.update! status: 1
conversation.archived!
conversation.archived? # => true
conversation.status    # => "archived"

# conversation.status = 1
conversation.status = "archived"

conversation.status = nil
conversation.status.nil? # => true
conversation.status      # => nil

Также будут предоставлены области видимости, основанные на разрешенных значениях поля перечисления. В примере выше:

Conversation.active
Conversation.archived

Конечно, вы также можете запросить их напрямую, если области видимости не подходят вашим потребностям:

Conversation.where(status: [:active, :archived])
Conversation.where.not(status: :active)

Вы можете установить значение по умолчанию из объявления базы данных, например:

create_table :conversations do |t|
  t.column :status, :integer, default: 0
end

Хорошей практикой является установка первого объявленного статуса в качестве значения по умолчанию.

Наконец, также возможно явно сопоставить связь между атрибутом и целым числом базы данных с помощью хэша:

class Conversation < ActiveRecord::Base
  enum status: { active: 0, archived: 1 }
end

Обратите внимание, что при использовании массива неявное сопоставление значений с целыми числами базы данных происходит в соответствии с порядком их появления в массиве. В примере :active сопоставлено с 0, так как это первый элемент, а :archived сопоставлено с 1. В общем случае i-й элемент сопоставляется с i-1 в базе данных.

Поэтому после добавления значения в массив перечислений необходимо сохранить его позицию в массиве, а новые значения следует добавлять только в конец массива. Для удаления неиспользуемых значений следует использовать явную синтаксическую конструкцию с хэшем.

В редких случаях вам может потребоваться напрямую получить доступ к сопоставлению. Сопоставления предоставляются через метод класса с именем атрибута во множественном числе, который возвращает сопоставление в виде HashWithIndifferentAccess:

Conversation.statuses[:active]    # => 0
Conversation.statuses["archived"] # => 1

Используйте этот метод класса, когда вам нужно узнать порядковое значение перечисления. Например, вы можете использовать его при ручном построении SQL-строк:

Conversation.where("status <> ?", Conversation.statuses[:archived])

Вы можете использовать опции :_prefix или :_suffix, если вам нужно определить несколько перечислений с одинаковыми значениями. Если переданное значение является true, методы будут предваряться/завершаться именем перечисления. Также возможно указать пользовательское значение:

class Conversation < ActiveRecord::Base
  enum status: [:active, :archived], _suffix: true
  enum comments_status: [:active, :inactive], _prefix: :comments
end

В приведенном примере методы с восклицательным знаком и предикат, а также связанные области видимости теперь предваряются и/или завершаются соответствующим именем перечисления:

conversation.active_status!
conversation.archived_status? # => false

conversation.comments_inactive!
conversation.comments_active? # => false

Константы

ENUM_CONFLICT_MESSAGE

Методы публичного экземпляра

enum(definitions) Показать исходный код

# File activerecord/lib/active_record/enum.rb, line 150
def enum(definitions)
  klass = self
  enum_prefix = definitions.delete(:_prefix)
  enum_suffix = definitions.delete(:_suffix)
  definitions.each do |name, values|
    # statuses = { }
    enum_values = ActiveSupport::HashWithIndifferentAccess.new
    name        = name.to_sym

    # def self.statuses() statuses end
    detect_enum_conflict!(name, name.to_s.pluralize, true)
    klass.singleton_class.send(:define_method, name.to_s.pluralize) { enum_values }

    detect_enum_conflict!(name, name)
    detect_enum_conflict!(name, "#{name}=")

    attr = attribute_alias?(name) ? attribute_alias(name) : name
    decorate_attribute_type(attr, :enum) do |subtype|
      EnumType.new(attr, enum_values, subtype)
    end

    _enum_methods_module.module_eval do
      pairs = values.respond_to?(:each_pair) ? values.each_pair : values.each_with_index
      pairs.each do |value, i|
        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}"
        enum_values[value] = i

        # def active?() status == 0 end
        klass.send(:detect_enum_conflict!, name, "#{value_method_name}?")
        define_method("#{value_method_name}?") { self[attr] == value.to_s }

        # def active!() update! status: :active end
        klass.send(:detect_enum_conflict!, name, "#{value_method_name}!")
        define_method("#{value_method_name}!") { update!(attr => value) }

        # scope :active, -> { where status: 0 }
        klass.send(:detect_enum_conflict!, name, value_method_name, true)
        klass.scope value_method_name, -> { where(attr => value) }
      end
    end
    defined_enums[name.to_s] = enum_values
  end
end