Merge branch 'release/v2.1.0'

.simplecov

@@ -1,4 +1,3 @@
-# encoding: utf-8
 SimpleCov.start do
   add_filter '/spec/'
 

.travis.yml

@@ -1,15 +1,11 @@
 language: ruby
 rvm:
-  - 2.0.0
-  - 2.1.0
-  - ruby-head
+  - 2.0
+  - 2.1
+  - 2.2
   - jruby
-  - jruby-head
   - rbx-2
-  - rbx-head
 script: "bundle exec rspec spec"
 matrix:
   allow_failures:
-    - rvm: ruby-head
-    - rvm: jruby-head
-    - rvm: rbx-head
+    - rvm: rbx-2

CHANGES.md

@@ -1,3 +1,13 @@
+2.1.0
+---
+* ActiveJob support [tarzan#71]
+* adding be expired in matcher [bernabas#72]
+* Fixed testing failures with be_delayed matcher due to rename of `enqueued_at` to `created_at` in latest Sidekiq [philostler]
+* Add support for NullBatch#on and NullStatus#failures to the null batch objects. [PacerPRO#64]
+* Adding a save_backtrace matcher [webdestroya#61]
+* Add flag to skip Batch stubs [paulfri#69]
+* allow passing an instance method to be_delayed matcher [lastobelus#63]
+
 2.0.0
 ---
 * Get specs to green [petergoldstein#58]

LICENSE

@@ -1,6 +1,6 @@
 The MIT License (MIT)
 
-Copyright (c) 2014 Phil Ostler
+Copyright (c) 2014, 2015 Phil Ostler
 
 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:
 

README.md

@@ -69,6 +69,10 @@ Object.delay_until(1.hour.from_now).is_nil? # delay until
 expect(Object.method :is_nil?).to be_delayed.until 1.hour.from_now
 Object.delay_until(1.hour.from_now).is_a? Object # delay until with argument
 expect(Object.method :is_a?).to be_delayed(Object).until 1.hour.from_now
+
+#Rails Mailer
+MyMailer.delay.some_mail
+expect(MyMailer.instance_method :some_mail).to be_delayed
 ```
 
 ### be_processed_in
@@ -95,6 +99,23 @@ expect(AwesomeJob).to be_retryable false # or
 it { is_expected.to be_retryable false }
 ```
 
+### save_backtrace
+*Describes if a job should save the error backtrace when there is a failure in it's execution*
+```ruby
+sidekiq_options backtrace: 5
+# test with...
+expect(AwesomeJob).to save_backtrace # or
+it { is_expected.to save_backtrace }
+# ...or alternatively specifiy the number of lines that should be saved
+expect(AwesomeJob).to save_backtrace 5 # or
+it { is_expected.to save_backtrace 5 }
+# ...or when it should not save the backtrace
+expect(AwesomeJob).to_not save_backtrace # or
+expect(AwesomeJob).to save_backtrace false # or
+it { is_expected.to_not save_backtrace } # or
+it { is_expected.to save_backtrace false }
+```
+
 ### be_unique
 *Describes when a job should be unique within it's queue*
 ```ruby
@@ -103,6 +124,14 @@ sidekiq_options unique: true
 expect(AwesomeJob).to be_unique
 it { is_expected.to be_unique }
 ```
+### be_expired_in
+*Describes when a job should expire*
+```ruby
+sidekiq_options expires_in: 1.hour
+# test with...
+it { is_expected.to be_expired_in 1.hour }
+it { is_expected.to_not be_expired_in 2.hours }
+```
 
 ### have_enqueued_job
 *Describes that there should be an enqueued job with the specified arguments*
@@ -120,6 +149,7 @@ describe AwesomeJob do
   it { is_expected.to be_processed_in :my_queue }
   it { is_expected.to be_retryable 5 }
   it { is_expected.to be_unique }
+  it { is_expected.to be_expired_in 1.hour }
 
   it 'enqueues another awesome job' do
     subject.perform

lib/rspec/sidekiq/batch.rb

@@ -14,10 +14,15 @@ class NullBatch < NullObject
 
         def initialize(bid = nil)
           @bid = bid || SecureRandom.hex(8)
+          @callbacks = []
         end
 
         def status
-          NullStatus.new(@bid)
+          NullStatus.new(@bid, @callbacks)
+        end
+
+        def on(*args)
+          @callbacks << args
         end
 
         def jobs(*)
@@ -28,12 +33,23 @@ def jobs(*)
       class NullStatus < NullObject
         attr_reader :bid
 
-        def initialize(bid)
+        def initialize(bid, callbacks)
           @bid = bid
+          @callbacks = callbacks
+        end
+
+        def failures
+          0
         end
 
         def join
           ::Sidekiq::Worker.drain_all
+
+          @callbacks.each do |event, callback_class, options|
+            if event != :success || failures == 0
+              callback_class.new.send("on_#{event}", self, options)
+            end
+          end
         end
 
         def total
@@ -44,7 +60,9 @@ def total
   end
 
   RSpec.configure do |config|
-    config.before(:each) do
+    config.before(:each) do |example|
+      next if example.metadata[:stub_batches] == false
+
       if mocked_with_mocha?
         Sidekiq::Batch.stubs(:new) { RSpec::Sidekiq::NullBatch.new }
       else

lib/rspec/sidekiq/matchers.rb

@@ -1,9 +1,11 @@
 require 'rspec/core'
 require 'rspec/sidekiq/matchers/be_delayed'
+require 'rspec/sidekiq/matchers/be_expired_in'
 require 'rspec/sidekiq/matchers/be_processed_in'
 require 'rspec/sidekiq/matchers/be_retryable'
 require 'rspec/sidekiq/matchers/be_unique'
 require 'rspec/sidekiq/matchers/have_enqueued_job'
+require 'rspec/sidekiq/matchers/save_backtrace'
 
 RSpec.configure do |config|
   config.include RSpec::Sidekiq::Matchers

lib/rspec/sidekiq/matchers/be_delayed.rb

@@ -19,7 +19,7 @@ def description
         end
 
         def failure_message
-          "expected #{@expected_method.receiver}.#{@expected_method.name} to " + description
+          "expected #{@expected_method_receiver}.#{@expected_method.name} to " + description
         end
 
         def for(interval)
@@ -29,10 +29,12 @@ def for(interval)
 
         def matches?(expected_method)
           @expected_method = expected_method
+          @expected_method_receiver = @expected_method.is_a?(UnboundMethod) ? @expected_method.owner : @expected_method.receiver
 
           find_job @expected_method, @expected_arguments do |job|
             if @expected_interval
-              return job['at'].to_i == job['enqueued_at'].to_i + @expected_interval
+              created_enqueued_at = job['enqueued_at'] || job['created_at']
+              return job['at'].to_i == created_enqueued_at.to_i + @expected_interval
             elsif @expected_time
               return job['at'].to_i == @expected_time.to_i
             else
@@ -44,7 +46,7 @@ def matches?(expected_method)
         end
 
         def failure_message_when_negated
-          "expected #{@expected_method.receiver}.#{@expected_method.name} to not " + description
+          "expected #{@expected_method_receiver}.#{@expected_method.name} to not " + description
         end
 
         def until(time)
@@ -57,7 +59,7 @@ def until(time)
         def find_job(method, arguments, &block)
           job = (::Sidekiq::Extensions::DelayedClass.jobs + ::Sidekiq::Extensions::DelayedModel.jobs + ::Sidekiq::Extensions::DelayedMailer.jobs).find do |job|
             yaml = YAML.load(job['args'].first)
-            @expected_method.receiver == yaml[0] && @expected_method.name == yaml[1] && (@expected_arguments <=> yaml[2]) == 0
+            @expected_method_receiver == yaml[0] && @expected_method.name == yaml[1] && (@expected_arguments <=> yaml[2]) == 0
           end
 
           yield job if block && job

lib/rspec/sidekiq/matchers/be_expired_in.rb

@@ -0,0 +1,33 @@
+module RSpec
+  module Sidekiq
+    module Matchers
+      def be_expired_in(expected_argument)
+        BeExpiredIn.new(expected_argument)
+      end
+
+      class BeExpiredIn
+        def initialize(expected_argument)
+          @expected_argument = expected_argument
+        end
+
+        def description
+          "to expire in #{@expected_argument}"
+        end
+
+        def failure_message
+          "expected to expire in #{@expected_argument} but expired in #{@actual}"
+        end
+
+        def failure_message_when_negated
+          "expected to not expire in #{@expected_argument}"
+        end
+
+        def matches?(job)
+          @klass = job.is_a?(Class) ? job : job.class
+          @actual = @klass.get_sidekiq_options['expires_in']
+          @actual.to_s == @expected_argument.to_s
+        end
+      end
+    end
+  end
+end

lib/rspec/sidekiq/matchers/be_processed_in.rb

@@ -20,7 +20,11 @@ def failure_message
 
         def matches?(job)
           @klass = job.is_a?(Class) ? job : job.class
-          @actual = @klass.get_sidekiq_options['queue']
+          if @klass.methods.include?(:get_sidekiq_options)
+            @actual = @klass.get_sidekiq_options['queue']
+          else
+            @actual = job.try(:queue_name)
+          end
           @actual.to_s == @expected_queue.to_s
         end
 

lib/rspec/sidekiq/matchers/have_enqueued_job.rb

@@ -23,7 +23,7 @@ def failure_message
 
         def matches?(klass)
           @klass = klass
-          @actual = klass.jobs.map { |job| job['args'] }
+          @actual = unwrapped_job_arguments(klass.jobs)
           @actual.any? { |arguments| contain_exactly?(arguments) }
         end
 
@@ -33,6 +33,29 @@ def failure_message_when_negated
 
         private
 
+        def unwrapped_job_arguments(jobs)
+          if jobs.is_a? Hash
+            jobs.values.flatten.map do |job|
+              map_arguments(job).flatten
+            end
+          else
+            map_arguments(jobs)
+          end
+        end
+
+        def map_arguments(job)
+          args = job_arguments(job) || job
+          if args.respond_to?(:any?) && args.any? { |e| e.is_a? Hash }
+            args.map { |a| map_arguments(a) }
+          else
+            args
+          end
+        end
+
+        def job_arguments(hash)
+          hash['arguments'] || hash['args'] unless hash.is_a? Array
+        end
+
         def contain_exactly?(arguments)
           exactly = RSpec::Matchers::BuiltIn::ContainExactly.new(expected_arguments)
           exactly.matches?(arguments)

lib/rspec/sidekiq/matchers/save_backtrace.rb

@@ -0,0 +1,39 @@
+module RSpec
+  module Sidekiq
+    module Matchers
+      def save_backtrace(expected_backtrace=true)
+        SaveBacktrace.new expected_backtrace
+      end
+
+      class SaveBacktrace
+        def initialize(expected_backtrace=true)
+          @expected_backtrace = expected_backtrace
+        end
+
+        def description
+          if @expected_backtrace.is_a?(Fixnum)
+            "save #{@expected_backtrace} lines of error backtrace" # backtrace: 5
+          elsif @expected_backtrace
+            'save error backtrace' # backtrace: true
+          else
+            'not save error backtrace' # backtrace: false
+          end
+        end
+
+        def failure_message
+          "expected #{@klass} to #{description} but got #{@actual}"
+        end
+
+        def matches?(job)
+          @klass = job.is_a?(Class) ? job : job.class
+          @actual = @klass.get_sidekiq_options['backtrace']
+          @actual == @expected_backtrace
+        end
+
+        def failure_message_when_negated
+          "expected #{@klass} to not #{description}".gsub 'not not ', ''
+        end
+      end
+    end
+  end
+end

lib/rspec/sidekiq/version.rb

@@ -1,5 +1,5 @@
 module RSpec
   module Sidekiq
-    VERSION = '2.0.0'
+    VERSION = '2.1.0'
   end
 end

rspec-sidekiq.gemspec

@@ -1,4 +1,3 @@
-# encoding: utf-8
 require File.expand_path('../lib/rspec/sidekiq/version', __FILE__)
 
 Gem::Specification.new do |s|
@@ -15,8 +14,11 @@ Gem::Specification.new do |s|
   s.add_dependency 'rspec', '~> 3.0', '>= 3.0.0'
   s.add_dependency 'sidekiq', '>= 2.4.0'
 
-  s.add_development_dependency 'coveralls', '~> 0.7', '>= 0.7.0'
+  s.add_development_dependency 'coveralls', '~> 0.8', '>= 0.8.0'
   s.add_development_dependency 'fuubar', '~> 2.0', '>= 2.0.0'
+  s.add_development_dependency 'activejob', '~> 4.2', '>= 4.0.0'
+  s.add_development_dependency 'actionmailer', '~> 4.2', '>= 4.0.0'
+
 
   s.files = Dir['.gitattributes'] +
             Dir['.gitignore'] +