sidekiq-lock 0.3.0 → 0.3.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: ae0d7372658be88512d4c4f9374796c5b5722b7d
-  data.tar.gz: a6882527481df8f118627157eab0204ef0f1a9a4
+SHA256:
+  metadata.gz: 70c2ca23e60ff013252e111d7507b3665deaaadd31d23a6dc10e972315be335f
+  data.tar.gz: 67cdd99cb1e60accad3304bc13f295051b54d09553ab278503d98240bf149d21
 SHA512:
-  metadata.gz: f56e2cbaecb3d42ad2dba3c3381f6c5ffb2b503697bfa64e49a52463dc6caa624b5581121c43b9e91f7de0efc3602174bff15dec67ba5647e1ba5e46609786f2
-  data.tar.gz: a652570e74c4101ae7d1f56bbaff11ee8bf6673955a8ff11340bc593e0f4b28d22eedee7554a4517830f5d351816ae1242c80b1ed9739ba73f2e985b7dd4849b
+  metadata.gz: 3595ae9803227cbb2051908bd7ecbbbbec409a57e5f41dbae552b838f5d71decf35dab1ade805ff851c806f7aa69896b0485018401fa41f5454e2638067133ca
+  data.tar.gz: ea73c729c4da75a0a6c47c652376e96f5574ba2f2f93b09ecc6f12564d2d605d00e625247643cbb17462a3a0dca3049a5ed696882f53fe26ff59dda84be3f0a1

data/.gitignore

@@ -18,3 +18,4 @@ tmp
 .rvmrc
 .ruby-version
 .ruby-gemset
+*.gemfile.lock

data/.travis.yml

@@ -1,15 +1,20 @@
 language: ruby
+cache: bundler
 
 services:
   - redis-server
 
+gemfile:
+  - gemfiles/sidekiq_2.gemfile
+  - gemfiles/sidekiq_3.gemfile
+  - gemfiles/sidekiq_4.gemfile
+  - gemfiles/sidekiq_5.gemfile
+
 rvm:
-  - 2.0.0
-  - 2.1.0
-  # seems like rack 2.0.1 needs it
-  - 2.2.2
-  - 2.3.0
-  - 2.3.1
+  - 2.2.9
+  - 2.3.6
+  - 2.4.3
+  - 2.5.0
 
 notifications:
   email: false

data/Appraisals

@@ -0,0 +1,15 @@
+appraise 'sidekiq-2' do
+  gem 'sidekiq', '~> 2.17', '>= 2.17.8'
+end
+
+appraise 'sidekiq-3' do
+  gem 'sidekiq', '~> 3.5', '>= 3.5.4'
+end
+
+appraise 'sidekiq-4' do
+  gem 'sidekiq', '~> 4.2', '>= 4.2.10'
+end
+
+appraise 'sidekiq-5' do
+  gem 'sidekiq', '~> 5.1', '>= 5.1'
+end

data/CHANGELOG.md

