RailsのActiveRecord enumで簡単に作れる、読みやすい属性の実装方法

「保留中」「承認済み」「フラグ付き」のいずれかの状態を持ちうる質問。あるいは「自宅」「会社」「携帯」「FAX」(もし1982年なら)のどれかに分類される電話番号。

こうしたデータが必要になるモデルは少なくありません。いくつかの候補の中から必ず1つの値だけを持つ属性であり、しかもその値のセットはほとんど変わることがありません。

純粋なRubyで書くなら、ここは単純にシンボルを使う場面です。

PhoneNumberTypeやQuestionStatusといったモデルを作成し、belongs_toの関連でこれらの値を保持する方法もありますが、そこまでする価値はなさそうです。YAMLファイルに押し込む手もありますが、今度はオブジェクトが何をできるのかを把握するために、まったく別の場所を確認しに行かなければなりません。

Rails 4.1では、この問題に対する解決策としてActiveRecord enumが導入されました。

モデル内で少数の値を扱う

ActiveRecordのenumはとても簡単に使えます。まずモデルにinteger型のカラムを用意します。

bin/rails g model phone number:string phone_number_type:integer

次に、その属性が取りうる値を列挙します。

class Phone < ActiveRecord::Base
  enum phone_number_type: [:home, :office, :mobile, :fax]
end

これで、生の数値の代わりに文字列として属性を扱えるようになります。

こんな表示ではなく:

irb(main):001:0> Phone.first.phone_number_type
=> 3

こう表示されます。

irb(main):002:0> Phone.first.phone_number_type
=> "fax"

属性の変更は、文字列でも整数でも行えます。

irb(main):003:0> phone.phone_number_type = 1; phone.phone_number_type
=> "office"
irb(main):004:0> phone.phone_number_type = "mobile"; phone.phone_number_type
=> "mobile"

バンメソッド(!付き)を使うことさえ可能です。

irb(main):005:0> phone.office!
=> true
irb(main):006:0> phone.phone_number_type
=> "office"

属性が特定の値を持っているかどうかを確認するメソッドも自動的に生成されます。

irb(main):007:0> phone.office?
=> true

さらに、目的の値を持つすべてのオブジェクトを検索することもできます。

irb(main):008:0> Phone.office
  Phone Load (0.3ms)  SELECT "phones".* FROM "phones" WHERE "phones"."phone_number_type" = ?  [["phone_number_type", 1]]

利用可能なすべての値と、それぞれに対応する数値を確認したい場合は、phone_number_typesクラスメソッドを使います。

irb(main):009:0> Phone.phone_number_types
=> {"home"=>0, "office"=>1, "mobile"=>2, "fax"=>3}

これにより、HTMLフォームへの組み込みも非常に簡単になります。

<div class="field">
  <%= f.label :phone_number_type %><br>
  <%= f.select :phone_number_type, Phone.phone_number_types.keys %>
</div>

注意すべきポイント

とはいえ、enumにも落とし穴があります。後々トラブルに巻き込まれないためにも、いくつかの点に留意しておきましょう。

enumを定義する際、値の順序が重要です。たとえば、後からコードを見返して「やっぱりアルファベット順に並べ替えよう」と判断したとしましょう。

class Phone < ActiveRecord::Base
  enum phone_number_type: [:fax, :home, :mobile, :office]
end

すると、既存レコードの型情報が正しく対応しなくなってしまいます。これを回避するには、どの数値がどの値に対応するかを明示的に指定します。

class Phone < ActiveRecord::Base
  enum phone_number_type: {fax: 3, home: 0, mobile: 2, office: 1}
end

ただし実際には、最初から順序を一貫して保つのが最善の対策です。

より大きな問題は、Railsの世界の外側との連携です。Rails上ではenumの値は文字列のように見えますが、データベース内には単なる整数として保存されています。そのため、生のデータを直接見ても、その数字が何を意味するのかまったく分かりません。これは同時に、そのデータベースを読み取るすべてのアプリケーションが、enumのマッピングを把握している必要があることも意味します。

本当に他の人にもマッピングを見せる必要があるなら、enumの対応表をデータベースやYAMLファイルに出力する方法もあります。しかしそれはDRY原則に反します。enumを2箇所で定義することになってしまうからです。そこまで手間をかけるなら、冒頭で避けていた道——完全に独立したモデルと関連を作成し、PhoneがPhoneNumberTypeにbelongs_toする構成——を選ぶほうが賢明かもしれません。

ただ、シンプルさを優先したいのであれば、enumは間違いなく優れた出発点となります。

P.S. お見逃しの方へ。『Practicing Rails』が7月6日(月)に開始されるRuby Book Bundleに収録されます。他の5冊の厳選Ruby書籍とまとめて、大幅割引で入手できます!