【Rails】モデルに列挙型(enum)を定義し、使いこなす方法

はじめに

Railsはモデルでカラム名と同名の列挙型(enum)を定義することで、カラムと列挙型の変数を紐付けることができます。カラムと列挙型の変数を紐付けると、カラムに対して様々な便利な使い方ができるようになります。

本記事では、モデルに列挙型(enum)を定義し、使いこなす方法について説明します。

モデルに列挙型(enum)を定義

モデルに列挙型(enum)と紐付けるカラムを追加します。追加するカラムのデータ型はintegerにします。今回はArticleモデルに記事の公開状態を保持するstatusというカラムを追加します。

% rails generate migration add_status_to_articles

作成されたマイグレーションファイルに以下を追記し、rails db:migrateを実行します。

db/migrate/yyyymmddhhmmss_add_status_to_articles.rb

class AddStatusToArticles < ActiveRecord::Migration
  def change
    add_column :articles, :status, :integer, null: false, default: 0
  end
end

モデルに追加したカラムと紐付ける列挙型(enum)の変数をHashで定義します。Hashではなく配列として定義することもできます。その場合、カラムのデータ型はintegerではなくstringなどに変更してください。

app/models/article.rb

  enum status: { draft: 0, published: 1 }

  # 配列として定義
  enum status: [:draft, :published]
  enum status: %i(draft published)

列挙型(enum)を使いこなす

列挙型(enum)の変数と紐付けたカラムに対してできることを列挙していきます。以下の例はrails consoleで行っていますが、もちろんモデルやコントローラー、ビューなどどこでも行うことができます。

% rails console
> article = Article.first

列挙型(enum)の取得

モデルに定義した列挙型(enum)の変数を取得するには、定義した変数名の複数形を指定します。

> Article.statuses
=> {"draft"=>0, "published"=>1}

keyとvalueを反転するには、以下のように記述します。

> Article.statuses.invert
=> {0=>"draft", 1=>"published"}

返却値はHashのため、keyを指定してvalueを取得することができます。

> Article.statuses[:published]
=> 1

keyまたはvalueの一覧を取得するには、以下のように記述します。

> Article.statuses.keys
=> ["draft", "published"]

> Article.statuses.values
=> [0, 1]

返却値は配列のため、インデックスを指定して値を取得することができます。

> Article.statuses.keys[0]
=> "draft"
> Article.statuses.key(0)
=> "draft"

> Article.statuses.values[0]
=> 0
> Article.statuses.value(0)
=> 0

値の取得

列挙型(enum)と紐付けたカラムの値を取得すると、Hashのkeyが返却されます。

> article.status
=> "published"

keyではなくvalueを取得するには、以下のように記述します。「列挙型(enum)の取得」セクションで説明したように、keyを指定してvalueを取得します。

> Article.statuses[article.status]
=> 1

値の判定

モデルに列挙型(enum)を定義すると、自動的に値を判定するメソッドが定義されます(article.status == "published"などと等価)。インスタンス変数に対してkeyの末尾に?をつけたメソッドを実行すると、keyの値に一致するかどうかを判定し真偽値を返却します。

> article.status
=> "published"

> article.draft?
=> false

> article.published?
=> true

値の更新

モデルに列挙型(enum)を定義すると、自動的に値を更新するメソッドが定義されます(article.update(status: "draft")などと等価)。インスタンス変数に対してkeyの末尾に!をつけたメソッドを実行すると、インスタンス変数をkeyの値に更新します。

> article.status
=> "published"

> article.draft!
=> true

> article.status
=> "draft"

スコープの操作

特定のステータスでレコードを絞り込みたい場合は、以下のように記述します。not_という接頭辞をつけることで否定条件になります(Rails 6以降)。

> Article.published.size
=> 186

> Article.not_published.size
=> 12

列挙型(enum)の定義時にscopes: falseを指定することで、スコープの操作を無効にすることができます。

app/models/article.rb

  enum status: { draft: 0, published: 1 }, scopes: false
> Article.published.size
NoMethodError

日本語訳の取得

列挙型(enum)の使い方ではありませんが、列挙型(enum)で定義した変数の日本語訳を追加しておくと便利です。

config/locales/ja/model.yml

ja:
  article:
    status:
      draft: 下書き
      published: 公開中
> status = article.status
=> "published"

> I18n.t("article.status.#{status}")
=> "公開中"

I18nを使用した多言語対応(日本語化)について詳しくは以下の記事を参照してください。

列挙型(enum)をさらに使いこなす

enum_helpというGemを使うことで、列挙型(enum)で定義した変数をさらに便利に使えるようになります。

Gemfileに以下を追記してbundle installを実行します。

Gemfile

gem 'enum_help'

言語ファイルに以下を追記します。

config/locales/ja/model.yml

ja:
  enums:
    article:
      status:
        draft: 下書き
        published: 公開中

enum_helpは、列挙型(enum)で定義した変数に_i18nという接尾辞を追加できるようになります。_i18nという接尾辞を追加して値を取得すると、valueを日本語に変換した値が取得できるようになります。

列挙型(enum)の取得

モデルに定義した列挙型(enum)の変数を取得するには、以下のように記述します。

> Article.statuses_i18n
=> {"draft"=>"下書き", "published"=>"公開中"}

keyとvalueを反転するには、以下のように記述します。

