Guard::Spork automatically manage Spork DRb servers
Guard::Spork automatically manage Spork DRb servers
Guard::Spork allows to automatically & intelligently start/reload your RSpec/Cucumber/Test::Unit Spork server(s).
Please be sure to have Guard installed before continuing.
Install the gem:
$ gem install guard-sporkAdd it to your Gemfile (inside development group):
group :development do
gem 'guard-spork'
endAdd guard definition to your Guardfile with:
$ guard init sporkPlease read the Guard usage documentation.
Please read Guard doc for more info about the Guardfile DSL.
IMPORTANT: place Spork guard before RSpec/Cucumber/Test::Unit guards!
guard 'spork' do
watch('config/application.rb')
watch('config/environment.rb')
watch(%r{^config/environments/.*\.rb$})
watch(%r{^config/initializers/.*\.rb$})
watch('Gemfile.lock')
watch('spec/spec_helper.rb') { :rspec }
watch('test/test_helper.rb') { :test_unit }
watch(%r{features/support/}) { :cucumber }
endPass the :cmd => "rspec --drb" option to Guard::RSpec and/or Guard::Cucumber to run them over the Spork DRb server:
guard 'rspec', :cmd => "rspec --drb" do
# ...
end
guard 'cucumber', :cmd => "rspec --drb" do
# ...
endFor MiniTest Guard you should pass the :drb => true option:
guard 'minitest', :drb => true do
# ...
endGuard::Spork automatically detect RSpec/Cucumber/Test::Unit/Bundler presence but you can disable any of them with the corresponding options:
guard 'spork', :rspec => false, :cucumber => false, :test_unit => false, :bundler => false do
# ...
endYou can provide additional environment variables for RSpec, Cucumber, and Test::Unit with the :rspec_env, :cucumber_env, and :test_unit_env options:
guard 'spork', :cucumber_env => { 'RAILS_ENV' => 'cucumber' }, :rspec_env => { 'RAILS_ENV' => 'test' }, :test_unit_env => { 'RAILS_ENV' => 'test' } do
# ...
endIf your application runs on Heroku or otherwise uses Foreman, you can provide the :foreman => true option to have environment variables present in the .env file passed on to the Spork server.
Available options:
…If you can start Spork manually but get the following error message when using Guard::Spork:
Starting Spork for RSpec ERROR: Could not start Spork for RSpec/Cucumber. Make sure you can use it manually first.
Try to increase the value of the :wait => 60 option before any further investigation.
It's possible that this error is the result of an unnecessary /test directory in the root of your application. Removing the /test directory entirely may resolve this error.
Pull requests are very welcome! Please try to follow these simple "rules", though:
For questions please join us on our Google group or on #guard (irc.freenode.net).
No open issues yet, or sync has not completed.