@@ -1,4 +1,10 @@
-## 0.3.0
+## 0.3.1 (March 3, 2018)
+
+- do not assume `ActiveSupport` is loaded / or old `Sidekiq` patches are present (add own symbolize keys logic)
+- make `options` and `payload` attr readers as `private` in `RedisLock` as it should be - **potentially breaking change** if you were accessing those (abusing) somehow for whatever reason (that shouldn't happen in the first place!)
+- run test on travis for sidekiq `2.17`, `3.5`, `4.2` and `>= 5.1` and all newest rubies (`2.2` - `2.5`)
+
+## 0.3.0 (July 28, 2016)
 
 - ability to set custom lock value. Works just like setting timeout and name (handles procs as well).
 
@@ -10,7 +16,7 @@ sidekiq_options lock: {
   }
 ```
 
-## 0.2.0
+## 0.2.0 (December 08, 2013)
 
 - ability to globally configure `lock` method name
 
@@ -30,6 +36,6 @@ end
   That will setup `RedisLock` under proper thread variable.
   This can be handy if you test your workers inline (without full stack middleware)
 
-## 0.0.1
+## 0.0.1 (October 14, 2013)
 
 - Initial release

data/Gemfile

@@ -1,8 +1,2 @@
 source "https://rubygems.org"
 gemspec
-
-platforms :rbx do
-  gem "rubysl", "~> 2.0"                     # if using anything in the ruby standard library
-  gem "rubinius-developer_tools", "~> 2.0.0" # if using any of coverage, debugger, profiler
-  gem "minitest"                             # if using minitest
-end

data/README.md

@@ -6,6 +6,8 @@
 [![Dependency Status](https://gemnasium.com/emq/sidekiq-lock.png)](https://gemnasium.com/emq/sidekiq-lock)
 [![Gem Version](https://badge.fury.io/rb/sidekiq-lock.png)](http://badge.fury.io/rb/sidekiq-lock)
 
+**Note:** This is a _complete_ piece of software, it should work across all future sidekiq & ruby versions.
+
 Redis-based simple locking mechanism for [sidekiq][2]. Uses [SET command][1] introduced in Redis 2.6.16.
 
 It can be handy if you push a lot of jobs into the queue(s), but you don't want to execute specific jobs at the same time - it provides a `lock` method that you can use in whatever way you want.

data/gemfiles/sidekiq_2.gemfile

@@ -0,0 +1,7 @@
+# This file was generated by Appraisal
+
+source "https://rubygems.org"
+
+gem "sidekiq", "~> 2.17", ">= 2.17.8"
+
+gemspec path: "../"

data/gemfiles/sidekiq_3.gemfile

@@ -0,0 +1,7 @@
+# This file was generated by Appraisal
+
+source "https://rubygems.org"
+
+gem "sidekiq", "~> 3.5", ">= 3.5.4"
+
+gemspec path: "../"

data/gemfiles/sidekiq_4.gemfile

@@ -0,0 +1,7 @@
+# This file was generated by Appraisal
+
+source "https://rubygems.org"
+
+gem "sidekiq", "~> 4.2", ">= 4.2.10"
+
+gemspec path: "../"

data/gemfiles/sidekiq_5.gemfile

@@ -0,0 +1,7 @@
+# This file was generated by Appraisal
+
+source "https://rubygems.org"
+
+gem "sidekiq", "~> 5.1", ">= 5.1"
+
+gemspec path: "../"

data/lib/sidekiq/lock.rb

@@ -1,12 +1,11 @@
-require "sidekiq/lock/middleware"
-require "sidekiq/lock/redis_lock"
-require "sidekiq/lock/version"
-require "sidekiq/lock/worker"
+require 'sidekiq/lock/middleware'
+require 'sidekiq/lock/redis_lock'
+require 'sidekiq/lock/version'
+require 'sidekiq/lock/worker'
 
 module Sidekiq
-
   def self.lock_method
-    @lock_method || :lock
+    @lock_method ||= :lock
   end
 
   def self.lock_method=(method)
@@ -23,4 +22,3 @@ Sidekiq.configure_server do |config|
     chain.add Sidekiq::Lock::Middleware
   end
 end
-

data/lib/sidekiq/lock/middleware.rb

@@ -1,7 +1,6 @@
 module Sidekiq
   module Lock
     class Middleware
-
       def call(worker, msg, queue)
         options = lock_options(worker)
         setup_lock(options, msg['args']) unless options.nil?
@@ -11,14 +10,13 @@ module Sidekiq
 
       private
 
-        def setup_lock(options, payload)
-          Thread.current[Sidekiq::Lock::THREAD_KEY] = RedisLock.new(options, payload)
-        end
-
-        def lock_options(worker)
-          worker.class.get_sidekiq_options['lock']
-        end
+      def setup_lock(options, payload)
+        Thread.current[Sidekiq::Lock::THREAD_KEY] = RedisLock.new(options, payload)
+      end
 
+      def lock_options(worker)
+        worker.class.get_sidekiq_options['lock']
+      end
     end
   end
 end

data/lib/sidekiq/lock/redis_lock.rb

@@ -1,16 +1,18 @@
 module Sidekiq
   module Lock
     class RedisLock
-      attr_reader :options, :payload
-
       # checks for configuration
-      def initialize(options, payload)
-        @options  = options.symbolize_keys
+      def initialize(options_hash, payload)
+        @options = {}
+
+        options_hash.each_key do |key|
+          @options[key.to_sym] = options_hash[key]
+        end
+
         @payload  = payload
         @acquired = false
 
-        timeout
-        name
+        timeout && name
       end
 
       def acquired?
@@ -36,42 +38,44 @@ module Sidekiq
       end
 
       def name
-        raise ArgumentError, "Provide a lock name inside sidekiq_options" if options[:name].nil?
+        raise ArgumentError, 'Provide a lock name inside sidekiq_options' if options[:name].nil?
 
         @name ||= (options[:name].respond_to?(:call) ? options[:name].call(*payload) : options[:name])
       end
 
       def timeout
-        raise ArgumentError, "Provide lock timeout inside sidekiq_options" if options[:timeout].nil?
+        raise ArgumentError, 'Provide lock timeout inside sidekiq_options' if options[:timeout].nil?
 
         @timeout ||= (options[:timeout].respond_to?(:call) ? options[:timeout].call(*payload) : options[:timeout]).to_i
       end
 
       private
 
-        def redis_lock_script_sha
-          @lock_script_sha ||= Digest::SHA1.hexdigest redis_lock_script
-        end
+      attr_reader :options, :payload
 
-        def redis_lock_script
-          <<-LUA
-          if redis.call("get", KEYS[1]) == ARGV[1]
-          then
-            return redis.call("del",KEYS[1])
-          else
-            return 0
-          end
-          LUA
-        end
+      def redis_lock_script_sha
+        @lock_script_sha ||= Digest::SHA1.hexdigest redis_lock_script
+      end
 
-        def value
-          @value ||= set_lock_value(options[:value])
+      def redis_lock_script
+        <<-LUA
+        if redis.call("get", KEYS[1]) == ARGV[1]
+        then
+          return redis.call("del",KEYS[1])
+        else
+          return 0
         end
+        LUA
+      end
 
-        def set_lock_value(custom_value)
-          return SecureRandom.hex(25) unless custom_value
-          custom_value.respond_to?(:call) ? custom_value.call(*payload) : custom_value
-        end
+      def value
+        @value ||= set_lock_value(options[:value])
+      end
+
+      def set_lock_value(custom_value)
+        return SecureRandom.hex(25) unless custom_value
+        custom_value.respond_to?(:call) ? custom_value.call(*payload) : custom_value
+      end
     end
   end
 end

data/lib/sidekiq/lock/version.rb

@@ -1,5 +1,5 @@
 module Sidekiq
   module Lock
-    VERSION = "0.3.0"
+    VERSION = '0.3.1'
   end
 end

data/lib/sidekiq/lock/worker.rb

@@ -1,13 +1,11 @@
 module Sidekiq
   module Lock
     module Worker
-
       def self.included(base)
         base.send(:define_method, Sidekiq.lock_method) do
           Thread.current[Sidekiq::Lock::THREAD_KEY]
         end
       end
-
     end
   end
 end

data/sidekiq-lock.gemspec

@@ -20,11 +20,11 @@ Gem::Specification.new do |spec|
   spec.add_dependency "sidekiq", ">= 2.14.0"
   spec.add_dependency "redis",   ">= 3.0.5"
 
-  spec.add_development_dependency "bundler", "~> 1.3"
+  spec.add_development_dependency "bundler"
   spec.add_development_dependency "rake"
   spec.add_development_dependency "rack-test"
-  spec.add_development_dependency "coveralls", "~> 0.7.0"
+  spec.add_development_dependency "coveralls", "~> 0.8"
   spec.add_development_dependency "mocha", "~> 0.14.0"
   spec.add_development_dependency "minitest"
-  spec.add_development_dependency "redis-namespace"
+  spec.add_development_dependency "appraisal"
 end

data/test/lib/lock_test.rb

@@ -0,0 +1,29 @@
+require 'test_helper'
+require 'open3'
+
+module Sidekiq
+  describe Lock do
+    it 'automatically loads lock middleware for sidekiq server' do
+      skip 'Sidekiq 2 does not print out middleware information' if Sidekiq::VERSION < '3.0.0'
+
+      cmd = 'sidekiq -r ./test/test_workers.rb -v'
+      buffer = ''
+
+      # very not fancy (https://78.media.tumblr.com/tumblr_lzkpw7DAl21qhy6c9o2_400.gif)
+      # solution, but should do the job
+      Open3.popen3(cmd) do |stdin, stdout, stderr, thread|
+        begin
+          Timeout.timeout(5) do
+            until stdout.eof? do
+              buffer << stdout.read_nonblock(16)
+            end
+          end
+        rescue Timeout::Error
+          Process.kill('KILL', thread.pid)
+        end
+      end
+
+      assert_match(/\s?Middleware:.*Sidekiq::Lock::Middleware/i, buffer)
+    end
+  end
+end

data/test/lib/middleware_test.rb

@@ -1,9 +1,8 @@
-require "test_helper"
+require 'test_helper'
 
 module Sidekiq
   module Lock
     describe Middleware do
-
       before do
         Sidekiq.redis = REDIS
         Sidekiq.redis { |c| c.flushdb }

data/test/lib/redis_lock_test.rb

@@ -1,4 +1,4 @@
-require "test_helper"
+require 'test_helper'
 
 module Sidekiq
   module Lock

data/test/lib/testing/inline_test.rb

@@ -2,7 +2,6 @@ require "test_helper"
 require "sidekiq/lock/testing/inline"
 
 describe "inline test helper" do
-
   after { set_lock_variable! }
 
   it "has helper fuction for setting lock" do

data/test/lib/worker_test.rb

@@ -1,9 +1,8 @@
-require "test_helper"
+require 'test_helper'
 
 module Sidekiq
   module Lock
     describe Worker do
-
       after { set_lock_variable! }
 
       it 'sets lock method that points to thread variable' do

data/test/test_helper.rb

@@ -1,22 +1,18 @@
 require 'coveralls'
 Coveralls.wear! do
-  add_filter "/test/"
+  add_filter '/test/'
 end
 
-Encoding.default_external = Encoding::UTF_8
-Encoding.default_internal = Encoding::UTF_8
+require 'minitest/autorun'
+require 'minitest/pride'
+require 'mocha/setup'
 
-require "minitest/autorun"
-require "minitest/pride"
-require "mocha/setup"
-
-require "sidekiq"
-require "sidekiq-lock"
-require "test_workers"
+require 'sidekiq'
+require 'test_workers'
 
 Sidekiq.logger.level = Logger::ERROR
 
-REDIS = Sidekiq::RedisConnection.create(url: "redis://localhost/15", namespace: "sidekiq_lock_test")
+REDIS = Sidekiq::RedisConnection.create(url: 'redis://localhost/15')
 
 def redis(command, *args)
   Sidekiq.redis do |c|

data/test/test_workers.rb

@@ -1,3 +1,5 @@
+require 'sidekiq-lock'
+
 class LockWorker
   include Sidekiq::Worker
   include Sidekiq::Lock::Worker

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: sidekiq-lock
 version: !ruby/object:Gem::Version
-  version: 0.3.0
+  version: 0.3.1
 platform: ruby
 authors:
 - Rafal Wojsznis
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-07-28 00:00:00.000000000 Z
+date: 2018-03-03 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: sidekiq
@@ -42,16 +42,16 @@ dependencies:
   name: bundler
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '1.3'
+        version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '1.3'
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
@@ -86,14 +86,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.7.0
+        version: '0.8'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.7.0
+        version: '0.8'
 - !ruby/object:Gem::Dependency
   name: mocha
   requirement: !ruby/object:Gem::Requirement
@@ -123,7 +123,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: redis-namespace
+  name: appraisal
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -145,11 +145,16 @@ extra_rdoc_files: []
 files:
 - ".gitignore"
 - ".travis.yml"
+- Appraisals
 - CHANGELOG.md
 - Gemfile
 - LICENSE.txt
 - README.md
 - Rakefile
+- gemfiles/sidekiq_2.gemfile
+- gemfiles/sidekiq_3.gemfile
+- gemfiles/sidekiq_4.gemfile
+- gemfiles/sidekiq_5.gemfile
 - lib/sidekiq-lock.rb
 - lib/sidekiq/lock.rb
 - lib/sidekiq/lock/middleware.rb
@@ -158,6 +163,7 @@ files:
 - lib/sidekiq/lock/version.rb
 - lib/sidekiq/lock/worker.rb
 - sidekiq-lock.gemspec
+- test/lib/lock_test.rb
 - test/lib/middleware_test.rb
 - test/lib/redis_lock_test.rb
 - test/lib/testing/inline_test.rb
@@ -184,11 +190,12 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.5.1
+rubygems_version: 2.7.6
 signing_key: 
 specification_version: 4
 summary: Simple redis-based lock mechanism for your sidekiq workers
 test_files:
+- test/lib/lock_test.rb
 - test/lib/middleware_test.rb
 - test/lib/redis_lock_test.rb
 - test/lib/testing/inline_test.rb