модуль ActiveRecord::Enum

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

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

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

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

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

В редких случаях может потребоваться прямой доступ к сопоставлению. Сопоставления доступны через метод класса с именем атрибута во множественном числе, который возвращает сопоставление в виде ActiveSupport::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

Чтобы отключить автоматически создаваемые методы модели, установите для параметра :instance_methods значение false:

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

По умолчанию при присваивании недопустимого значения будет вызвано исключение ArgumentError:

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

conversation = Conversation.new

conversation.status = :unknown # 'unknown' is not a valid status (ArgumentError)

Если же нужно проверять значение перечисления перед сохранением, используйте параметр :validate:

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

conversation = Conversation.new

conversation.status = :unknown
conversation.valid? # => false

conversation.status = nil
conversation.valid? # => false

conversation.status = :active
conversation.valid? # => true

Также можно передать дополнительные параметры проверки:

class Conversation < ActiveRecord::Base
  enum :status, [ :active, :archived ], validate: { allow_nil: true }
end

conversation = Conversation.new

conversation.status = :unknown
conversation.valid? # => false

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

conversation.status = :active
conversation.valid? # => true