rspec-sidekiq 0.1.0

data/.gitattributes

@@ -0,0 +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

data/.gitignore

@@ -0,0 +1,163 @@
+#################
+## Eclipse
+#################
+
+*.pydevproject
+.project
+.metadata
+bin/
+tmp/
+*.tmp
+*.bak
+*.swp
+*~.nib
+local.properties
+.classpath
+.settings/
+.loadpath
+
+# External tool builders
+.externalToolBuilders/
+
+# Locally stored "Eclipse launch configurations"
+*.launch
+
+# CDT-specific
+.cproject
+
+# PDT-specific
+.buildpath
+
+
+#################
+## Visual Studio
+#################
+
+## Ignore Visual Studio temporary files, build results, and
+## files generated by popular Visual Studio add-ons.
+
+# User-specific files
+*.suo
+*.user
+*.sln.docstates
+
+# Build results
+[Dd]ebug/
+[Rr]elease/
+*_i.c
+*_p.c
+*.ilk
+*.meta
+*.obj
+*.pch
+*.pdb
+*.pgc
+*.pgd
+*.rsp
+*.sbr
+*.tlb
+*.tli
+*.tlh
+*.tmp
+*.vspscc
+.builds
+*.dotCover
+
+## TODO: If you have NuGet Package Restore enabled, uncomment this
+#packages/
+
+# Visual C++ cache files
+ipch/
+*.aps
+*.ncb
+*.opensdf
+*.sdf
+
+# Visual Studio profiler
+*.psess
+*.vsp
+
+# ReSharper is a .NET coding add-in
+_ReSharper*
+
+# Installshield output folder
+[Ee]xpress
+
+# DocProject is a documentation generator add-in
+DocProject/buildhelp/
+DocProject/Help/*.HxT
+DocProject/Help/*.HxC
+DocProject/Help/*.hhc
+DocProject/Help/*.hhk
+DocProject/Help/*.hhp
+DocProject/Help/Html2
+DocProject/Help/html
+
+# Click-Once directory
+publish
+
+# Others
+[Bb]in
+[Oo]bj
+sql
+TestResults
+*.Cache
+ClientBin
+stylecop.*
+~$*
+*.dbmdl
+Generated_Code #added for RIA/Silverlight projects
+
+# Backup & report files from converting an old project file to a newer
+# Visual Studio version. Backup files are not needed, because we have git ;-)
+_UpgradeReport_Files/
+Backup*/
+UpgradeLog*.XML
+
+
+
+############
+## Windows
+############
+
+# Windows image file caches
+Thumbs.db
+
+# Folder config file
+Desktop.ini
+
+
+#############
+## Python
+#############
+
+*.py[co]
+
+# Packages
+*.egg
+*.egg-info
+dist
+build
+eggs
+parts
+bin
+var
+sdist
+develop-eggs
+.installed.cfg
+
+# Installer logs
+pip-log.txt
+
+# Unit test / coverage reports
+.coverage
+.tox
+
+#Translations
+*.mo
+
+#Mr Developer
+.mr.developer.cfg
+
+# Mac crap
+.DS_Store

data/.rspec

@@ -0,0 +1,3 @@
+--colour
+--format Fuubar
+--format html --out rspec_results.html

data/CHANGES.md

@@ -0,0 +1,3 @@
+0.1.0
+---
+* Initial release

data/Gemfile

@@ -0,0 +1,3 @@
+source "https://rubygems.org"
+
+gemspec

data/LICENSE

@@ -0,0 +1,9 @@
+MIT License
+
+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

