redis_getlock 0.1.0 → 0.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 036e43b36aedd8b5350a4c6654a9e23bd67578cc
-  data.tar.gz: b89cfca59c6fd6f9817741a60fcfdd839aa04d9d
+  metadata.gz: a5ec4a3361c80eb549bd10339f8238fcfff931ff
+  data.tar.gz: f014c8fed835373c21c8e97b8bf9c9248b6c7437
 SHA512:
-  metadata.gz: 60e3c90c10505acfceb91f1f67cbcbec663d3ac3c1d967b9db62ce5cb7b3107367bcb3ba9d0e3c8fb74958f63a2042a096f96cdd095e59e89d809bac363f2071
-  data.tar.gz: 0a2abe5631ae645f0f6c37612a6885616ba14d0fc4c893e5252dec7e9ffc3351746538558cfe511a816b8e886c3675ca7060facc93843af664ae1d321796bcf5
+  metadata.gz: 1d29834b4078ed4ba5badcb4019061cde85eb1583c54dddb5e8e8f8cdaec5541d4964875e1cf4ac666ce508fd200a5e5e548e44a34a7d7ccec75046676400df4
+  data.tar.gz: a13b4af68d49ebf0da7cf9721e4ee1e2ed843c05fe3d3c5346707ca431ad5e5cdb0e69ec48504f12faecdccd90a61ac211137e8328d34558c0edff50a5c15e63

data/CHANGELOG.md

@@ -1,3 +1,10 @@
+# 0.1.1 (2016-02-28)
+
+Changes:
+
+* Trivial change of log format
+
 # 0.1.0 (2016-02-28)
 
 First version
+

data/README.md

@@ -30,9 +30,9 @@ 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.
+This way ensures to release orphaned lock in 2 seconds. We are released from caring of the value of `timeout`!!
 
-Simple codes are as follows:
+Simple ruby codes to explain how this gem works are as follows:
 
 ```ruby
 loop do
@@ -83,6 +83,19 @@ Similarly with ruby standard library [mutex](https://ruby-doc.org/core-2.2.0/Mut
 * unlock
   * Releases the lock.
 
+Options of `RedisGetlock.new` are:
+
+* redis
+  * Provide a redis instance
+* key
+  * 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.
+* interval
+  * Interval to extend lock expiration. Must be `timeout > interval`. The default is `1` second.
+
 ### Example
 
 ```ruby

data/lib/redis_getlock/version.rb

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

data/lib/redis_getlock.rb

@@ -17,7 +17,7 @@ class RedisGetlock
   end
 
   def lock
-    logger.info { "RedisGetlock: Wait acquiring a lock: #{key}" } if logger
+    logger.info { "#{log_head}Wait acquiring a redis lock '#{key}'" } if logger
     if set_options_available?
       lock_with_set_options
       @thr = Thread.new(&method(:keeplock_with_set_options))
@@ -25,13 +25,13 @@ class RedisGetlock
       lock_without_set_options
       @thr = Thread.new(&method(:keeplock_without_set_options))
     end
-    logger.info { "RedisGetlock: Acquired a lock: #{key}" } if logger
+    logger.info { "#{log_head}Acquired a redis lock '#{key}'" } if logger
   end
 
   def unlock
     @thr.terminate
     redis.del(key)
-    logger.info { "RedisGetlock: Released a lock: #{key}" } if logger
+    logger.info { "#{log_head}Released a redis lock '#{key}'" } if logger
   end
 
   def locked?
@@ -49,6 +49,10 @@ class RedisGetlock
 
   private
 
+  def log_head
+    "PID-#{::Process.pid} TID-#{::Thread.current.object_id.to_s(36)}: "
+  end
+
   def set_options_available?
     return @set_options_avialble unless @set_options_avialble.nil?
     major, minor, patch = redis.info['redis_version'].split('.').map(&:to_i)

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: redis_getlock
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.1
 platform: ruby
 authors:
 - Naotoshi Seo
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2016-08-27 00:00:00.000000000 Z
+date: 2016-08-28 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: redis