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

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

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

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

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

Если вы хотите, чтобы значение перечисления проверялось перед сохранением, используйте опцию :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

В противном случае ArgumentError вызовет:

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

conversation = Conversation.new

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