redis_getlock 0.1.1 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: a5ec4a3361c80eb549bd10339f8238fcfff931ff
-  data.tar.gz: f014c8fed835373c21c8e97b8bf9c9248b6c7437
+  metadata.gz: 010459a0c19e3b361f1f0a72d654c017e24f61a1
+  data.tar.gz: 9b08bf52a858125339c95893d0d76ca2eed1e8a8
 SHA512:
-  metadata.gz: 1d29834b4078ed4ba5badcb4019061cde85eb1583c54dddb5e8e8f8cdaec5541d4964875e1cf4ac666ce508fd200a5e5e548e44a34a7d7ccec75046676400df4
-  data.tar.gz: a13b4af68d49ebf0da7cf9721e4ee1e2ed843c05fe3d3c5346707ca431ad5e5cdb0e69ec48504f12faecdccd90a61ac211137e8328d34558c0edff50a5c15e63
+  metadata.gz: 08686f08d50978d37900b3cc402583587585b16bf5a45b45611bb8497c0d1b750c4886130bd88aed053e2f203dbc56731d7f3eea2b37036c8a3eed7a68526e42
+  data.tar.gz: efb8e7b53b4c1afbc16c2e9869ded9ee78338ebfec2108e05c9060a63ab49b9dbe8a2a7437161bc723a9a0dc8518a34f2203427df27055b02f58690f686331ca

data/CHANGELOG.md

@@ -1,10 +1,15 @@
-# 0.1.1 (2016-02-28)
+# 0.2.0 (2016-08-28)
+
+Changes:
+
+* Rename `timeout` option to `expire` option
+
+# 0.1.1 (2016-08-28)
 
 Changes:
 
 * Trivial change of log format
 
-# 0.1.0 (2016-02-28)
+# 0.1.0 (2016-08-28)
 
 First version
-

data/README.md

@@ -10,7 +10,7 @@ Simple ruby codes which [http://redis.io/commands/set](http://redis.io/commands/
 
 ```ruby
 loop do
-  break if redis.set(key, 'anystring', {nx: true, ex: timeout})
+  break if redis.set(key, 'anystring', {nx: true, ex: expire})
   sleep 1
 end
 puts 'get lock'
@@ -21,8 +21,8 @@ ensure
 end
 ```
 
-The problem here is the value of `timeout`.
-The expiration time `timeout` is necessary so that a lock will eventually be released even if a process is crashed or killed by SIGKILL before deleting the key.
+The problem here is the value of `expire`.
+The expiration time `expire` is necessary so that a lock will eventually be released even if a process is crashed or killed by SIGKILL before deleting the key.
 However, how long should we set if we are uncertain how long a job takes?
 
 This gem takes a following approach to resolve this problem.
@@ -30,7 +30,7 @@ This gem takes a following approach to resolve this problem.
 1. Expiration time is set to `2` (default) seconds
 2. Extend the lock in each `1` (default) sencond interval invoking another thread
 
-This way ensures to release orphaned lock in 2 seconds. We are released from caring of the value of `timeout`!!
+This way ensures to release orphaned lock in 2 seconds. We are released from caring of the value of `expire`!!
 
 Simple ruby codes to explain how this gem works are as follows:
 
@@ -91,10 +91,10 @@ Options of `RedisGetlock.new` are:
   * Key name for a distributed lock
 * logger
   * Provide a logger for RedisGetlock (for debug)
-* timeout
-  * The expiration timeout of the lock. The default is `2` second. Users usually do not need to care of this because the expiration is automatically extended in a invoked thread.
+* expire
+  * The expiration seconds of the lock. The default is `2` second. Users usually do not need to care of this because the expiration is automatically extended in a invoked thread.
 * interval
-  * Interval to extend lock expiration. Must be `timeout > interval`. The default is `1` second.
+  * Interval to extend lock expiration. Must be `expire > interval`. The default is `1` second.
 
 ### Example
 

data/lib/redis_getlock.rb

@@ -3,16 +3,16 @@ require "redis_getlock/version"
 require 'securerandom'
 
 class RedisGetlock
-  attr_reader :redis, :key, :logger, :timeout, :interval
+  attr_reader :redis, :key, :logger, :expire, :interval
 
-  TIMEOUT = 2
+  EXPIRE = 2
   INTERVAL = 1
 
-  def initialize(redis:, key:, logger: nil, timeout: TIMEOUT, interval: INTERVAL)
+  def initialize(redis:, key:, logger: nil, expire: EXPIRE, interval: INTERVAL)
     @redis = redis
     @key = key
     @logger = logger
-    @timeout = timeout
+    @expire = expire
     @interval = interval
   end
 
@@ -64,14 +64,14 @@ class RedisGetlock
   def lock_with_set_options
     uuid = SecureRandom.uuid
     loop do
-      break if redis.set(key, uuid, {nx: true, ex: timeout}) # key does not exist
+      break if redis.set(key, uuid, {nx: true, ex: expire}) # key does not exist
       sleep interval
     end
   end
 
   def keeplock_with_set_options
     loop do
-      redis.expire(key, timeout) # extend expiration
+      redis.expire(key, expire) # extend expiration
       sleep interval
     end
   end
@@ -81,13 +81,13 @@ class RedisGetlock
   def lock_without_set_options
     loop do
       current = Time.now.to_f
-      if redis.setnx(key, (current + timeout).to_s) # key does not exist
-        redis.expire(key, timeout)
+      if redis.setnx(key, (current + expire).to_s) # key does not exist
+        redis.expire(key, expire)
         break # acquire lock
       end
       expired = redis.get(key)
       if expired.to_f < current # key exists, but expired
-        compared = redis.getset(key, (current + timeout).to_s)
+        compared = redis.getset(key, (current + expire).to_s)
         break if expired == compared # acquire lock
       end
       sleep interval
@@ -97,7 +97,7 @@ class RedisGetlock
   def keeplock_without_set_options
     loop do
       current = Time.now.to_f
-      redis.setex(key, timeout,  (current + timeout).to_s) # extend expiration
+      redis.setex(key, expire,  (current + expire).to_s) # extend expiration
       sleep interval
     end
   end

data/lib/redis_getlock/version.rb

@@ -1,3 +1,3 @@
 class RedisGetlock
-  VERSION = "0.1.1"
+  VERSION = "0.2.0"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: redis_getlock
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.2.0
 platform: ruby
 authors:
 - Naotoshi Seo