sidekiq-unique-jobs 4.0.18 → 5.0.0

data/CHANGELOG.md

@@ -1,3 +1,7 @@
+## v5.0.0
+
+- Only support Sidekiq >= 4
+
 ## v4.0.18
 
 - Allow mock_redis to be used over redis

data/Gemfile

@@ -1,16 +1,20 @@
-source 'http://rubygems.org'
+# rubocop:disable Style/FileName
+
+source 'https://rubygems.org'
 gemspec
 
 gem 'appraisal', '~> 2.0.0'
 gem 'rspec-its',  require: false
 gem 'rspec-wait', require: false
-gem 'mock_redis', require: false
 
-platforms :mri_23 do
-  gem 'fasterer',                  require: false
+platforms :mri_24 do
   gem 'benchmark-ips',             require: false
+  gem 'codeclimate-test-reporter', require: false
+  gem 'fasterer',                  require: false
+  gem 'memory_profiler',           require: false
+  gem 'mock_redis',                require: false
   gem 'pry-byebug',                require: false
+  gem 'rubocop',                   require: false
   gem 'simplecov-json',            require: false
-  gem 'memory_profiler',           require: false
-  gem 'codeclimate-test-reporter', require: false
+  gem 'travis',                    require: false
 end

data/README.md

@@ -123,7 +123,7 @@ Requiring the gem in your gemfile should be sufficient to enable unique jobs.
 ```ruby
 Sidekiq.default_worker_options = {
   unique: :until_executing,
-  unique_args: ->(args) { args.first.except('job_id') }
+  unique_args: ->(args) { [ args.first.except('job_id') ] }
 }
 ```
 
@@ -139,7 +139,7 @@ The method or the proc can return a modified version of args without the transie
 ```ruby
 class UniqueJobWithFilterMethod
   include Sidekiq::Worker
-  sidekiq_options unique: :until_and_during_execution,
+  sidekiq_options unique: :until_and_while_execution,
                   unique_args: :unique_args
 
   def self.unique_args(name, id, options)
@@ -222,6 +222,20 @@ You can if you want use `gem 'mock_redis'` to prevent sidekiq unique jobs using
 
 See https://github.com/mhenrixon/sidekiq-unique-jobs/tree/master/rails_example/spec/controllers/work_controller_spec.rb for an example of how to configure sidekiq and unique jobs without redis.
 
+If you really don't care about testing uniquness and trust we get that stuff right you can (in newer sidekiq versions) remove the client middleware.
+
+```ruby
+describe "Some test" do
+  before(:each) do
+    Sidekiq.configure_client do |config|
+      config.client_middleware do |chain|
+        chain.remove SidekiqUniqueJobs::Client::Middleware
+      end
+    end
+  end
+end
+```
+
 ## Contributing
 
 1. Fork it

data/Rakefile

@@ -1,4 +1,5 @@
 #!/usr/bin/env rake
+# frozen_string_literal: true
 
 require 'rubygems'
 require 'bundler/setup'

data/bin/bench

@@ -1,4 +1,5 @@
 #!/usr/bin/env ruby
+# frozen_string_literal: true
 
 # Trap interrupts to quit cleanly. See
 # https://twitter.com/mitchellh/status/283014103189053442

data/bin/jobs

@@ -1,4 +1,5 @@
 #!/usr/bin/env ruby
+# frozen_string_literal: true
 
 require 'bundler/setup'
 require 'sidekiq-unique-jobs'

data/circle.yml

@@ -1,7 +1,7 @@
 machine:
   ruby:
     version:
-      2.2.3
+      2.3.0
   java:
     version: oraclejdk8
   environment:
@@ -14,19 +14,21 @@ dependencies:
     - rvm install rbx-2
     - rvm install 2.0.0
     - rvm install 2.1.7
+    - rvm install 2.2.3
   override:
     - rvm-exec jruby-9.0.0.0 bundle install
     - rvm-exec jruby-1.7 bundle install
     - rvm-exec rbx-2 bundle install
     - rvm-exec 2.0.0 bundle install
-    - rvm-exec 2.1.7 bundle install
-    - rvm-exec 2.2.3 bundle install
+    - rvm-exec 2.1.8 bundle install
+    - rvm-exec 2.2.4 bundle install
     - rvm-exec jruby-9.0.0.0 bundle exec appraisal install
     - rvm-exec jruby-1.7 bundle exec appraisal install
     - rvm-exec rbx-2 bundle exec appraisal install
     - rvm-exec 2.0.0 bundle exec appraisal install
     - rvm-exec 2.1.7 bundle exec appraisal install
     - rvm-exec 2.2.3 bundle exec appraisal install
+    - rvm-exec 2.3.0 bundle exec appraisal install
 
 test:
   override:
@@ -36,3 +38,4 @@ test:
     - rvm-exec 2.0.0 bundle exec appraisal rspec
     - rvm-exec 2.1.7 bundle exec appraisal rspec
     - rvm-exec 2.2.3 bundle exec appraisal rspec
+    - rvm-exec 2.3.0 bundle exec appraisal rspec

data/gemfiles/sidekiq_4.0.gemfile

@@ -1,19 +1,22 @@
 # This file was generated by Appraisal
 
-source "http://rubygems.org"
+source "https://rubygems.org"
 
 gem "appraisal", "~> 2.0.0"
 gem "rspec-its", :require => false
 gem "rspec-wait", :require => false
 gem "sidekiq", "~> 4.0.0"
 
-platforms :mri_23 do
-  gem "fasterer", :require => false
+platforms :mri_24 do
   gem "benchmark-ips", :require => false
+  gem "codeclimate-test-reporter", :require => false
+  gem "fasterer", :require => false
+  gem "memory_profiler", :require => false
+  gem "mock_redis", :require => false
   gem "pry-byebug", :require => false
+  gem "rubocop", :require => false
   gem "simplecov-json", :require => false
-  gem "memory_profiler", :require => false
-  gem "codeclimate-test-reporter", :require => false
+  gem "travis", :require => false
 end
 
 gemspec :path => "../"

data/gemfiles/sidekiq_4.1.gemfile

@@ -1,19 +1,22 @@
 # This file was generated by Appraisal
 
-source "http://rubygems.org"
+source "https://rubygems.org"
 
 gem "appraisal", "~> 2.0.0"
 gem "rspec-its", :require => false
 gem "rspec-wait", :require => false
 gem "sidekiq", "~> 4.1.0"
 
-platforms :mri_23 do
-  gem "fasterer", :require => false
+platforms :mri_24 do
   gem "benchmark-ips", :require => false
+  gem "codeclimate-test-reporter", :require => false
+  gem "fasterer", :require => false
+  gem "memory_profiler", :require => false
+  gem "mock_redis", :require => false
   gem "pry-byebug", :require => false
+  gem "rubocop", :require => false
   gem "simplecov-json", :require => false
-  gem "memory_profiler", :require => false
-  gem "codeclimate-test-reporter", :require => false
+  gem "travis", :require => false
 end
 
 gemspec :path => "../"

data/gemfiles/{sidekiq_3.1.gemfile → sidekiq_4.2.gemfile}

@@ -1,19 +1,22 @@
 # This file was generated by Appraisal
 
-source "http://rubygems.org"
+source "https://rubygems.org"
 
 gem "appraisal", "~> 2.0.0"
 gem "rspec-its", :require => false
 gem "rspec-wait", :require => false
-gem "sidekiq", "~> 3.1.0"
+gem "sidekiq", "~> 4.2.0"
 
-platforms :mri_23 do
-  gem "fasterer", :require => false
+platforms :mri_24 do
   gem "benchmark-ips", :require => false
+  gem "codeclimate-test-reporter", :require => false
+  gem "fasterer", :require => false
+  gem "memory_profiler", :require => false
+  gem "mock_redis", :require => false
   gem "pry-byebug", :require => false
+  gem "rubocop", :require => false
   gem "simplecov-json", :require => false
-  gem "memory_profiler", :require => false
-  gem "codeclimate-test-reporter", :require => false
+  gem "travis", :require => false
 end
 
 gemspec :path => "../"

data/gemfiles/{sidekiq_3.2.gemfile → sidekiq_5.0.gemfile}

@@ -1,19 +1,22 @@
 # This file was generated by Appraisal
 
-source "http://rubygems.org"
+source "https://rubygems.org"
 
 gem "appraisal", "~> 2.0.0"
 gem "rspec-its", :require => false
 gem "rspec-wait", :require => false
-gem "sidekiq", "~> 3.2.0"
+gem "sidekiq", ">= 5.0.0.beta", "< 6"
 
-platforms :mri_23 do
-  gem "fasterer", :require => false
+platforms :mri_24 do
   gem "benchmark-ips", :require => false
+  gem "codeclimate-test-reporter", :require => false
+  gem "fasterer", :require => false
+  gem "memory_profiler", :require => false
+  gem "mock_redis", :require => false
   gem "pry-byebug", :require => false
+  gem "rubocop", :require => false
   gem "simplecov-json", :require => false
-  gem "memory_profiler", :require => false
-  gem "codeclimate-test-reporter", :require => false
+  gem "travis", :require => false
 end
 
 gemspec :path => "../"

data/gemfiles/sidekiq_develop.gemfile

@@ -1,19 +1,22 @@
 # This file was generated by Appraisal
 
-source "http://rubygems.org"
+source "https://rubygems.org"
 
 gem "appraisal", "~> 2.0.0"
 gem "rspec-its", :require => false
 gem "rspec-wait", :require => false
 gem "sidekiq", :github => "mperham/sidekiq"
 
-platforms :mri_23 do
-  gem "fasterer", :require => false
+platforms :mri_24 do
   gem "benchmark-ips", :require => false
+  gem "codeclimate-test-reporter", :require => false
+  gem "fasterer", :require => false
+  gem "memory_profiler", :require => false
+  gem "mock_redis", :require => false
   gem "pry-byebug", :require => false
+  gem "rubocop", :require => false
   gem "simplecov-json", :require => false
-  gem "memory_profiler", :require => false
-  gem "codeclimate-test-reporter", :require => false
+  gem "travis", :require => false
 end
 
 gemspec :path => "../"

data/lib/sidekiq-unique-jobs.rb

@@ -1,4 +1,4 @@
-require 'yaml' if RUBY_VERSION.include?('2.0.0') # rubocop:disable FileName
+require 'yaml' if RUBY_VERSION.include?('2.0.0')
 require 'forwardable'
 require 'sidekiq_unique_jobs/version'
 require 'sidekiq_unique_jobs/constants'

data/lib/sidekiq_unique_jobs/config.rb

@@ -1,19 +1,11 @@
 module SidekiqUniqueJobs
   class Config < OpenStruct
-    CONFIG_ACCESSORS = [
-      :unique_prefix,
-      :default_queue_lock_expiration,
-      :default_run_lock_expiration,
-      :default_lock,
-      :redis_mode
-    ].freeze
-
     def inline_testing_enabled?
       testing_enabled? && Sidekiq::Testing.inline?
     end
 
     def mocking?
-      inline_testing_enabled? && redis_test_mode.to_sym == :mock
+      redis_test_mode.to_sym == :mock
     end
 
     def testing_enabled?

data/lib/sidekiq_unique_jobs/constants.rb

@@ -5,6 +5,7 @@ module SidekiqUniqueJobs
   JID_KEY ||= 'jid'.freeze
   LOG_DUPLICATE_KEY ||= 'log_duplicate_payload'.freeze
   QUEUE_KEY ||= 'queue'.freeze
+  HASH_KEY ||= 'uniquejobs'.freeze
   QUEUE_LOCK_TIMEOUT_KEY ||= 'unique_expiration'.freeze
   RUN_LOCK_TIMEOUT_KEY ||= 'run_lock_expiration'.freeze
   TESTING_CONSTANT ||= 'Testing'.freeze

data/lib/sidekiq_unique_jobs/core_ext.rb

@@ -3,49 +3,59 @@ begin
   require 'active_support/core_ext/hash/deep_merge'
 rescue LoadError
   class Hash
-    def slice(*keys)
-      keys.map! { |key| convert_key(key) } if respond_to?(:convert_key, true)
-      keys.each_with_object(self.class.new) { |k, hash| hash[k] = self[k] if key?(k) }
-    end unless {}.respond_to?(:slice)
+    unless {}.respond_to?(:slice)
+      def slice(*keys)
+        keys.map! { |key| convert_key(key) } if respond_to?(:convert_key, true)
+        keys.each_with_object(self.class.new) { |k, hash| hash[k] = self[k] if key?(k) }
+      end
+    end
 
-    def slice!(*keys)
-      keys.map! { |key| convert_key(key) } if respond_to?(:convert_key, true)
-      omit = slice(*self.keys - keys)
-      hash = slice(*keys)
-      hash.default      = default
-      hash.default_proc = default_proc if default_proc
-      replace(hash)
-      omit
-    end unless {}.respond_to?(:slice!)
+    unless {}.respond_to?(:slice!)
+      def slice!(*keys)
+        keys.map! { |key| convert_key(key) } if respond_to?(:convert_key, true)
+        omit = slice(*self.keys - keys)
+        hash = slice(*keys)
+        hash.default      = default
+        hash.default_proc = default_proc if default_proc
+        replace(hash)
+        omit
+      end
+    end
   end
 end
 
 class Array
-  def extract_options!
-    if last.is_a?(Hash) && last.instance_of?(Hash)
-      pop
-    else
-      {}
+  unless [].respond_to?(:extract_options!)
+    def extract_options!
+      if last.is_a?(Hash) && last.instance_of?(Hash)
+        pop
+      else
+        {}
+      end
     end
-  end unless [].respond_to?(:extract_options!)
+  end
 end
 
 class String
-  def classify
-    camelize(sub(/.*\./, ''))
-  end unless ''.respond_to?(:classify)
+  unless ''.respond_to?(:classify)
+    def classify
+      camelize(sub(/.*\./, ''))
+    end
+  end
 
-  def camelize(uppercase_first_letter = true)
-    string = self
-    string = if uppercase_first_letter
-               string.sub(/^[a-z\d]*/) { $&.capitalize }
-             else
-               string.sub(/^(?:(?=\b|[A-Z_])|\w)/) { $&.downcase }
-             end
-    string.gsub!(%r{(?:_|(\/))([a-z\d]*)}i) do
-      "#{Regexp.last_match(1)}#{Regexp.last_match(2).capitalize}"
+  unless ''.respond_to?(:camelize)
+    def camelize(uppercase_first_letter = true)
+      string = self
+      string = if uppercase_first_letter
+                 string.sub(/^[a-z\d]*/) { $&.capitalize }
+               else
+                 string.sub(/^(?:(?=\b|[A-Z_])|\w)/) { $&.downcase }
+               end
+      string.gsub!(%r{(?:_|(\/))([a-z\d]*)}i) do
+        "#{Regexp.last_match(1)}#{Regexp.last_match(2).capitalize}"
+      end
+      string.gsub!(%r{/}, '::')
+      string
     end
-    string.gsub!(%r{/}, '::')
-    string
-  end unless ''.respond_to?(:camelize)
+  end
 end

data/lib/sidekiq_unique_jobs/lock/while_executing.rb

@@ -14,7 +14,7 @@ module SidekiqUniqueJobs
 
       def synchronize
         @mutex.lock
-        sleep 0.001 until locked?
+        sleep 0.1 until locked?
 
         yield
       rescue Sidekiq::Shutdown

data/lib/sidekiq_unique_jobs/script_mock.rb

@@ -21,12 +21,9 @@ module SidekiqUniqueJobs
 
         return stored_jid == job_id ? 1 : 0 if stored_jid
 
-        if redis.set(unique_key, job_id, nx: true, ex: expires)
-          redis.hsetnx('uniquejobs', job_id, unique_key)
-          return 1
-        else
-          return 0
-        end
+        return 0 unless redis.set(unique_key, job_id, nx: true, ex: expires)
+        redis.hsetnx(SidekiqUniqueJobs::HASH_KEY, job_id, unique_key)
+        return 1
       end
     end
 
@@ -40,6 +37,7 @@ module SidekiqUniqueJobs
         return 0 unless stored_jid == job_id || stored_jid == '2'
 
         redis.del(unique_key)
+        redis.hdel(SidekiqUniqueJobs::HASH_KEY, job_id)
         return 1
       end
     end
@@ -50,7 +48,6 @@ module SidekiqUniqueJobs
         time       = options[:argv][0].to_i
         expires    = options[:argv][1].to_f
 
-        stored_jid = redis.get(unique_key).to_i
         return 1 if redis.set(unique_key, time + expires, nx: true, ex: expires)
 
         stored_time = redis.get(unique_key)