resque-mongo 1.4.0 → 1.8.1

data/CONTRIBUTORS

@@ -1,14 +1,32 @@
 * Chris Wanstrath
+* gravis
+* scotttam
 * John Barnette
-* Adam Cooke
+* Mike Mangino
 * Rob Hanlon
 * Jason Amster
-* jgeiger
 * Aaron Quint
+* Adam Cooke
+* Ashley Martens
+* Matt Duncan
+* Michael Dwan
+* Daniel Ceballos
+* Roman Heinrich
+* Thibaut Barrère
+* jgeiger
+* Simon Rozet
+* Dave Hoover
+* Christos Trochalakis
 * Ben VandenBos
-* PJ Hyett
+* snusnu
 * Arthur Zapparoli
-* Simon Rozet
+* Ben Marini
 * Brian P O'Rourke
-* Dave Hoover
-* Michael Dwan
+* Jim Remsik and Les Hill
+* Karel Minarik
+* Luc Castera
+* Masatomo Nakano
+* Matt Palmer
+* PJ Hyett
+* Roland Moriz
+* malomalo

data/HISTORY.md

@@ -1,3 +1,68 @@
+## 1.8.0 (2010-04-07)
+
+* Jobs that never complete due to killed worker are now failed.
+* Worker "working" state is now maintained by the parent, not the child.
+* Stopped using deprecated redis.rb methods
+* `Worker.working` race condition fixed
+* `Worker#process` has been deprecated.
+* Monit example fixed
+* Redis::Client and Redis::Namespace can be passed to `Resque.redis=`
+
+## 1.7.1 (2010-04-02)
+
+* Bugfix: Make job hook execution order consistent
+* Bugfix: stdout buffering in child process
+
+## 1.7.0 (2010-03-31)
+
+* Job hooks API. See docs/HOOKS.md.
+* web: Hovering over dates shows a timestamp
+* web: AJAXify retry action for failed jobs
+* web bugfix: Fix pagination bug
+
+## 1.6.1 (2010-03-25)
+
+* Bugfix: Workers may not be clearing their state correctly on
+  shutdown
+* Added example monit config.
+* Exception class is now recorded when an error is raised in a
+  worker.
+* web: Unit tests
+* web: Show namespace in header and footer
+* web: Remove a queue
+* web: Retry failed jobs
+
+## 1.6.0 (2010-03-09)
+
+* Added `before_first_fork`, `before_fork`, and `after_fork` hooks.
+* Hoptoad: Added server_environment config setting
+* Hoptoad bugfix: Don't depend on RAILS_ROOT
+* 1.8.6 compat fixes
+
+## 1.5.2 (2010-03-03)
+
+* Bugfix: JSON check was crazy.
+
+## 1.5.1 (2010-03-03)
+
+* `Job.destroy` and `Resque.dequeue` return the # of destroyed jobs.
+* Hoptoad notifier improvements
+* Specify the namespace with `resque-web` by passing `-N namespace`
+* Bugfix: Don't crash when trying to parse invalid JSON.
+* Bugfix: Non-standard namespace support
+* Web: Red backgound for queue "failed" only shown if there are failed jobs.
+* Web bugfix: Tabs highlight properly now
+* Web bugfix: ZSET partial support in stats
+* Web bugfix: Deleting failed jobs works again
+* Web bugfix: Sets (or zsets, lists, etc) now paginate.
+
+## 1.5.0 (2010-02-17)
+
+* Version now included in procline, e.g. `resque-1.5.0: Message`
+* Web bugfix: Ignore idle works in the "working" page
+* Added `Resque::Job.destroy(queue, klass, *args)`
+* Added `Resque.dequeue(klass, *args)`
+
 ## 1.4.0 (2010-02-11)
 
 * Fallback when unable to bind QUIT and USR1 for Windows and JRuby.

data/README.markdown

@@ -7,14 +7,11 @@ monitoring sinatra app works except the "stats" panel, although there are
 a lot of details that need to been taken care of.
 
 Resque-mongo uses a fairly new feature of mongo, [findAndModify()][fnr].
-findAndModify is not yet supported by the ruby mongo driver because the
-command's api might change a bit. You can use a [patched version
-mongo-ruby-driver][fnr-ruby] that supports the current implementation.
+findAndModify that is only supported by 0.20+ version ofthe ruby mongo driver.
 
 Also, check your mongo version: 1.3.0 or higher
 
 [fnr]: http://www.mongodb.org/display/DOCS/findandmodify+Command 
-[fnr-ruby]: http://github.com/ctrochalakis/mongo-ruby-driver/tree/find_replace
 
 Resque
 ======
@@ -428,6 +425,10 @@ the script as the final argument:
 
     $ resque-web -p 8282 rails_root/config/initializers/resque.rb
 
+You can also set the namespace directly using `resque-web`:
+
+    $ resque-web -p 8282 -N myapp
+
 ### Passenger
 
 Using Passenger? Resque ships with a `config.ru` you can use. See
@@ -499,6 +500,8 @@ tool that's best for your app.
 Installing Redis
 ----------------
 
