Material for group study, regarding Crafting Rails 4 Applications

1. Crafting Rails 4 Applications
第2章
Active Modelを使って
モデルを作る

2. 目標
Mail Formプラグインを作ってActive Modelを勉強する
• ActiveModel::AttributeMethods
• API準拠
• ActiveModel::Conversion
• ActiveModel::Naming
• ActiveModel::Translation
• ActiveModel::Validations
• ActiveModel::Callbacks
• そして最後に…

3. 以下のプラグインを作ってみよう
Post リクエストから送信されたハッシュを受け取り、バリデーシ
ョンを行ってから、特定のメールアドレスに送信する
まずは一発

4. attributes()
最初にattributes()メソッドを作ってみる
(動作: Mail Formオブジェクトに含める属性を指定する)

5. ActiveModel::AttributeMethods
Mail Formオブジェクトに含める属性を指定する
テスト:

6. attributes()
この時点ではMailForm::Baseがないので
bundle exec rake testすると当然失敗する

7. テストが通るようにするためにMailForm::Baseを実装
属性の作成はattr_accessor()に委譲(delegate)している
attributes()

8. attributes()
autoload()とは
• MailForm::Baseという定数が最初に参照されるまでは
mail_form/base.rbが読み込まない
• 起動を早めるためによく使われるテクニック
autoload()を追加することでテストがパスする

9. ActiveModel::AttributeMethods
ActiveModel::AttributeMethodsは、定義済みの属性を追いかけて共
通の動作を追加する
ここではclear_というprefixにマッチするメソッドを定義してみる
(ActiveRecordでおなじみの、定義した属性に自動的にメソッドが
追加される、あの動作を再現する)
まずはテストを作成

10. ActiveModel::AttributeMethods
clear_で始まる属性を定義し、それを使用してメソッドを定義する

11. ActiveModel::AttributeMethods
これでテストに通る

12. ActiveModel::AttributeMethods
attribute_method_prefix()をattribute_method_suffixに変えればsuffix
でも同じことができる
name?()とemail?()にマッチさせる場合
attribute_method_affix()を使用すれば両方を同時に指定することも
できる

13. 秘密はmethod_missing()にあり
ActiveModel::AttributeMethodsは、動的なメソッドをキャッチする
ために内部でmethod_missing()を使用する
clear_name()やclear_email()のようなメソッドが明示的には定義さ
れていないのに、属性を定義するだけで利用できるのはこのおかげ
そしてActiveModelは、clear_*をキャッチしたらclear_attributeを呼
び出してくれる

14. method_missing()
method_missing()は、メッセージの継承パスの最後のところでメッ
セージをキャッチする
(排水口に取り付けたストッキングみたいなもの?)
method_missing()はしばしば黒魔法にたとえられる
非常に強力だが、乱用すると流れを追いにくくなり、えらいことに
なるらしい
このあたりのことは「Metaprogramming Ruby」に詳しく載っている

15. method_missing
ActiveRecordではこのような動的なattribute methodが広く使われ
ている
でも、Rails 4 で find_by_* 形式の動的な検索メソッドが非推奨にな
ったのは、もしかしてやりすぎてしまったからなのかも。
Railscastより:

16. ぼそっと
rubyのクラス定義でクラス名をファジーマッチできたらもっとシン
プルにならないだろうか?
冗談です

17. Active Model APIに準拠する
自作モデルをActive Model APIに沿ったものにする:
(そうしないとcontrollerやviewで使えない)
実は ActiveModel::Lint::Testsですべて行える

18. Active Model APIに準拠する
APIに合致するまでエラーを出しまくる

19. Active Model APIに準拠する
以下のエラーを解決しよう
以下を定義すればよい
でもこれをもろに実装する必要はない

20. ActiveModel::Conversion
ActiveModel::Conversionを使用すれば、to_model()だけでなく
to_key()やto_param()、to_partial_path()などの必須メソッドを実
装できる
• to_key() : モデルを指定するキーの配列を返す。viewのdom_id()で
使用され、dom_id()はRailsで広く使われている
• to_param() : ルーティングで使用され、モデルのユニークURL生
成のために広く使われている
• to_partial_path() : ビューのrender()で使用される

