with_advisory_lock 0.0.7 → 0.0.8

checksums.yaml

@@ -1,15 +1,15 @@
 ---
 !binary "U0hBMQ==":
   metadata.gz: !binary |-
-    MjRiZmQ3MDg3MTEwZDYwNzkzMDQ1YWFjNjc0Y2FmYmJlNTkyN2NjZQ==
+    YzA3MTE5YzM5MzkwMjJmZjRjOWFhMTc1ZjA0ZGNmNWFlNTE1NjM4MQ==
   data.tar.gz: !binary |-
-    ODk2NDU3MzZkMjk1YTIyZmU0Y2UzYmM1OGQzYjJmMWNmNTkwZTg5Mw==
+    ZGViZjU2NzczOGYyMTVkZDJjYWRmZjYwMTMwOWQwMDlkNDI1ZDc3Yw==
 !binary "U0hBNTEy":
   metadata.gz: !binary |-
-    OTU4OGVjMDQyNzI4Njg5N2RhZmYzOTk5ZmNjMGRjZDg4M2MyZWJhYTJjNDcx
-    OTYzMGU4Nzc5Y2Y3NWMxMTk5ZTUzNjU5M2M5OWI4MGRmMjQ1OTJlNDY4YTQ4
-    NGY3MmI5ZjRhODZmYjM5NTMyZDRiZjFiZTE4ZDYwMzZiMDBjMmQ=
+    NDNmYWE3ZmNhZGFlZDU3ODQzMzAyODdlNTAxZjdkZTFkYzk2NDM2N2I0Mjhm
+    YTE0OGM0MmZlNDY1ZWMyN2YzNmZmYTIzOWE5ODRhODFjZmE2MjY5MDNkNmY2
+    Y2M2ZmNhOWVkNGVjNzI3MDczZmVjN2IxZTI0NjcwYmUzYzI2MmE=
   data.tar.gz: !binary |-
-    ZWQ1NzY2N2QwM2JlNmRkMDg1N2NiZWVkOTU4MjUxMDA2NmQwZWRkZmQ0OWJj
-    ZDE4Yzg0ZDBkODQwYzI2M2JjZGQ0YmZhNzFlZGVhYWFiMDViNDA1ZjU0MGI4
-    Y2RkNTRlOWFiMDZmMzQ0N2RlOGE0ZWEyNjNmMjQ1ODg2N2IwNTY=
+    NmY4MDdkOTM1NzkxODU1N2NiN2U0N2Q2MTNiYTk0YjU4NGFmZTY2NDA4NjEz
+    MWU5ODZhYTFkYWUwZGE4MmE4ZjZhNWU5ZGY5NDZkYzkxZjA3MGVmODgxOTEz
+    MDM3ZDYwNTk5YTg1NjNkY2M1MWI5MDYxYzkwM2E0MzI2ZjllMzA=

data/README.md

@@ -1,9 +1,11 @@
-# with_advisory_lock [![Build Status](https://api.travis-ci.org/mceachen/with_advisory_lock.png?branch=master)](https://travis-ci.org/mceachen/with_advisory_lock)
+# with_advisory_lock
 
