Guardメモ

Guard 2.16.2、guard-brakeman 0.8.6、guard-reek 1.2.0、guard-rspec 4.7.3、guard-rubocop 1.4.0で確認。

GitHubリポジトリ：Guard

以下を参考に各gemをインストールしておくこと。

以下のGemをインストールする。

group :development do
  # Guard本体
  gem 'guard'
  # Brakeman拡張
  gem 'guard-brakeman'
  # Reek拡張
  gem 'guard-reek'
  # RSpec拡張
  gem 'guard-rspec', require: false
  # RuboCop拡張
  gem 'guard-rubocop'
  # guard-rails_best_practicesというgemもあるが古すぎるのかうまく動かなかった
end

bundle exec guard initを実行するとGuardfileが作成される。インストールされている拡張すべての設定が出力されるが、後でgemを追加した場合はbundle exec guard init rspecのようなコマンドを実行すれば個別に適用ができる。詳細は各gemのGitHubリポジトリを参照。

bundle exec guardを実行すればファイルの監視を始め、変更を検知したらそのファイルに対して各タスクを実行する。[1] guard(main)>の状態でEnterすれば全てのファイルに対して各タスクが実行される（基本的には）。Guard起動時に全てのファイルに対して実行されるようになっている拡張もある。

自分の考える推奨設定

RSpecメモを参考に、bin/rspecを作成しておく。

# Springによるキャッシュを利用するため
# cmd: 'bundle exec rspec'からcmd: 'bin/rspec'に変更する
# ブロック内部はデフォルト
guard :rspec, cmd: 'bin/rspec' do
  require 'guard/rspec/dsl'
  dsl = Guard::RSpec::Dsl.new(self)

  # Feel free to open issues for suggestions and improvements

  # RSpec files
  rspec = dsl.rspec
  watch(rspec.spec_helper) { rspec.spec_dir }
  watch(rspec.spec_support) { rspec.spec_dir }
  watch(rspec.spec_files)

  # Ruby files
  ruby = dsl.ruby
  dsl.watch_spec_files_for(ruby.lib_files)

  # Rails files
  rails = dsl.rails(view_extensions: %w[erb haml slim])
  dsl.watch_spec_files_for(rails.app_files)
  dsl.watch_spec_files_for(rails.views)

  watch(rails.controllers) do |m|
    [
      rspec.spec.call("routing/#{m[1]}_routing"),
      rspec.spec.call("controllers/#{m[1]}_controller"),
      rspec.spec.call("acceptance/#{m[1]}")
    ]
  end

  # Rails config changes
  watch(rails.spec_helper)     { rspec.spec_dir }
  watch(rails.routes)          { "#{rspec.spec_dir}/routing" }
  watch(rails.app_controller)  { "#{rspec.spec_dir}/controllers" }

  # Capybara features specs
  watch(rails.view_dirs)     { |m| rspec.spec.call("features/#{m[1]}") }
  watch(rails.layouts)       { |m| rspec.spec.call("features/#{m[1]}") }

  # Turnip features and steps
  watch(%r{^spec/acceptance/(.+)\.feature$})
  watch(%r{^spec/acceptance/steps/(.+)_steps\.rb$}) do |m|
    Dir[File.join("**/#{m[1]}.feature")][0] || 'spec/acceptance'
  end
end

# all_on_start: false, cli: %w[--format quiet -P]を追加する
# all_on_start : Guard起動時に実行するか（falseで実行しない）
# cli : コマンドラインオプションの指定
#       --format quiet 最小限の表示指定
#       -P             パラレル実行の指定
# ブロック内部はデフォルト
guard :rubocop, all_on_start: false, cli: %w[--format quiet -P] do
  watch(/.+\.rb$/)
  watch(%r{(?:.+/)?\.rubocop(?:_todo)?\.yml$}) { |m| File.dirname(m[0]) }
end

# run_on_start: false, quiet: trueを追加する
# run_on_start : Guard起動時に実行するか（falseで実行しない）
# quiet : trueで最小限の表示
# ブロック内部はデフォルト
guard :brakeman, run_on_start: false, quiet: true do
  watch(%r{^app/.+\.(erb|haml|rhtml|rb)$})
  watch(%r{^config/.+\.rb$})
  watch(%r{^lib/.+\.rb$})
  watch('Gemfile')
end

# all_on_start: false, cli: '--no-progress'を追加する
# all_on_start : Guard起動時に実行するか（falseで実行しない）
# cli : コマンドラインオプションの指定
#       --no-progress 最小限の表示指定
guard 'reek', all_on_start: false, cli: '--no-progress' do
  watch(/.+\.rb$/)
  # '.reek'を'.reek.yml'に変更する
  watch('.reek.yml')
end

上記の設定で実行結果は以下のようになる。

[1] guard(main)>
20:21:43 - INFO - Run all
20:21:43 - INFO - Running all specs
Running via Spring preloader in process 6366
 86/86 |=============== 100 ================>| Time: 00:00:03

Finished in 3.14 seconds (files took 0.75492 seconds to load)
86 examples, 0 failures

20:21:47 - INFO - Inspecting Ruby code style of all files
20:21:50 - INFO - 0 brakeman findings
20:21:50 - INFO - Guard::Reek is running on all files
20:21:50 - INFO - Guard::Reek is running on all
0 total warnings

各gemのドキュメント

その他のGuardプラグインはRubyGems.orgでguard-を検索して探すと良い。