Rubyコードの健康を保つためのgem 5+1選

こんにちは、Railsエンジニアの鈴木(信)です。

先日31歳になったんですが、やはり30歳を超えたあたりから衰えたというか、何か体に変化があったように思います。自身の健康はもちろんですが、コードの健康(品質)のことも気になる年頃になりました。そこで今回は弊社で利用しているコード解析ツールをご紹介します。　

brakeman - セキュリティ

brakemanは、簡単なXSSやインジェクション系の脆弱性を検出してくれるgemです。

もちろんこれだけで完全に安心という訳ではありませんが、弊社ではJenkinsのBrakeman Pluginを使って、継続的にモニタリング、修正しています。

使い方

$ brakeman
$ brakeman --only-files=path/to/specific_file

simplecov - テストカバレッジ

simplecovはカバレッジ計測ツールです。

RSpecなどのテストツールと組み合わせて、テストの網羅性を計測することができます。

使い方

rails_helper.rb

if ENV['COVERAGE']
  require 'simplecov'
  require 'simplecov-rcov'
  SimpleCov.start 'rails' do
    add_filter '/vendor'
  end
  SimpleCov.formatter = SimpleCov::Formatter::RcovFormatter
end

$ gem install simplecov simplecov-rcov
$ COVERAGE=1 rspec

coverage/rcov/index.htmlにカバレッジレポートが生成されます。　

rubocop - コーディングスタイル

rubocopはコーディングスタイルの違反を検出してくれるだけでなく、長すぎるメソッドや複雑すぎるロジックを検出して、コードの保守性を維持してくれるスグレモノです。

最初から導入していれば良いですが、途中から使いはじめると大量の警告が出てしまうと思います。

インデントやスペースの過不足など、修正方法が自動的に決まるものについては、自動修正が効きます。

$ rubocop --auto-gen-config  # 検出されたスタイル違反からrubocop-todo.ymlを自動生成。.rubocop.ymlで読み込んで一時的に無視できる
$ rubocop -a path/to/file.rb # 自動修正できるものを自動修正

また、git diffに対してだけrubocopを適用する、rubocop-gitというgemもあります。途中からの導入はこちらの方が使いやすいかもしれません。　

pre-commit - コーディングスタイル

過去に新サービスを立ち上げる際、エンジニアとしてやって良かった 9個の事という記事でもご紹介しました。

pre-commitはgitのpre-commit hookを利用して、余計なスペースや消し忘れのデバッグコードをコミットしてしまうのを防いでくれるgemです。デフォルトでは無効ですが、rubocopを実行することもできます。

使い方

$ pre-commit install
$ pre-commit disable yaml checks rubocop

bullet - パフォーマンス

bulletはN+1問題(ループでSQLが大量に実行される問題)を検出するgemです。

反対に、includes(:association)でeager loadingしたけど、実際にはassociationが使われていないというのも検出してくれます。

警告が発生したときの出力は、エラーを発生させたり、JavaScriptでalertを発生させたり、ログに出力したりと色々オプションがあります。

使い方

ログに出力する例です。

config/environments/development.rb

Your::Application.configure do
  config.after_initialize do
    Bullet.enable = true
    Bullet.bullet_logger = true
    Bullet.stacktrace_includes
  end
end