#28: Ruby の style guide を読み始めた

やったこと(Done)

Ruby の style guide を読んでいました。

先日から RuboCop にチェックしてもらっていますが、style guide の方をちゃんと読んでその書き方を覚え、慣れていくべきですね。

わかったこと(Fact)

  • 先日書いた、メソッドのエイリアスが複数用意されていて不思議、というのも style guide を読めば「アレではなくコレを使おう」と書かれている。
  • それぞれ同じ内容もあれば、意見が分かれている部分もある。
    • 例えば 1 行あたりの文字数
    • RuboCop : 80 文字
    • Airbnb : 100 文字
    • Cookpad : 128 文字

参考文献(References)

RuboCop

Airbnb

Cookpad

その他

  • Cookpad のものは MUST/SHOULD とラベリングされていて読みやすいですね。
  • それぞれ詳細に比較したわけではありませんが、Airbnb のものが良さそうに見えました。
  • そもそも RuboCop のものが最初にあり、Rails をヘビーに使っているであろう Airbnb 社での実務上の要求と合致しない部分があるから独自の guide を設けているのだと思われます。
  • RuboCop 標準では厳しいところを部分的に緩めるにしてもその判断を自分で下すよりも Airbnb(あるいは Cookpad)による判断に身を任せる方が合理的だろうと考えています。

そのうちやること(Someday)

  • [ ] テスト用のディレクトリ、テストの雛形ファイルなどを Rake で生成したい。
  • [ ] RubyMine インストールしてみる?
  • [ ] Ruby を書くためのエディタの設定(Emacs
  • [ ] bash の設定ファイルに必要なエイリアスを追加する。