
Rails+RSpec+Guardでコード編集時にテストを自動実行
Railsアプリに対しRSpecでテストを書いている場合、コードを編集してテストを実行するのに、
毎回bundle exec rspec
を実行するのは面倒です。
ここでは、guard(guard-rspec)というライブラリを使って、コードの編集と同時にテストを動かす方法について纏めてみます。
guard
guardは、Rubyで書かれたライブラリで、ファイルやディレクトリの変更を検知し、ユーザが定義した様々なタスクを実行する事ができます。MITライセンスのオープンソースとして公開されています。
guard-rspec
guard-rspecは、ファイルやディレクトリの変更を検知し、RSpecを実行するためのguardのプラグインで、これもMITライセンスのオープンソースとして公開されています。
環境
この記事を書くにあたって、使用した環境は次のとおりです。
- MacOS X Yosemite(10.10.5)
- ruby 2.4.0(rbenv)
- rails 5.0.1
- rspec-rails 3.5.2
- guard-rspec 4.7.3
guardの導入
Gemfileに、
group :development, :test do
gem 'guard-rspec', require: false
end
を追記して、bundle install
します。
次に、
bundle exec guard init rails
を実行し、Guardfile
を生成します。
生成されたGuardfile
は、次のような内容となっています。
# A sample Guardfile
# More info at https://github.com/guard/guard#readme
## Uncomment and set this to only include directories you want to watch
# directories %w(app lib config test spec features) \
# .select{|d| Dir.exists?(d) ? d : UI.warning("Directory #{d} does not exist")}
## Note: if you are using the `directories` clause above and you are not
## watching the project directory ('.'), then you will want to move
## the Guardfile to a watched dir and symlink it back, e.g.
#
# $ mkdir config
# $ mv Guardfile config/
# $ ln -s config/Guardfile .
#
# and, you'll have to watch "config/Guardfile" instead of "Guardfile"
# Note: The cmd option is now required due to the increasing number of ways
# rspec may be run, below are examples of the most common uses.
# * bundler: 'bundle exec rspec'
# * bundler binstubs: 'bin/rspec'
# * spring: 'bin/rspec' (This will use spring if running and you have
# installed the spring binstubs per the docs)
# * zeus: 'zeus rspec' (requires the server to be started separately)
# * 'just' rspec: 'rspec'
guard :rspec, cmd: "bundle exec 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
guardの実行
guardによるファイルの変更監視を実行するには、次のコマンドを実行します。
bundle exec guard
すると、guardが起動し、ファイルの監視が始まり、ソースコードやテストコードを編集すると、RSpecが自動で実行されます。
guardはわずかな手順で導入でき、開発効率を向上させることができるので、積極的に使っていきたいですね。