RubyStyleGuideとRubocopでの設定

いろいろな書き方ができるRuby。そのRubyを取り巻くコーディングポリシーの状況やツールについて、この回では書いていきたいと思います。

以前に某AdventCalendarに載せた内容だけどRubyStyleGuideもRubocopもその時に比べて変更されてきているので、改めて内容の反映した上でこっちに掲載。

Rubyの特徴とベストプラクティス

Rubyは１つの目的を達成するために複数のアプローチが可能な言語です。例えば配列の長さを取得したいときにarray.sizeとarray.lengthのどちらを使っても、配列の長さを取得することができます。これはもともと他の言語を使っていた人がRubyに親しみやすくなる要因の一つとなっているのですが、ある程度大きな開発をするときにはコーディングポリシーをしっかり決めておかないと、プログラムを書いた人によっては癖が強すぎて読みづらい事態が起きたり、最悪の場合追加開発の時に元のコードを読み違えて、バグの誘発につながるリスクもあります。

それらのリスクを低減し、他のRubyプログラマーが保守できるコードを書くためのベストプラクティスとして、The Ruby Style Guideというものが規定されています。

しかし定義されているポリシーは膨大で、気をつけていたつもりでも実は準拠していないコードを書いてしまうケースもあるでしょう。

そんな時に役にたつツールの一つとして、RuboCopがあります。

静的解析ツール：RuboCop

RuboCopは、あらかじめ決められたコーディングポリシーを元に、それに対して違反していないか、違反していた場合どう直すべきかの指標を示してくれるツールの１つです。

インストールも簡単で、下記のコマンドでインストールを行えます。

$ gem install rubocop --no-ri --no-rdoc
Successfully installed rubocop-0.27.1
1 gem installed

実際に下記のようなrubyファイルを作成し、rubocopコマンドで検査してみましょう

rubyファイル（sample.rb）

def aaaa
    bbbb
end

チェックの実行

$ rubocop sample.rb 
Inspecting 1 file
C

Offenses:

sample.rb:2:1: C: Use 2 (not 6) spaces for indentation.
      bbbb
^^^^^^

1 file inspected, 1 offense detected

実行してみるとエラーが出ます。 これはインデントが半角スペース2つ(RubyStyleGuide準拠)ではないために起こっているエラーです。

これを半角スペース２つに直すと、今度は無事に実行完了となるはずです。

$ rubocop sample.rb 
Inspecting 1 file
.

1 file inspected, no offenses detected

RuboCop活用する

さきほどは保存したファイルに対してRuboCopを実行しましたが、保存する前段階にエディタに警告を表示してくれるプラグインもあったりします。

• vim-rubocop
• rubocop-emacs
• Sublime RuboCop plugin

また、Jenkinsを活用している場合、rubocop-checkstyle_formatterとJenkinsのViolationsPluginを組み合わせることで、Jenkinsのジョブ上に警告を表示させることもできます。

RuboCopとチーム開発

RuboCopは上記ツール類と組み合わせることで、チームとしてのコーディングポリシーをある程度統一することができます。ただ、各々のプロジェクトチームのこれまでの積み重ねであったり、文化的な背景であったりで、「どうしてもこの記述は合わない」といったような例外事項が出てくると思います

そんなときのためにRuboCopには設定ファイルでポリシーを制御する機能があります。プロジェクトのルートフォルダに.rubocop.ymlという名前で設定を記述することで、チームにとって最適なポリシーでコーディングすることができます。設定ファイルの内容はconfig/default.ymlを元に記述します。

ただ、各設定項目がRuby Style Guideのどの部分に該当するのかを日本語でまとめたところがなかったので、デフォルトでの有効無効設定と合わせてまとめてみました。(2016/10/01現在)

もし、すでにある程度ポリシーが固まっている場合は、下記のコマンドを使って.rubocop_todo.ymlを生成することができます。

$ rubocop --auto-gen-config
Inspecting 1 file
C

Offenses:

sample.rb:2:1: C: Use 2 (not 4) spaces for indentation.
    bbbb
^^^^

1 file inspected, 1 offense detected
Created .rubocop_todo.yml.
Run `rubocop --config .rubocop_todo.yml`, or
add inherit_from: .rubocop_todo.yml in a .rubocop.yml file.

これはそのプロジェクトのコーディングポリシーがconfig/default.ymlからどれだけ違っているかが記述されているファイルです。現在のコードを規範として利用するときにはここで生成した.rubocop_todo.ymlを.rubocop.ymlとして配布するか、実行時に下記のように指定することで、コーディングポリシーの統一を図ることができます。

$ rubocop --config .rubocop_todo.yml

RuboCopによるコードの自動修正

RuboCopはコーディングポリシーに即していないコードについて、自動修正する機能があります。ただし、修正できる項目は上記で生成した.rubocop_todo.ymlの内容として、# Cop supports --auto-correct.が付与されているものに限ります。

# Offense count: 1
# Cop supports --auto-correct.
# Configuration parameters: Width.
Style/IndentationWidth:
  Enabled: false

上記の記述が.rubocop_todo.ymlに含まれていた場合は、Ruby Style Guideのインデントには スペース 2つ(別名ソフトタブ)。 ハードタブを用いてはいけません。に則していない項目があることを示しています。これに対して下記のコマンドで自動修正を行うことができます。

$ rubocop --auto-correct
Inspecting 1 file
C

Offenses:

sample.rb:2:1: C: [Corrected] Use 2 (not 4) spaces for indentation.
    bbbb
^^^^

1 file inspected, 1 offense detected, 1 offense corrected

まとめ

今回はRubyの記述に関するベストプラクティスであるRuby Style Guideと、それを元にした静的解析ツールのRuboCop、そしてその周辺ツール、コーディングポリシーのチューニング方法、コードの自動修正機能について紹介しました。

自分のコードの客観評価としても利用できるツールだと思いますし、導入も簡単なのでちょっと試してみてはいかがでしょう？