resque_spec 0.7.0 → 0.8.0

data/README.md

@@ -1,16 +1,13 @@
 ResqueSpec
 ==========
 
-A simple RSpec and Cucumber matcher for Resque.enqueue and
-Resque.enqueue_at/enqueue_in (from `ResqueScheduler`), loosely based on
+A test double of Resque for RSpec and Cucumber. The code was originally based
+on
 [http://github.com/justinweiss/resque_unit](http://github.com/justinweiss/resque_unit).
 
 ResqueSpec will also fire Resque hooks if you are using them. See below.
 
-This should work with `Resque v1.15.0` and up and `RSpec v2.5.0` and up.
-
-If you are using `RSpec ~> 1.3.0`, you should use version `~> 0.2.0`. This
-branch is not actively maintained.
+The current version works with `Resque v1.19.0` and up and `RSpec v2.5.0` and up.
 
 Install
 -------
@@ -23,6 +20,15 @@ Update your Gemfile to include `resque_spec` only in the *test* group (Not using
       gem 'resque_spec'
     end
 
+What is ResqueSpec?
+===================
+
+ResqueSpec is a fake of the *stable API* for Resque 1.19.x (which is `enqueue`,
+`enqueue_to`, `dequeue`, `reserve`, and the Resque hooks). It does not have a
+test double for Redis, so this may lead to some interesting and puzzling
+behaviour if you use some of the popular Resque plugins (such as
+`resque_lock`).
+
 Resque with Specs
 =================
 
@@ -77,6 +83,29 @@ Then I write some code to make it pass:
       end
     end
 
+You can check the size of the queue in your specs too.
+
+    describe "#recalculate" do
+      before do
+        ResqueSpec.reset!
+      end
+
+      it "adds an entry to the Person queue" do
+        person.recalculate
+        Person.should have_queue_size_of(1)
+      end
+    end
+
+ResqueMailer with Specs
+=======================
+
+To use with [ResqueMailer](https://github.com/zapnap/resque_mailer) you should
+have an initializer that does *not* exclude the `test` (or `cucumber`)
+environment. Your initializer will probably end up looking like:
+
+    # config/initializers/resque_mailer.rb
+    Resque::Mailer.excluded_environments = []
+
 ResqueScheduler with Specs
 ==========================
 
@@ -122,26 +151,10 @@ Then I write some code to make it pass:
       end
     end
 
-Queue Size Specs
-================
-
-You can check the size of the queue in your specs too.
-
-    describe "#recalculate" do
-      before do
-        ResqueSpec.reset!
-      end
-
-      it "adds an entry to the Person queue" do
-        person.recalculate
-        Person.should have_queue_size_of(1)
-      end
-    end
-
 Performing Jobs in Specs
 ========================
 
-Normally, Resque does not perform queued jobs within tests. You may want to
+Normally, ResqueSpec does not perform queued jobs within tests. You may want to
 make assertions based on the result of your jobs. ResqueSpec can process jobs
 immediately as they are queued or under your control.
 
@@ -205,14 +218,19 @@ I might write this as a Cucumber step
 Hooks
 =====
 
-Resque provides hooks at different points of the queueing lifecylce.  ResqueSpec fires these hooks when appropriate.
+Resque provides hooks at different points of the queueing lifecylce.
+ResqueSpec fires these hooks when appropriate.
 
-The after enqueue hook is always called when you use `Resque#enqueue`.
+The before and after `enqueue` hooks are always called when you use
+`Resque#enqueue`. If your `before_enqueue` hook returns `false`, the job will
+not be queued and `after_enqueue` will not be called.
 
 The `perform` hooks: before, around, after, and on failure are fired by
 ResqueSpec if you are using the `with_resque` helper or set `ResqueSpec.inline = true`.
 
-Important! `Resque#enqueue_at/enqueue_in` does not fire the after enqueue hook (the job has not been queued yet!), but will fire the `perform` hooks if you are using `inline` mode.
+Important! If you are using ResqueScheduler, `Resque#enqueue_at/enqueue_in`
+does not fire the after enqueue hook (the job has not been queued yet!), but
+will fire the `perform` hooks if you are using `inline` mode.
 
 Note on Patches/Pull Requests
 =============================
@@ -225,6 +243,22 @@ Note on Patches/Pull Requests
   (if you want to have your own version, that is fine but bump version in a commit by itself I can ignore when I pull)
 * Send me a pull request. Bonus points for topic branches.
 
+Contributors
+============
+
+* Les Hill          (@leshill)       : author
+* Kenneth Kalmer    (@kennethkalmer) : rspec dependency fix
+* Brian Cardarella  (@bcardarella)   : fix mutation bug
+* Joshua Davey      (@joshdavey)     : with_resque helper
+* Lar Van Der Jagt  (@supaspoida)    : with_resque helper
+* Evan Sagge        (@evansagge)     : Hook in via Job.create, have_queued.in
+* Jon Larkowski     (@l4rk)          : inline perform
+* James Conroy-Finn (@jcf)           : spec fix
+* Dennis Walters    (@ess)           : enqueue_in support
+*                   (@RipTheJacker)  : remove_delayed support
+* Kurt Werle        (@kwerle)        : explicit require spec for v020
+*                   (@dwilkie)       : initial before_enqueue support
+
 Copyright
 =========
 

data/lib/resque_spec/ext.rb

@@ -21,15 +21,25 @@ module Resque
   end
 
   def enqueue(klass, *args)
+    enqueue_to(queue_from_class(klass), klass, *args)
+  end
+
+  def enqueue_to(queue, klass, *args)
     if ResqueSpec.inline
+      return if run_before_enqueue(klass, *args)
       run_after_enqueue(klass, *args)
-      Job.create(queue_from_class(klass), klass, *args)
+      Job.create(queue, klass, *args)
     else
-      Job.create(queue_from_class(klass), klass, *args)
+      return if run_before_enqueue(klass, *args)
+      Job.create(queue, klass, *args)
       run_after_enqueue(klass, *args)
     end
   end
 
+  def reserve(queue_name)
+    ResqueSpec.pop(queue_name)
+  end
+
   private
 
   def run_after_enqueue(klass, *args)
@@ -37,4 +47,11 @@ module Resque
       klass.send(hook, *args)
     end
   end
+
+  def run_before_enqueue(klass, *args)
+    before_hooks = Plugin.before_enqueue_hooks(klass).collect do |hook|
+      klass.send(hook, *args)
+    end
+    before_hooks.any? { |result| result == false }
+  end
 end

data/lib/resque_spec/version.rb

@@ -1,3 +1,3 @@
 module ResqueSpec
-  VERSION = "0.7.0"
+  VERSION = "0.8.0"
 end

data/lib/resque_spec.rb

@@ -28,6 +28,11 @@ module ResqueSpec
     end
   end
 
+  def pop(queue_name)
+    return unless payload = queue_by_name(queue_name).shift
+    new_job(queue_name, payload)
+  end
+
   def queue_by_name(name)
     queues[name.to_s]
   end
@@ -65,8 +70,12 @@ module ResqueSpec
     klass.respond_to?(:queue) and klass.queue
   end
 
+  def new_job(queue_name, payload)
+    Resque::Job.new(queue_name, payload_with_string_keys(payload))
+  end
+
   def perform(queue_name, payload)
-    Resque::Job.new(queue_name, payload_with_string_keys(payload)).perform
+    new_job(queue_name, payload).perform
   end
 
   def perform_or_store(queue_name, payload)

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: resque_spec
 version: !ruby/object:Gem::Version
-  version: 0.7.0
+  version: 0.8.0
   prerelease: 
 platform: ruby
 authors:
@@ -9,22 +9,22 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2011-08-08 00:00:00.000000000Z
+date: 2011-11-20 00:00:00.000000000Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: resque
-  requirement: &70320129935120 !ruby/object:Gem::Requirement
+  requirement: &70321864755860 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
       - !ruby/object:Gem::Version
-        version: 1.15.0
+        version: 1.19.0
   type: :runtime
   prerelease: false
-  version_requirements: *70320129935120
+  version_requirements: *70321864755860
 - !ruby/object:Gem::Dependency
   name: rspec
-  requirement: &70320129934620 !ruby/object:Gem::Requirement
+  requirement: &70321864754320 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -32,10 +32,10 @@ dependencies:
         version: 2.5.0
   type: :runtime
   prerelease: false
-  version_requirements: *70320129934620
+  version_requirements: *70321864754320
 - !ruby/object:Gem::Dependency
   name: ruby-debug19
-  requirement: &70320129934240 !ruby/object:Gem::Requirement
+  requirement: &70321864753860 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -43,10 +43,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70320129934240
+  version_requirements: *70321864753860
 - !ruby/object:Gem::Dependency
   name: timecop
-  requirement: &70320129933780 !ruby/object:Gem::Requirement
+  requirement: &70321864753220 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -54,7 +54,7 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70320129933780
+  version_requirements: *70321864753220
 description: RSpec matchers for Resque
 email: leshill@gmail.com
 executables: []
@@ -90,7 +90,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: 1.3.6
 requirements: []
 rubyforge_project: 
-rubygems_version: 1.8.6
+rubygems_version: 1.8.10
 signing_key: 
 specification_version: 3
 summary: RSpec matchers for Resque