resque_spec 0.1.2 → 0.2.0

data/README.md

@@ -1,7 +1,7 @@
 ResqueSpec
 ==========
 
-A simple RSpec and Cucumber matcher for Resque.enqueue, loosely based on
+A simple RSpec and Cucumber matcher for Resque.enqueue and Resque.enqueue_at (from `ResqueScheduler`), loosely based on
 [http://github.com/justinweiss/resque_unit](resque_unit).
 
 This should work with Resque v1.6.0 and up and RSpec v1.3.0 and up.
@@ -61,8 +61,49 @@ Then I write some code to make it pass:
       end
     end
 
+ResqueScheduler with Specs
+--------------------------
 
-== Note on Patches/Pull Requests
+Given this scenario
+
+    Given a person
+    When I schedule a recalculate
+    Then the person has calculate scheduled
+
+And I write this spec using the `resque_spec` matcher
+
+    describe "#recalculate" do
+      before do
+        ResqueSpec.reset!
+      end
+
+      it "adds person.calculate to the Person queue" do
+        person.recalculate
+        Person.should have_scheduled(person.id, :calculate)
+      end
+    end
+
+(And I take note of the `before` block that is calling `reset!` for every spec)
+
+And I might write this as a Cucumber step
+
+    Then /the (\w?) has (\w?) scheduled/ do |thing, method|
+      thing_obj = instance_variable_get("@#{thing}")
+      thing_obj.class.should have_scheduled(thing_obj.id, method.to_sym)
+    end
+
+Then I write some code to make it pass:
+
+    class Person
+      @queue = :people
+
+      def recalculate
+        Resque.enqueue_at(Time.now + 3600, Person, id, :calculate)
+      end
+    end
+
+Note on Patches/Pull Requests
+=============================
 
 * Fork the project.
 * Make your feature addition or bug fix.
@@ -72,6 +113,7 @@ Then I write some code to make it pass:
   (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.
 
-== Copyright
+Copyright
+=========
 
 Copyright (c) 2010 Les Hill. See LICENSE for details.

data/VERSION

@@ -1 +1 @@
-0.1.2
+0.2.0

data/lib/resque_spec/resque_scheduler_spec.rb

@@ -0,0 +1,62 @@
+require 'resque_spec'
+
+module ResqueSpec
+
+  def scheduled?(klass, time, *args)
+    schedule_for(klass).any? {|entry| entry[:klass] == klass && entry[:time] == time && entry[:args] == args}
+  end
+
+  def scheduled_anytime?(klass, *args)
+    schedule_for(klass).any? {|entry| entry[:klass] == klass && entry[:args] == args}
+  end
+
+  def schedule_for(klass)
+    name = queue_name(klass).to_s << "_scheduled"
+    queues[name]
+  end
+
+  module ResqueScheduler
+    def enqueue_at(time, klass, *args)
+      ResqueSpec.schedule_for(klass) << {:klass => klass, :time  => time, :args => args}
+    end
+  end
+end
+
+Resque.extend(ResqueSpec::ResqueScheduler)
+
+Spec::Matchers.define :have_scheduled do |*expected_args|
+  match do |actual|
+    ResqueSpec.scheduled_anytime?(actual, *expected_args)
+  end
+
+  failure_message_for_should do |actual|
+    "expected that #{actual} would have [#{expected_args.join(', ')}] queued"
+  end
+
+  failure_message_for_should_not do |actual|
+    "expected that #{actual} would not have [#{expected_args.join(', ')}] queued"
+  end
+
+  description do
+    "have scheduled arguments"
+  end
+end
+
+Spec::Matchers.define :have_scheduled_at do |*expected_args|
+  match do |actual|
+    ResqueSpec.scheduled?(actual, *expected_args)
+  end
+
+  failure_message_for_should do |actual|
+    "expected that #{actual} would have [#{expected_args.join(', ')}] queued"
+  end
+
+  failure_message_for_should_not do |actual|
+    "expected that #{actual} would not have [#{expected_args.join(', ')}] queued"
+  end
+
+  description do
+    "have scheduled at the given time the arguments"
+  end
+end
+

data/lib/resque_spec/resque_spec.rb

@@ -0,0 +1,53 @@
+require 'resque'
+
+module ResqueSpec
+  extend self
+
+  def in_queue?(klass, *args)
+    queue_for(klass).any? {|entry| entry[:klass] == klass && entry[:args] == args}
+  end
+
+  def queue_for(klass)
+    queues[queue_name(klass)]
+  end
+
+  def queue_name(klass)
+    queue_name = klass.instance_variable_get(:@queue) || klass.respond_to?(:queue) && klass.queue
+    raise ::Resque::NoQueueError.new("Jobs must be placed onto a queue.") unless queue_name
+  end
+
+  def queues
+    @queues ||= Hash.new {|h,k| h[k] = []}
+  end
+
+  def reset!
+    queues.clear
+  end
+
+  module Resque
+    def enqueue(klass, *args)
+      ResqueSpec.queue_for(klass) << {:klass => klass, :args => args}
+    end
+  end
+end
+
+Resque.extend(ResqueSpec::Resque)
+
+Spec::Matchers.define :have_queued do |*expected_args|
+  match do |actual|
+    ResqueSpec.in_queue?(actual, *expected_args)
+  end
+
+  failure_message_for_should do |actual|
+    "expected that #{actual} would have [#{expected_args.join(', ')}] queued"
+  end
+
+  failure_message_for_should_not do |actual|
+    "expected that #{actual} would not have [#{expected_args.join(', ')}] queued"
+  end
+
+  description do
+    "have queued arguments"
+  end
+end
+

data/lib/resque_spec.rb

@@ -1,50 +1,2 @@
-require 'resque'
-
-module ResqueSpec
-  extend self
-
-  def in_queue?(klass, *args)
-    queue_for(klass).any? {|entry| entry[:klass] == klass && entry[:args] == args}
-  end
-
-  def queue_for(klass)
-    queue_name = klass.instance_variable_get(:@queue) || klass.respond_to?(:queue) && klass.queue
-    raise ::Resque::NoQueueError.new("Jobs must be placed onto a queue.") unless queue_name
-    queues[queue_name]
-  end
-
-  def queues
-    @queues ||= Hash.new {|h,k| h[k] = []}
-  end
-
-  def reset!
-    queues.clear
-  end
-
-  module Resque
-    def enqueue(klass, *args)
-      ResqueSpec.queue_for(klass) << {:klass => klass, :args => args}
-    end
-  end
-end
-
-Resque.extend(ResqueSpec::Resque)
-
-Spec::Matchers.define :have_queued do |*expected_args|
-  match do |actual|
-    ResqueSpec.in_queue?(actual, *expected_args)
-  end
-
-  failure_message_for_should do |actual|
-    "expected that #{actual} would have [#{expected_args.join(', ')}] queued"
-  end
-
-  failure_message_for_should_not do |actual|
-    "expected that #{actual} would not have [#{expected_args.join(', ')}] queued"
-  end
-
-  description do
-    "have queued arguments"
-  end
-end
-
+require 'resque_spec/resque_spec'
+require 'resque_spec/resque_scheduler_spec'

data/resque_spec.gemspec

@@ -5,11 +5,11 @@
 
 Gem::Specification.new do |s|
   s.name = %q{resque_spec}
-  s.version = "0.1.2"
+  s.version = "0.2.0"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Les Hill"]
-  s.date = %q{2010-06-13}
+  s.date = %q{2010-06-24}
   s.description = %q{RSpec matchers for Resque}
   s.email = %q{leshill@gmail.com}
   s.extra_rdoc_files = [
@@ -26,7 +26,10 @@ Gem::Specification.new do |s|
      "Rakefile",
      "VERSION",
      "lib/resque_spec.rb",
+     "lib/resque_spec/resque_scheduler_spec.rb",
+     "lib/resque_spec/resque_spec.rb",
      "resque_spec.gemspec",
+     "spec/resque_scheduler_spec_spec.rb",
      "spec/resque_spec_spec.rb",
      "spec/spec.opts",
      "spec/spec_helper.rb",
@@ -37,10 +40,11 @@ Gem::Specification.new do |s|
   s.homepage = %q{http://github.com/leshill/resque_spec}
   s.rdoc_options = ["--charset=UTF-8"]
   s.require_paths = ["lib"]
-  s.rubygems_version = %q{1.3.6}
+  s.rubygems_version = %q{1.3.7}
   s.summary = %q{RSpec matchers for Resque}
   s.test_files = [
-    "spec/resque_spec_spec.rb",
+    "spec/resque_scheduler_spec_spec.rb",
+     "spec/resque_spec_spec.rb",
      "spec/spec_helper.rb",
      "spec/support/account.rb",
      "spec/support/address.rb",
@@ -51,7 +55,7 @@ Gem::Specification.new do |s|
     current_version = Gem::Specification::CURRENT_SPECIFICATION_VERSION
     s.specification_version = 3
 
-    if Gem::Version.new(Gem::RubyGemsVersion) >= Gem::Version.new('1.2.0') then
+    if Gem::Version.new(Gem::VERSION) >= Gem::Version.new('1.2.0') then
       s.add_runtime_dependency(%q<resque>, [">= 1.6.0"])
       s.add_development_dependency(%q<jeweler>, [">= 1.4.0"])
       s.add_development_dependency(%q<rspec>, [">= 1.3.0"])

data/spec/resque_scheduler_spec_spec.rb

@@ -0,0 +1,114 @@
+require 'spec_helper'
+
+describe "ResqueSchedulerSpec" do
+  before do
+    ResqueSpec.reset!
+  end
+
+  let(:first_name) { 'Les' }
+  let(:last_name) { 'Hill' }
+  let(:scheduled_at) { Time.now + 5 * 60 }
+
+  describe "scheduled?" do
+    it "returns true if the arguments were queued" do
+      Resque.enqueue_at(scheduled_at, Person, first_name, last_name)
+      ResqueSpec.scheduled?(Person, scheduled_at, first_name, last_name).should be
+    end
+
+    it "returns false if the arguments were not queued" do
+      ResqueSpec.scheduled?(Person, scheduled_at, first_name, last_name).should_not be
+    end
+  end
+
+  describe "scheduled_anytime?" do
+    it "returns true if the arguments were queued" do
+      Resque.enqueue_at(scheduled_at, Person, first_name, last_name)
+      ResqueSpec.scheduled_anytime?(Person, first_name, last_name).should be
+    end
+
+    it "returns false if the arguments were not queued" do
+      ResqueSpec.scheduled_anytime?(Person, first_name, last_name).should_not be
+    end
+  end
+
+  describe "#schedule_for" do
+    it "raises if there is no schedule queue defined for a class" do
+      expect do
+        ResqueSpec.schedule_for(Address)
+      end.should raise_exception(::Resque::NoQueueError)
+    end
+
+    it "recognizes a queue defined as a class instance variable" do
+      expect do
+        ResqueSpec.schedule_for(Person)
+      end.should_not raise_exception(::Resque::NoQueueError)
+    end
+
+    it "recognizes a queue defined as a class method" do
+      expect do
+        ResqueSpec.schedule_for(Account)
+      end.should_not raise_exception(::Resque::NoQueueError)
+    end
+
+    it "has an empty array if nothing queued for a class" do
+      ResqueSpec.schedule_for(Person).should == []
+    end
+
+    it "allows additions" do
+      ResqueSpec.schedule_for(Person) << 'queued'
+      ResqueSpec.schedule_for(Person).should_not be_empty
+    end
+  end
+
+  describe "Resque" do
+    describe "#enqueue_at" do
+
+      before do
+        Resque.enqueue_at(scheduled_at, Person, first_name, last_name)
+      end
+
+      it "adds to the scheduled queue hash" do
+        ResqueSpec.schedule_for(Person).should_not be_empty
+      end
+
+      it "sets the klass on the queue" do
+        ResqueSpec.schedule_for(Person).first.should include(:klass => Person)
+      end
+
+      it "sets the arguments on the queue" do
+        ResqueSpec.schedule_for(Person).first.should include(:args => [first_name, last_name])
+      end
+
+      it "sets the time on the scheduled queue" do
+        ResqueSpec.schedule_for(Person).first.should include(:time => scheduled_at)
+      end
+
+    end
+  end
+
+  context "Matchers" do
+    before do
+      Resque.enqueue_at(scheduled_at, Person, first_name, last_name)
+    end
+
+    describe "#have_scheduled_at" do
+      it "returns true if the arguments are found in the queue" do
+        Person.should have_scheduled_at(scheduled_at, first_name, last_name)
+      end
+
+      it "returns false if the arguments are not found in the queue" do
+        Person.should_not have_scheduled_at(scheduled_at, last_name, first_name)
+      end
+    end
+
+    describe "#have_scheduled" do
+      it "returns true if the arguments are found in the queue" do
+        Person.should have_scheduled(first_name, last_name)
+      end
+
+      it "returns false if the arguments are not found in the queue" do
+        Person.should_not have_scheduled(last_name, first_name)
+      end
+    end
+  end
+end

metadata

@@ -1,12 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: resque_spec
 version: !ruby/object:Gem::Version 
+  hash: 23
   prerelease: false
   segments: 
   - 0
-  - 1
   - 2
-  version: 0.1.2
+  - 0
+  version: 0.2.0
 platform: ruby
 authors: 
 - Les Hill
@@ -14,16 +15,18 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-06-13 00:00:00 -04:00
+date: 2010-06-24 00:00:00 -04:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
   name: resque
   prerelease: false
   requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
+        hash: 15
         segments: 
         - 1
         - 6
@@ -35,9 +38,11 @@ dependencies:
   name: jeweler
   prerelease: false
   requirement: &id002 !ruby/object:Gem::Requirement 
+    none: false
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
+        hash: 7
         segments: 
         - 1
         - 4
@@ -49,9 +54,11 @@ dependencies:
   name: rspec
   prerelease: false
   requirement: &id003 !ruby/object:Gem::Requirement 
+    none: false
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
+        hash: 27
         segments: 
         - 1
         - 3
@@ -78,7 +85,10 @@ files:
 - Rakefile
 - VERSION
 - lib/resque_spec.rb
+- lib/resque_spec/resque_scheduler_spec.rb
+- lib/resque_spec/resque_spec.rb
 - resque_spec.gemspec
+- spec/resque_scheduler_spec_spec.rb
 - spec/resque_spec_spec.rb
 - spec/spec.opts
 - spec/spec_helper.rb
@@ -95,27 +105,32 @@ rdoc_options:
 require_paths: 
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
+      hash: 3
       segments: 
       - 0
       version: "0"
 required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
+      hash: 3
       segments: 
       - 0
       version: "0"
 requirements: []
 
 rubyforge_project: 
-rubygems_version: 1.3.6
+rubygems_version: 1.3.7
 signing_key: 
 specification_version: 3
 summary: RSpec matchers for Resque
 test_files: 
+- spec/resque_scheduler_spec_spec.rb
 - spec/resque_spec_spec.rb
 - spec/spec_helper.rb
 - spec/support/account.rb