ryansch-resque_spec 0.2.3.1

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2010 Les Hill
+
+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,119 @@
+ResqueSpec
+==========
+
+A simple RSpec and Cucumber matcher for Resque.enqueue and Resque.enqueue_at (from `ResqueScheduler`), loosely based on
+[http://github.com/justinweiss/resque_unit](http://github.com/justinweiss/resque_unit).
+
+This should work with Resque v1.6.0 and up and RSpec v1.3.0 and up.
+
+Install
+-------
+
+Install the gem
+
+    % gem install resque_spec
+
+And update your Gemfile (Not using bundler? Do the necessary thing for
+your app's gem management)
+
+    group :test do
+      gem 'resque_spec'
+    end
+
+Resque with Specs
+-----------------
+
+Given this scenario
+
+    Given a person
+    When I recalculate
+    Then the person has calculate queued
+
+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_queued(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?) queued/ do |thing, method|
+      thing_obj = instance_variable_get("@#{thing}")
+      thing_obj.class.should have_queued(thing_obj.id, method.to_sym)
+    end
+
+Then I write some code to make it pass:
+
+    class Person
+      @queue = :people
+
+      def recalculate
+        Resque.enqueue(Person, id, :calculate)
+      end
+    end
+
+ResqueScheduler with Specs
+--------------------------
+
+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.
+* Add tests for it. This is important so I don't break it in a
+  future version unintentionally.
+* Commit, do not mess with rakefile, version, or history.
+  (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 (c) 2010 Les Hill. See LICENSE for details.

data/Rakefile

@@ -0,0 +1,26 @@
+require 'rubygems'
+require 'rake'
+
+require 'spec/rake/spectask'
+Spec::Rake::SpecTask.new(:spec) do |spec|
+  spec.libs << 'lib' << 'spec'
+  spec.spec_files = FileList['spec/**/*_spec.rb']
+end
+
+Spec::Rake::SpecTask.new(:rcov) do |spec|
+  spec.libs << 'lib' << 'spec'
+  spec.pattern = 'spec/**/*_spec.rb'
+  spec.rcov = true
+end
+
+task :default => :spec
+
+require 'rake/rdoctask'
+Rake::RDocTask.new do |rdoc|
+  version = File.exist?('VERSION') ? File.read('VERSION') : ""
+
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title = "resque_spec #{version}"
+  rdoc.rdoc_files.include('README*')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end

data/lib/resque_spec.rb

@@ -0,0 +1,2 @@
+require 'resque_spec/resque_spec'
+require 'resque_spec/resque_scheduler_spec'

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,70 @@
+require 'resque'
+require 'spec'
+
+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)
+    name_from_instance_var(klass) or
+      name_from_queue_accessor(klass) or
+      raise ::Resque::NoQueueError.new("Jobs must be placed onto a queue.")
+  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
+    def dequeue(klass, *args)
+      ResqueSpec.queue_for(klass).delete_if do |job|
+        job[:class] == klass.to_s && args.empty? || job[:args] == args
+      end
+    end
+  end
+
+  private
+
+  def name_from_instance_var(klass)
+    klass.instance_variable_get(:@queue)
+  end
+
+  def name_from_queue_accessor(klass)
+    klass.respond_to?(:queue) and klass.queue
+  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/version.rb

@@ -0,0 +1,3 @@
+module ResqueSpec
+  VERSION = '0.2.3.1'
+end

metadata

@@ -0,0 +1,76 @@
+--- !ruby/object:Gem::Specification
+name: ryansch-resque_spec
+version: !ruby/object:Gem::Version
+  version: 0.2.3.1
+  prerelease: 
+platform: ruby
+authors:
+- Les Hill
+- Nick Morgan
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2011-10-18 00:00:00.000000000 -07:00
+default_executable: 
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: resque
+  requirement: &70217040727940 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 1.6.0
+  type: :runtime
+  prerelease: false
+  version_requirements: *70217040727940
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: &70217040727440 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.3.0
+  type: :runtime
+  prerelease: false
+  version_requirements: *70217040727440
+description: RSpec matchers for Resque
+email: ryan@instanceinc.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- lib/resque_spec/resque_scheduler_spec.rb
+- lib/resque_spec/resque_spec.rb
+- lib/resque_spec/version.rb
+- lib/resque_spec.rb
+- LICENSE
+- README.md
+- Rakefile
+has_rdoc: true
+homepage: http://github.com/ryansch/resque_spec
+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.6.2
+signing_key: 
+specification_version: 3
+summary: RSpec matchers for Resque
+test_files: []