redis_locks 0.1.0 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 9d50bb61032babb4eb127f5f4cf8a4b8804d84c0
-  data.tar.gz: 658610bbd101c4bce5004415c08517a44b23dd35
+  metadata.gz: 518aef2c939e2b41ead60befec91c025b82c65f6
+  data.tar.gz: 52d9fc52e779061090109b865a919536f939e5d0
 SHA512:
-  metadata.gz: b512b7584dc46896361d1c622a1c183ba6efc3ec5c22144e1162e614f47bc0bbe0c7e9e93bcb8323a1103982ceb26cd97df538d0f375b92a1b66eef13f675a60
-  data.tar.gz: 461ba90c3336dc56296053475a24141a1f0454e6cbb96cfe2d16c590eee7b7080147559a369a5713020f2af334495b7c7bb522737358930bffcc90242cca7619
+  metadata.gz: d800f5854643134b3d4e18da510e6cb5674a5abd7452f9610bb88a321cfab5958b7d5e04a5aba5a196a2dd8d3ab778f77c4b83907664b68f11f3c9cd0172fa1c
+  data.tar.gz: a3ec08d9ddbc21735a4091b8067847a472160be86bafe686ab5877535953616ca525cca62c71adcb52750aa98cd3012c2e64201cb3255890051fac89fe392ae6

data/lib/redis_locks.rb

@@ -1,4 +1,5 @@
 require 'redis_locks/version'
+require 'redis_locks/lock_error'
 require 'redis_locks/resource_unavailable'
 require 'redis_locks/evalsha_or_eval'
 require 'redis_locks/mutex'

data/lib/redis_locks/lock_error.rb

@@ -0,0 +1,4 @@
+module RedisLocks
+  class LockError < RuntimeError
+  end
+end

data/lib/redis_locks/mutex.rb

@@ -5,6 +5,12 @@ module RedisLocks
     end
   end
 
+  class MutexExpired < LockError
+    def initialize(key)
+      super("Mutex [#{key}] has expired!")
+    end
+  end
+
   class Mutex
 
     NAMESPACE = "mutex"
@@ -59,13 +65,23 @@ module RedisLocks
 
       # To prevent deleting a lock acquired from another process, only delete
       # the key if it's still valid, and will be for another 2 seconds
-      if Time.now.utc.to_i - 2 < @expires_at
+      if !expired?(safety_margin: 2)
         @redis.with { |conn| conn.del(@key) }
       end
 
       @expires_at = nil
     end
 
+    def expired?(safety_margin: 0)
+      return true unless @expires_at
+
+      Time.now.utc.to_i + safety_margin >= @expires_at
+    end
+
+    def not_expired!(safety_margin: 0)
+      raise MutexExpired.new(@key) if expired?(safety_margin: safety_margin)
+    end
+
     private
 
     def return_or_yield

data/lib/redis_locks/resource_unavailable.rb

@@ -1,4 +1,4 @@
 module RedisLocks
-  class ResourceUnavailable < RuntimeError
+  class ResourceUnavailable < LockError
   end
 end

data/lib/redis_locks/version.rb

@@ -1,3 +1,3 @@
 module RedisLocks
-  VERSION = '0.1.0'
+  VERSION = '0.2.0'
 end

data/spec/redis_locks/mutex_spec.rb

@@ -45,6 +45,22 @@ describe RedisLocks::Mutex do
       expect { mutex.lock! }.to raise_error(RedisLocks::AlreadyLocked)
     end
 
+    it 'says not expired' do
+      expect(mutex.expired?).to be_falsey
+    end
+
+    it 'says not expired with small safety margin' do
+      expect(mutex.expired?(safety_margin: 2)).to be_falsey
+    end
+
+    it 'says expired with large safety margin' do
+      expect(mutex.expired?(safety_margin: 60 * 60 * 24 * 365)).to be_truthy
+    end
+
+    it 'asserts not_expired!' do
+      mutex.not_expired!
+    end
+
     context 'and then unlocked' do
       before do
         mutex.unlock
@@ -65,5 +81,13 @@ describe RedisLocks::Mutex do
     it 'allows lock' do
       expect(mutex.lock).to be_truthy
     end
+
+    it 'says expired' do
+      expect(mutex.expired?).to be_truthy
+    end
+
+    it 'fails not_expired!' do
+      expect { mutex.not_expired! }.to raise_error(RedisLocks::MutexExpired)
+    end
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: redis_locks
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors:
 - Academia.edu
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-05-25 00:00:00.000000000 Z
+date: 2016-06-11 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: redis
@@ -83,6 +83,7 @@ files:
 - lib/redis_locks.rb
 - lib/redis_locks/connections.rb
 - lib/redis_locks/evalsha_or_eval.rb
+- lib/redis_locks/lock_error.rb
 - lib/redis_locks/mutex.rb
 - lib/redis_locks/resource_unavailable.rb
 - lib/redis_locks/semaphore.rb
@@ -117,9 +118,5 @@ rubygems_version: 2.4.5.1
 signing_key: 
 specification_version: 4
 summary: Various locking utilities for Ruby using Redis
-test_files:
-- spec/redis_locks/mutex_spec.rb
-- spec/redis_locks/semaphore_spec.rb
-- spec/redis_locks/token_bucket_spec.rb
-- spec/spec_helper.rb
+test_files: []
 has_rdoc: