rspec-sidekiq 0.3.0 → 0.4.0

checksums.yaml

@@ -1,15 +1,15 @@
 ---
 !binary "U0hBMQ==":
   metadata.gz: !binary |-
-    ODc2ZWI3NTdmZjk2MTY3N2I4YmMyNzYxOTQ2MjE4NTY2NWE1OGQ4Yw==
+    MzgyMTA1YzA0ZTU2MjU3YjJhNGQ0NzI0YmVkMjJkYTdmYTc3MzUzMg==
   data.tar.gz: !binary |-
-    Zjk0MjBkYTY4NTNiZjlkNWZlZTRhZGVkNzRhYWM3YjcyMWQyYmRjZg==
+    YzE0MzllMDU3MmQyZjI0MGM0YzA4ZTFhZjkxMjVkN2QxODNmNjdhZg==
 !binary "U0hBNTEy":
   metadata.gz: !binary |-
-    NmNmNDZiYzFkZGU4OWRjNWQ0MjdiZDIwOTY5YzA1YzY4OWI5ZDlkZTQ3NGM3
-    ZmM3NGQ0MzE3NjNhMmQ2ZTE0NzY0NWVhMWQyOTc0OWQ3YTVkODE1N2RmMTIz
-    ZWQyMmYyY2Q5OTAyOGM3NDEwNDhmYjRhMDA2MWVmNGMwNGNlNjA=
+    NWIzZGE3MmZjM2I1MmQzN2M5NTdiOGY0ZmZhMjc0Nzg2NmQ1OTk4ZDE3M2I0
+    OTMyMjk2ZWMzODkxMDQ5OTIyZWEyYTM5NGVlYWEwMjU2MDhjOGI1NTBmMzFl
+    Yjc2ODY0YjQ0MDNkMWY1ZGY4OThkZWNmYmQwZGE1NjFhN2I4NWM=
   data.tar.gz: !binary |-
-    YTYxZDBhYmJlOTg5MTA4YjVkZGU0ZTM4NjE4OTg4MzlmN2ZmYzBjNzZjZDk4
-    OTM1NGI3YmE1MmQ3YWViZTdkMWRhOTFjOGNjZjA0ZjQ1NmUxN2QyYmJiZWVl
-    MGY2NjNhMmE1NTUwNjk5Nzk1YmQwMjc4NTU3NDUwZWZkMzQ4MDk=
+    ZjdjYzcyMGE1OTE2NTU4MmMzNWUyNGMyYjU2NzBkNWUxNTUxMDgwZjMyMDM2
+    N2MyNjVhNjVlZDQ0ZmY4Yzg3MzY2ZjVlMWQ0NWM1Yzg0OTk0OWFiZjRmMzk5
+    OTc1ZGRlM2RiZmFlNmNjMTY5MDIyZDFjMzJhZmY1OTNjMTdlMDU=

data/.gitignore

@@ -1,163 +1,2 @@
-#################
-## 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
+Gemfile.lock
+spec_result

data/.rspec

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

data/CHANGES.md

@@ -1,3 +1,8 @@
+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]

data/README.md

@@ -1,13 +1,32 @@
-# RSpec for Sidekiq [![RubyGems][gem_version_badge]][ruby_gems] [![Code Climate][code_climate_badge]][code_climate] [![Travis CI][travis_ci_badge]][travis_ci] [![Gemnasium][gemnasium_badge]][gemnasium]
+# 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]
+
 *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]
+[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
 ```
-gem "rspec-sidekiq"
-```
-There is no need to ```require "sidekiq/testing"``` when using rspec-sidekiq
+```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*
 
 ## Configuration
 If you wish to modify the default behaviour, add the following to your ```spec_helper.rb``` file
@@ -28,17 +47,21 @@ end
 ### be_processed_in
 *Describes the queue that the job should be processed in*
 ```ruby
-it { should be_processed_in :download } } # one liner
+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
-it { should be_retryable true } } # one liner
+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
+it { should be_retryable 5 } # one liner
 expect(AwesomeJob).to be_retryable 5 # new expect syntax
 ```
 
@@ -47,7 +70,7 @@ expect(AwesomeJob).to be_retryable 5 # new expect syntax
 ```ruby
 sidekiq_options unique: true # job option
 
-it { should be_unique } } # one liner
+it { should be_unique } # one liner
 expect(AwesomeJob).to be_unique # new expect syntax
 ```
 
@@ -94,6 +117,8 @@ 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
+[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

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

@@ -19,9 +19,9 @@ module RSpec
         end
 
         def matches? job
-          @klass = job.class
+          @klass = job.kind_of?(Class) ? job : job.class
           @actual = @klass.get_sidekiq_options["queue"]
-          @actual == @expected
+          @actual.to_s == @expected.to_s
         end
         
         def negative_failure_message

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

@@ -25,7 +25,7 @@ module RSpec
         end
 
         def matches? job
-          @klass = job.class
+          @klass = job.kind_of?(Class) ? job : job.class
           @actual = @klass.get_sidekiq_options["retry"]
           @actual == @expected
         end

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

@@ -15,7 +15,7 @@ module RSpec
         end
 
         def matches? job
-          @klass = job.class
+          @klass = job.kind_of?(Class) ? job : job.class
           @actual = @klass.get_sidekiq_options["unique"]
           @actual == true
         end

data/lib/rspec/sidekiq/version.rb

@@ -1,5 +1,5 @@
 module RSpec
   module Sidekiq
-    VERSION = "0.3.0"
+    VERSION = "0.4.0"
   end
 end

data/rspec-sidekiq.gemspec

@@ -15,6 +15,7 @@ Gem::Specification.new do |s|
   s.add_dependency "rspec", "~> 2.0"
   s.add_dependency "sidekiq", ">= 2.4.0"
 
+  s.add_development_dependency "coveralls", "~> 0.6.0"
   s.add_development_dependency "fuubar", "~> 1.1"
   s.add_development_dependency "rspec", "~> 2.0"
   s.add_development_dependency "sidekiq", ">= 2.4.0"

data/spec/rspec/sidekiq/matchers/be_processed_in_spec.rb

@@ -0,0 +1,29 @@
+require "spec_helper"
+
+describe "Be Processed In matcher" do
+  subject { TestWorker }
+
+  describe "expect syntax" do
+    context "when queue is specified as a string" do
+      it "correctly matches" do
+        expect(TestWorker).to be_processed_in "data"
+      end
+    end
+
+    context "when queue is specified as a symbol" do
+      it "correctly matches" do
+        expect(TestWorker).to be_processed_in :data
+      end
+    end
+  end
+
+  describe "one liner syntax" do
+    context "when queue is specified as a string" do
+      expect_it { to be_processed_in "data" }
+    end
+
+    context "when queue is specified as a symbol" do
+      expect_it { to be_processed_in :data }
+    end
+  end  
+end

data/spec/rspec/sidekiq/matchers/be_retryable_spec.rb

@@ -0,0 +1,41 @@
+require "spec_helper"
+
+describe "Be Retryable matcher" do
+
+  describe "expect syntax" do
+    context "when retryable is number" do
+      it "correctly matches" do
+        expect(TestWorker).to be_retryable 5
+      end
+    end
+
+    context "when retryable is true" do
+      it "correctly matches" do
+        expect(TestWorkerDefaults).to be_retryable true
+      end
+    end
+
+    context "when retryable is false" do
+      it "correctly matches" do
+        expect(TestWorkerAlternative).to be_retryable false
+      end
+    end
+  end
+
+  describe "one liner syntax" do
+    context "when retryable is number" do
+      subject { TestWorker }
+      expect_it { to be_retryable 5 }
+    end
+
+    context "when retryable is true" do
+      subject { TestWorkerDefaults }
+      expect_it { to be_retryable true }
+    end
+
+    context "when retryable is false" do
+      subject { TestWorkerAlternative }
+      expect_it { to be_retryable false }
+    end
+  end  
+end

data/spec/rspec/sidekiq/matchers/be_unique_spec.rb

@@ -0,0 +1,15 @@
+require "spec_helper"
+
+describe "Be Unique matcher" do
+  subject { TestWorker }
+
+  describe "expect syntax" do
+    it "correctly matches" do
+      expect(TestWorker).to be_unique
+    end
+  end
+
+  describe "one liner syntax" do
+    expect_it { to be_unique }
+  end  
+end

data/spec/rspec/sidekiq/version_spec.rb

@@ -3,5 +3,5 @@ require "spec_helper"
 describe "Version" do
   subject { RSpec::Sidekiq::VERSION }
 
-  expect_it { to eq("0.3.0") }
+  expect_it { to eq("0.4.0") }
 end

data/spec/spec_helper.rb

@@ -1,6 +1,17 @@
+require "simplecov"
+require "coveralls"
+
 require "sidekiq"
 require "rspec-sidekiq"
 
+require_relative "support/init"
+
+SimpleCov.formatter = SimpleCov::Formatter::MultiFormatter[
+  Coveralls::SimpleCov::Formatter,
+  SimpleCov::Formatter::HTMLFormatter
+]
+SimpleCov.start
+
 RSpec.configure do |config|
   config.alias_example_to :expect_it
 

data/spec/support/init.rb

@@ -0,0 +1,3 @@
+require_relative "test_worker"
+require_relative "test_worker_alternative"
+require_relative "test_worker_defaults"

data/spec/support/test_worker.rb

@@ -0,0 +1,8 @@
+class TestWorker
+  include Sidekiq::Worker
+
+  sidekiq_options queue: :data, retry: 5, unique: true
+
+  def perform
+  end
+end

data/spec/support/test_worker_alternative.rb

@@ -0,0 +1,8 @@
+class TestWorkerAlternative
+  include Sidekiq::Worker
+
+  sidekiq_options queue: "data", retry: false, unique: false
+
+  def perform
+  end
+end

data/spec/support/test_worker_defaults.rb

@@ -0,0 +1,6 @@
+class TestWorkerDefaults
+  include Sidekiq::Worker
+
+  def perform
+  end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: rspec-sidekiq
 version: !ruby/object:Gem::Version
-  version: 0.3.0
+  version: 0.4.0
 platform: ruby
 authors:
 - Phil Ostler
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-04-09 00:00:00.000000000 Z
+date: 2013-05-15 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rspec
@@ -38,6 +38,20 @@ dependencies:
     - - ! '>='
       - !ruby/object:Gem::Version
         version: 2.4.0
+- !ruby/object:Gem::Dependency
+  name: coveralls
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.6.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.6.0
 - !ruby/object:Gem::Dependency
   name: fuubar
   requirement: !ruby/object:Gem::Requirement
@@ -105,8 +119,15 @@ files:
 - lib/rspec/sidekiq/sidekiq.rb
 - lib/rspec/sidekiq/version.rb
 - lib/rspec-sidekiq.rb
+- spec/rspec/sidekiq/matchers/be_processed_in_spec.rb
+- spec/rspec/sidekiq/matchers/be_retryable_spec.rb
+- spec/rspec/sidekiq/matchers/be_unique_spec.rb
 - spec/rspec/sidekiq/version_spec.rb
 - spec/spec_helper.rb
+- spec/support/init.rb
+- spec/support/test_worker.rb
+- spec/support/test_worker_alternative.rb
+- spec/support/test_worker_defaults.rb
 homepage: http://github.com/philostler/rspec-sidekiq
 licenses:
 - MIT