redlock 0.1.7 → 0.1.8

checksums.yaml

@@ -1,7 +1,15 @@
 ---
-SHA1:
-  metadata.gz: 86073e680a1deb905852ddfcd28042cf81729875
-  data.tar.gz: 76cffc3d01b4fa649ad4ae4276149453282c0ed4
+!binary "U0hBMQ==":
+  metadata.gz: !binary |-
+    NzQwMDRhZWQ2ZjUyM2FjMTgxMzJiY2Q1ZmY5YzI3ODk1ZWY4NTNmMA==
+  data.tar.gz: !binary |-
+    ZDliZjZlMmM3OGNmZGMyYzhlNWI3YjBlMmUyNGRmNGY0Yjk0N2FkYw==
 SHA512:
-  metadata.gz: 8b0687bd912eff82bb3f4607de313d681d1e18971cbd3b6b484bae0fabae38b258ef423f0c00256b45e633fbc83abea9b38c57fbf08ce4d6567a2c254701eeb7
-  data.tar.gz: 86dc485ebc704b9d46bd6878d18f9b7403c13840721a2475b4b61b5c7b4099a40db3375045df8c8be7e9270d52f9560854b489a3656805046d995e253b1d126b
+  metadata.gz: !binary |-
+    ZTZjYWUyNmI2NTliZjliODZkM2ZhYzczZDAyM2RlM2FiY2Y5MTkxMDk4YjVk
+    YzVhMGJjMjBiMTM4NDYzY2ZkNWNiYzRmODk5YWFlZTJlMzczMTZlMzI4ZmRh
+    YTNkZDNhNjgxNzcxOTlhNGE2YTdjNzgyZTgwNTY0YWY4OTUwMjc=
+  data.tar.gz: !binary |-
+    NDllNDgxMmQ0ODk1NTdlNTNkMjczN2EyYjQyMjE2MWU5YmJmMDVlMmJkY2Q1
+    YTZjNTE5NjFjNTI3Mjc3NzJiZDBlMDIwYzUwM2NlMGM1YjE0NDVkNDIzODFm
+    MjVhNjU3OTI4NzY0YzY3OTE1ZDhiNGRhNmRlMzM5OGE3YjczMTI=

data/.gitignore

@@ -1,2 +1,3 @@
 *.gem
 coverage/
+.bundle/

data/Gemfile.lock

@@ -1,8 +1,8 @@
 PATH
   remote: .
   specs:
-    redlock (0.1.7)
-      redis (~> 3, >= 3.3.0)
+    redlock (0.1.8)
+      redis (~> 3, >= 3.0.0)
 
 GEM
   remote: https://rubygems.org/
@@ -45,11 +45,7 @@ PLATFORMS
   ruby
 
 DEPENDENCIES
-  bundler (~> 1.12, >= 1.12.3)
   coveralls (~> 0.8.13)
   rake (~> 11.1, >= 11.1.2)
   redlock!
-  rspec (~> 3.4, >= 3.4.0)
-
-BUNDLED WITH
-   1.12.3
+  rspec (~> 3, >= 3.0.0)

data/README.md

@@ -95,21 +95,34 @@ rescue Redlock::LockError
 end
 ```
 
-To extend the life of the lock, provided that you didn't let it expire:
+To extend the life of the lock:
 
 ```ruby
 begin
   block_result = lock_manager.lock!("resource_key", 2000) do |lock_info|
     # critical code
