sidekiq-lock 0.2.0 → 0.3.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: ae0d7372658be88512d4c4f9374796c5b5722b7d
+  data.tar.gz: a6882527481df8f118627157eab0204ef0f1a9a4
+SHA512:
+  metadata.gz: f56e2cbaecb3d42ad2dba3c3381f6c5ffb2b503697bfa64e49a52463dc6caa624b5581121c43b9e91f7de0efc3602174bff15dec67ba5647e1ba5e46609786f2
+  data.tar.gz: a652570e74c4101ae7d1f56bbaff11ee8bf6673955a8ff11340bc593e0f4b28d22eedee7554a4517830f5d351816ae1242c80b1ed9739ba73f2e985b7dd4849b

data/.travis.yml

@@ -4,10 +4,12 @@ services:
   - redis-server
 
 rvm:
-  - 1.9.3
-  - jruby-19mode
-  - rbx
   - 2.0.0
+  - 2.1.0
+  # seems like rack 2.0.1 needs it
+  - 2.2.2
+  - 2.3.0
+  - 2.3.1
 
 notifications:
   email: false

data/CHANGELOG.md

@@ -1,3 +1,15 @@
+## 0.3.0
+
+- ability to set custom lock value. Works just like setting timeout and name (handles procs as well).
+
+``` ruby
+sidekiq_options lock: {
+    timeout: timeout,
+    name:    name,
+    value:   custom_value
+  }
+```
+
 ## 0.2.0
 
 - ability to globally configure `lock` method name

data/README.md

@@ -58,7 +58,7 @@ So now in your worker class you can call (whenever you need):
 
 - `lock.acquire!` - will try to acquire the lock, if returns false on failure (that means some other process / thread took the lock first)
 - `lock.acquired?` - set to `true` when lock is successfully acquired
-- `lock.release!` - deletes the lock (if not already expired / taken by another process)
+- `lock.release!` - deletes the lock (only if it's: acquired by current thread and not already expired)
 
 ### Lock options
 
@@ -66,6 +66,7 @@ sidekiq_options lock will accept static values or `Proc` that will be called on
 
 - timeout - specified expire time, in milliseconds
 - name - name of the redis key that will be used as lock name
+- value - (optional) value of the lock, if not provided it's set to random hex
 
 Dynamic lock example:
 
@@ -75,7 +76,8 @@ class Worker
   include Sidekiq::Lock::Worker
   sidekiq_options lock: {
     timeout: proc { |user_id, timeout| timeout * 2 },
-    name:    proc { |user_id, timeout| "lock:peruser:#{user_id}" }
+    name:    proc { |user_id, timeout| "lock:peruser:#{user_id}" },
+    value:   proc { |user_id, timeout| "#{user_id}" }
   }
 
   def perform(user_id, timeout)
@@ -83,7 +85,15 @@ class Worker
     # do some work
     # only at this point I want to acquire the lock
     if lock.acquire!
-      # I can do the work
+      begin
+        # I can do the work
+        # ...
+      ensure
+        # You probably want to manually release lock after work is done
+        # This method can be safely called even if lock wasn't acquired
+        # by current worker (thread). For more references see RedisLock class
+        lock.release!
+      end
     else
       # reschedule, raise an error or do whatever you want
     end

data/lib/sidekiq/lock/redis_lock.rb

@@ -65,7 +65,12 @@ module Sidekiq
         end
 
         def value
-          @value ||= SecureRandom.hex(25)
+          @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

data/lib/sidekiq/lock/version.rb

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

data/sidekiq-lock.gemspec

@@ -25,4 +25,6 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency "rack-test"
   spec.add_development_dependency "coveralls", "~> 0.7.0"
   spec.add_development_dependency "mocha", "~> 0.14.0"
+  spec.add_development_dependency "minitest"
+  spec.add_development_dependency "redis-namespace"
 end

data/test/lib/redis_lock_test.rb

@@ -40,11 +40,15 @@ module Sidekiq
       it "can accept block as arguments" do
         lock = RedisLock.new({
             'timeout' => proc { |options| options['timeout'] * 2 },
-            'name'    => proc { |options| "#{options['test']}-sidekiq" }
+            'name'    => proc { |options| "#{options['test']}-sidekiq" },
+            'value'    => proc { |options| "#{options['test']}-sidekiq" }
           }, ['timeout' => 500, 'test' => 'hello'])
 
         assert_equal 1000, lock.timeout
         assert_equal 'hello-sidekiq', lock.name
+        lock.acquire!
+        assert_equal 'hello-sidekiq', redis("get", lock.name)
+        lock.release!
       end
 
       it "can acquire a lock" do
@@ -84,6 +88,16 @@ module Sidekiq
 
         assert_equal new_lock_value, redis("get", "test-lock")
       end
+
+      it "releases taken lock" do
+        custom_args = [args.first.merge('value' => 'custom_value'), []]
+        lock = RedisLock.new(*custom_args)
+        lock.acquire!
+        assert redis("get", "test-lock")
+
+        lock.release!
+        assert_nil redis("get", "test-lock")
+      end
     end
   end
 end

data/test/test_helper.rb

@@ -1,5 +1,7 @@
 require 'coveralls'
-Coveralls.wear!
+Coveralls.wear! do
+  add_filter "/test/"
+end
 
 Encoding.default_external = Encoding::UTF_8
 Encoding.default_internal = Encoding::UTF_8

metadata

@@ -1,128 +1,141 @@
 --- !ruby/object:Gem::Specification
 name: sidekiq-lock
 version: !ruby/object:Gem::Version
-  version: 0.2.0
-  prerelease: 
+  version: 0.3.0
 platform: ruby
 authors:
 - Rafal Wojsznis
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-12-08 00:00:00.000000000 Z
+date: 2016-07-28 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: sidekiq
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: 2.14.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: 2.14.0
 - !ruby/object:Gem::Dependency
   name: redis
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: 3.0.5
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: 3.0.5
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '1.3'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '1.3'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
   name: rack-test
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
   name: coveralls
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: 0.7.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: 0.7.0
 - !ruby/object:Gem::Dependency
   name: mocha
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: 0.14.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: 0.14.0
+- !ruby/object:Gem::Dependency
+  name: minitest
+  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: redis-namespace
+  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: Simple redis-based lock mechanism for your sidekiq workers
 email:
 - rafal.wojsznis@gmail.com
@@ -130,8 +143,8 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- .gitignore
-- .travis.yml
+- ".gitignore"
+- ".travis.yml"
 - CHANGELOG.md
 - Gemfile
 - LICENSE.txt
@@ -154,33 +167,26 @@ files:
 homepage: https://github.com/emq/sidekiq-lock
 licenses:
 - MIT
+metadata: {}
 post_install_message: 
 rdoc_options: []
 require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
-  none: false
   requirements:
-  - - ! '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: '0'
-      segments:
-      - 0
-      hash: -2239756141932312381
 required_rubygems_version: !ruby/object:Gem::Requirement
-  none: false
   requirements:
-  - - ! '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: '0'
-      segments:
-      - 0
-      hash: -2239756141932312381
 requirements: []
 rubyforge_project: 
-rubygems_version: 1.8.25
+rubygems_version: 2.5.1
 signing_key: 
-specification_version: 3
+specification_version: 4
 summary: Simple redis-based lock mechanism for your sidekiq workers
 test_files:
 - test/lib/middleware_test.rb