> Article.statuses_i18n.invert
=> {"下書き"=>"draft", "公開中"=>"published"}

返却値はHashのため、keyを指定してvalueを取得することができます。

> Article.statuses_i18n[:published]
=> "公開中"

keyまたはvalueの一覧を取得するには、以下のように記述します。

> Article.statuses_i18n.keys
=> ["draft", "published"]

> Article.statuses_i18n.values
=> ["下書き", "公開中"]

返却値は配列のため、インデックスを指定して値を取得することができます。

> Article.statuses_i18n.keys[0]
=> "draft"

> Article.statuses_i18n.values[0]
=> "下書き"

値の取得

列挙型(enum)と紐付けたカラムの値を取得すると、Hashのkeyが返却されます。

> article.status_i18n
=> "公開中"

keyではなくvalueを取得するには、以下のように記述します。「列挙型(enum)の取得」セクションで説明したように、keyを指定してvalueを取得します。

> Article.statuses_i18n[article.status]
=> "公開中"

列挙型(enum)をビューで使用する

フォームのセレクトボックスなどで列挙型(enum)で定義している変数を使用したい場合があります。Hashのvalueをセレクトボックスの値に使用し、サーバーに送られる値はkeyとするのが一般的です。enum_helpというGemを使用する方法と使用しない方法がありますが、Gemを使用したほうがスマートなのでこちらをおすすめします。

Gemを使用する方法

enum_helpというGemを使用します。インストールしていない場合は「列挙型(enum)をさらに使いこなす」セクションを参照してインストールしてください。

<%= form_with model: @article, local: true do |form| %>
  <%= form.select :status, Article.statuses_i18n.invert, selected: @article.status %>
<% end %>

変数名の複数形に_i18nという接尾辞をつけて日本語に対応したHashを取得しています。そのままだとkeyが表示されてしまうので、keyとvalueを反転しています。

Gemを使用しない方法

<%= form_with model: @article, local: true do |form| %>
  <%= form.select :status, Article.statuses.map { |key, _| [t("article.status.#{key}"), key] }, selected: @article.status %>
<% end %>

変数名の複数形でHashを取得し、それらに対して言語ファイルから対応する日本語を取得しています。

まとめ

モデルに列挙型(enum)を定義し、使いこなす方法について説明しました。カラムと列挙型(enum)を紐付けると様々な便利な使い方ができるようになります。定義するだけで自動的に使えるようになるメソッドなどもあり、それらを使いこなすことでよりエレガントなコードが書けるようになります。

本記事を参考にして、列挙型(enum)を使いこなしていただければと思います。

関連記事

【Rails】RSpecを使った自動テスト《システムスペック編》
# はじめに Railsでアプリケーションを開発する際、品質を担保するためにテストは欠かせません。その中でも、RSpecは多くの開発者に愛用されているテストフレームワークです。 今回は、RSpecを使ったRailsアプリケーションのテスト方 [...]
2024年7月11日 17:07
【Rails】RSpecを使った自動テスト《リクエストスペック編》
# はじめに Railsでアプリケーションを開発する際、品質を担保するためにテストは欠かせません。その中でも、RSpecは多くの開発者に愛用されているテストフレームワークです。 今回は、RSpecを使ったRailsアプリケーションのテスト方 [...]
2024年7月11日 16:06
【Rails】RSpecを使った自動テスト《コントローラースペック編》
# はじめに Railsでアプリケーションを開発する際、品質を担保するためにテストは欠かせません。その中でも、RSpecは多くの開発者に愛用されているテストフレームワークです。 今回は、RSpecを使ったRailsアプリケーションのテスト方 [...]
2024年7月11日 15:39
【Rails】RSpecを使った自動テスト《モデルスペック編》
# はじめに Railsでアプリケーションを開発する際、品質を担保するためにテストは欠かせません。その中でも、RSpecは多くの開発者に愛用されているテストフレームワークです。 今回は、RSpecを使ったRailsアプリケーションのテスト方 [...]
2024年7月11日 11:50
【Rails】RSpecを使った自動テスト《基本編》
# はじめに Railsでアプリケーションを開発する際、品質を担保するためにテストは欠かせません。その中でも、RSpecは多くの開発者に愛用されているテストフレームワークです。 今回は、RSpecを使ったRailsアプリケーションのテスト方 [...]
2024年7月10日 17:49
【Rails】デザインパターン「Concern」の基本情報と実装方法
# はじめに Ruby on RailsなどのMVCフレームワークで構築したWebシステムにはアンチパターンというものが存在します。システム開発におけるアンチパターンとは、避けるべき悪い設計や実装方法のことを指します。 MVCフレームワーク [...]
2024年7月10日 13:32
【Rails】デザインパターン「Form Object」の基本情報と実装方法
# はじめに Ruby on RailsなどのMVCフレームワークで構築したWebシステムにはアンチパターンというものが存在します。システム開発におけるアンチパターンとは、避けるべき悪い設計や実装方法のことを指します。 MVCフレームワーク [...]
2024年7月6日 22:50
【Rails】デザインパターン「Service Object」の基本情報と実装方法
# はじめに Ruby on RailsなどのMVCフレームワークで構築したWebシステムにはアンチパターンというものが存在します。システム開発におけるアンチパターンとは、避けるべき悪い設計や実装方法のことを指します。 MVCフレームワーク [...]
2024年7月6日 19:59