модуль 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)

Определение областей может быть отключено, установив :_scopes на false.

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

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

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

conversation = Conversation.new
conversation.status # => "active"

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

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 160
def enum(definitions)
  enum_prefix = definitions.delete(:_prefix)
  enum_suffix = definitions.delete(:_suffix)
  enum_scopes = definitions.delete(:_scopes)

  default = {}
  default[:default] = definitions.delete(:_default) if definitions.key?(:_default)

  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, **default) do |subtype|
      EnumType.new(attr, enum_values, subtype)
    end

    value_method_names = []
    _enum_methods_module.module_eval do
      enum_prefix = name if enum_prefix == true
      prefix = "#{enum_prefix}_" if enum_prefix

      enum_suffix = name if enum_suffix == true
      suffix = "_#{enum_suffix}" if enum_suffix

      pairs = values.respond_to?(:each_pair) ? values.each_pair : values.each_with_index
      pairs.each do |label, value|
        label = label.to_s
        enum_values[label] = value

        value_method_name = "#{prefix}#{label}#{suffix}"
        value_method_names << value_method_name
        define_enum_methods(name, value_method_name, label, enum_scopes)

        method_friendly_label = label.gsub(/[\W&&[:ascii:]]+/, "_")
        value_method_alias = "#{prefix}#{method_friendly_label}#{suffix}"

        if value_method_alias != value_method_name && !value_method_names.include?(value_method_alias)
          value_method_names << value_method_alias
          define_enum_methods(name, value_method_alias, label, enum_scopes)
        end
      end
    end
    detect_negative_enum_conditions!(value_method_names) if enum_scopes != false
    enum_values.freeze
  end
end