Guard::Shoryuken

Build Status

Guard::Shoryuken automatically starts/stops/restarts Shoryuken workers

forked from Guard::Sidekiq

Install

Please be sure to have Guard installed before continue.

Install the gem:

git clone 'https://github.com/tagloo/guard-shoryuken.git
cd guard-shoryuken && gem build guard-shoryuken.gemspec
gem install guard-shoryuken

Add it to your Gemfile (inside test group):

gem 'guard-shoryuken', :git => 'https://github.com/tagloo/guard-shoryuken.git'

Add guard definition to your Guardfile by running this command:

guard init shoryuken

Usage

Please read Guard usage doc.

It is suggested to put the shoryuken guard definition before your test/rspec guard if your tests depend on it being active.

Guardfile

guard 'shoryuken', :environment => 'development' do
  watch(%r{^workers/(.+)\.rb})
end

Options

You can customize the shoryuken task via the following options:

  • environment: the rails environment to run the workers in (defaults to nil)
  • queue: the Amazon SQS queue to run (defaults to default). Can supply a list of queues here.
  • logfile: shoryuken defaults to logging to STDOUT. Can specify a file to log to instead.
  • timeout: shutdown timeout
  • concurrency: the number of threads to include (defaults to 25)
  • verbose: whether to use verbose logging (defaults to nil)
  • stop_signal: how to kill the process when restarting (defaults to TERM)
  • require: location of rails application with workers or file to require (defaults to nil)
  • config: can specify a config file to load queue settings

Development

Pull requests are very welcome! Make sure your patches are well tested. Please create a topic branch for every separate change you make.

Testing the gem locally

gem install guard-shoryuken-0.x.x.gem

Building and deploying gem

  • Update the version number in lib/guard/shoryuken/version.rb
  • Update CHANGELOG.md

  • Build the gem:

    gem build guard-shoryuken.gemspec

  • Push to rubygems.org:

    gem push guard-shoryuken-0.x.x.gem

Guard::Delayed Authors

David Parry, Dennis Reimann

Ideas for this gem came from Guard::WEBrick.

Guard::Resque Authors

Jacques Crocker

I hacked this together from the guard-delayed gem for use with Resque. All credit go to the original authors though. I just search/replaced and tweaked a few things.

Guard::Sidekiq Authors

Mark Bolusmjak, Pitr Vernigorov, David Parry

Replaces "rescue" with "sidekiq".

Guard::Shoryuken Authors

Eduardo Sebastian

Replaces "sidekiq" with "shoryuken".

  • Copyright
    • Copyright 2015 Tagloo App s.l.
  • License
    • Apache License, Version 2.0