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

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

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)