2005-08-02 優しいRailsの育て方 [長年日記]
● [rails] Validations
ある ActiveRecord オブジェクトの内部状態が期待する値かどうかを検査するのがvalidation 機能です。例えば、ある変数(状態)が、空値、決まった範囲、特定の正規表現にマッチ、であるかどうかといった検査を定義します。定義するには、ActiveRecord::Base#validate を override します。validate_on_create や validate_on_update などに関しても同様です。
- validate_on_create: オブジェクトが新規に作成されたときにのみ実行されます
- validate_on_update: オブジェクトが更新されたときのみ実行されます
- validate: 新規・更新のどちらの場合でも実行されます
validate と validate_on_* の両方が定義された場合は、validate の方が先に実行されます。
● validate の定義
では、validate を定義してみます。エラー(いわゆる想定外の値)が発生した場合はエラー処理用オブジェクト(errors)を利用することが推奨されています。必須ではないので自前で管理しても大丈夫だと思いますが、errors を利用すると以下の2点のメリットがあります。
- 一般的な検証機能がメソッドで用意されている。
- helper の error_messages_for によるエラー表示の恩恵を受けられる。
まずは、簡単な入力チェックをしてみましょう。
class Berryz < ActiveRecord::Base
def validate
if name.to_s.empty?
errors.add(:name, "が入力されていません")
end
end
errors を利用する場合は、このように add メソッドでエラー情報を追加していきます。第一引数(必須)にはエラーの起きた要素名(カラム名)を入れ、第二引数(省略可)には表示するメッセージを入れます。省略するとデフォルトの英語のメッセージになります。
● メリット1: 一般的な検証機能
今の空文字列チェックも組み込みで準備されていますので、errorsを利用する場合はそれを利用する方がよいでしょう。
class Berryz < ActiveRecord::Base
def validate
errors.add_on_empty %w( name ), "が入力されていません"
end
end
第一引数にチェックしたいカラム名(もしくは属性名)を列挙できるので、複数の項目を検査するときに記述がすっきりします。以下の検証機能(errorsのメソッド)が利用可能です。
- add_on_blank # Rails拡張ObjectのObject#blank? による検査 ("", " ", nil, 0)
- add_on_boundary_breaking # 範囲オブジェクト(range)による検査
- add_on_empty # empty? による検査
また、どのカラムにも結びつかないけどエラーを表示させたい場合は、
- add_to_base
を利用します。以下、利用例です。
class Berryz < ActiveRecord::Base
def validate
errors.add_on_blank %w( name ), "が入力されていません"
errors.add_on_boundary_breaking %w( password ), (1..8), "のサイズが上限(%d)を超えています"
rescue
errors.add_to_base "何か様子が変です"
end
end
● メリット2: エラー表示機能(error_messages_for)
edit.rhtml の中に <%= error_messages_for :berryz %> を追加してみましょう。このヘルパーメソッドは errors オブジェクトの要素が空でないときに、自動的に警告用の文言を返します。引数には edit アクションで利用しているオブジェクト(インスタンス変数)の名前が入ります。作成したモデル(AcitveRecordのサブクラス)の名前ではないので注意しましょう。
# app/views/berryz/edit.rhtml <%= stylesheet_link_tag 'scaffold' %> # ← public/stylesheets/scaffold.css を用意しておく(色付け用) <%= start_form_tag :action => 'update', :id => @berryz %> <%= error_messages_for 'berryz' %> <p>名前: <%= text_field 'berryz', 'name' %></p> <p>パスワード: <%= text_field 'berryz', 'password' %></p> <%= submit_tag '登録' %> <%= end_form_tag %>
すると、error_messages_for 部分にこのようなエラーメッセージが表示されます。
scaffold.css の場所や error_messages_for 等の書式がわかり辛い場合は、一度 generate scaffold でテンプレート一式を作ってみるとよいでしょう。その場合、app/views/(モデル名)/_form.rhtml が上記の edit.rhtml に相当します。
● 宣言的な定義
今まではインスタンスメソッドとして validate* を定義してきましたが、Rails お得意の関数型というか宣言的な定義でも可能です。
class Account < ActiveRecord::Base
validates_presence_of :subdomain, :name, :email_address, :password
validates_uniqueness_of :subdomain
validates_acceptance_of :terms_of_service, :on => :create
validates_confirmation_of :password, :email_address, :on => :create
end
从’w’) ＜こういう書式ってRailsで多用されてるよねー。
川´・_・｀川＜確かに単純なものならメソッドよりも見栄えはいいけど。
ﾙ ��-��ﾘ ＜ロジックが入って長くなると逆に可読性を損なう諸刃の剣。
从oﾟーﾟ从 ＜意図通りの validation の検査機能メソッドがないと使えないのです。
从 ´∇｀从＜英語と日本語の違いもあるかもしれないけど、なかなかフィットしないですねー。
ﾉﾉl∂_∂'ﾙ ＜ここらへんの presence, uniqueness, ... はインスタンスメソッドでは用意されてないし。
州*‘ o‘ﾘ ＜微妙ですー。
ﾉﾉl∂_∂'ﾙ ＜で、uniqueness は全件サーチするので index 張ってないカラムで使っちゃうと、、、
州*‘ o‘ﾘ ＜怖いんですけど。本当に怖いんですけど。
（´(ｴ)｀）ｲ＜そして、index を張るならそのまま unique index にするクマー。
ﾙ ��-��ﾘ ＜これ全部要らないから ActiveRecord::Errors#add_on_regexp きぼん。
ﾉﾉl∂_∂'ﾙ ＜こういう宣言だけで作れたら確かにコードはかっこいいけど、、、
州*‘ o‘ﾘ ＜そうやって一番うまくいった例(コード)を「Railsの生産性」として謳う流れになるのは嫌だよね。
ﾙ ��-��ﾘ ＜Rails懐疑派の人はそういう匂いを感じてるのかも。(参考: http://funk.exblog.jp/2335721/ )
（´(ｴ)｀）ｲ＜scaffold の匂いがするクマー。
ﾉﾉl∂_∂'ﾙ ＜scaffold 1行で書けることよりも、scaffold が作ったメソッドの中に凝縮されてるコードの方がRailsの本質だよね♪
州*‘ o‘ﾘ ＜うん。あの list, show, edit, destroy が殆ど1行な方が凄いよね。
从’w’) ＜結果的に宣言的ならいいけど、そこが目的にならないようにしたいね♪
● メッセージの日本語化
一部は日本語になりましたが、メッセージを完全に日本語化するには次の3つの関門を突破しなくてはなりません。(Railsはまだ黎明期なので localization が鬼門です)
- エラーの内容詳細メッセージ
- エラーのカラム名(上の "Password" の部分)
- エラーのタイトル(見出し)
1は既に対応しましたが、@@default_error_messagesによってまとめて設定することが可能ですので、そちらも紹介します。
module ActiveRecord
class Errors
@@default_error_messages = {
:empty => "が入力されていません",
:invalid => "が不正な値です",
:too_long => "のサイズが上限(%d)を超えています",
# :inclusion => "is not included in the list",
# :exclusion => "is reserved",
# :invalid => "is invalid",
# :confirmation => "doesn't match confirmation",
# :accepted => "must be accepted",
# :empty => "can't be empty",
# :blank => "can't be blank",
# :too_long => "is too long (max is %d characters)",
# :too_short => "is too short (min is %d characters)",
# :wrong_length => "is the wrong length (should be %d characters)",
# :taken => "has already been taken",
# :not_a_number => "is not a number",
}
end
end
2は Rails 側には用意されていないので、ActiveRecord.human_attribute_nameを無理矢理乗っ取ることにします。これは "user_name" → "User Name" のようにカラム名を人が読みやすい形に変換するメソッドなので、表示部分以外では使われないはずだと期待できます。(将来的に仕様が変更されてもこの日本語化が無効になるぐらいで誤動作の心配はないでしょう)。
class Kids < ActiveRecord::Base
class << self
HUMANIZED_ATTRIBUTE_KEY_NAMES = {
"name" => "名前",
"password" => "パスワード",
}
def human_attribute_name(attribute_key_name)
HUMANIZED_ATTRIBUTE_KEY_NAMES[attribute_key_name] || super
end
end
ここまできたら後は見出しの表示部分の3を残すのみです。これは文字列を置き換えるだけなので楽勝でしょう。コーヒーで一服しながら "There were problems with the following" を grepしてソースを探すことにしましょう。
从＃’w’) ＜なんじゃこりゃー！！
州*;‘ o‘ﾘ ＜力一杯埋め込んであるんですけど、、、
ﾙ ��-��ﾘ ＜終了〜。
川´・_・｀川＜一応報告 http://dev.rubyonrails.com/ticket/1089 はされてますね。
从oﾟーﾟ从 ＜でれでれ〜、あぅあぅあ〜♪
<%= error_messages_for(:berryz).sub(/There were problems with the following fields:/,
"このフィールドは問題があるとゆいたいです") %>
ﾉﾉl;∂_∂'ﾙ ＜まーさちゃん、笑顔で何ぶっそうなことやってるの！
从oTーT从＜あうぁ〜、あ〜ばばう〜あ〜あ〜う〜
从 ´∇｀从＜まーさは明日が納品で焦ってるんだよねー。
州*‘ o‘ﾘ ＜可哀想だから ApplicationHelper にメソッド作ろっか。
ﾉﾉl∂_∂'ﾙ ＜じゃあ、りー、お願いね。私は view 作るから。
# app/helpers/application_helper.rb
def template_error_messages_for (object_name, options = {})
options = options.symbolize_keys
object = instance_variable_get("@#{object_name}")
unless object.errors.empty?
render :partial=>"system/error_messages_for",
:locals=>{:messages=>object.errors.full_messages, :object=>object}
end
end
# app/views/system/_error_messages_for.rhtml
<div class="errorExplanation" id="errorExplanation">
<h2><%= messages.size %>個のエラーが発生しました</h2>
<p>次の項目に問題があります</p>
<ul>
<% for mes in messages %><li><%= mes %></li><% end %>
</ul>
</div>
从’w’) ＜この template_error_messages_for を変わりに使えばいいんだね♪
从’w’) ＜デレデレ!!シンデレLOVE!!
初めまして。<br>messageの日本語化、参考にさせていただきました。<br>貴重な日本語の情報ありがとうございます。<br><br>私の作業日記から情報参照サイトとして勝手ながらこの日付のブログへ直リンクを貼らせていただきました・・・。<br>もし何か問題があるようでしたらお手数ですが・・・一言お願いします。ttp://d.hatena.ne.jp/catalina/20050929