redlock 1.0.1 → 1.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: '09e97229d3f4d001a612e97e6c76a7855a7186ec612afaee0d6e7b1dc5fd2cfc'
-  data.tar.gz: ad13c6b86a28eaba8359729b9f857c147610dbac0bb272613e2950b6c5adbee8
+  metadata.gz: d883de4dd36be4eab1fd32417cdc59a99cd4a7e0a68efbbe1a3865a8f9150ea7
+  data.tar.gz: f732c4b1fb41bb2d9b34917879d6bc893375d9a2d4d527ecfe29d935c3d998a2
 SHA512:
-  metadata.gz: cb58e84074840f2a08ce2b6d53385ec86faf3a94a1579b4ca3477278a7ba95bbd3ffaeff5adaadc4d3515c84f97659a45177393c1e6ebda13ef9458dd28eae06
-  data.tar.gz: 6a5a52c8d48cb09f64bb071dccda4518bdc0e07ddea596ac152a6ed52ff6fdf473de6565ce68ecbf4077008acc289c32eeda41d4617ec9370d5e2cabada86f2d
+  metadata.gz: b05d03ae1e3e6de8b21d9cc2d7c367d03dba26a1b72b06e821a07e81183345a9ea4e32a5a984d941eb6ef5cd628acb446946e9395d37c7e532b16b5e6444b1eb
+  data.tar.gz: 3066e7c68d4dd14e7e193bb58f29aad00a4624a47aabd4b7b1dfff32318bcaffad7f38910e1b2ab77a0e8572a71f828dc4c83d8af8a3cd13fe95da7e95910a6e

data/.travis.yml

@@ -2,7 +2,9 @@ language: ruby
 services:
     - redis-server
 rvm:
-  - "2.2.2"
+  - 2.2.2
+  - 2.5.6
+  - 2.6.4
 script: bundle exec rspec spec
 sudo: false
 cache: bundler

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    redlock (1.0.0)
+    redlock (1.1.0)
       redis (>= 3.0.0, < 5.0)
 
 GEM
@@ -17,7 +17,7 @@ GEM
     docile (1.3.1)
     json (2.1.0)
     rake (11.3.0)
-    redis (4.0.3)
+    redis (4.1.1)
     rspec (3.5.0)
       rspec-core (~> 3.5.0)
       rspec-expectations (~> 3.5.0)

data/README.md

@@ -108,10 +108,10 @@ rescue Redlock::LockError
 end
 ```
 
-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 the `extend_life` parameter:
+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 and released by someone else in the meantime. To only extend the life of the lock if currently locked by yourself, use the `extend_only_if_locked` parameter:
 
 ```ruby