-    lock_manager.extend_life!(lock_info, 3000)
+    lock_manager.lock("resource key", 3000, extend: lock_info)
     # more critical code
   end
 rescue Redlock::LockError
   # error handling
 end
 ```
-There's also a non-bang version that returns true when the lock was
-extended
+
+The above code will also acquire the lock if the previous lock has expired and the lock is currently free. Keep in mind that this means the lock could have been acquired by someone else in the meantime. To only extend the life of the lock if currently locked by yourself, use `extend_life` parameter:
+
+```ruby
+begin
+  block_result = lock_manager.lock!("resource_key", 2000) do |lock_info|
+    # critical code
+    lock_manager.lock("resource key", 3000, extend: lock_info, extend_life: true)
+    # more critical code, only if lock was still hold
+  end
+rescue Redlock::LockError
+  # error handling
+end
+```
+
 
 ## Run tests
 

data/lib/redlock/client.rb

@@ -37,8 +37,8 @@ module Redlock
     # +extend+: A lock ("lock_info") to extend.
     # +block+:: an optional block to be executed; after its execution, the lock (if successfully
     # acquired) is automatically unlocked.
-    def lock(resource, ttl, extend: nil, &block)
-      lock_info = try_lock_instances(resource, ttl, extend)
+    def lock(resource, ttl, options = {}, &block)
+      lock_info = try_lock_instances(resource, ttl, options)
 
       if block_given?
         begin
@@ -52,30 +52,6 @@ module Redlock
       end
     end
 
-    def extend_life(to_extend, ttl)
-      value = to_extend.fetch(:value)
-      resource = to_extend.fetch(:resource)
-
-
-      extended, time_elapsed = timed do
-        @servers.all? { |s| s.extend_life(resource, value, ttl) }
-      end
-
-      validity = ttl - time_elapsed - drift(ttl)
-
-      if extended
-        { validity: validity, resource: resource, value: value }
-      else
-        @servers.each { |s| s.unlock(resource, value) }
-        false
-      end
-    end
-
-    def extend_life!(to_extend, ttl)
-      new_lock_info = self.extend_life(to_extend, ttl)
-      raise LockError, 'failed to extend lock' unless new_lock_info
-    end
-
     # Unlocks a resource.
     # Params:
     # +lock_info+:: the lock that has been acquired when you locked the resource.
@@ -86,10 +62,10 @@ module Redlock
     # Locks a resource, executing the received block only after successfully acquiring the lock,
     # and returning its return value as a result.
     # See Redlock::Client#lock for parameters.
-    def lock!(*args, **keyword_args)
+    def lock!(*args)
       fail 'No block passed' unless block_given?
 
-      lock(*args, **keyword_args) do |lock_info|
+      lock(*args) do |lock_info|
         raise LockError, 'failed to acquire lock' unless lock_info
         return yield
       end
@@ -115,7 +91,7 @@ module Redlock
         end
       eos
 
-      EXTEND_LOCK_SCRIPT = <<-eos
+      EXTEND_LIFE_SCRIPT = <<-eos
         if redis.call("get", KEYS[1]) == ARGV[1] then
           redis.call("expire", KEYS[1], ARGV[2])
           return 0
@@ -124,7 +100,6 @@ module Redlock
         end
       eos
 
-
       def initialize(connection)
         if connection.respond_to?(:client)
           @redis = connection
@@ -141,9 +116,9 @@ module Redlock
         end
       end
 
-      def extend_life(resource, val, ttl)
+      def extend(resource, val, ttl)
         recover_from_script_flush do
-          rc = @redis.evalsha @extend_lock_script_sha, keys: [resource], argv: [val, ttl]
+          rc = @redis.evalsha @extend_life_script_sha, keys: [resource], argv: [val, ttl]
           rc == 0
         end
       end
@@ -161,7 +136,7 @@ module Redlock
       def load_scripts
         @unlock_script_sha = @redis.script(:load, UNLOCK_SCRIPT)
         @lock_script_sha = @redis.script(:load, LOCK_SCRIPT)
-        @extend_lock_script_sha = @redis.script(:load, EXTEND_LOCK_SCRIPT)
+        @extend_life_script_sha = @redis.script(:load, EXTEND_LIFE_SCRIPT)
       end
 
       def recover_from_script_flush
@@ -183,9 +158,11 @@ module Redlock
       end
     end
 
-    def try_lock_instances(resource, ttl, extend)
-      @retry_count.times do
-        lock_info = lock_instances(resource, ttl, extend)
+    def try_lock_instances(resource, ttl, options)
+      tries = options[:extend] ? 1 : @retry_count
+
+      tries.times do
+        lock_info = lock_instances(resource, ttl, options)
         return lock_info if lock_info
 
         # Wait a random delay before retrying
@@ -195,11 +172,12 @@ module Redlock
       false
     end
 
-    def lock_instances(resource, ttl, extend)
-      value = extend ? extend.fetch(:value) : SecureRandom.uuid
+    def lock_instances(resource, ttl, options)
+      value  = options[:extend] ? options[:extend].fetch(:value) : SecureRandom.uuid
+      method = options[:extend_life] ? :extend : :lock
 
       locked, time_elapsed = timed do
-        @servers.select { |s| s.lock(resource, value, ttl) }.size
+        @servers.select { |s| s.send(method, resource, value, ttl) }.size
       end
 
       validity = ttl - time_elapsed - drift(ttl)

data/lib/redlock/testing.rb

@@ -4,17 +4,17 @@ module Redlock
 
     alias_method :try_lock_instances_without_testing, :try_lock_instances
 
-    def try_lock_instances(resource, ttl, extend)
+    def try_lock_instances(resource, ttl, options)
       if @testing_mode == :bypass
         {
           validity: ttl,
           resource: resource,
-          value: extend ? extend.fetch(:value) : SecureRandom.uuid
+          value: options[:extend] ? options[:extend].fetch(:value) : SecureRandom.uuid
         }
       elsif @testing_mode == :fail
         false
       else
-        try_lock_instances_without_testing resource, ttl, extend
+        try_lock_instances_without_testing resource, ttl, options
       end
     end
 

data/lib/redlock/version.rb

@@ -1,3 +1,3 @@
 module Redlock
-  VERSION = '0.1.7'
+  VERSION = '0.1.8'
 end

data/redlock.gemspec

@@ -18,10 +18,9 @@ Gem::Specification.new do |spec|
   spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
   spec.require_paths = ["lib"]
 
-  spec.add_dependency 'redis', '~> 3', '>= 3.3.0'
+  spec.add_dependency 'redis', '~> 3', '>= 3.0.0'
 
-  spec.add_development_dependency 'bundler', '~> 1.12', '>= 1.12.3'
   spec.add_development_dependency "coveralls", "~> 0.8.13"
   spec.add_development_dependency 'rake', '~> 11.1', '>= 11.1.2'
-  spec.add_development_dependency 'rspec', '~> 3.4', '>= 3.4.0'
+  spec.add_development_dependency 'rspec', '~> 3', '>= 3.0.0'
 end

data/spec/client_spec.rb

@@ -43,10 +43,19 @@ RSpec.describe Redlock::Client do
         expect(@lock_info[:value]).to eq(my_lock_info[:value])
       end
 
-      it "sets the given value when trying to extend a non-existent lock" do
-        @lock_info = lock_manager.lock(resource_key, ttl, extend: {value: 'hello world'})
-        expect(@lock_info).to be_lock_info_for(resource_key)
-        expect(@lock_info[:value]).to eq('hello world') # really we should test what's in redis
+      context 'when extend_life flag is given' do
+        it 'does not extend a non-existent lock' do
+          @lock_info = lock_manager.lock(resource_key, ttl, extend: {value: 'hello world'}, extend_life: true)
+          expect(@lock_info).to eq(false)
+        end
+      end
+
+      context 'when extend_life flag is not given' do
+        it "sets the given value when trying to extend a non-existent lock" do
+          @lock_info = lock_manager.lock(resource_key, ttl, extend: {value: 'hello world'}, extend_life: false)
+          expect(@lock_info).to be_lock_info_for(resource_key)
+          expect(@lock_info[:value]).to eq('hello world') # really we should test what's in redis
+        end
       end
 
       it "doesn't extend somebody else's lock" do
@@ -170,40 +179,6 @@ RSpec.describe Redlock::Client do
     end
   end
 
-  describe "extend" do
-    context 'when lock is available' do
-      before { @lock_info = lock_manager.lock(resource_key, ttl) }
-      after(:each) { lock_manager.unlock(@lock_info) if @lock_info }
-
-      it 'can extend its own lock' do
-        lock_info = lock_manager.extend_life(@lock_info, ttl)
-        expect(lock_info).to be_lock_info_for(resource_key)
-      end
-
-      it "can't extend a nonexistent lock" do
-        lock_manager.unlock(@lock_info)
-        lock_info = lock_manager.extend_life(@lock_info, ttl)
-        expect(lock_info).to eq(false)
-      end
-    end
-  end
-
-  describe "extend!" do
-    context 'when lock is available' do
-      before { @lock_info = lock_manager.lock(resource_key, ttl) }
-      after(:each) { lock_manager.unlock(@lock_info) if @lock_info }
-
-      it 'can extend its own lock' do
-        expect{ lock_manager.extend_life!(@lock_info, ttl) }.to_not raise_error
-      end
-
-      it "can't extend a nonexistent lock" do
-        lock_manager.unlock(@lock_info)
-        expect{ lock_manager.extend_life!(@lock_info, ttl) }.to raise_error(Redlock::LockError)
-      end
-    end
-  end
-
   describe 'lock!' do
     context 'when lock is available' do
       it 'locks' do
@@ -226,6 +201,11 @@ RSpec.describe Redlock::Client do
         lock_manager.lock!(resource_key, ttl) { fail } rescue nil
         expect(resource_key).to be_lockable(lock_manager, ttl)
       end
+
+      it 'passes the extension parameter' do
+        my_lock_info = lock_manager.lock(resource_key, ttl)
+        expect{ lock_manager.lock!(resource_key, ttl, extend: my_lock_info){} }.to_not raise_error
+      end
     end
 
     context 'when lock is not available' do

data/spec/spec_helper.rb

@@ -3,7 +3,7 @@ require 'coveralls'
 Coveralls.wear!
 require 'redlock'
 
-LOCK_INFO_KEYS = %i{validity resource value}
+LOCK_INFO_KEYS = [:validity, :resource, :value]
 
 RSpec::Matchers.define :be_lock_info_for do |resource|
   def correct_type?(actual)

metadata

@@ -1,109 +1,89 @@
 --- !ruby/object:Gem::Specification
 name: redlock
 version: !ruby/object:Gem::Version
-  version: 0.1.7
+  version: 0.1.8
 platform: ruby
 authors:
 - Leandro Moreira
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-05-20 00:00:00.000000000 Z
+date: 2016-05-24 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: redis
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ~>
       - !ruby/object:Gem::Version
         version: '3'
-    - - ">="
+    - - ! '>='
       - !ruby/object:Gem::Version
-        version: 3.3.0
+        version: 3.0.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ~>
       - !ruby/object:Gem::Version
         version: '3'
-    - - ">="
+    - - ! '>='
       - !ruby/object:Gem::Version
-        version: 3.3.0
-- !ruby/object:Gem::Dependency
-  name: bundler
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '1.12'
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: 1.12.3
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '1.12'
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: 1.12.3
+        version: 3.0.0
 - !ruby/object:Gem::Dependency
   name: coveralls
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ~>
       - !ruby/object:Gem::Version
         version: 0.8.13
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ~>
       - !ruby/object:Gem::Version
         version: 0.8.13
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ~>
       - !ruby/object:Gem::Version
         version: '11.1'
-    - - ">="
+    - - ! '>='
       - !ruby/object:Gem::Version
         version: 11.1.2
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ~>
       - !ruby/object:Gem::Version
         version: '11.1'
-    - - ">="
+    - - ! '>='
       - !ruby/object:Gem::Version
         version: 11.1.2
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ~>
       - !ruby/object:Gem::Version
-        version: '3.4'
-    - - ">="
+        version: '3'
+    - - ! '>='
       - !ruby/object:Gem::Version
-        version: 3.4.0
+        version: 3.0.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ~>
       - !ruby/object:Gem::Version
-        version: '3.4'
-    - - ">="
+        version: '3'
+    - - ! '>='
       - !ruby/object:Gem::Version
-        version: 3.4.0
+        version: 3.0.0
 description: Distributed lock using Redis written in Ruby. Highly inspired by https://github.com/antirez/redlock-rb.
 email:
 - leandro.ribeiro.moreira@gmail.com
@@ -111,9 +91,9 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- ".gitignore"
-- ".rspec"
-- ".travis.yml"
+- .gitignore
+- .rspec
+- .travis.yml
 - CONTRIBUTORS
 - Gemfile
 - Gemfile.lock
@@ -138,17 +118,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.6.3
+rubygems_version: 2.4.6
 signing_key: 
 specification_version: 4
 summary: Distributed lock using Redis written in Ruby.