+Resque requires Redis 0.900 or higher.
+
 Resque uses Redis' lists for its queues. It also stores worker state
 data in Redis.
 
@@ -543,6 +546,9 @@ Resque Dependencies
 If you cannot install `yajl-ruby` (JRuby?), you can install the `json`
 gem and Resque will use it instead.
 
+When problems arise, make sure you have the newest versions of the
+`redis` and `redis-namespace` gems.
+
 
 Installing Resque
 -----------------
@@ -663,6 +669,17 @@ this way we can tell our Sinatra app about the config file:
 Now everyone is on the same page.
 
 
+Plugins and Hooks
+-----------------
+
+For a list of available plugins see
+<http://wiki.github.com/defunkt/resque/plugins>.
+
+If you'd like to write your own plugin, or want to customize Resque
+using hooks (such as `Resque.after_fork`), see
+[docs/HOOKS.md](http://github.com/defunkt/resque/blob/master/HOOKS.md).
+
+
 Namespaces
 ----------
 
@@ -694,10 +711,18 @@ Try it out by looking at the README, found at `examples/demo/README.markdown`.
 Monitoring
 ----------
 
+### god
+
 If you're using god to monitor Resque, we have provided example
 configs in `examples/god/`. One is for starting / stopping workers,
 the other is for killing workers that have been running too long.
 
+### monit
+
+If you're using monit, `examples/monit/resque.monit` is provided free
+of charge. This is **not** used by GitHub in production, so please
+send patches for any tweaks or improvements you can make to it.
+
 
 Development
 -----------
@@ -743,13 +768,16 @@ Once you've made your great commits:
 4. Create an [Issue][2] with a link to your branch
 5. That's it!
 
+You might want to checkout our [Contributing][cb] wiki page for information
+on coding standards, new features, etc.
+
 
 Mailing List
 ------------
 
 To join the list simply send an email to <resque@librelist.com>. This
 will subscribe you and send you information about your subscription,
-include unsubscribe information.
+including unsubscribe information.
 
 The archive can be found at <http://librelist.com/browser/>.
 
@@ -778,3 +806,4 @@ Chris Wanstrath :: chris@ozmm.org :: @defunkt
 [2]: http://github.com/defunkt/resque/issues
 [sv]: http://semver.org/
 [rs]: http://github.com/defunkt/redis-namespace
+[cb]: http://wiki.github.com/defunkt/resque/contributing

data/Rakefile

@@ -38,7 +38,7 @@ begin
     gemspec.authors = ["Christos Trochalakis"]
     gemspec.version = Resque::Version
 
-    gemspec.add_dependency "mongo"
+    gemspec.add_dependency "mongo", ">=0.20"
     gemspec.add_dependency "vegas", ">=0.1.2"
     gemspec.add_dependency "sinatra", ">=0.9.2"
     gemspec.add_development_dependency "jeweler"

data/bin/resque

@@ -35,7 +35,7 @@ def list
 end
 
 if (i = ARGV.index('-r')) && ARGV[i+1]
-  Resque.redis = ARGV[i+1]
+  Resque.mongo = ARGV[i+1]
   ARGV.delete_at(i)
   ARGV.delete_at(i+1)
 end
@@ -48,7 +48,7 @@ when 'remove'
 when 'list'
   list
 else
-  puts "Usage: resque [-r redis_host:redis_port] COMMAND [option]"
+  puts "Usage: resque [-r mongo_host:mongo_port] COMMAND [option]"
   puts
   puts "Commands:"
   puts "  remove WORKER   Removes a worker"

data/bin/resque-web

@@ -15,4 +15,9 @@ Vegas::Runner.new(Resque::Server, 'resque-web', {
     path = (ENV['RESQUECONFIG'] || v.args.first)
     load path.to_s.strip if path
   }
-})
+}) do |runner, opts, app|
+  opts.on('-N NAMESPACE', "--namespace NAMESPACE", "set the Redis namespace") {|namespace|
+    runner.logger.info "Using Redis namespace '#{namespace}'"
+    Resque.redis.namespace = namespace
+  }
+end

data/deps.rip

@@ -1,8 +1,8 @@
-git://github.com/ctrochalakis/mongo-ruby-driver find_replace
 mongo
-mongo_ext
+bson_ext
 git://github.com/brianmario/yajl-ruby.git 0.6.3
 git://github.com/sinatra/sinatra.git 0.9.4
 git://github.com/rack/rack.git 1.0
 git://github.com/quirkey/vegas.git v0.1.2
+git://github.com/brynary/rack-test.git v0.5.3
 rake

data/docs/HOOKS.md