-lock_manager.lock("resource key", 3000, extend: lock_info, extend_life: true)
+lock_manager.lock("resource key", 3000, extend: lock_info, extend_only_if_locked: true)
 ```
 
 ## Redis client configuration

data/lib/redlock/client.rb

@@ -55,11 +55,21 @@ module Redlock
     # +ttl+:: The time-to-live in ms for the lock.
     # +options+:: Hash of optional parameters
     #  * +extend+: A lock ("lock_info") to extend.
-    #  * +extend_only_if_life+: If +extend+ is given, only acquire lock if currently held
+    #  * +extend_only_if_locked+: Boolean, if +extend+ is given, only acquire lock if currently held
+    #  * +extend_only_if_life+: Deprecated, same as +extend_only_if_locked+
+    #  * +extend_life+: Deprecated, same as +extend_only_if_locked+
     # +block+:: an optional block to be executed; after its execution, the lock (if successfully
     # acquired) is automatically unlocked.
     def lock(resource, ttl, options = {}, &block)
       lock_info = try_lock_instances(resource, ttl, options)
+      if options[:extend_only_if_life] && !Gem::Deprecate.skip
+        warn 'DEPRECATION WARNING: The `extend_only_if_life` option has been renamed `extend_only_if_locked`.'
+        options[:extend_only_if_locked] = options[:extend_only_if_life]
+      end
+      if options[:extend_life] && !Gem::Deprecate.skip
+        warn 'DEPRECATION WARNING: The `extend_life` option has been renamed `extend_only_if_locked`.'
+        options[:extend_only_if_locked] = options[:extend_life]
+      end
 
       if block_given?
         begin
@@ -118,6 +128,8 @@ module Redlock
         else
           @redis = Redis.new(connection)
         end
+
+        load_scripts
       end
 
       def lock(resource, val, ttl, allow_new_lock)
@@ -178,7 +190,7 @@ module Redlock
 
     def lock_instances(resource, ttl, options)
       value = (options[:extend] || { value: SecureRandom.uuid })[:value]
-      allow_new_lock = (options[:extend_life] || options[:extend_only_if_life]) ? 'no' : 'yes'
+      allow_new_lock = options[:extend_only_if_locked] ? 'no' : 'yes'
 
       locked, time_elapsed = timed do
         @servers.select { |s| s.lock resource, value, ttl, allow_new_lock }.size

data/lib/redlock/version.rb

@@ -1,3 +1,3 @@
 module Redlock
-  VERSION = '1.0.1'
+  VERSION = '1.1.0'
 end

data/spec/client_spec.rb

@@ -64,9 +64,9 @@ RSpec.describe Redlock::Client do
         end
       end
 
-      context 'when extend_only_if_life flag is given' do
+      context 'when extend_only_if_locked 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_only_if_life: true)
+          @lock_info = lock_manager.lock(resource_key, ttl, extend: {value: 'hello world'}, extend_only_if_locked: true)
           expect(@lock_info).to eq(false)
         end
       end
@@ -76,14 +76,14 @@ RSpec.describe Redlock::Client do
         lock_info = lock_manager.lock(resource_key, ttl)
         expect(resource_key).to_not be_lockable(lock_manager, ttl)
 
-        lock_info = lock_manager.lock(resource_key, ttl, extend: lock_info, extend_life: true)
+        lock_info = lock_manager.lock(resource_key, ttl, extend: lock_info, extend_only_if_locked: true)
         expect(lock_info).not_to be_nil
         expect(redis_client.pttl(resource_key)).to be_within(200).of(ttl)
       end
 
-      context 'when extend_only_if_life flag is not given' do
+      context 'when extend_only_if_locked 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_only_if_life: false)
+          @lock_info = lock_manager.lock(resource_key, ttl, extend: {value: 'hello world'}, extend_only_if_locked: 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
@@ -94,6 +94,28 @@ RSpec.describe Redlock::Client do
         second_attempt = lock_manager.lock(resource_key, ttl)
         expect(second_attempt).to eq(false)
       end
+
+      context 'when extend_life flag is given' do
+        it 'treats it as extend_only_if_locked but warns it is deprecated' do
+          ttl = 20_000
+          lock_info = lock_manager.lock(resource_key, ttl)
+          expect(resource_key).to_not be_lockable(lock_manager, ttl)
+          expect(lock_manager).to receive(:warn).with(/DEPRECATION WARNING: The `extend_life`/)
+          lock_info = lock_manager.lock(resource_key, ttl, extend: lock_info, extend_life: true)
+          expect(lock_info).not_to be_nil
+        end
+      end
+
+      context 'when extend_only_if_life flag is given' do
+        it 'treats it as extend_only_if_locked but warns it is deprecated' do
+          ttl = 20_000
+          lock_info = lock_manager.lock(resource_key, ttl)
+          expect(resource_key).to_not be_lockable(lock_manager, ttl)
+          expect(lock_manager).to receive(:warn).with(/DEPRECATION WARNING: The `extend_only_if_life`/)
+          lock_info = lock_manager.lock(resource_key, ttl, extend: lock_info, extend_only_if_life: true)
+          expect(lock_info).not_to be_nil
+        end
+      end
     end
 
     context 'when lock is not available' do

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: redlock
 version: !ruby/object:Gem::Version
-  version: 1.0.1
+  version: 1.1.0
 platform: ruby
 authors:
 - Leandro Moreira
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-05-29 00:00:00.000000000 Z
+date: 2019-11-15 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: redis