rspec-sidekiq 0.5.1 → 1.0.0

checksums.yaml

@@ -1,15 +1,15 @@
 ---
 !binary "U0hBMQ==":
   metadata.gz: !binary |-
-    ZjNmMWRlZTNlNDJkYTllMDg1YWRkZGRmMTBhNjIyNjA2NTAyZGNhNQ==
+    MjNiZmI2MTNlM2Q2ZDBjOTlmYTU4NTliYzlkZDUyODY0Y2RiNmE0Mw==
   data.tar.gz: !binary |-
-    M2NjNzkyMTk4ZWZjYTVlN2I3MTQ2YzYzMjdjMDJjOTUxNzIzMjBiOQ==
-!binary "U0hBNTEy":
+    YzlmNjA3MjViZDdhNDhkMWM2Y2FiZjBiZjNlNmE3YzI3Yjk0MTk2OA==
+SHA512:
   metadata.gz: !binary |-
-    NDVhZjc3NzFkNDM4NjNhYmZiNTdiMzc1MDQ2YTY0YTQ1Mzc5MjE1ZmZjZWM2
-    MjRmNmQ1MjVhOGJhMzQ5NGY5Y2ZmYTZhYTY2ZjE4ODA5MzFhOWMzNzQ3YzY0
-    ZTVkZTY4ZjAxZTAwYWQ0NDczNzFjNWJiYmMzMzExNTczYTdjMmM=
+    NWE0YjVkYmE5YjZkZGZlNmIyN2JkNDdlNjNlZDE0MWI5NDY1ZGUxZTZmYzE3
+    YTMyZWM1MGY0YTkwNWI1YTBkN2E3MmQwNmU5ZjRlMGY4YTgyYjUxOGI2Nzkx
+    MDJhNjgyMGZkYmRkMDViODE0M2Y1Yzg1MTFkMzZkYjRhYTFjOWY=
   data.tar.gz: !binary |-
-    M2U1NmQ1NjZlMGZhYzE1MDZjYjc1MzhiYjE2ZGQxNTNmNmNlZGRhNzNiYTE1
-    NjYxZTQ1MjM4MjBjNzc3MmNlMTlkODEwNGU3MGE5MDk1MWM1ZDQ3ZTRmNGQ3
-    YTcxOWMxMmMzZWRhNjcyNzQ2Y2M2NmM1YjAzNzg0NGUzYWI1MzI=
+    N2I3M2Y1ODZmYjY4YTA0MGVhYWM5ODhlNTU3YjBjYTQ5ZDcxYzdlNjM4NmM4
+    ODg3OTVjNzZmOTFiYzc4NTNjZWZhMThjZjZkOGIwMTk5MDM5YzVlY2JiZjE3
+    ZGU0ODYwMjBiODc0YmE0MDFhZTllYjZiNWNkNzYxZjhhNDMzMDc=

data/.gitattributes

@@ -1,22 +1,22 @@
-# Auto detect text files and perform LF normalization
-* text=auto
-
-# Custom for Visual Studio
-*.cs     diff=csharp
-*.sln    merge=union
-*.csproj merge=union
-*.vbproj merge=union
-*.fsproj merge=union
-*.dbproj merge=union
-
-# Standard to msysgit
-*.doc	 diff=astextplain
-*.DOC	 diff=astextplain
-*.docx diff=astextplain
-*.DOCX diff=astextplain
-*.dot  diff=astextplain
-*.DOT  diff=astextplain
-*.pdf  diff=astextplain
-*.PDF	 diff=astextplain
-*.rtf	 diff=astextplain
-*.RTF	 diff=astextplain
+# Auto detect text files and perform LF normalization
+* text=auto
+
+# Custom for Visual Studio
+*.cs     diff=csharp
+*.sln    merge=union
+*.csproj merge=union
+*.vbproj merge=union
+*.fsproj merge=union
+*.dbproj merge=union
+
+# Standard to msysgit
+*.doc	 diff=astextplain
+*.DOC	 diff=astextplain
+*.docx diff=astextplain
+*.DOCX diff=astextplain
+*.dot  diff=astextplain
+*.DOT  diff=astextplain
+*.pdf  diff=astextplain
+*.PDF	 diff=astextplain
+*.rtf	 diff=astextplain
+*.RTF	 diff=astextplain

data/.gitignore

@@ -1,2 +1,2 @@
-Gemfile.lock
+Gemfile.lock
 spec_result

