Rubocopとの付き合い方

第78回ruby関西での登壇資料です。
https://rubykansai.doorkeeper.jp/events/62491

Transcript

1. rubocop との付き合い方
2. self.inspect 植森 康友 所属： 株式会社Aiming 役職： エンジニア 管理ツー ル開発 WebAPI 開発 Docker おじさん SNS: twitter: @wakaba260yen github: yuemori
3. 今日の話 コー ドレビュー rubocop 守破離
4. コー ドレビュー
5. コー ドレビュー、 してますか？
6. コー ドレビュー がなぜ必要なのか 新人教育 品質向上 相互学習
7. でも、 ちょっとまって
8. そのレビュー、 本当に必要？
9. 例えば、 こういうレビュー
10. コー ドレビュー の本質 コー ドレビュー に慣れないチー ムが、 何の考えもナシにコー ドレビ ュー を始めるととにかく気になったこと大小様々 な指摘が行われる ことになる。 一見、 いろいろな指摘が出て議論が活発になっている ように見えるが、 だいたい議論が紛糾しているのは「 コー ドのイン デント幅が違う」 とか「return が省略されてる。 俺は return があ ったほうが好み」 とか「 その場合は字下げをした方が綺麗にみえる んでは」 とか、 そんな些末なことばかりである、 ということが多い naoya のはてなダイアリー「 些末なコー ドレビュー」 より http://d.hatena.ne.jp/naoya/20140313/1394664578
11. コー ドレビュー の本質 そんなことを延々 議論していたって、 はっきり言って何の意味もな い。 何の意味もない、 は言い過ぎにしても、 そんなところを改善し たところで実質的な品質は何ひとつ上がらないわけだし、 どうして も揃えたいなら lint ツー ルか何かで機械的にチェックすればよいこ とであって人間がやることではない。 naoya のはてなダイアリー「 些末なコー ドレビュー」 より http://d.hatena.ne.jp/naoya/20140313/1394664578
12. コー ドレビュー の本質 やらなければいけないのは、「 その設計は拡張に対して開いていな いから開くべき」 とか「 これではエッジケー スが想定されていない からこういう不具合につながるのでは」 とか「 そのテストでは後日 見返したときに第三者が要求仕様を解釈しづらい」 とかそういう指 摘である。 naoya のはてなダイアリー「 些末なコー ドレビュー」 より http://d.hatena.ne.jp/naoya/20140313/1394664578
13. 再び、 コー ドレビュー がなぜ必要なのか 新人教育 品質向上 相互学習 => より本質的なことにクロー ズアップした教育をしたい => 変更や拡張、 バグ回避などに重点を置きたい => 設計や実装などのより良い議論に時間を使いたい
14. "lint ツー ルか何かで機械的にチェックすればよい"
16. rubocop、 使ってますか？
17. rubocop とは Ruby の静的解析ツー ル コー ディングルー ルを始め、 様々 な静的解析を行ってくれる コー ディングルー ルは同作者のruby‑style‑guide に準拠 https://github.com/bbatsov/ruby‑style‑guide
18. コー ディングルー ル？ Ruby には公式のコー ディングルー ルがない Ruby の思想 ＝ Happy Hacking! 楽しくプログラミングできるようにデザインされた言語 おのおのが好きなように、 楽しくかけるのが重要
19. コー ディングルー ル？ しかし、 必ずしも一人が楽しければHappy ではない 他人のコー ドを読む・ 触るとき 他人にコー ドを書いてもらうとき（Pull Request!） 業務においてはコー ドが自分だけのものではない 状況に応じた適切なコー ディングルー ルがあるとみんながハッピー になれる
20. 静的解析の恩恵 rubocop はスタイルチェックだけではない Metrics、Performance、Security、etc... より良いコー ドを書くためのチェックも行う より綺麗で読みやすいコー ドを書けるようになる
21. rubocop の機能紹介
22. Cop I n R u b o C o p l i n g o t h e v a r i o u s c h e c k s p e r f o r m e d o n t h e c o d e a r e c a l l e d c o p s rubocop の用語で、 コー ド上で実行される検査のことをCop と呼ぶ Cop の種類 Style Layout Lint Metrics Performance Security Rails Bundler
23. StyleCop コー ディングスタイルに対するCop。 コー ディングルー ルの一貫性のチェックを行う。 デフォルトはruby‑style‑guide に準拠。 設定により変更することもできる。
24. LayoutCop レイアウトに対するCop。 インデント、alignment、 空白などに対するチェックを行う。
25. LintCop エラー に対するCop。 曖昧な表現や、 エラー に対するチェックを行う。
26. MetricsCop メトリクスに対するCop。 コー ドの複雑さや保守性などのメトリクスを解析しチェックを行う。
27. PerformanceCop パフォー マンスに対するCop。 パフォー マンスの低いコー ドのチェックを行う。
28. SecurityCop セキュリティに対するCop。 セキュリティに問題のあるコー ドのチェックを行う。
29. RailsCop Rails に対するCop。 Rails に特定したコー ドのチェックを行う。
30. BundlerCop Bundler に対するCop。 Bundler に特定したコー ドのチェックを行う。
31. auto‑correct auto‑correct 対応のCop に対し、 自動整形を行う。
32. Todo r u b o c o p - - a u t o - g e n - c o n f i g を実行することで、Todo リストを作成 することができる。 「 今は直せない負債」 を目に見える形で残すことができるため、 既存プ ロジェクトへの導入などに効果的
33. 守破離
34. rubocop はきょうせいギブス
35. rubocop はきょうせいギブス 1 ファイルに警告×300 個
36. やかましい！
37. ちょっとまった
38. Configuration .rubocop.yml を設置することで設定を変更することができる コー ディングルー ルなどプロジェクト内の設定を記述する
39. 守破離って、 知ってますか？
40. 守破離 日本での茶道、 武道、 芸術等における師弟関係のあり方の一つ 個人のスキル( 作業遂行能力) を3 段階のレベルで表している
41. 守破離 まずは、 師匠の教えを守る 「 型を守る」 ところから修行を始める => 支援のもとに作業を遂行できる( 半人前) => 自律的に作業を遂行できる(1 人前)
42. 守破離 型を研究し自分と照らし合わせていき、 自分にあった型を見つける 自分の型を作ることで「 型を破る」 => 作業を分析し改善・ 改良できる(1.5 人前)
43. 守破離 最終的に師匠の型と自分が作り出した型の上に立脚する個人になる 型から自由になり、 型から「 離れ」 て自在になることができる => 新たな知識( 技術) を開発できる( 創造者)
44. 守破離 守：rubocop 先生に教えを請う 破：rubocop のルー ルを自分に合わせて改善する 離： 自分なりのコー ディングスタイルを確立する 自分のレベルに合わせたrubocop の活用をしていく 画像引用： http://www.motivation‑up.com/motivation/shuhari.html
45. rubucop.yml rubocop 用の設定ファイル。rubucop の警告の挙動を変更する デフォルトでイケてないなと思う挙動を変更する（ 結構ある） 不要なルー ルは無効化する 好きな方を選べるルー ルも多い（ インデントスタイルなど） ‑> 自分なりのrubocop.yml を育てていくことで「 離」 につながる
46. よりrubocop を活かすために
47. rubocop を入れただけでは平和にならない
48. rubocop を入れただけでは平和にならない 入れただけでは守らない そのうち警告がうるさくなってきて無視 そして戦場へ...
49. CI、 自動チェック git hook pre‑commit, pre‑push チー ム全体でhook を共有しておくのがおすすめ github 連携 houndci, sideci など
50. 設定相談 rubocop の設定を議論することで共通認識ができる 気に入らないルー ルはissue などで相談する ‑> rubocop の設定を チー ムの合意 にする
51. ロー カルでの自動チェック エディタ連携 guard‑rubocop
52. rubocop の導入 既存プロジェクトに入れるのはコストがかかるのでtodo を活かす プロジェクトに入れるなら最初から入れる 個人プロジェクトにデフォルト設定で入れるのが一番おすすめ 自分のコー ディングの弱点を知る そのうち「 これは本質的な警告じゃないな」 と思うようになる rubocop の教えを理解した上で無効化するようにしていく
53. まとめ 自動化できるチェックはrubocop で自動化する rubocop は自分やチー ムの段階に応じて調教していく rubocop と一緒に成長し自分なりのコー ディングスタイルの確立へ
54. ご静聴ありがとうございました
55. 最後に一つ宣伝を
57. rails developer meetup 第一線で活躍する開発者や企業から知見を学び現場で活かせる考え 方やテクニックを得る非営利勉強会 所属企業と地域の枠を超えた技術コミュニティ なんのコネもない開発者・ 企業に唐突に登壇依頼をする運営スタイ ル
58. 次回 日時： 8/24( 木) の19 30～ connpass の募集は8/1 から ハッシュタグ： #railsdm keynote： pocke さん、 伊藤淳一さん 興味のある方は是非ご参加ください