Crafting Rails 4 Application 読み会（第６章）

有志で開催した Crafting Rails 4 Application 読書会の発表資料です。この読書会は参加者全員が事前に全部読んでくるという形式だったので、未読者はいないという前提で気になったポイントを中心にまとめてあります。

Transcript

1. Cra$ing  Rails4  Applica0on   Masatoshi  Iwasaki 6.  Wri0ng  DRY  Controllers   with  Responders
2. 概要 •  カスタムのResponderを使うことでよりDRYにコ ントローラが書ける。   •  ScaffoldのテンプレートをカスタムResponder 用にカスタマイズするとさらにDRYになる。   •  （青字になっている箇所は発表者注です。）  
3. Introduc0on •  Scaffoldのコードはちょっと冗長。   – 繰り返し大杉。   – 特にrespond_to周辺。   •  これをrespond_withを使うことでさくっとDRYな 感じにできる。  
4. Scaffold的なコントローラ
5. respond_with使うとDRYに書ける
6. Ac0onController::Responder •  この辺をまとめて引き受けてるのが Responder。   •  自分でResponderを定義することでさらにいろ んなことができる。
7. 本章のゴール •  ２種類のResponderを作る。   – １）HTTPリクエストに対して適切なキャッシュを返 すResponder   – ２）Flashを管理するResponder。  
8. Responderを理解する
9. HTTP  verbs（method） •  ResponderはHTTP  verbs（HTTPメソッド）と密接 に関連してる。   •  Responderが具体的にどういうメソッドにどう 対応しているかを見ていく。   •  なぜかここではRESTという単語が出てこない がで、本章後半で説明される。   •  Railsで開発してると当たり前な説明なので HTP  verbsの結論までは省略。    
10. 要するにこんな感じ •  Naviga0onalはHTMLで返す場合の対応   •  APIはJSONやXMLで返す場合の対応  
11. 寄り道：RESTとは •  Representa0onal  State  Transferの略   •  Roy  Fieldingsの博士論文で提唱された。   –  “Architectural  Styles  and  the  Design  of  Network-­‐based   So$ware  Architectures”  (2000)   •  PDFとHTMLで公開されてる。   –  博士論文ということもあって前半は過去の研究のまと めで分量がヘビー。   –  一見シンプルでさくっと思いつきそうにみえるRESTも 実際は様々なアーキテクチャを踏まえた上でのウェ ブにおける解だということが分かる。   •  HTTP  1.1とURIをデザインに影響を与えた。  
12. 寄り道：RESTで何が良くなった？ •  HTTP  1.0ではRFCで定義されていたのはGET,   HEAD,  POSTだけ。   – PUTやDELETEなどはaddi0onal  feature扱い。   •  HTTP  1.1でRESTで使われているPUT,  DELETE などが追加された。   – 元々URLに指定されたHTMLを取ってくるだけだっ たプロトコルがURIとHTTPメソッドによってサー バー上のリソース管理をできるように拡張された   – （と、いうことが画期的だったんだと思う）。  
13. Responderの呼び出し   インターフェース •  Callメソッドを持っていて引数を受け取れれば いいだけ。   – 引数は呼び出し元のコントローラ、リソース、オプ ションの３つ。   •  newしてすぐrespondメソッドが呼ばれる。    
14. Responderのメソッド •  やってることは単純。   •  to_htmlとto_jsだけ 定義されていて、他 はsendで to_hogehogeを呼び 出すだけ。  
15. Responder#to_html •  テンプレートをレンダリングしようとして、な かったらnaviga0on_behaviorを呼ぶ。  
16. Responder#naviga0on_behavior •  この動きが先ほど出てきたHTTP  verbsとの対 応関係に沿っている。
17. Responder#to_format •  こっちもテンプレートなかったらapi_behaviorを 呼ぶ。   •  エラーがちゃんとされていればdisplay_errors のほうに行く。  
18. Responder#api_behavior •  こちらもHTTP  verbsに対応している。   – else以下はupdateやdestroyでテンプレートがない 場合で、そのときはno_contentらしい。  
19. Responder#display •  FormatはURIで指定された形式（index.jsonなど）   •  Formatはini0alizeでcontrollerから読み込んでいる。  
20. Respond_withでのオプション指定 •  respond_toと同様に特定のケースでは上書きできる。   –  これがさっき出てきた Responder#to_formatの default_render。  
21. Responderの読み込み方 •  特定のコントローラでも。   •  config/applica0on.rbなどから。  
22. Flash  Responderを作る というか具体的なコードみないとよく分からん。
23. Flash  Responderのゴール •  ScaffoldでcreateとupdateでFlashだすけど、 処理は同じだからResponderにいれてしま え。   – でも文言は完全に一緒じゃないのでI18nで参 照できるようにしておく。   •  まずはおきまりのplugin作成。  
24. とりあえずTDD 至って普通のscaffold向け。Destroyでもエラーを出すようにしてる。
25. Dummyアプリでのscaffold作成 •  普通のRailsアプリと同様に作ります。
26. Responderを使うように変更 •  当然scaffoldは responderを使うように なってないので respond_toを respond_withに変える。   •  Flashの記述をコント ローラから消したので、 テストはこける。
27. Flash  Responderの実装開始 •  まずcreateから。   •  Createが成功したら   – flash.users.create.no0ceを表示。   •  Createが失敗したら   – flash.users.create.alertを表示。  
28. こんな感じに実装 •  I18nのスコープ 作るところだけ がちょっとやや こしい。
29. I18n_lookupを詳しく見る たとえば、createが成功してstatusがno0ceの場合、scopeも含めて探す翻訳 のパスと、見つからなかったときのデフォルトパスは以下のようになる。     欲しい物:  flash.users.create.no0ce   デフォルト:  flash.ac0ons.create.no0ce     なお、最後の引数のresource_nameは翻訳テキストのプレースホルダに対応 する。  
30. 従ってこんな感じのyamlを作る
31. Responderをコントローラに •  ここではアプリ全体で標準のresponderにしている。   •  翻訳ファイルも同時にload_pathに読み込ませてい る。  
32. テスト書く •  I18n.backend.store_transla0onsでデフォルトの 翻訳文を上書きして、その上書きした文章が flashに出るかどうかというテストをしている。  
33. でもこける •  Destroy出来ないときのエラーなので。。。   •  Destroyしようとしたらエラーにするようにしない とだめ。   •  ここであえてdestroyでエラーが返る例にしているの は、HTTP  verbsの説明でDELETEメソッドでもfailureに なるケースがあることに触れていたためと思われる。  
34. HTTP  Cache  Responderを作る
35. REST •  Railsは1.2の頃からRESTを利用している。   – API作るのに便利。   •  だけど、APIの実装と同時にパフォーマンス の最適化が必要になる。   •  ブラウザからリソースを生成した後、何回か 読み取るケースがあるが、その都度同じレ スポンスを返すのは非効率。   – これをブラウザ側のキャッシュで対応したい。  
36. 寄り道：RESTでのキャッシュ •  $がキャッシュ（cashとかけてる）。   •  Server+CacheとClient+Cacheの二種類が共存できる。   From:  Architectural  Styles  and  the  Design  of  Network-­‐based  So$ware  Architectures    
37. ブラウザキャッシュ •  HTTP  1.1のLast-­‐Modified/  If-­‐Modified-­‐since ヘッダを使ってリソースが更新されてなけれ ばペイロードを空にしてヘッダだけ返す。
38. 実装方針 •  If-­‐Modified-­‐Sinceが含まれないリクエストの場 合、通常のレスポンスにLast-­‐Modifiedヘッ ダーを付与。   •  If-­‐Modified-­‐Sinceが含まれていてリソースが 更新されていなければ、304コードを返してレ スポンスのbodyは空。   •  If-­‐Modified-­‐Sinceが含まれていてリソースが 更新されていれば、通常のレスポンスにLast-­‐ Modifiedヘッダーを付与。
39. 図にするとこんな感じ 特にRailsではアセット系のファイルで効果大。更新頻度が低くて参照頻度の高いHTMLは   サーバー側キャッシュとサーバー構成をうまくやることでRailsのプロセス自体へのアクセス を抑えることができるのもポイント。  
40. この辺の話については •  「ハイパフォーマンスWebサイト」がおすすめです。   –  「サービス遅いからってサーバーサイドだけ速くすれ ばいいってもんじゃねぇぞ」的な。   –  今となっては基本中の基本。  
41. んでTDD •  さっきの実装 方針をその まんまテスト に落としただ け。  
42. Resopnders#HipCacheを作る •  RailsはHTTP  cacheをうまく扱うヘルパーメソッ ドをすでに持っているので、それらを使う。
43. こんな感じ •  シンプルに渡された リソースの最終更 新時間をチェックし ている。  
44. 細かく見ていく（to_format） •  to_formatのところでHTTP  cacheのハンドリン グをかぶせてる。  
45. 細かく見ていく（do_hip_cache?） •  Perform_cachingが有効で、かつGETの場合 のみ対応。  
46. 細かく見ていく（do_hip_cache!） •  Request.fresh?  はこんな感じ。  
47. 細かく見ていく（max_0mestamp） •  実際のサービスのindex  ac0onあたりではこん なresourcesのupdated_at見るとかするよりSQL 叩いた結果とかを使いたい場合のほうが多い と思われる。
48. そして組み込む •  これでテストが通った。  
49. Generatorのカスタマイズ
50. Scaffoldのテンプレート変えちゃえ •  Responderの仕様を前提にすれば、最初から flashやrespond_toのところをrespond_withだ けに一本化できる。   •  だったら、scaffold生成時に出来るコントロー ラのテンプレートを変えてしまえばいい。
51. Scaffoldのカスタマイズ方法 •  ２種類ある。   – Scaffold  generatorを作る。   – Scaffold用のテンプレートを変更する。   •  今回は後者でいく。   •  前者の方法はすでに4章で取り上げたためと 思われる。  
52. Scaffoldテンプレートの上書き •  Rails  generatorにこんなコードがある。   – ってことはコピー元のファイルを変えればいい？ •  source_pathの存在   –  Generatorは複数のパスを見ることが出来る。   –  パスを追加してそちらを優先させればいい。   •  幸い、lib/templatesを優先してみるように作られてい る。  
53. Rails::Generatorsを読む •  controller.rbというファイルがコントローラのテ ンプレートだと分かる。
54. カスタムテンプレートを   生成するようにする
55. カスタムテンプレートを   生成するようにする
56. テンプレートを詳しく •  ERBを使ってDSLっぽくなっている。   – orm_classが対象となるモデル名。   •  plural  /  singular  はこの手の奴でよく出てくる。
57. テンプレートを詳しく •  set_リソース名 で  @user  =  User.find的なもの を定義。   •  64行目はStrongParameters用のメソッド。
58. Generatorのインストール •  これでカスタムtemplateがデフォルトになる。
59. GeneratorのORM  Agnos0cism   （ＯＲＭ不可知論） •  さっき出てきたorm_classの話。   – ORMがAc0veRecordからMongoidとかいろいろ変 わったらどうする？   •  ORMが変わっても対応できるような機構が Railsに用意されている。  
60. Ac0veModelの例 •  さっきの   <%=  orm_class.find  %>     はこれを使っていた。  
61. 例：DataMaper •  findに相当するメソッドをgetに変えている   •  これにより、datamapper  gemをインストールし た後、今回のpluginをインストールしても scaffold  templateはそのままでいい。  
62. まとめ •  Responderがどう動いているか、どうカスタマ イズすればいいかを学んだ。   •  HTTP  cacheとflash  メッセージのハンドリングを responderで実装した。   •  今回実装したのはCondi0onal  GET。   •  Condi0onal  PUTというものもあるよ。   – リソース更新時に最終更新日が変わっていたら 409  Conflictを返す。