data/.rspec

@@ -1,3 +1,3 @@
---colour
---format Fuubar
+--colour
+--format Fuubar
 --format html --out spec_result/rspec.html

data/.simplecov

@@ -0,0 +1,5 @@
+SimpleCov.start do
+  add_filter "/spec/"
+
+  coverage_dir "spec_result"
+end

data/CHANGES.md

@@ -1,35 +1,52 @@
-0.5.1
----
-* Allows Sidekiq::Batch support to work with Mocha as well RSpec stubbing [noiseunion#20]
-
-0.5.0
----
-* Adds stub support for Sidekiq::Batch [kmayer#17]
-
-0.4.0
----
-* Bug fix for matcher failure if sidekiq_options were defined as strings vs symbols [mhuffnagle#16 & philostler]
-* Matcher tests (partial coverage) added [mhuffnagle#16 & philostler]
-
-0.3.0
----
-* Removed restriction on needing to use sidekiq-middleware with be_unique matcher [philostler#4]
-* Ensure RSpec.configure is defined on loading rspec/sidekiq/matchers [centaure#3]
-
-0.2.2
----
-* Matcher ```be_retryable false``` not producing correct output description [philostler]
-
-0.2.1
----
-* Removed debug #puts [philostler]
-
-0.2.0
----
-* New #have_enqueued_job matcher [philostler]
-* Improved #have_enqueued_jobs description [philostler]
-* Minor documentation updates [philostler]
-
-0.1.0
----
-* Initial release [philostler]
+1.0.0
+---
+* Improve coverage and readability of README [philostler#26]
+* Greatly increase test coverage [philostler#27]
+* Refactor and greatly improve be_a_delayed_job matcher (now be_delayed) [philostler#24 & #25]
+* Add implementation of status.total [matthargett & Kelly Felkins#32 & #39]
+* Fix Rubinius build [petergoldstein#38]
+* Remove have_enqueued_jobs matcher [philostler#37]
+* Travis - Ruby 2.1.0, fix Rubinius build [petergoldstein#35]
+* Prepare for RSpec 3.x [petergoldstein#34]
+* Print warning when used in development mode [mperham & philostler#33]
+* Add helper for testing retries exhausted block [Noreaster76#31]
+* Allow to use [general matchers](https://www.relishapp.com/rspec/rspec-mocks/v/2-14/docs/argument-matchers/general-matchers) in have_enqueued_job [johanneswuerbach#30]
+* Loosen RSpec dependency [philostler#23]
+* Add delay extension matchers [sosaucily#22]
+* Update coveralls development dependency to version 0.7.x [philostler]
+
+0.5.1
+---
+* Allows Sidekiq::Batch support to work with Mocha as well RSpec stubbing [noiseunion#20]
+
+0.5.0
+---
+* Adds stub support for Sidekiq::Batch [kmayer#17]
+
+0.4.0
+---
+* Bug fix for matcher failure if sidekiq_options were defined as strings vs symbols [mhuffnagle#16 & philostler]
+* Matcher tests (partial coverage) added [mhuffnagle#16 & philostler]
+
+0.3.0
+---
+* Removed restriction on needing to use sidekiq-middleware with be_unique matcher [philostler#4]
+* Ensure RSpec.configure is defined on loading rspec/sidekiq/matchers [centaure#3]
+
+0.2.2
+---
+* Matcher ```be_retryable false``` not producing correct output description [philostler]
+
+0.2.1
+---
+* Removed debug #puts [philostler]
+
+0.2.0
+---
+* New #have_enqueued_job matcher [philostler]
+* Improved #have_enqueued_jobs description [philostler]
+* Minor documentation updates [philostler]
+
+0.1.0
+---
+* Initial release [philostler]

data/Gemfile

@@ -1,3 +1,9 @@
-source "https://rubygems.org"
-
+source "https://rubygems.org"
+
+platforms :rbx do
+  gem "rubysl", "~> 2.0"
+  gem "psych"
+  gem "rubinius-developer_tools"
+end
+
 gemspec

data/LICENSE

@@ -1,9 +1,9 @@
-The MIT License (MIT)
-
-Copyright (c) 2013 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:
-
-The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
-
+The MIT License (MIT)
+
+Copyright (c) 2013 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:
+
+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

@@ -1,135 +1,181 @@
-# RSpec for Sidekiq
-
-[![RubyGems][gem_version_badge]][ruby_gems]
-[![Code Climate][code_climate_badge]][code_climate]
-[![Travis CI][travis_ci_badge]][travis_ci]
-[![Coveralls][coveralls_badge]][coveralls]
-[![Gemnasium][gemnasium_badge]][gemnasium]
-[![coderwall][coderwall_badge]][coderwall]
-
-*Simple testing of Sidekiq jobs via a collection of matchers and common tasks*
-
-[RubyGems][ruby_gems] |
-[Code Climate][code_climate] |
-[GitHub][github] |
-[Travis CI][travis_ci] |
-[Coveralls][coveralls] |
-[Gemnasium][gemnasium] |
-[RubyDoc][ruby_doc] |
-[Ruby Toolbox][ruby_toolbox]
-
-## Installation
-```ruby
-# Gemfile
-group :test do
-  gem "rspec-sidekiq"
-end
-```
-```rspec-sidekiq``` requires ```sidekiq/testing``` by default so there is no need to include the line ```require "sidekiq/testing"``` inside your ```spec_helper.rb```.
-
-*This has the effect of not pushing enqueued jobs to Redis but to a ```job``` array to enable testing ([see Sidekiq's testing wiki](https://github.com/mperham/sidekiq/wiki/Testing)). Thus, only include ```gem "rspec-sidekiq"``` in environments where this behaviour is required, such as the ```test``` group.*
-
-If you are using Sidekiq Batches ([Sidekiq Pro feature](https://github.com/mperham/sidekiq/wiki/Batches)), ```rspec-sidekiq``` replaces the implementation (using the NullObject pattern) enabling testing without a Redis instance. Mocha and RSpec stubbing is supported here.
-
-## Configuration
-If you wish to modify the default behaviour, add the following to your ```spec_helper.rb``` file
-```ruby
-RSpec::Sidekiq.configure do |config|
-  # Clears all job queues before each example
-  config.clear_all_enqueued_jobs = false # default => true
-end
-```
-
-## Matchers
-* [be_processed_in](#be_processed_in)
-* [be_retryable](#be_retryable)
-* [be_unique](#be_unique)
-* [have_enqueued_job](#have_enqueued_job)
-* [have_enqueued_jobs](#have_enqueued_jobs)
-
-### be_processed_in
-*Describes the queue that the job should be processed in*
-```ruby
-sidekiq_options queue: :download # job option
-
-it { should be_processed_in :download } # one liner
-expect(AwesomeJob).to be_processed_in :download # new expect syntax
-```
-
-### be_retryable
-*Describes if the job retries when there is a failure in it's execution*
-```ruby
-sidekiq_options retry: 5 # job option
-
-it { should be_retryable true } # one liner
-expect(AwesomeJob).to be_retryable true # new expect syntax
-# ...or alternatively specifiy the number of times it should be retried
-it { should be_retryable 5 } # one liner
-expect(AwesomeJob).to be_retryable 5 # new expect syntax
-```
-
-### be_unique
-*Describes if the job should be unique within it's queue*
-```ruby
-sidekiq_options unique: true # job option
-
-it { should be_unique } # one liner
-expect(AwesomeJob).to be_unique # new expect syntax
-```
-
-### have_enqueued_job
-*Evaluates that there is an enqueued job with the specified arguments*
-```ruby
-expect(AwesomeJob).to have_enqueued_job("Awesome", true) # new expect syntax
-```
-
-### have_enqueued_jobs
-*Evaluates the number of enqueued jobs for a specified job class*
-```ruby
-expect(AwesomeJob).to have_enqueued_jobs(1) # new expect syntax
-# ...but you could just use
-expect(AwesomeJob).to have(1).jobs
-# ...or even
-expect(AwesomeJob).to have(1).enqueued.jobs
-```
-
-## Example
-```ruby
-require "spec_helper"
-
-describe AwesomeJob do
-  it { should be_processed_in :download }
-  it { should be_retryable false }
-  it { should be_unique }
-
-  it "enqueues another awesome job" do
-    subject.perform
-
-    expect(AnotherAwesomeJob).to have_enqueued_job("Awesome", true)
-  end
-end
-```
-
-## Testing
-```bundle exec rspec spec```
-
-## Contribute
-Please do! If there's a feature missing that you'd love to see then get in on the action!
-
-Issues/Pull Requests/Comments bring them on...
-
-[code_climate]: https://codeclimate.com/github/philostler/rspec-sidekiq
-[code_climate_badge]: https://codeclimate.com/github/philostler/rspec-sidekiq.png
-[coderwall]: https://coderwall.com/philostler
-[coderwall_badge]: https://api.coderwall.com/philostler/endorsecount.png
-[coveralls]: https://coveralls.io/r/philostler/rspec-sidekiq
-[coveralls_badge]: https://coveralls.io/repos/philostler/rspec-sidekiq/badge.png?branch=master
-[gem_version_badge]: https://badge.fury.io/rb/rspec-sidekiq.png
-[gemnasium]: https://gemnasium.com/philostler/rspec-sidekiq
-[gemnasium_badge]: https://gemnasium.com/philostler/rspec-sidekiq.png
-[github]: http://github.com/philostler/rspec-sidekiq
-[ruby_doc]: http://rubydoc.info/github/philostler/rspec-sidekiq/master/frames
-[ruby_gems]: http://rubygems.org/gems/rspec-sidekiq
-[ruby_toolbox]: http://www.ruby-toolbox.com/projects/rspec-sidekiq
-[travis_ci]: http://travis-ci.org/philostler/rspec-sidekiq
-[travis_ci_badge]: https://secure.travis-ci.org/philostler/rspec-sidekiq.png
+# RSpec for Sidekiq
+
+[![RubyGems][gem_version_badge]][ruby_gems]
+[![Code Climate][code_climate_badge]][code_climate]
+[![Travis CI][travis_ci_badge]][travis_ci]
+[![Coveralls][coveralls_badge]][coveralls]
+[![Gemnasium][gemnasium_badge]][gemnasium]
+[![coderwall][coderwall_badge]][coderwall]
+
+*Simple testing of Sidekiq jobs via a collection of matchers and helpers*
+
+[RubyGems][ruby_gems] |
+[Code Climate][code_climate] |
+[GitHub][github] |
+[Travis CI][travis_ci] |
+[Coveralls][coveralls] |
+[Gemnasium][gemnasium] |
+[RubyDoc][ruby_doc] |
+[Ruby Toolbox][ruby_toolbox]
+
+[Jump to Matchers »](#matchers) | [Jump to Helpers »](#helpers)
+
+## Installation
+```ruby
+# Gemfile
+group :test do
+  gem "rspec-sidekiq"
+end
+```
+rspec-sidekiq requires ```sidekiq/testing``` by default so there is no need to include the line ```require "sidekiq/testing"``` inside your ```spec_helper.rb```.
+
+*IMPORTANT! This has the effect of not pushing enqueued jobs to Redis but to a ```job``` array to enable testing ([see the FAQ & Troubleshooting Wiki page][rspec_sidekiq_wiki_faq_&_troubleshooting]). Thus, only include ```gem "rspec-sidekiq"``` in environments where this behaviour is required, such as the ```test``` group.*
+
+## Configuration
+If you wish to modify the default behaviour, add the following to your ```spec_helper.rb``` file
+```ruby
+RSpec::Sidekiq.configure do |config|
+  # Clears all job queues before each example
+  config.clear_all_enqueued_jobs = true # default => true
+
+  # Whether to use terminal colours when outputting messages
+  config.enable_terminal_colours = true # default => true
+
+  # Warn when jobs are not enqueued to Redis but to a job array
+  config.warn_when_jobs_not_processed_by_sidekiq = true # default => true
+end
+```
+
+## Matchers
+* [be_delayed](#be_delayed)
+* [be_processed_in](#be_processed_in)
+* [be_retryable](#be_retryable)
+* [be_unique](#be_unique)
+* [have_enqueued_job](#have_enqueued_job)
+* ~~[have_enqueued_jobs](#have_enqueued_jobs)~~
+
+### be_delayed
+*Describes a method that should be invoked asynchronously (See [Sidekiq Delayed Extensions][sidekiq_wiki_delayed_extensions])*
+```ruby
+Object.delay.is_nil? # delay
+expect(Object.method :is_nil?).to be_delayed
+Object.delay.is_a? Object # delay with argument
+expect(Object.method :is_a?).to be_delayed(Object)
+
+Object.delay_for(1.hour).is_nil? # delay for
+expect(Object.method :is_nil?).to be_delayed.for 1.hour
+Object.delay_for(1.hour).is_a? Object # delay for with argument
+expect(Object.method :is_a?).to be_delayed(Object).for 1.hour
+
+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
+```
+
+### be_processed_in
+*Describes the queue that a job should be processed in*
+```ruby
+sidekiq_options queue: :download
+# test with...
+expect(AwesomeJob).to be_processed_in :download # or
+it { should be_processed_in :download }
+```
+
+### be_retryable
+*Describes if a job should retry when there is a failure in it's execution*
+```ruby
+sidekiq_options retry: 5
+# test with...
+expect(AwesomeJob).to be_retryable true # or
+it { should be_retryable true }
+# ...or alternatively specifiy the number of times it should be retried
+expect(AwesomeJob).to be_retryable 5 # or
+it { should be_retryable 5 }
+# ...or when it should not retry
+expect(AwesomeJob).to be_retryable false # or
+it { should be_retryable false }
+```
+
+### be_unique
+*Describes when a job should be unique within it's queue*
+```ruby
+sidekiq_options unique: true
+# test with...
+expect(AwesomeJob).to be_unique
+it { should be_unique }
+```
+
+### have_enqueued_job
+*Describes that there should be an enqueued job with the specified arguments*
+```ruby
+Awesomejob.perform_async "Awesome", true
+# test with...
+expect(AwesomeJob).to have_enqueued_job("Awesome", true)
+```
+
+### ~~have_enqueued_jobs~~
+*Removed. [See the FAQ & Troubleshooting Wiki page][rspec_sidekiq_wiki_faq_&_troubleshooting] for alternative and more information*
+
+## Example matcher usage
+```ruby
+require "spec_helper"
+
+describe AwesomeJob do
+  it { should be_processed_in :my_queue }
+  it { should be_retryable 5 }
+  it { should be_unique }
+
+  it "enqueues another awesome job" do
+    subject.perform
+
+    expect(AnotherAwesomeJob).to have_enqueued_job("Awesome", true)
+  end
+end
+```
+
+## Helpers
+* [Batches](#batches)
+* [within_sidekiq_retries_exhausted_block](#within_sidekiq_retries_exhausted_block)
+
+### Batches
+If you are using Sidekiq Batches ([Sidekiq Pro feature][sidekiq_wiki_batches]), rspec-sidekiq replaces the implementation (using the NullObject pattern) enabling testing without a Redis instance. Mocha and RSpec stubbing is supported here.
+
+### within_sidekiq_retries_exhausted_block
+```ruby
+sidekiq_retries_exhausted do |msg|
+  bar('hello')
+end
+# test with...
+FooClass.within_sidekiq_retries_exhausted_block {
+  expect(FooClass).to receive(:bar).with("hello")
+}
+```
+
+## Testing
+```bundle exec rspec spec```
+
+## Contribute
+Please do! If there's a feature missing that you'd love to see then get in on the action!
+
+Issues/Pull Requests/Comments all welcome...
+
+[code_climate]: https://codeclimate.com/github/philostler/rspec-sidekiq
+[code_climate_badge]: https://codeclimate.com/github/philostler/rspec-sidekiq.png
+[coderwall]: https://coderwall.com/philostler
+[coderwall_badge]: https://api.coderwall.com/philostler/endorsecount.png
+[coveralls]: https://coveralls.io/r/philostler/rspec-sidekiq
+[coveralls_badge]: https://coveralls.io/repos/philostler/rspec-sidekiq/badge.png?branch=master
+[gem_version_badge]: https://badge.fury.io/rb/rspec-sidekiq.png
+[gemnasium]: https://gemnasium.com/philostler/rspec-sidekiq
+[gemnasium_badge]: https://gemnasium.com/philostler/rspec-sidekiq.png
+[github]: http://github.com/philostler/rspec-sidekiq
+[ruby_doc]: http://rubydoc.info/github/philostler/rspec-sidekiq/master/frames
+[ruby_gems]: http://rubygems.org/gems/rspec-sidekiq
+[ruby_toolbox]: http://www.ruby-toolbox.com/projects/rspec-sidekiq
+[travis_ci]: http://travis-ci.org/philostler/rspec-sidekiq
+[travis_ci_badge]: https://secure.travis-ci.org/philostler/rspec-sidekiq.png
+
+[rspec_sidekiq_wiki_faq_&_troubleshooting]: https://github.com/philostler/rspec-sidekiq/wiki/FAQ-&-Troubleshooting
+[sidekiq_wiki_batches]: https://github.com/mperham/sidekiq/wiki/Batches
+[sidekiq_wiki_delayed_extensions]: https://github.com/mperham/sidekiq/wiki/Delayed-Extensions