qu-spec 0.1.2 → 0.2.0

data/MIT-LICENSE

@@ -1,4 +1,4 @@
-Copyright 2011 YOURNAME
+Copyright 2011 Morton Jonuschat <yabawock@gmail.com>
 
 Permission is hereby granted, free of charge, to any person obtaining
 a copy of this software and associated documentation files (the

data/README.md

@@ -1,3 +1,184 @@
 # QuSpec
 
-This project rocks and uses MIT-LICENSE.
+## Description
+
+A QuSpec implements a set of matchers to help testing Qu interaction
+with RSpec and Cucumber. The code has been inspired by
+[ResqueSpec](https://leshill/resque_spec) but
+thanks to the modular architecture of Qu most of the heavy lifting has
+been implemented as an in-memory Qu::Backend implementation that
+passes the Qu test suite for backends.
+
+## Installation
+
+    # Rails 3.x: add it to your Gemfile
+    group :test do
+      gem 'qu-spec'
+    end
+
+## Usage
+
+### Configuring QuSpec
+
+To use QuSpec in your tests you need to setup Qu to use the included
+Memory Backend. The easiest way to accomplish this is with the
+`QuSpec.setup!` method:
+
+    RSpec.configure do |config|
+      config.before do
+        QuSpec.setup!
+      end
+    end
+
+### Writing tests
+
+Given this scenario
+
+    Given a person
+    When I recalculate
+    Then the person has calculate queued
+
+And I write this spec using the `qu-spec` matcher
+
+    describe "#recalculate" do
+      before do
+        QuSpec.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 use the `in` statement to specify the queue:
+
+    describe "#recalculate" do
+      before do
+        QuSpec.reset!
+      end
+
+      it "adds person.calculate to the Person queue" do
+        person.recalculate
+        Person.should have_queued(person.id, :calculate).in(:people)
+      end
+    end
+
+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
+        Qu.enqueue(Person, id, :calculate)
+      end
+    end
+
+You can check the size of the queue in your specs too.
+
+    describe "#recalculate" do
+      before do
+        QuSpec.reset!
+      end
+
+      it "adds an entry to the Person queue" do
+        person.recalculate
+        Person.should have_queue_size_of(1)
+      end
+    end
+
+## QuMailer with Specs
+
+To use with [QuMailer](https://github.com/yabawock/qu-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/qu_mailer.rb
+    Qu::Mailer.excluded_environments = []
+
+## QuScheduler with Specs
+
+Support for [QuScheduler](https://github.com/yabawock/qu-scheduler) is integrated into QuSpec, 
+no additional setup is needed.
+
+### Writing tests
+
+Given this scenario
+
+    Given a person
+    When I schedule a recalculate
+    Then the person has calculate scheduled
+
+And I write this spec using the `qu-spec` matcher
+
+    describe "#recalculate" do
+      before do
+        QuSpec.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)
+
+*(There is also a **have_scheduled_at** matcher)*
+
+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
+        Qu.enqueue_at(Time.now + 3600, Person, id, :calculate)
+      end
+    end
+
+## Performing Jobs in Specs
+
+QuSpec doesn't currently support performing jobs within tests. This is a
+feature that might get implemented in a future release.
+
+## 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.
+
+## Credits
+
+This work has been heavily inspired by [ResqueSpec](https://github.com/leshill/resque_spec) by Les Hill.  
+
+## Maintainers
+
+* [Morton Jonuschat](https://github.com/yabawock)
+
+## License
+
+MIT License
+
+## Copyright
+
+Copyright 2011 Morton Jonuschat  
+Some parts copyright 2010-2011 Les Hill  

data/lib/qu-spec.rb

@@ -1,5 +1,6 @@
 require 'qu/backend/memory'
 require 'qu-spec/matchers'
+require 'qu-spec/scheduler'
 
 module QuSpec
   def self.setup!

data/lib/qu-spec/matchers.rb

@@ -62,3 +62,40 @@ RSpec::Matchers.define :have_queue_size_of do |size|
     "have a queue size of #{size}"
   end
 end
+
+RSpec::Matchers.define :have_scheduled do |*expected_args|
+  match do |actual|
+    QuSpec.schedule_for(actual).any? { |entry| entry.klass.to_s == actual.to_s && entry.args == expected_args }
+  end
+
+  failure_message_for_should do |actual|
+    "expected that #{actual} would have [#{expected_args.join(', ')}] scheduled"
+  end
+
+  failure_message_for_should_not do |actual|
+    "expected that #{actual} would not have [#{expected_args.join(', ')}] scheduled"
+  end
+
+  description do
+    "have scheduled arguments"
+  end
+end
+
+RSpec::Matchers.define :have_scheduled_at do |*expected_args|
+  match do |actual|
+    time = expected_args.shift
+    QuSpec.schedule_for(actual).any? { |entry| entry.klass.to_s == actual.to_s && entry.time == time && entry.args == expected_args }
+  end
+
+  failure_message_for_should do |actual|
+    "expected that #{actual} would have [#{expected_args.join(', ')}] scheduled"
+  end
+
+  failure_message_for_should_not do |actual|
+    "expected that #{actual} would not have [#{expected_args.join(', ')}] scheduled"
+  end
+
+  description do
+    "have scheduled at the given time the arguments"
+  end
+end

data/lib/qu-spec/scheduler.rb

@@ -0,0 +1,33 @@
+module QuSpec
+  module SchedulerExtension
+    def enqueue_at(time, klass, *args)
+      QuSpec.enqueue_at(time, klass, *args)
+    end
+
+    def enqueue_in(time, klass, *args)
+      QuSpec.enqueue_in(time, klass, *args)
+    end
+
+    def remove_delayed(klass, *args)
+      QuSpec.remove_delayed(klass, *args)
+    end
+  end
+
+  def self.enqueue_at(time, klass, *args)
+    Qu.backend.delayed_push(time, Qu::Payload.new(:klass => klass, :args => args))
+  end
+
+  def self.enqueue_in(time, klass, *args)
+    enqueue_at(Time.now + time, klass, *args)
+  end
+
+  def self.remove_delayed(klass, *args)
+    Qu.backend.remove_delayed(klass, *args)
+  end
+
+  def self.schedule_for(klass)
+    Qu.backend.get_schedule_by_klass(klass)
+  end
+end
+
+Qu.send :extend, QuSpec::SchedulerExtension

data/lib/qu-spec/version.rb

@@ -1,3 +1,3 @@
 module QuSpec
-  VERSION = "0.1.2"
+  VERSION = "0.2.0"
 end

data/lib/qu/backend/memory.rb

@@ -57,6 +57,20 @@ module Qu
         payload
       end
 
+      def delayed_push(time, payload)
+        payload.id = SimpleUUID::UUID.new.to_guid
+        payload.time = time
+        @queues[scheduled_queue_name(payload.klass)] << payload
+        logger.debug { "Enqueued delayed job #{payload}" }
+        payload
+      end
+
+      def remove_delayed(klass, *args)
+        get_queue_by_name(scheduled_queue_name(klass)).delete_if do |payload|
+          payload.klass.to_s == klass.to_s && payload.args == args
+        end
+      end
+
       def reserve(worker, options = {:block => true})
         loop do
           worker.queues.each do |queue|
@@ -94,6 +108,16 @@ module Qu
         payload = Payload.new(:klass => klass)
         get_queue_by_name(payload.queue)
       end
+
+      def get_schedule_by_klass(klass)
+        get_queue_by_name(scheduled_queue_name(klass))
+      end
+
+      private
+
+      def scheduled_queue_name(klass)
+        "#{klass.to_s}_scheduled"
+      end
     end
   end
 end

data/spec/qu-spec/matchers_spec.rb

@@ -74,4 +74,20 @@ describe "QuSpec Matchers" do
       it { should_not have_queue_size_of(1).in('other_people') }
     end
   end
+
+  describe "#have_scheduled_at" do
+    let(:scheduled_at) { Time.now + 5 * 60 }
+
+    before do
+      Qu.enqueue_at(scheduled_at, Person, first_name, last_name)
+    end
+
+    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
+      Qu.should_not have_scheduled_at(scheduled_at, last_name, first_name)
+    end
+  end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: qu-spec
 version: !ruby/object:Gem::Version
-  version: 0.1.2
+  version: 0.2.0
   prerelease: 
 platform: ruby
 authors:
@@ -13,7 +13,7 @@ date: 2011-12-04 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: qu
-  requirement: &70160136907080 !ruby/object:Gem::Requirement
+  requirement: &70131682168640 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -21,10 +21,10 @@ dependencies:
         version: 0.1.3
   type: :runtime
   prerelease: false
-  version_requirements: *70160136907080
+  version_requirements: *70131682168640
 - !ruby/object:Gem::Dependency
   name: rspec
-  requirement: &70160136906420 !ruby/object:Gem::Requirement
+  requirement: &70131682167960 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -32,10 +32,10 @@ dependencies:
         version: 2.5.0
   type: :runtime
   prerelease: false
-  version_requirements: *70160136906420
+  version_requirements: *70131682167960
 - !ruby/object:Gem::Dependency
   name: simple_uuid
-  requirement: &70160136905640 !ruby/object:Gem::Requirement
+  requirement: &70131682167180 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -43,10 +43,10 @@ dependencies:
         version: 0.2.0
   type: :runtime
   prerelease: false
-  version_requirements: *70160136905640
+  version_requirements: *70131682167180
 - !ruby/object:Gem::Dependency
   name: rake
-  requirement: &70160136904880 !ruby/object:Gem::Requirement
+  requirement: &70131682165160 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -54,7 +54,7 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70160136904880
+  version_requirements: *70131682165160
 description: RSpec matchers and an in-memory backend for Qu
 email:
 - yabawock@gmail.com
@@ -64,6 +64,7 @@ extra_rdoc_files: []
 files:
 - lib/qu/backend/memory.rb
 - lib/qu-spec/matchers.rb
+- lib/qu-spec/scheduler.rb
 - lib/qu-spec/version.rb
 - lib/qu-spec.rb
 - MIT-LICENSE
@@ -87,7 +88,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: 4087639463335953036
+      hash: 1380140734345455011
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements:
@@ -96,7 +97,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: 4087639463335953036
+      hash: 1380140734345455011
 requirements: []
 rubyforge_project: 
 rubygems_version: 1.8.10