rainforest-guard-resque 0.0.6

data/.gitignore

@@ -0,0 +1,6 @@
+*.gem
+.bundle
+Gemfile.lock
+pkg/*
+.rvmrc
+.rbx

data/.travis.yml

@@ -0,0 +1,2 @@
+rvm:
+  - 1.9.3

data/CHANGELOG.md

@@ -0,0 +1,46 @@
+## 0.0.6 (2013-01-15)
+
+ * Added Travis CI image and set it up
+ * Added Gemnasium to check dependancies
+ * Clarified documentation
+ * Made the output to Guard's console more consistent
+ * Allow custom SIGKILL timeout instead
+ * Fixed "WARNING: This way of doing signal handling is now deprecated. Please see http://hone.heroku.com/resque/2012/08/21/resque-signals.html for more info."
+
+## 0.0.5
+
+ * Unknown (to be updated later)
+
+## 0.0.4
+
+ * Add a :vverbose option to distinguish from the :verbose option
+ * Add a timeout when killing Resque, to force it with SIGKILL
+ * Change the way the #spawn call is made, so it doesn't create a subshell to launch
+   Resque, which was causing issue #2
+
+## 0.0.3
+
+ * Forked from guard-delayed and started guard-resque
+
+
+-- guard-delayed --
+
+## 0.1.0 (2011-07-28)
+
+ * Fixed options for current delayed_job version (from dbloete)
+ * Environment settings needed to be passed in via RAILS_ENV=
+
+## 0.0.9 (2011-06-22)
+
+ * Fixed argument passing to the start script
+ * Cleaned up some documentation.
+
+## 0.0.8 (2011-05-24)
+
+ * Changed template to include :environment => 'development'
+ * Changed name from 'guard-delayed_job' to 'guard-delayed'
+ * Fixed options passing
+
+## 0.0.3 (2011-05-23)
+
+ * Initial release.

data/Gemfile

@@ -0,0 +1,4 @@
+source "http://rubygems.org"
+
+# Specify your gem's dependencies in guard-resque.gemspec
+gemspec

data/Guardfile

@@ -0,0 +1,10 @@
+guard 'bundler' do
+  watch(/^Gemfile/)
+  watch(/^.+\.gemspec/)
+end
+
+guard 'rspec', :version => 2 do
+  watch(/^spec\/.*_spec\.rb/)
+  watch(/^lib\/(.*)\.rb/)         { |m| "spec/#{m[1]}_spec.rb" }
+  watch(/^spec\/spec_helper\.rb/) { "spec" }
+end

data/LICENSE

@@ -0,0 +1,18 @@
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,115 @@
+[![Build Status](https://travis-ci.org/rainforestapp/guard-resque.png?branch=master)](https://travis-ci.org/rainforestapp/guard-resque)
+
+[![Dependency Status](https://gemnasium.com/rainforestapp/guard-resque.png)](https://gemnasium.com/rainforestapp/guard-resque)
+
+
+# Guard::Resque
+
+Guard::Resque automatically starts/stops/restarts resque workers
+
+*Forked from [Guard::Resque](http://github.com/railsjedi/guard-resque)*
+
+## Install
+
+Please be sure to have [Guard](http://github.com/guard/guard) installed before you continue.
+
+Install the gem:
+
+```bash
+gem install ainforest-guard-resque
+```
+
+Add it to your Gemfile (inside test group):
+
+```bash
+gem 'ainforest-guard-resque'
+```
+
+Add guard definition to your Guardfile by running this command:
+
+```bash
+guard init resque
+```
+
+## Usage
+
+Please read Guards [usage documents](http://github.com/guard/guard#readme).
+
+I suggest you put the resque guard definition *before* your test/rspec guard if your tests depend on it being active.
+
+### Guardfile
+
+```ruby
+guard 'resque', :environment => 'development' do
+  watch(%r{^app/(.+)\.rb$})
+  watch(%r{^lib/(.+)\.rb$})
+end
+```
+
+Feel free to be more specific, for example watching only for `app/models` and `app/jobs` to avoid reloading on a javascript file change.
+
+### Options
+
+You can customize the resque task via the following options:
+
+* `environment`: the rails environment to run the workers in (defaults to `nil`)
+* `task`: the name of the rake task to use (defaults to `"resque:work"`)
+* `queue`: the resque queue to run (defaults to `"*"`)
+* `interval`: the interval to use for checking for new resque jobs (defaults to `5`)
+* `count`: the number of workers to include (defaults to `1`)
+* `verbose`: whether to use verbose logging (defaults to `nil`)
+* `vverbose`: whether to use very verbose logging (defaults to `nil`)
+* `trace`: whether to include `--trace` on the rake command (defaults to `nil`)
+* `stop_signal`: how to kill the process when restarting (defaults to `SIGTERM`)
+* `stop_timeout`: how long to wait (in seconds) for resque to exit (defaults to 5 seconds, one more than the resque default)
+* `term_child`: defaults to 1 to use the new signal handling in 2.x
+
+
+## Development
+
+ * Source hosted at [GitHub](http://github.com/ukd1/guard-resque)
+ * Report issues/Questions/Feature requests on [GitHub Issues](http://github.com/ukd1/guard-resque/issues)
+
+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
+
+```bash
+gem install guard-resque-0.x.x.gem
+```
+
+### Building and deploying gem
+
+ * Update the version number in `lib/guard/resque/version.rb`
+ * Update `CHANGELOG.md`
+ * Build the gem:
+
+```bash
+gem build guard-resque.gemspec
+```
+
+ * Push to rubygems.org:
+
+```bash
+gem push guard-resque-0.x.x.gem
+```
+
+
+### Guard::Delayed Authors
+
+  * [David Parry](https://github.com/suranyami)
+  * [Dennis Reimann](https://github.com/dbloete)
+
+Ideas for this gem came from [Guard::WEBrick](http://github.com/fnichol/guard-webrick).
+
+
+### Guard::Resque Authors
+
+[Jacques Crocker](https://github.com/railsjedi) hacked this together from the `guard-delayed` gem for use with Resque. All credit go to the original authors though. Jacques just search/replaced and tweaked a few things.
+
+I've ([ukd1](https://github.com/ukd1)) only fixed a few issues that have cropped up recently that were annoying and unfixed.
+
+
+## License
+
+MIT License. See [LICENSE](/rainforestapp/guard-resque/blob/master/LICENSE) for details.

data/Rakefile

@@ -0,0 +1,33 @@
+require 'bundler'
+Bundler::GemHelper.install_tasks
+
+require 'rspec/core/rake_task'
+RSpec::Core::RakeTask.new(:spec)
+task :default => :spec
+
+namespace :spec do
+  desc "Run all specs on multiple ruby versions (requires rvm)"
+  task :portability do
+
+    command = <<-BASH
+      source ~/.rvm/scripts/rvm;
+      rvm #{ENV['RUBIES'] || 'all'} do bundle exec rake spec
+    BASH
+    system "bash -c '#{command}'"
+
+  end
+
+  namespace :portability do
+    desc 'Installs bundler/rake and runs bundle install for all rubies'
+    task :prepare do
+      # FIXME: This isn't working for me when it gets to JRuby, specs are running fine - RL
+      command = <<-BASH
+        source ~/.rvm/scripts/rvm;
+        rvm #{ENV['RUBIES'] || 'all'} do gem install bundler rake;
+        rvm #{ENV['RUBIES'] || 'all'} do bundle install
+      BASH
+
+      system "bash -c '#{command}'"
+    end
+  end
+end

data/guard-resque.gemspec

@@ -0,0 +1,30 @@
+# -*- encoding: utf-8 -*-
+$:.push File.expand_path("../lib", __FILE__)
+require "guard/resque/version"
+
+Gem::Specification.new do |s|
+  s.name        = "rainforest-guard-resque"
+  s.version     = Guard::ResqueVersion::VERSION
+  s.platform    = Gem::Platform::RUBY
+  s.authors     = ["Jacques Crocker", "Ryan Long", "David Parry", "Jim Deville", "Russell Smith"]
+  s.email       = ["railsjedi@gmail.com", "ryan@rtlong.com", "james.deville@gmail.com", "russ@rainforestqa.com"]
+  s.homepage    = 'http://github.com/rainforestapp/guard-resque'
+  s.summary     = %q{guard gem for resque}
+  s.description = %q{Guard::Resque automatically starts/stops/restarts resque worker}
+
+  s.required_rubygems_version = '>= 1.3.6'
+
+  s.add_dependency 'guard', '>= 1.1'
+  s.add_dependency 'resque'
+
+  s.add_development_dependency 'bundler'
+  s.add_development_dependency 'rake'
+  s.add_development_dependency 'rspec'
+  s.add_development_dependency 'guard-rspec',   '>= 0.2.0'
+  s.add_development_dependency 'guard-bundler', '>= 0.1.1'
+
+  s.files         = `git ls-files`.split("\n")
+  s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
+  s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
+  s.require_paths = ["lib"]
+end

data/lib/guard-resque.rb

@@ -0,0 +1 @@
+require 'guard/resque'

data/lib/guard/resque.rb

@@ -0,0 +1,118 @@
+require 'guard'
+require 'guard/guard'
+require 'timeout'
+
+module Guard
+  class Resque < Guard
+
+    DEFAULT_TERM_CHILD = 1
+    DEFAULT_SIGNAL = :SIGTERM
+    DEFAULT_QUEUE = '*'.freeze
+    DEFAULT_COUNT = 1
+    DEFAULT_TASK_SINGLE = 'resque:work'.freeze
+    DEFAULT_TASK_MULTIPLE = 'resque:workers'.freeze
+
+    # Allowable options are:
+    #  - :environment  e.g. 'test'
+    #  - :task .e.g 'resque:work'
+    #  - :queue e.g. '*'
+    #  - :count e.g. 3
+    #  - :interval e.g. 5
+    #  - :verbose e.g. true
+    #  - :vverbose e.g. true
+    #  - :trace e.g. true
+    #  - :stop_signal e.g. :QUIT or :SIGQUIT
+    #  - :stop_timeout in seconds. Defaults to 5 seconds (one more than resque)
+    #  - :term_child defaults to 1 to use the new signal handling in 2.x
+    def initialize watchers = [], options = {}
+      @options = options
+      @pid = nil
+      @stop_signal = options[:stop_signal] || DEFAULT_SIGNAL
+      @stop_timeout = options[:stop_timeout] || 5
+
+      @options[:term_child] ||= DEFAULT_TERM_CHILD
+      @options[:queue] ||= DEFAULT_QUEUE
+      @options[:count] ||= DEFAULT_COUNT
+      @options[:task] ||= (@options[:count].to_i == 1) ? DEFAULT_TASK_SINGLE : DEFAULT_TASK_MULTIPLE
+      super
+    end
+
+    def start
+      stop
+      UI.info 'Resque: Starting...'
+      UI.info 'Resque: ' + [ cmd, env.map{|v| v.join('=')} ].join(' ')
+
+      # launch Resque worker
+      @pid = spawn(env, cmd)
+    end
+
+    def stop
+      if @pid
+        UI.info 'Resque: Stopping...'
+        ::Process.kill @stop_signal, @pid
+        begin
+          Timeout.timeout(@stop_timeout) do
+            ::Process.wait @pid
+          end
+        rescue Timeout::Error
+          UI.info "Resque: Sending SIGKILL as it has taken longer than #{@stop_timeout} to exit. Customize this with the stop_timeout option."
+          ::Process.kill :KILL, @pid
+          ::Process.wait @pid
+        end
+        UI.info 'Resque: Stopped'
+      end
+    rescue Errno::ESRCH
+      UI.info 'Resque: lost the worker subprocess!'
+    ensure
+      @pid = nil
+    end
+
+    # Called on Ctrl-Z signal
+    def reload
+      UI.info 'Resque: Restarting...'
+      restart
+    end
+
+    # Called on Ctrl-/ signal
+    def run_all
+      true
+    end
+
+    # Called on file(s) modifications
+    def run_on_changes paths
+      restart
+    end
+
+    def restart
+      stop
+      start
+    end
+
+    private
+
+    def cmd
+      command = ['bundle exec rake', @options[:task].to_s]
+
+      # trace setting
+      command << '--trace' if @options[:trace]
+
+      command.join(' ')
+    end
+
+    def env
+      var = Hash.new
+
+      var['TERM_CHILD']= @options[:term_child].to_s  if @options[:term_child]
+      var['INTERVAL']  = @options[:interval].to_s    if @options[:interval]
+      var['QUEUE']     = @options[:queue].to_s       if @options[:queue]
+      var['COUNT']     = @options[:count].to_s       if @options[:count]
+      var['RAILS_ENV'] = @options[:environment].to_s if @options[:environment]
+
+      var['VERBOSE']  = '1' if @options[:verbose]
+      var['VVERBOSE'] = '1' if @options[:vverbose]
+
+      var
+    end
+  end
+end
+

data/lib/guard/resque/templates/Guardfile

@@ -0,0 +1,12 @@
+### Guard::Resque
+#  available options:
+#  - :task (defaults to 'resque:work' if :count is 1; 'resque:workers', otherwise)
+#  - :verbose / :vverbose (set them to anything but false to activate their respective modes)
+#  - :trace
+#  - :queue (defaults to "*")
+#  - :count (defaults to 1)
+#  - :environment (corresponds to RAILS_ENV for the Resque worker)
+guard 'resque', :environment => 'development' do
+  watch(%r{^app/(.+)\.rb$})
+  watch(%r{^lib/(.+)\.rb$})
+end

data/lib/guard/resque/version.rb

@@ -0,0 +1,5 @@
+module Guard
+  module ResqueVersion
+    VERSION = "0.0.6"
+  end
+end

data/spec/guard/resque_spec.rb

@@ -0,0 +1,74 @@
+require 'spec_helper'
+
+describe Guard::Resque do
+  describe 'start' do
+
+    it 'should accept :environment option' do
+      environment = :foo
+
+      obj = Guard::Resque.new [], :environment => environment
+      obj.send(:env).should include 'RAILS_ENV' => environment.to_s
+    end
+
+    it 'should accept :term_child option' do
+      queue = :foo
+
+      obj = Guard::Resque.new [], :term_child => 2
+      obj.send(:env).should include 'TERM_CHILD' => 2.to_s
+    end
+
+    it 'should accept :queue option' do
+      queue = :foo
+
+      obj = Guard::Resque.new [], :queue => queue
+      obj.send(:env).should include 'QUEUE' => queue.to_s
+    end
+
+    it 'should accept :count option' do
+      count = 2
+
+      obj = Guard::Resque.new [], :count => count
+      obj.send(:env).should include 'COUNT' => count.to_s
+    end
+
+    it 'should accept :vverbose option' do
+      obj = Guard::Resque.new [], :vverbose => true
+      obj.send(:env).should include 'VVERBOSE'
+    end
+
+    it 'should accept :verbose option' do
+      obj = Guard::Resque.new [], :verbose => true
+      obj.send(:env).should include 'VERBOSE'
+    end
+
+    it 'should accept :trace option' do
+      obj = Guard::Resque.new [], :trace => true
+      obj.send(:cmd).should include '--trace'
+    end
+
+    it 'should accept :task option' do
+      task = 'environment foo'
+
+      obj = Guard::Resque.new [], :task => task
+      obj.send(:cmd).should include task
+      obj.send(:cmd).should_not include Guard::Resque::DEFAULT_TASK_SINGLE
+    end
+
+    it 'should provide default options' do
+      obj = Guard::Resque.new []
+      obj.send(:env).should include 'QUEUE' => Guard::Resque::DEFAULT_QUEUE.to_s
+      obj.send(:env).should include 'COUNT' => Guard::Resque::DEFAULT_COUNT.to_s
+      obj.send(:cmd).should include Guard::Resque::DEFAULT_TASK_SINGLE
+    end
+
+    it 'should provide different default options when :count is multiple' do
+      count = 2
+
+      obj = Guard::Resque.new [], :count => count
+      obj.send(:env).should include 'QUEUE' => Guard::Resque::DEFAULT_QUEUE.to_s
+      obj.send(:env).should include 'COUNT' => count.to_s
+      obj.send(:cmd).should include Guard::Resque::DEFAULT_TASK_MULTIPLE
+    end
+
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,10 @@
+require 'rspec'
+require 'guard/resque'
+
+ENV['GUARD_ENV'] = 'test'
+
+RSpec.configure do |config|
+  config.color_enabled = true
+  config.filter_run :focus => true
+  config.run_all_when_everything_filtered = true
+end

metadata

@@ -0,0 +1,182 @@
+--- !ruby/object:Gem::Specification
+name: rainforest-guard-resque
+version: !ruby/object:Gem::Version
+  version: 0.0.6
+  prerelease: 
+platform: ruby
+authors:
+- Jacques Crocker
+- Ryan Long
+- David Parry
+- Jim Deville
+- Russell Smith
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-01-15 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: guard
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '1.1'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '1.1'
+- !ruby/object:Gem::Dependency
+  name: resque
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: guard-rspec
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 0.2.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 0.2.0
+- !ruby/object:Gem::Dependency
+  name: guard-bundler
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 0.1.1
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 0.1.1
+description: Guard::Resque automatically starts/stops/restarts resque worker
+email:
+- railsjedi@gmail.com
+- ryan@rtlong.com
+- james.deville@gmail.com
+- russ@rainforestqa.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .travis.yml
+- CHANGELOG.md
+- Gemfile
+- Guardfile
+- LICENSE
+- README.md
+- Rakefile
+- guard-resque.gemspec
+- lib/guard-resque.rb
+- lib/guard/resque.rb
+- lib/guard/resque/templates/Guardfile
+- lib/guard/resque/version.rb
+- spec/guard/resque_spec.rb
+- spec/spec_helper.rb
+homepage: http://github.com/rainforestapp/guard-resque
+licenses: []
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: 1.3.6
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.24
+signing_key: 
+specification_version: 3
+summary: guard gem for resque
+test_files:
+- spec/guard/resque_spec.rb
+- spec/spec_helper.rb
+has_rdoc: