sidekiq-unique-jobs 2.7.0 → 2.7.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 774a1d7ddc612a093c21bc717c839b2ad6c0eb86
-  data.tar.gz: 7b4c90512accf84894675887cee3addba328c9d5
+  metadata.gz: 1b39f24bdf9c726995309be6197b768d386f10f7
+  data.tar.gz: eff0e7d8830cb959a212c1ddb6305eb83a4ecaba
 SHA512:
-  metadata.gz: 27f27613ec3338945275678c377ddd77500540ac28ebe4986ef45684c2461b20ea72c7e12c67d80feba466f141295f54bc23bbbfce30dc37304273596befc255
-  data.tar.gz: ce9a29bdd35166e5bdda72b8f45f48b0048d2f48e678d57c01c082441059f0b192c177d71d1b0e795805340dae7bf85f800bdc2bee609b66fba9b1cbca0c2442
+  metadata.gz: a4b47722b22edfb2157dfd13b49b212cf64e860f0c6ee4fee26045ed854a00511c98a8b89a729e6c0329d3033c603b7bb3e7e24b1b3cfe50cf21c13510de2d78
+  data.tar.gz: 79c75c467a0ed416b3a5db44d5f1f119df472e1d5ad4aab4fddcf12ee300a6c90f9585b176c4caed2418b74e270993ff912b17d5af772a269d9f34922906a06d

data/.gitignore

@@ -7,3 +7,4 @@ Gemfile.lock
 
 .ruby-version
 .idea/