21. ActiveModel::Conversion
これらのメソッドをカスタマイズすることもできる
to_param() : URLのidにタイトルを加えたい:
to_partial_path() : postでフォーマットを指定したい
ビューでこう書くより
オーバーライドしてから呼び出す方がスマートかつ高速
(render呼び出しが1回で済むので)

22. ActiveModel::Conversion
ActiveModel::Conversionをインクルードするだけでよい
これでエラーが3つに減った

23. ActiveModel::Naming
model_nameのエラーを減らすには、ActiveModel::Namingをエク
ステンド
これを追加すると、human()やsingular()などのモデル名活用が行わ
れる

24. ActiveModel::Translation
i18n対応するにはActiveModel::Translationをエクステンド
* i18nバックエンドが確実にリロードされるように
begin…ensure…endで囲んでいる

25. ActiveModel::Validation
以下のエラーを解消するためにActiveModel::Validationをインク
ルード

26. persisted?()
今回、以下のエラーについては自前で実装が必要

27. persisted?()
このmail_formで永続性は不要なのでfalseを返すようにする
(※protectedの下に書かないこと)
これでテストはすべてパスする

28. Formを配信する
次はdeliver()メソッドを実装してみる
• モデルのemail属性に保存されているメアドに送信する
でテスト

29. Formを配信する
実装
(MailForm::Notifierを作成)
ActionMailer::Baseを継承して実装
contact()はMailFormクラスではなく子クラスのメールデータ
(:to, :from, :subject)を返す(配信先をカスタマイズするのにNotifierクラ
スをいじる必要がない

30. Formを配信する
append_view_path()はプラグインフォルダ内にlib/viewsフォルダを
追加しテンプレート検索の対象とする
以下を追加

31. Formを配信する
準備が整ったのでサンプルクラスにメソッドを追加してみる
メイラーにビューテンプレートがないのでこの時点では失敗する
ビューテンプレートを追加してみる

32. Formを配信する
attrubete_names()というclass_attributeを定義して属性のリストを
取得できる
• attributes()を呼ぶたびに更新される
• 継承時に自動的に動作する
これでテストに通る

33. capybaraで結合テスト
(略)

34. validation
validates_presence_of() の動作:
以下の呼び出しは基本的にどれも同じ
Railsは:presenceキーを PresenceValidateに変換し、現在のクラス
にPresenceValidatorという名前の定数があるかどうかを調べる:

35. validation
Rubyでは定数の探索はすべての先祖クラスに対して行われるの
で、これは動作する

36. validation
スパム判定用のabsence validatorを作ってみる
(ボットにしか見えないnicknameフィールドをわざとフォームに
作っておき、そこに書き込みがあればスパムとみなす)
まずはテスト
AbsenceValidatorクラスを定義 (EachValidatorを継承)

37. validation
MailForm::Baseでインクルードする
MailForm::ValidatorsはMailForm::Baseの先祖チェインに追加され
る
それにより、:absenceをvalidates()のキーとして与えると、
AbsenceValidator定数の値が探索され、MailForm::Validatorsの中を
検索、初期化が行われる
(PresenceValidatorのときと同様)
あとはautoloadすればよい

38. ActiveModel::Callbacks
最後に、deliver()メソッドにbeforeとafterを追加してみよう
まずはfixture
evaluated_callbacks()メソッドを定義

39. ActiveModel::Callbacks
callbackが評価されていることを確認するテスト
実装 (ActiveModel::Callbacksをextendしてコールバックを定義)

40. ActiveModel::Callbacks
これでテストは通る

41. ActiveModel::Model
ここまでは勉強のために個別に実装を行ってきたが、実はActive
Modelに準拠するのは非常に簡単:
ActiveModel::Modelをインクルードするだけでいい
これだけで、Lintテストはすべてパスする

42. ActiveModel::Model
その実装
(これまでやってきたことを
集約しただけ)

43. おまけ
この章と同じコンセプトで作られたmail_form gemがある
https://github.com/plataformatec/mail_form

44. おつかれさまでした