mysql_getlock 0.2.0 → 0.2.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 13472db42b56d8508600971446847ed1eca62d47
-  data.tar.gz: 3f29aaa3f8507db4ad7a4c5bb2785ee961cb5a49
+  metadata.gz: 5e4b268a546f480cf35e54bec236f82e2ee74f25
+  data.tar.gz: a11b170c1fd935e9f02b258b23185d1879fc952f
 SHA512:
-  metadata.gz: 55970b8a826d111753244739c70c5ab97b5f12135e9813a78089ebc756a05eafb649e2d400b57ddbf650ba8d0f1188364d916807f9633c0d4641d7d1c1ed8c8a
-  data.tar.gz: c2cf83488fa66076b885a966e73eaba7c893a53ffe47283e81b21d9773a7ee0180bb69f5fe9d590e3c6339e5136b8e5fbfc5ea01acd4d117976281f5632b7e26
+  metadata.gz: 94050442d95798cd3a54571c8662f87b09c8190aa1709ffe64f48f0aaea0f1119724560f93497b9ee78293f1186f2fe2af63a86b9617daf59155e490015883ba
+  data.tar.gz: 44e6fc1dbd8202f89fd87f8cc79f61f81572afbaeadc1dfd8e5ecea17d69c92e21d14dd3c56b9aa62373b986369613e32af827c56dc79a3a79f3843ce95e965f

data/CHANGELOG.md

@@ -1,3 +1,9 @@
+# 0.2.1 (2016-08-28)
+
+Enhancements:
+
+* Raises `LockError` if #synchronize failed to acquore a lock
+
 # 0.2.0 (2016-08-28)
 
 Enhancements:

data/README.md

@@ -26,6 +26,7 @@ Note that
 
 1. Before 5.7.5, only a single simultaneous lock can be acquired in a session, and `get_lock()` releases any existing lock.
  * This gem raises `MysqlGetlock::Error` at `#lock` if another `get_lock()` for another key is issued in a session to prevent accidental releases of existing lock.
+ * MEMO: lock twice for the same key in a session does not block, only one lock is held for both mysql < 5.7.5 and >= 5.7.5.
 2. The key name is global in a mysql instance. It is advised to use database-specific or application-specific lock names such as `db_name.str` or `app_name.environment.str`
 
 ## Installation
@@ -49,11 +50,11 @@ Or install it yourself as:
 Similarly with ruby standard library [mutex](https://ruby-doc.org/core-2.2.0/Mutex.html), following methods are available:
 
 * lock
-  * Attempts to grab the lock and waits if it isn’t availabl. Returns true if successfully acquird a lock.
+  * Attempts to grab the lock and waits if it isn’t available. Returns true if successfully acquired a lock
 * locked?
   * Returns true if this lock is currently held by some (including myself)
 * synchronize {}
-  * Obtains a lock, runs the block, and releases the lock when the block completes.
+  * Obtains a lock, runs the block, and releases the lock when the block completes. Raises `MysqlGetlock::LockError` if failed to acquire a lock
 * unlock
   * Releases the lock. Returns true if successfully released a lock.
 * self_locked?

data/bin/try

@@ -3,8 +3,23 @@
 require "bundler/setup"
 require "mysql_getlock"
 require 'logger'
+require 'optparse'
 
-if ARGV[0] == 'exit!'
+opts = {
+  timeout: -1,
+  kill: false
+}
+OptionParser.new.tap {|op|
+  op.on('--timeout VALUE') {|v|
+    opts[:timeout] = Float(v)
+  }
+  op.on('--kill') {|v|
+    opts[:kill] = true
+  }
+  op.parse(ARGV)
+}
+
+if opts[:kill]
   trap('INT') do
     exit!
   end
@@ -12,7 +27,8 @@ end
 
 mysql2 = Mysql2::Client.new
 mutex = MysqlGetlock.new(
-  mysql2: mysql2, key: 'mysql_getlock2', logger: Logger.new(STDOUT)
+  mysql2: mysql2, key: 'mysql_getlock', logger: Logger.new(STDOUT),
+  timeout: opts[:timeout]
 )
 mutex.synchronize do
   loop do

data/lib/mysql_getlock/version.rb

@@ -1,3 +1,3 @@
 class MysqlGetlock
-  VERSION = "0.2.0"
+  VERSION = "0.2.1"
 end

data/lib/mysql_getlock.rb

@@ -7,6 +7,7 @@ class MysqlGetlock
   TIMEOUT = -1 # inifinity
 
   class Error < ::StandardError; end
+  class LockError < ::StandardError; end
 
   def initialize(mysql2:, key:, logger: nil, timeout: TIMEOUT)
     self.mysql2 = mysql2
@@ -27,7 +28,7 @@ class MysqlGetlock
       raise Error, "get_lock() is already issued in the same connection for '#{current_session_key}'"
     end
 
-    logger.info { "#{log_head}Wait acquiring a mysql lock '#{key}'" } if logger
+    logger.info { "#{log_head}Wait #{timeout < 0 ? '' : "#{timeout} sec "}to acquire a mysql lock '#{key}'" } if logger
     results = mysql2.query(%Q[select get_lock('#{key}', #{timeout})], as: :array)
     case results.to_a.first.first
     when 1
@@ -81,7 +82,7 @@ class MysqlGetlock
   end
 
   def synchronize(&block)
-    lock
+    raise LockError unless lock
     begin
       yield
     ensure

metadata

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