+gemfiles/*.lock

data/.travis.yml

@@ -6,6 +6,12 @@ rvm:
   - jruby-19mode
   - rbx-19mode
   - 2.0.0
+  - 2.1.0
+gemfile:
+  - gemfiles/sidekiq_2.15.gemfile
+  - gemfiles/sidekiq_2.16.gemfile
+  - gemfiles/sidekiq_2.17.gemfile
+  - gemfiles/sidekiq_develop.gemfile
 branches:
   only:
     - master

data/Appraisals

@@ -0,0 +1,15 @@
+appraise "sidekiq-develop" do
+  gem 'sidekiq', github: 'mperham/sidekiq'
+end
+
+appraise "sidekiq-2.17" do
+  gem 'sidekiq', '2.17'
+end
+
+appraise "sidekiq-2.16" do
+  gem "sidekiq", '2.16'
+end
+
+appraise "sidekiq-2.15" do
+  gem "sidekiq", '2.15'
+end

data/Gemfile

@@ -1,10 +1,7 @@
 source 'http://rubygems.org'
 gemspec
 
-group :development do
-  gem 'sidekiq', github: 'mperham/sidekiq'
-end
-
+gem 'appraisal', '~> 1.0.0.beta'
 gem 'pry'
 gem 'pry-stack_explorer'
 gem 'pry-debugger'

data/README.md

@@ -24,6 +24,13 @@ All that is required is that you specifically set the sidekiq option for *unique
 sidekiq_options unique: true
 ```
 
+For jobs scheduled in the future it is possible to set for how long the job
+should be unique. The job will be unique for the number of seconds configured
+or until the job has been completed.
+
+*If you want the unique job to stick around even after it has been successfully
+processed then just set the unique_unlock_order to anything except `:before_yield` or `:after_yield` (`unique_unlock_order = :never`)
+
 You can also control the expiration length of the uniqueness check. If you want to enforce uniqueness over a longer period than the default of 30 minutes then you can pass the number of seconds you want to use to the sidekiq options:
 
 ```ruby
@@ -34,8 +41,9 @@ Requiring the gem in your gemfile should be sufficient to enable unique jobs.
 
 ### Finer Control over Uniqueness
 
-Sometimes it is desired to have a finer control over which arguments are used in determining uniqueness of the job, and others may be _transient_. For this use-case, you need to
-set `SidekiqUniqueJobs::Config.unique_args_enabled` to true in an initializer, and then defined either `unique_args` method, or a ruby proc.
+Sometimes it is desired to have a finer control over which arguments are used in determining uniqueness of the job, and others may be _transient_. For this use-case, you need to set `SidekiqUniqueJobs::Config.unique_args_enabled` to true in an initializer, and then defined either `unique_args` method, or a ruby proc.
+
+The unique_args method need to return an array of values to use for uniqueness check.
 
 ```ruby
 SidekiqUniqueJobs::Config.unique_args_enabled = true
@@ -67,10 +75,7 @@ class UniqueJobWithFilterProc
 end
 ```
 
-Note that objects passed into workers are converted to JSON *after* running through client middleware. In server
-middleware, the JSON is passed directly to the worker `#perform` method. So, you may run into issues where the
-arguments are different when enqueuing than they are when performing. Your `unique_args` method may need to
-account for this.
+Note that objects passed into workers are converted to JSON *after* running through client middleware. In server middleware, the JSON is passed directly to the worker `#perform` method. So, you may run into issues where the arguments are different when enqueuing than they are when performing. Your `unique_args` method may need to account for this.
 
 ### Unlock Ordering
 

data/Rakefile

@@ -1,4 +1,6 @@
 #!/usr/bin/env rake
+require "rubygems"
+require "bundler/setup"
 require "bundler/gem_tasks"
 require 'rspec/core/rake_task'
 

data/gemfiles/sidekiq_2.15.gemfile

@@ -0,0 +1,11 @@
+# This file was generated by Appraisal
+
+source "http://rubygems.org"
+
+gem "appraisal", "~> 1.0.0.beta"
+gem "pry"
+gem "pry-stack_explorer"
+gem "pry-debugger"
+gem "sidekiq", "2.15"
+
+gemspec :path=>".././"

data/gemfiles/sidekiq_2.16.gemfile

@@ -0,0 +1,11 @@
+# This file was generated by Appraisal
+
+source "http://rubygems.org"
+
+gem "appraisal", "~> 1.0.0.beta"
+gem "pry"
+gem "pry-stack_explorer"
+gem "pry-debugger"
+gem "sidekiq", "2.16"
+
+gemspec :path=>".././"

data/gemfiles/sidekiq_2.17.gemfile

@@ -0,0 +1,11 @@
+# This file was generated by Appraisal
+
+source "http://rubygems.org"
+
+gem "appraisal", "~> 1.0.0.beta"
+gem "pry"
+gem "pry-stack_explorer"
+gem "pry-debugger"
+gem "sidekiq", "2.17"
+
+gemspec :path=>".././"

data/gemfiles/sidekiq_develop.gemfile

@@ -0,0 +1,11 @@
+# This file was generated by Appraisal
+
+source "http://rubygems.org"
+
+gem "appraisal", "~> 1.0.0.beta"
+gem "pry"
+gem "pry-stack_explorer"
+gem "pry-debugger"
+gem "sidekiq", :github=>"mperham/sidekiq"
+
+gemspec :path=>".././"

data/lib/sidekiq-unique-jobs/middleware/server/unique_jobs.rb

@@ -4,21 +4,45 @@ module SidekiqUniqueJobs
   module Middleware
     module Server
       class UniqueJobs
-        def call(worker, item, queue)
-          unlock_order = worker.class.get_sidekiq_options['unique_unlock_order'] ||
-            SidekiqUniqueJobs::Config.default_unlock_order
+        attr_reader :unlock_order
 
+        def call(worker, item, queue)
+          set_unlock_order(worker.class)
           lock_key = payload_hash(item)
-
-          unlocked = unlock_order == :before_yield ? unlock(lock_key).inspect : 0
+          unlocked = before_yield? ? unlock(lock_key).inspect : 0
 
           yield
         ensure
-          if unlock_order == :after_yield || !defined? unlocked || unlocked != 1
+          if after_yield? || !defined? unlocked || unlocked != 1
             unlock(lock_key)
           end
         end
 
+        def set_unlock_order(klass)
+          @unlock_order = if unlock_order_configured?(klass)
+            klass.get_sidekiq_options['unique_unlock_order']
+          else
+            default_unlock_order
+          end
+        end
+
+        def unlock_order_configured?(klass)
+          klass.respond_to?(:get_sidekiq_options) &&
+            !klass.get_sidekiq_options['unique_unlock_order'].nil?
+        end
+
+        def default_unlock_order
+          SidekiqUniqueJobs::Config.default_unlock_order
+        end
+
+        def before_yield?
+          unlock_order == :before_yield
+        end
+
+        def after_yield?
+          unlock_order == :after_yield
+        end
+
         protected
 
         def payload_hash(item)

data/lib/sidekiq-unique-jobs/version.rb

@@ -1,3 +1,3 @@
 module SidekiqUniqueJobs
-  VERSION = "2.7.0"
+  VERSION = "2.7.1"
 end

data/sidekiq-unique-jobs.gemspec

@@ -14,11 +14,11 @@ Gem::Specification.new do |gem|
   gem.name          = "sidekiq-unique-jobs"
   gem.require_paths = ["lib"]
   gem.version       = SidekiqUniqueJobs::VERSION
-  gem.add_dependency                  'sidekiq', '~> 2.6'
-  gem.add_dependency                  'mock_redis'
-  gem.add_development_dependency      'rspec', '>= 2'
-  gem.add_development_dependency      'rake'
-  gem.add_development_dependency      'rspec-sidekiq'
-  gem.add_development_dependency      'activesupport', '~> 3'
-  gem.add_development_dependency      'simplecov'
+  gem.add_dependency             'sidekiq', '~> 2.6'
+  gem.add_dependency             'mock_redis'
+  gem.add_development_dependency 'rspec', '~> 3.0.0.beta'
+  gem.add_development_dependency 'rake'
+  gem.add_development_dependency 'rspec-sidekiq'
+  gem.add_development_dependency 'activesupport', '~> 3'
+  gem.add_development_dependency 'simplecov'
 end

data/spec/lib/middleware/server/unique_jobs_spec.rb

@@ -0,0 +1,81 @@
+require 'spec_helper'
+
+module SidekiqUniqueJobs
+  module Middleware
+    module Server
+      describe UniqueJobs do
+        describe '#unlock_order_configured?' do
+          context "when class isn't a Sidekiq::Worker" do
+            it "returns false" do
+              expect(subject.unlock_order_configured?(Class))
+                .to eq(false)
+            end
+          end
+
+          context "when get_sidekiq_options[:unique_unlock_order] is nil" do
+            it "returns false" do
+              expect(subject.unlock_order_configured?(MyWorker))
+                .to eq(false)
+            end
+          end
+
+          it "returns true when unique_unlock_order has been set" do
+            UniqueWorker.sidekiq_options unique_unlock_order: :before_yield
+            expect(subject.unlock_order_configured?(UniqueWorker))
+              .to eq(true)
+          end
+        end
+
+        describe '#set_unlock_order' do
+          context "when worker has specified unique_unlock_order" do
+            it "changes unlock_order to the configured value" do
+              UniqueWorker.sidekiq_options unique_unlock_order: :before_yield
+              expect do
+                subject.set_unlock_order(UniqueWorker)
+              end.to change { subject.unlock_order }.to :before_yield
+            end
+          end
+
+          context "when worker hasn't specified unique_unlock_order" do
+            it "falls back to configured default_unlock_order" do
+              SidekiqUniqueJobs::Config.default_unlock_order = :before_yield
+              expect do
+                subject.set_unlock_order(UniqueWorker)
+              end.to change { subject.unlock_order }.to :before_yield
+            end
+          end
+        end
+
+        describe '#before_yield?' do
+          it "returns unlock_order == :before_yield" do
+            allow(subject).to receive(:unlock_order).and_return(:after_yield)
+            expect(subject.before_yield?).to eq(false)
+
+            allow(subject).to receive(:unlock_order).and_return(:before_yield)
+            expect(subject.before_yield?).to eq(true)
+          end
+        end
+
+        describe '#after_yield?' do
+          it "returns unlock_order == :before_yield" do
+            allow(subject).to receive(:unlock_order).and_return(:before_yield)
+            expect(subject.after_yield?).to eq(false)
+
+            allow(subject).to receive(:unlock_order).and_return(:after_yield)
+            expect(subject.after_yield?).to eq(true)
+          end
+        end
+
+        describe '#default_unlock_order' do
+          it 'returns the default value from config' do
+            SidekiqUniqueJobs::Config.default_unlock_order = :before_yield
+            expect(subject.default_unlock_order).to eq(:before_yield)
+
+            SidekiqUniqueJobs::Config.default_unlock_order = :after_yield
+            expect(subject.default_unlock_order).to eq(:after_yield)
+          end
+        end
+      end
+    end
+  end
+end

data/spec/lib/sidekiq_testing_enabled_spec.rb

@@ -3,18 +3,19 @@ require 'sidekiq/worker'
 require "sidekiq-unique-jobs"
 require 'sidekiq/scheduled'
 require 'sidekiq-unique-jobs/middleware/server/unique_jobs'
+require 'rspec-sidekiq'
 
 describe "When Sidekiq::Testing is enabled" do
   describe 'when set to :fake!', sidekiq: :fake do
     context "with unique worker" do
       it "does not push duplicate messages" do
         param = 'work'
-        expect(UniqueWorker).to have_enqueued_jobs(0)
+        expect(UniqueWorker.jobs.size).to eq(0)
         UniqueWorker.perform_async(param)
-        expect(UniqueWorker).to have_enqueued_jobs(1)
+        expect(UniqueWorker.jobs.size).to eq(1)
         expect(UniqueWorker).to have_enqueued_job(param)
         UniqueWorker.perform_async(param)
-        expect(UniqueWorker).to have_enqueued_jobs(1)
+        expect(UniqueWorker.jobs.size).to eq(1)
       end
     end
 
@@ -22,12 +23,12 @@ describe "When Sidekiq::Testing is enabled" do
 
       it "pushes duplicates messages" do
         param = 'work'
-        expect(MyWorker).to have_enqueued_jobs(0)
+        expect(MyWorker.jobs.size).to eq(0)
         MyWorker.perform_async(param)
-        expect(MyWorker).to have_enqueued_jobs(1)
+        expect(MyWorker.jobs.size).to eq(1)
         expect(MyWorker).to have_enqueued_job(param)
         MyWorker.perform_async(param)
-        expect(MyWorker).to have_enqueued_jobs(2)
+        expect(MyWorker.jobs.size).to eq(2)
       end
     end
   end

data/spec/spec_helper.rb

@@ -14,7 +14,6 @@ require 'sidekiq/util'
 require 'sidekiq-unique-jobs'
 Sidekiq.logger.level = Logger::ERROR
 
-require 'sidekiq/testing'
 require 'rspec-sidekiq'
 
 Sidekiq::Testing.disable!
@@ -25,5 +24,16 @@ REDIS = Sidekiq::RedisConnection.create(:url => redis_url, :namespace => 'testy'
 
 Dir[File.join(File.dirname(__FILE__), 'support', '**', '*.rb')].each { |f| require f }
 RSpec.configure do |config|
-  config.treat_symbols_as_metadata_keys_with_true_values = true
+  # config.treat_symbols_as_metadata_keys_with_true_values = true
+end
+
+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

data/spec/support/sidekiq_meta.rb

@@ -1,5 +1,5 @@
 RSpec.configure do |config|
-  config.before(:each) do # |example| TODO: Add this for RSpec 3
+  config.before(:each) do |example|
     sidekiq = example.metadata[:sidekiq]
     if sidekiq
       sidekiq = :fake if sidekiq == true
@@ -7,7 +7,7 @@ RSpec.configure do |config|
     end
   end
 
-  config.after(:each) do # |example| TODO: Add this for RSpec 3
+  config.after(:each) do |example|
     if sidekiq = example.metadata[:sidekiq]
       Sidekiq::Testing.disable!
     end

metadata

@@ -1,111 +1,111 @@
 --- !ruby/object:Gem::Specification
 name: sidekiq-unique-jobs
 version: !ruby/object:Gem::Version
-  version: 2.7.0
+  version: 2.7.1
 platform: ruby
 authors:
 - Mikael Henriksson
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-11-24 00:00:00.000000000 Z
+date: 2014-01-27 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: sidekiq
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '2.6'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '2.6'
 - !ruby/object:Gem::Dependency
   name: mock_redis
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '2'
+        version: 3.0.0.beta
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '2'
+        version: 3.0.0.beta
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
   name: rspec-sidekiq
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
   name: activesupport
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '3'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '3'
 - !ruby/object:Gem::Dependency
   name: simplecov
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
 description: The unique jobs that were removed from sidekiq
@@ -115,14 +115,19 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- .gitignore
-- .rspec
-- .travis.yml
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- Appraisals
 - CHANGELOG.md
 - Gemfile
 - LICENSE
 - README.md
 - Rakefile
+- gemfiles/sidekiq_2.15.gemfile
+- gemfiles/sidekiq_2.16.gemfile
+- gemfiles/sidekiq_2.17.gemfile
+- gemfiles/sidekiq_develop.gemfile
 - lib/sidekiq-unique-jobs.rb
 - lib/sidekiq-unique-jobs/config.rb
 - lib/sidekiq-unique-jobs/middleware.rb
@@ -133,6 +138,7 @@ files:
 - lib/sidekiq-unique-jobs/version.rb
 - sidekiq-unique-jobs.gemspec
 - spec/lib/client_spec.rb
+- spec/lib/middleware/server/unique_jobs_spec.rb
 - spec/lib/sidekiq_testing_enabled_spec.rb
 - spec/lib/unlock_order_spec.rb
 - spec/spec_helper.rb
@@ -149,17 +155,17 @@ require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
-  - - '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.1.11
+rubygems_version: 2.2.1
 signing_key: 
 specification_version: 4
 summary: The unique jobs that were removed from sidekiq