модуль 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.not_active
Conversation.archived
Conversation.not_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(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)
  enum_scopes = definitions.delete(:_scopes)
  definitions.each do |name, values|
    assert_valid_enum_definition_values(values)
    # statuses = { }
    enum_values = ActiveSupport::HashWithIndifferentAccess.new
    name = name.to_s

    # def self.statuses() statuses end
    detect_enum_conflict!(name, name.pluralize, true)
    singleton_class.define_method(name.pluralize) { enum_values }
    defined_enums[name] = 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 |label, value|
        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}#{label}#{suffix}"
        enum_values[label] = value
        label = label.to_s

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

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

        # scope :active, -> { where(status: 0) }
        # scope :not_active, -> { where.not(status: 0) }
        if enum_scopes != false
          klass.send(:detect_negative_condition!, value_method_name)

          klass.send(:detect_enum_conflict!, name, value_method_name, true)
          klass.scope value_method_name, -> { where(attr => value) }

          klass.send(:detect_enum_conflict!, name, "not_#{value_method_name}", true)
          klass.scope "not_#{value_method_name}", -> { where.not(attr => value) }
        end
      end
    end
    enum_values.freeze
  end
end