@@ -0,0 +1,70 @@
+# RSpec for Sidekiq [![Code Climate][code_climate_badge]][code_climate] [![Travis CI][travis_ci_badge]][travis_ci] [![Gemnasium][gemnasium_badge]][gemnasium]
+*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] | [Gemnasium][gemnasium] | [RubyDoc][ruby_doc] | [Ruby Toolbox][ruby_toolbox]
+
+## Installation
+```
+gem "rspec-sidekiq"
+```
+There is no need to ```require "sidekiq/testing"``` when using rspec-sidekiq
+
+## Configuration
+```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_jobs](#have_enqueued_jobs)
+
+### be_processed_in
+*Describes the queue that the job should be processed in*
+```ruby
+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
+it { should be_retryable true } } # one liner
+expect(AwesomeJob).to be_retryable true # new expect syntax
+```
+
+### be_unique (Only available when using [sidekiq-middleware](https://github.com/krasnoukhov/sidekiq-middleware))
+*Describes if the job should be unique within it's queue*
+```ruby
+it { should be_unique } } # one liner
+expect(AwesomeJob).to be_unique # new expect syntax
+```
+
+### have_enqueued_jobs
+*Evaluates the number of enqueued jobs for a specified job*
+```ruby
+expect(AwesomeJob).to have_enqueued_jobs(1) # new expect syntax
+```
+
+## Testing
+```bundle exec rspec spec```
+
+## Contribute
+Yes do it! If there's a feature missing that you'd love them 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
+[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

data/lib/rspec-sidekiq.rb

@@ -0,0 +1,5 @@
+require "sidekiq/testing"
+
+require "rspec/sidekiq/configuration"
+require "rspec/sidekiq/matchers"
+require "rspec/sidekiq/sidekiq"

data/lib/rspec/sidekiq/configuration.rb

@@ -0,0 +1,11 @@
+module RSpec
+  module Sidekiq
+    class Configuration
+      attr_accessor :clear_all_enqueued_jobs
+
+      def initialize
+        @clear_all_enqueued_jobs = true
+      end
+    end
+  end
+end

data/lib/rspec/sidekiq/matchers.rb

@@ -0,0 +1,11 @@
+require "rspec/sidekiq/matchers/be_processed_in"
+require "rspec/sidekiq/matchers/be_retryable"
+require "rspec/sidekiq/matchers/have_enqueued_jobs"
+
+if defined?(Sidekiq::Middleware::Client::UniqueJobs)
+  require "rspec/sidekiq/matchers/be_unique"
+end
+
+RSpec.configure do |config|
+  config.include RSpec::Sidekiq::Matchers
+end

data/lib/rspec/sidekiq/matchers/be_processed_in.rb

@@ -0,0 +1,33 @@
+module RSpec
+  module Sidekiq
+    module Matchers
+      def be_processed_in expected
+        BeProcessedIn.new expected
+      end
+
+      class BeProcessedIn
+        def initialize expected
+          @expected = expected
+        end
+
+        def description
+          "be processed in the \"#{@expected}\" queue"
+        end
+
+        def failure_message
+          "expected #{@klass} to be processed in the #{@expected} queue but got #{@actual}"
+        end
+
+        def matches? job
+          @klass = job.class
+          @actual = @klass.get_sidekiq_options["queue"]
+          @actual == @expected
+        end
+        
+        def negative_failure_message
+          "expected #{@klass} to not be processed in the #{@expected} queue"
+        end
+      end
+    end
+  end
+end

data/lib/rspec/sidekiq/matchers/be_retryable.rb

@@ -0,0 +1,37 @@
+module RSpec
+  module Sidekiq
+    module Matchers
+      def be_retryable expected
+        BeRetryable.new expected
+      end
+
+      class BeRetryable
+        def initialize expected
+          @expected = expected
+        end
+
+        def description
+          "retry #{number_of_description} times"
+        end
+
+        def failure_message
+          "expected #{@klass} to retry #{number_of_description} times but got #{@actual}"
+        end
+
+        def matches? job
+          @klass = job.class
+          @actual = @klass.get_sidekiq_options["retry"]
+          @actual == @expected
+        end
+        
+        def negative_failure_message
+          "expected #{@klass} to not retry #{number_of_description} times"
+        end
+
+        def number_of_description
+          @expected.is_a?(Fixnum) ? @expected : "the default number of"
+        end
+      end
+    end
+  end
+end

data/lib/rspec/sidekiq/matchers/be_unique.rb

@@ -0,0 +1,29 @@
+module RSpec
+  module Sidekiq
+    module Matchers
+      def be_unique
+        BeUnique.new
+      end
+
+      class BeUnique
+        def description
+          "be unique in the queue"
+        end
+
+        def failure_message
+          "expected #{@klass} to be unique in the queue but it is not"
+        end
+
+        def matches? job
+          @klass = job.class
+          @actual = @klass.get_sidekiq_options["unique"]
+          @actual == true
+        end
+        
+        def negative_failure_message
+          "expected #{@klass} to not be unique in the queue"
+        end
+      end
+    end
+  end
+end

data/lib/rspec/sidekiq/matchers/have_enqueued_jobs.rb

@@ -0,0 +1,33 @@
+module RSpec
+  module Sidekiq
+    module Matchers
+      def have_enqueued_jobs expected
+        HaveEnqueuedJobs.new expected
+      end
+
+      class HaveEnqueuedJobs
+        def initialize expected
+          @expected = expected
+        end
+
+        def description
+          "enqueues a #{@klass} job"
+        end
+
+        def failure_message
+          "expected #{@klass} to have #{@expected} enqueued jobs but got #{@actual}"
+        end
+
+        def matches? klass
+          @klass = klass
+          @actual = klass.jobs.size
+          @actual == @expected
+        end
+        
+        def negative_failure_message
+          "expected #{@klass} to not have #{@expected} enqueued jobs"
+        end
+      end
+    end
+  end
+end

data/lib/rspec/sidekiq/sidekiq.rb

@@ -0,0 +1,21 @@
+module RSpec
+  module Sidekiq
+    class << self
+      def configure &block
+        yield configuration
+
+        configuration
+      end
+
+      def configuration
+        @configuration ||= Configuration.new
+      end
+    end
+  end
+end
+
+RSpec.configure do |config|
+  config.before(:each) do
+    Sidekiq::Worker.clear_all if RSpec::Sidekiq.configuration.clear_all_enqueued_jobs
+  end
+end

data/lib/rspec/sidekiq/version.rb

@@ -0,0 +1,5 @@
+module RSpec
+  module Sidekiq
+    VERSION = "0.1.0"
+  end
+end

data/rspec-sidekiq.gemspec

@@ -0,0 +1,33 @@
+# -*- encoding: utf-8 -*-
+require File.expand_path("../lib/rspec/sidekiq/version", __FILE__)
+
+Gem::Specification.new do |s|
+  s.name        = "rspec-sidekiq"
+  s.version     = RSpec::Sidekiq::VERSION
+  s.platform    = Gem::Platform::RUBY
+  s.author      = "Phil Ostler"
+  s.email       = "github@philostler.com"
+  s.homepage    = "http://github.com/philostler/rspec-sidekiq"
+  s.summary     = "RSpec for Sidekiq"
+  s.description = "Simple testing of Sidekiq jobs via a collection of matchers and common tasks"
+  s.license     = "MIT"
+
+  s.add_dependency "rspec", "~> 2.0"
+  s.add_dependency "sidekiq", ">= 2.4.0"
+
+  s.add_development_dependency "fuubar", "~> 1.1"
+  s.add_development_dependency "rspec", "~> 2.0"
+  s.add_development_dependency "sidekiq", ">= 2.4.0"
+
+  s.files = Dir[".gitattributes"] +
+            Dir[".gitignore"] +
+            Dir[".rspec"] +
+            Dir[".travis"] +
+            Dir["CHANGES.md"] +
+            Dir["Gemfile"] +
+            Dir["LICENSE"] +
+            Dir["README.md"] +
+            Dir["rspec-sidekiq.gemspec"] +
+            Dir["**/*.rb"]
+  s.require_paths = ["lib"]
+end

data/spec/rspec/sidekiq/version_spec.rb

@@ -0,0 +1,7 @@
+require "spec_helper"
+
+describe "Version" do
+  subject { RSpec::Sidekiq::VERSION }
+
+  expect_it { to eq("0.1.0") }
+end

data/spec/spec_helper.rb

@@ -0,0 +1,15 @@
+require "sidekiq"
+require "rspec-sidekiq"
+
+RSpec.configure do |config|
+  config.alias_example_to :expect_it
+
+  config.expect_with :rspec do |config|
+    config.syntax = :expect
+  end
+end
+
+RSpec::Core::MemoizedHelpers.module_eval do
+  alias to should
+  alias to_not should_not
+end

metadata

@@ -0,0 +1,145 @@
+--- !ruby/object:Gem::Specification
+name: rspec-sidekiq
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+  prerelease: 
+platform: ruby
+authors:
+- Phil Ostler
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-03-24 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '2.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '2.0'
+- !ruby/object:Gem::Dependency
+  name: sidekiq
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 2.4.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 2.4.0
+- !ruby/object:Gem::Dependency
+  name: fuubar
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.1'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.1'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '2.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '2.0'
+- !ruby/object:Gem::Dependency
+  name: sidekiq
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 2.4.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 2.4.0
+description: Simple testing of Sidekiq jobs via a collection of matchers and common
+  tasks
+email: github@philostler.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitattributes
+- .gitignore
+- .rspec
+- CHANGES.md
+- Gemfile
+- LICENSE
+- README.md
+- rspec-sidekiq.gemspec
+- lib/rspec/sidekiq/configuration.rb
+- lib/rspec/sidekiq/matchers/be_processed_in.rb
+- lib/rspec/sidekiq/matchers/be_retryable.rb
+- lib/rspec/sidekiq/matchers/be_unique.rb
+- lib/rspec/sidekiq/matchers/have_enqueued_jobs.rb
+- lib/rspec/sidekiq/matchers.rb
+- lib/rspec/sidekiq/sidekiq.rb
+- lib/rspec/sidekiq/version.rb
+- lib/rspec-sidekiq.rb
+- spec/rspec/sidekiq/version_spec.rb
+- spec/spec_helper.rb
+homepage: http://github.com/philostler/rspec-sidekiq
+licenses:
+- MIT
+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: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.24
+signing_key: 
+specification_version: 3
+summary: RSpec for Sidekiq
+test_files: []