-Adds advisory locking to ActiveRecord 3.2.x.
+Adds advisory locking (mutexes) to ActiveRecord 3.0, 3.1, 3.2, and 4.0.0 when used with
 [MySQL](http://dev.mysql.com/doc/refman/5.0/en/miscellaneous-functions.html#function_get-lock)
-and [PostgreSQL](http://www.postgresql.org/docs/9.1/static/functions-admin.html#FUNCTIONS-ADVISORY-LOCKS)
-are supported natively. SQLite resorts to file locking (which won't span hosts, of course!).
+or [PostgreSQL](http://www.postgresql.org/docs/9.1/static/functions-admin.html#FUNCTIONS-ADVISORY-LOCKS).
+SQLite resorts to file locking.
+
+[![Build Status](https://api.travis-ci.org/mceachen/with_advisory_lock.png?branch=master)](https://travis-ci.org/mceachen/with_advisory_lock)
 
 ## What's an "Advisory Lock"?
 
@@ -38,19 +40,6 @@ The return value of ```with_advisory_lock``` will be the result of the yielded b
 if the lock was able to be acquired and the block yielded, or ```false```, if you provided
 a timeout_seconds value and the lock was not able to be acquired in time.
 
-### Transactions and Advisory Locks
-
-Advisory locks with MySQL and PostgreSQL ignore database transaction boundaries.
-
-You will want to wrap your block within a transaction to ensure consistency.
-
-### MySQL doesn't support nesting
-
-With MySQL (at least <= v5.5), if you ask for a *different* advisory lock within a ```with_advisory_lock``` block,
-you will be releasing the parent lock (!!!). A ```NestedAdvisoryLockError```will be raised
-in this case. If you ask for the same lock name, ```with_advisory_lock``` won't ask for the
-lock again, and the block given will be yielded to.
-
 ## Installation
 
 Add this line to your application's Gemfile:
@@ -89,8 +78,57 @@ gem, these prevent concurrent access to **any instance of a model**. Their coars
 aren't going to be commonly applicable, and they can be a source of
 [deadlocks](http://en.wikipedia.org/wiki/Deadlock).
 
+## FAQ
+
+### Transactions and Advisory Locks
+
+Advisory locks with MySQL and PostgreSQL ignore database transaction boundaries.
+
+You will want to wrap your block within a transaction to ensure consistency.
+
+### MySQL doesn't support nesting
+
+With MySQL (at least <= v5.5), if you ask for a *different* advisory lock within a ```with_advisory_lock``` block,
+you will be releasing the parent lock (!!!). A ```NestedAdvisoryLockError```will be raised
+in this case. If you ask for the same lock name, ```with_advisory_lock``` won't ask for the
+lock again, and the block given will be yielded to.
+
+### There are many ```lock-*``` files in my project directory after test runs
+
+This is expected if you aren't using MySQL or Postgresql for your tests.
+See [issue 3](https://github.com/mceachen/with_advisory_lock/issues/3).
+
+SQLite doesn't have advisory locks, so we resort to file locking, which will only work
+if the ```FLOCK_DIR``` is set consistently for all ruby processes.
+
+In your ```spec_helper.rb``` or ```minitest_helper.rb```, add a ```before``` and ```after``` block:
+
+```ruby
+before do
+  ENV['FLOCK_DIR'] = Dir.mktmpdir
+end
+
+after do
+  FileUtils.remove_entry_secure ENV['FLOCK_DIR']
+end
+```
+
 ## Changelog
 
+### 0.0.8
+
+* Addressed [issue 5](https://github.com/mceachen/with_advisory_lock/issues/5) by
+  using a deterministic hash for Postgresql + MRI >= 1.9.
+  Thanks for the pull request, [Joel Turkel](https://github.com/jturkel)!
+* Addressed [issue 2](https://github.com/mceachen/with_advisory_lock/issues/2) by
+  using a cache-busting query for MySQL and Postgres to deal with AR value caching bug.
+  Thanks for the pull request, [Jaime Giraldo](https://github.com/sposmen)!
+* Addressed [issue 4](https://github.com/mceachen/with_advisory_lock/issues/4) by
+  adding support for ```em-postgresql-adapter```.
+  Thanks, [lestercsp](https://github.com/lestercsp)!
+
+(Hey, github—your notifications are WAY too easy to ignore!)
+
 ### 0.0.7
 
 * Added Travis tests for Rails 3.0, 3.1, 3.2, and 4.0

data/lib/with_advisory_lock/concern.rb

@@ -21,7 +21,7 @@ module WithAdvisoryLock
 
       def with_advisory_lock(lock_name, timeout_seconds=nil, &block)
         impl_class = case (connection.adapter_name.downcase)
-          when "postgresql"
+          when "postgresql", "empostgresql"
             WithAdvisoryLock::PostgreSQL
           when "mysql", "mysql2"
             WithAdvisoryLock::MySQL

data/lib/with_advisory_lock/mysql.rb

@@ -14,15 +14,19 @@ module WithAdvisoryLock
       # 0 if the attempt timed out (for example, because another client has
       # previously locked the name), or NULL if an error occurred
       # (such as running out of memory or the thread was killed with mysqladmin kill).
-      1 == connection.select_value("SELECT GET_LOCK(#{quoted_lock_name}, 0)").to_i
+      # The timestamp prevents AR from caching the result improperly, and is ignored.
+      sql = "SELECT GET_LOCK(#{quoted_lock_name}, 0), #{Time.now.to_f}"
+      1 == connection.select_value(sql).to_i
     end
 
     def release_lock
-      # Returns 1 if the lock was released,
+      # Returns > 0 if the lock was released,
       # 0 if the lock was not established by this thread (
       # in which case the lock is not released), and
       # NULL if the named lock did not exist.
-      1 == connection.select_value("SELECT RELEASE_LOCK(#{quoted_lock_name})").to_i
+      # The timestamp prevents AR from caching the result improperly, and is ignored.
+      sql = "SELECT RELEASE_LOCK(#{quoted_lock_name}), #{Time.now.to_f}"
+      1 == connection.select_value(sql).to_i
     end
 
     def already_locked?

data/lib/with_advisory_lock/postgresql.rb

@@ -1,3 +1,5 @@
+require 'zlib'
+
 module WithAdvisoryLock
   class PostgreSQL < Base
 
@@ -6,11 +8,13 @@ module WithAdvisoryLock
     def try_lock
       # pg_try_advisory_lock will either obtain the lock immediately
       # and return true, or return false if the lock cannot be acquired immediately
-      "t" == connection.select_value("SELECT pg_try_advisory_lock(#{numeric_lock})").to_s
+      sql = "SELECT pg_try_advisory_lock(#{numeric_lock}), #{Time.now.to_f}"
+      "t" == connection.select_value(sql).to_s
     end
 
     def release_lock
-      "t" == connection.select_value("SELECT pg_advisory_unlock(#{numeric_lock})").to_s
+      sql = "SELECT pg_advisory_unlock(#{numeric_lock}), #{Time.now.to_f}"
+      "t" == connection.select_value(sql).to_s
     end
 
     def numeric_lock
@@ -18,7 +22,9 @@ module WithAdvisoryLock
         if lock_name.is_a? Numeric
           lock_name.to_i
         else
-          lock_name.to_s.hash
+          # Ruby MRI's String#hash is randomly seeded as of Ruby 1.9 so
+          # make sure we use a deterministic hash.
+          Zlib.crc32(lock_name.to_s)
         end
       end
     end

data/lib/with_advisory_lock/version.rb

@@ -1,3 +1,3 @@
 module WithAdvisoryLock
-  VERSION = "0.0.7"
+  VERSION = "0.0.8"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: with_advisory_lock
 version: !ruby/object:Gem::Version
-  version: 0.0.7
+  version: 0.0.8
 platform: ruby
 authors:
 - Matthew McEachen
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-06-21 00:00:00.000000000 Z
+date: 2013-06-22 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activerecord