@@ -0,0 +1,121 @@
+Resque Hooks
+============
+
+You can customize Resque or write plugins using its hook API. In many
+cases you can use a hook rather than mess with Resque's internals.
+
+For a list of available plugins see
+<http://wiki.github.com/defunkt/resque/plugins>.
+
+
+Worker Hooks
+------------
+
+If you wish to have a Proc called before the worker forks for the
+first time, you can add it in the initializer like so:
+
+    Resque.before_first_fork do
+      puts "Call me once before the worker forks the first time"
+    end
+
+You can also run a hook before _every_ fork:
+
+    Resque.before_fork do |job|
+      puts "Call me before the worker forks"
+    end
+
+The `before_fork` hook will be run in the **parent** process. So, be
+careful - any changes you make will be permanent for the lifespan of
+the worker.
+
+And after forking:
+
+    Resque.after_fork do |job|
+      puts "Call me after the worker forks"
+    end
+
+The `after_fork` hook will be run in the child process and is passed
+the current job. Any changes you make, therefor, will only live as
+long as the job currently being processes.
+
+All worker hooks can also be set using a setter, e.g.
+
+    Resque.after_fork = proc { puts "called" }
+
+
+Job Hooks
+---------
+
+Plugins can utilize job hooks to provide additional behavior. A job
+hook is a method name in the following format:
+
+    HOOKNAME_IDENTIFIER
+
+For example, a `before_perform` hook which adds locking may be defined
+like this:
+
+    def before_perform_with_lock(*args)
+      set_lock!
+    end
+
+Once this hook is made available to your job (either by way of
+inheritence or `extend`), it will be run before the job's `perform`
+method is called. Hooks of each type are executed in alphabetical order,
+so `before_perform_a` will always be executed before `before_perform_b`.
+An unnamed hook (`before_perform`) will be executed first.
+
+The available hooks are:
+
+* `before_perform`: Called with the job args before perform. If it raises
+  `Resque::Job::DontPerform`, the job is aborted. If other exceptions
+  are raised, they will be propagated up the the `Resque::Failure`
+  backend.
+
+* `after_perform`: Called with the job args after it performs. Uncaught
+  exceptions will propagate up to the `Resque::Failure` backend.
+
+* `around_perform`: Called with the job args. It is expected to yield in order
+  to perform the job (but is not required to do so). It may handle exceptions
+  thrown by `perform`, but any that are not caught will propagate up to the
+  `Resque::Failure` backend.
+
+* `on_failure`: Called with the exception and job args if any exception occurs
+  while performing the job (or hooks).
+
+Hooks are easily implemented with superclasses or modules. A superclass could
+look something like this.
+
+    class LoggedJob
+      def self.before_perform_log_job(*args)
+        Logger.info "About to perform #{self} with #{args.inspect}"
+      end
+    end
+
+    class MyJob < LoggedJob
+      def self.perform(*args)
+        ...
+      end
+    end
+
+Modules are even better because jobs can use many of them.
+
+    module LoggedJob
+      def before_perform_log_job(*args)
+        Logger.info "About to perform #{self} with #{args.inspect}"
+      end
+    end
+
+    module RetriedJob
+      def on_failure_retry(e, *args)
+        Logger.info "Performing #{self} caused an exception (#{e}). Retrying..."
+        Resque.enqueue self, *args
+      end
+    end
+
+    class MyJob
+      extend LoggedJob
+      extend RetriedJob
+      def self.perform(*args)
+        ...
+      end
+    end

data/docs/PLUGINS.md

@@ -0,0 +1,93 @@
+Resque Plugins
+==============
+
+Resque encourages plugin development. For a list of available plugins,
+please see <http://wiki.github.com/defunkt/resque/plugins>.
+
+The `docs/HOOKS.md` file included with Resque documents the available
+hooks you can use to add or change Resque functionality. This document
+describes best practice for plugins themselves.
+
+
+Version
+-------
+
+Plugins should declare the major.minor version of Resque they are
+known to work with explicitly in their README.
+
+For example, if your plugin depends on features in Resque 2.1, please
+list "Depends on Resque 2.1" very prominently near the beginning of
+your README.
+
+Because Resque uses [Semantic Versioning][sv], you can safely make the
+following assumptions:
+
+* Your plugin will work with 2.2, 2.3, etc - no methods will be
+  removed or changed, only added.
+* Your plugin might not work with 3.0+, as APIs may change or be
+  removed.
+
+
+Namespace
+---------
+
+All plugins should live under the `Resque::Plugins` module to avoid
+clashing with first class Resque constants or other Ruby libraries.
+
+Good:
+
+* Resque::Plugins::Lock
+* Resque::Plugins::FastRetry
+
+Bad:
+
+* Resque::Lock
+* ResqueQueue
+
+
+Gem Name
+--------
+
+Gem names should be in the format of `resque-FEATURE`, where `FEATURE`
+succinctly describes the feature your plugin adds to Resque.
+
+Good:
+
+* resque-status
+* resque-scheduler
+
+Bad:
+
+* multi-queue
+* defunkt-resque-lock
+
+
+Hooks
+-----
+
+Job hook names should be namespaced to work properly.
+
+Good:
+
+* before_perform_lock
+* around_perform_check_status
+
+Bad:
+
+* before_perform
+* on_failure
+
+
+Lint
+----
+
+Plugins should test compliance to this document using the
+`Resque::Plugin.lint` method.
+
+For example:
+
+    assert_nothing_raised do
+      Resque::Plugin.lint(Resque::Plugins::Lock)
+    end
+
+[sv]: http://semver.org/