with_advisory_lock 1.0.0 → 2.0.0

checksums.yaml

@@ -1,15 +1,7 @@
 ---
-!binary "U0hBMQ==":
-  metadata.gz: !binary |-
-    MWIyOWFmZWRlMTkzZWM0ZTFlY2UzZjVkYmQ3NTc5M2M5OTYxNzI0OQ==
-  data.tar.gz: !binary |-
-    OTdhNjkxNjZmODc5MjE2ODc2OWZmYzkzZDYxOTViNWY2ZWRlMDk2Nw==
+SHA1:
+  metadata.gz: 9a06363d16fb4769a2ee0486a8f0295dfe6e0c21
+  data.tar.gz: 3ce9cf5d558777ab689388fc086ce1fc2b18e1aa
 SHA512:
-  metadata.gz: !binary |-
-    NWFmZDViM2VmYmJmNWIwNTYwZGMzY2ZmODQ1MTcxNmZhZmFkZDUyNmQyNGE1
-    NWRlNGY3YTA0NmU3MjBiOGJiNjVkOGYxNWI3NjFmMjRlYmNhODM2NDg3N2U5
-    ZWM2NzNjYTczOWNiN2E2MzI4OWJiYWVlZWY1ZWEyNjM3MDhhNzY=
-  data.tar.gz: !binary |-
-    NmQyOWI0NmY4ZTJmNTFjY2YzNzlhNzM1ZDlmNWM0NWE5NjRiMWE2NDI3ZmU3
-    NTBmYzIwODZhZDUzMjQxYjM2NThkZDgxNGM1M2ZiODE4MjJhNmJiYTcwMTEw
-    MTEzMmMyYzQ0Yjk2YjRmMWZjMzAzZjAwNzlmZTJlYjQ1ODg2MWQ=
+  metadata.gz: 1e162976296fc77f93eb8a46bf2681c4a7694727317a384b38bdfc552cd7dba6738a84e035879df673256624a6bdf3c0a74e16a677ce06adae80b2ee9daf59b8
+  data.tar.gz: 5454c4de4150ceaa24c797ae726913ed0b239fdfcbf19471985d760d76c41a2b78da3ea1df4c733afb1ba75301e02ae0550252876e3b3e4b145e4984b4c5e3b4

data/.gitignore

@@ -4,7 +4,7 @@
 .bundle
 .config
 .yardoc
-Gemfile.lock
+*.lock
 InstalledFiles
 _yardoc
 coverage

data/.travis.yml

@@ -1,16 +1,16 @@
 language: ruby
 
 rvm:
-  - 2.0.0
-#  - 1.8.7
+  - jruby-19mode
+  - 2.1.2
   - 1.9.3
+# TODO  - rbx-2
 
 gemfile:
-  - ci/Gemfile.rails-4.1.x
-  - ci/Gemfile.rails-4.0.x
-  - ci/Gemfile.rails-3.2.x
-#  - ci/Gemfile.rails-3.1.x
-#  - ci/Gemfile.rails-3.0.x
+  - gemfiles/activerecord_3.2.gemfile
+  - gemfiles/activerecord_4.0.gemfile
+  - gemfiles/activerecord_4.1.gemfile
+  - gemfiles/activerecord_edge.gemfile
 
 env:
   - DB=sqlite
@@ -23,41 +23,10 @@ before_script:
   - mysql -e 'create database with_advisory_lock_test'
   - psql -c 'create database with_advisory_lock_test' -U postgres
 
+addons:
+  postgresql: "9.3"
+
 matrix:
-  exclude:
-    - rvm: 1.8.7
-      gemfile: ci/Gemfile.rails-4.0.x
-      env: DB=sqlite
-    - rvm: 1.8.7
-      gemfile: ci/Gemfile.rails-4.0.x
-      env: DB=mysql
-    - rvm: 1.8.7
-      gemfile: ci/Gemfile.rails-4.0.x
-      env: DB=postgresql
-    - rvm: 2.0.0
-      gemfile: ci/Gemfile.rails-3.0.x
-      env: DB=sqlite
-    - rvm: 2.0.0
-      gemfile: ci/Gemfile.rails-3.0.x
-      env: DB=mysql
-    - rvm: 2.0.0
-      gemfile: ci/Gemfile.rails-3.0.x
-      env: DB=postgresql
-    - rvm: 2.0.0
-      gemfile: ci/Gemfile.rails-3.1.x
-      env: DB=sqlite
-    - rvm: 2.0.0
-      gemfile: ci/Gemfile.rails-3.1.x
-      env: DB=mysql
-    - rvm: 2.0.0
-      gemfile: ci/Gemfile.rails-3.1.x
-      env: DB=postgresql
-    - rvm: 2.0.0
-      gemfile: ci/Gemfile.rails-3.2.x
-      env: DB=sqlite
-    - rvm: 2.0.0
-      gemfile: ci/Gemfile.rails-3.2.x
-      env: DB=mysql
-    - rvm: 2.0.0
-      gemfile: ci/Gemfile.rails-3.2.x
-      env: DB=postgresql
+  allow_failures:
+    - gemfile: gemfiles/activerecord_edge.gemfile
+    - rvm: rbx-2

data/Appraisals

@@ -0,0 +1,16 @@
+appraise "activerecord-3.2" do
+  gem 'activerecord', '~> 3.2.0'
+end
+
+appraise "activerecord-4.0" do
+  gem "activerecord", "~> 4.0.0"
+end
+
+appraise "activerecord-4.1" do
+  gem "activerecord", "~> 4.1.0"
+end
+
+appraise "activerecord-edge" do
+  gem "activerecord", github: "rails/rails"
+  gem 'arel', github: 'rails/arel'
+end

data/Gemfile

@@ -1,3 +1,15 @@
 source 'https://rubygems.org'
 
 gemspec
+
+platforms :ruby do
+  gem 'mysql2'
+  gem 'pg'
+  gem 'sqlite3'
+end
+
+platforms :jruby do
+  gem 'activerecord-jdbcmysql-adapter'
+  gem 'activerecord-jdbcpostgresql-adapter'
+  gem 'activerecord-jdbcsqlite3-adapter'
+end

data/README.md

@@ -1,15 +1,14 @@
 # with_advisory_lock
 
-Adds advisory locking (mutexes) to ActiveRecord 3.0, 3.1, 3.2, 4.0 and 4.1 when used with
+Adds advisory locking (mutexes) to ActiveRecord 3.2, 4.0 and 4.1 when used with
 [MySQL](http://dev.mysql.com/doc/refman/5.0/en/miscellaneous-functions.html#function_get-lock)
-or [PostgreSQL](http://www.postgresql.org/docs/9.1/static/functions-admin.html#FUNCTIONS-ADVISORY-LOCKS).
+or [PostgreSQL](http://www.postgresql.org/docs/9.3/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)
 [![Gem Version](https://badge.fury.io/rb/with_advisory_lock.png)](http://rubygems.org/gems/with_advisory_lock)
 [![Code Climate](https://codeclimate.com/github/mceachen/with_advisory_lock.png)](https://codeclimate.com/github/mceachen/with_advisory_lock)
 [![Dependency Status](https://gemnasium.com/mceachen/with_advisory_lock.png)](https://gemnasium.com/mceachen/with_advisory_lock)
-[![Bitdeli Badge](https://d2weczhvl823v0.cloudfront.net/mceachen/with_advisory_lock/trend.png)](https://bitdeli.com/free "Bitdeli Badge")
 
 ## What's an "Advisory Lock"?
 
@@ -38,8 +37,14 @@ end
 The second parameter for ```with_advisory_lock``` is ```timeout_seconds```, and defaults to ```nil```,
 which means wait indefinitely for the lock.
 
-If a non-nil value is provided, the block may not be invoked.
+A value of zero will try the lock only once. If the lock is acquired, the block
+will be yielded to. If the lock is currently being held, the block will not be called.
 
+Note that if a non-nil value is provided for `timeout_seconds`, the block will not be invoked if
+the lock cannot be acquired within that timeframe.
+
+### Return values
+ 
 The return value of ```with_advisory_lock``` will be the result of the yielded block,
 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.
@@ -129,6 +134,19 @@ end
 
 ## Changelog
 
+### 2.0.0
+
+* Lock timeouts of 0 now attempt the lock once, as per suggested by 
+  [Jon Leighton](https://github.com/jonleighton) and implemented by 
+  [Abdelkader Boudih](https://github.com/seuros). Thanks to both of you!
+* [Pull request 11](https://github.com/mceachen/with_advisory_lock/pull/11) 
+  fixed a downstream issue with jruby support! Thanks, [Aaron Todd](https://github.com/ozzyaaron)!
+* Added Travis tests for jruby
+* Dropped support for Rails 3.0, 3.1, and Ruby 1.8.7, as they are no longer
+  receiving security patches. See http://rubyonrails.org/security/ for more information. 
+  This required the major version bump.
+* Refactored `advisory_lock_exists?` to use existing functionality
+* Fixed sqlite's implementation so parallel tests could be run against it 
 
 ### 1.0.0
 

data/Rakefile

@@ -8,8 +8,8 @@ end
 require 'rake/testtask'
 
 Rake::TestTask.new do |t|
-  t.libs.push "lib"
-  t.libs.push "test"
+  t.libs.push 'lib'
+  t.libs.push 'test'
   t.pattern = 'test/**/*_test.rb'
   t.verbose = true
 end

data/gemfiles/activerecord_3.2.gemfile

@@ -0,0 +1,19 @@
+# This file was generated by Appraisal
+
+source "https://rubygems.org"
+
+gem "activerecord", "~> 3.2.0"
+
+platforms :ruby do
+  gem "mysql2"
+  gem "pg"
+  gem "sqlite3"
+end
+
+platforms :jruby do
+  gem "activerecord-jdbcmysql-adapter"
+  gem "activerecord-jdbcpostgresql-adapter"
+  gem "activerecord-jdbcsqlite3-adapter"
+end
+
+gemspec :path => "../"

data/gemfiles/activerecord_4.0.gemfile

@@ -0,0 +1,19 @@
+# This file was generated by Appraisal
+
+source "https://rubygems.org"
+
+gem "activerecord", "~> 4.0.0"
+
+platforms :ruby do
+  gem "mysql2"
+  gem "pg"
+  gem "sqlite3"
+end
+
+platforms :jruby do
+  gem "activerecord-jdbcmysql-adapter"
+  gem "activerecord-jdbcpostgresql-adapter"
+  gem "activerecord-jdbcsqlite3-adapter"
+end
+
+gemspec :path => "../"

data/gemfiles/activerecord_4.1.gemfile

@@ -0,0 +1,19 @@
+# This file was generated by Appraisal
+
+source "https://rubygems.org"
+
+gem "activerecord", "~> 4.1.0"
+
+platforms :ruby do
+  gem "mysql2"
+  gem "pg"
+  gem "sqlite3"
+end
+
+platforms :jruby do
+  gem "activerecord-jdbcmysql-adapter"
+  gem "activerecord-jdbcpostgresql-adapter"
+  gem "activerecord-jdbcsqlite3-adapter"
+end
+
+gemspec :path => "../"

data/gemfiles/activerecord_edge.gemfile

@@ -0,0 +1,20 @@
+# This file was generated by Appraisal
+
+source "https://rubygems.org"
+
+gem "activerecord", :github => "rails/rails"
+gem "arel", :github => "rails/arel"
+
+platforms :ruby do
+  gem "mysql2"
+  gem "pg"
+  gem "sqlite3"
+end
+
+platforms :jruby do
+  gem "activerecord-jdbcmysql-adapter"
+  gem "activerecord-jdbcpostgresql-adapter"
+  gem "activerecord-jdbcsqlite3-adapter"
+end
+
+gemspec :path => "../"

data/lib/with_advisory_lock.rb

@@ -1,4 +1,17 @@
+require 'with_advisory_lock/version'
+
+module WithAdvisoryLock
+  extend ActiveSupport::Autoload
+
+  autoload :Concern
+  autoload :Base
+  autoload :DatabaseAdapterSupport
+  autoload :Flock
+  autoload :MySQL, 'with_advisory_lock/mysql'
+  autoload :NestedAdvisoryLockError
+  autoload :PostgreSQL, 'with_advisory_lock/postgresql'
+end
+
 ActiveSupport.on_load :active_record do
-  require 'with_advisory_lock/concern'
   ActiveRecord::Base.send :include, WithAdvisoryLock::Concern
 end

data/lib/with_advisory_lock/base.rb

@@ -7,35 +7,21 @@ module WithAdvisoryLock
     def initialize(connection, lock_name, timeout_seconds)
       @connection = connection
       @lock_name = lock_name
-      lock_name_prefix = ENV['WITH_ADVISORY_LOCK_PREFIX']
-      if lock_name_prefix
-        @lock_name = if lock_name.is_a? Numeric
-          "#{lock_name_prefix.to_i}#{lock_name}".to_i
-        else
-          "#{lock_name_prefix}#{lock_name}"
-        end
-      end
       @timeout_seconds = timeout_seconds
     end
 
-    def quoted_lock_name
-      connection.quote(lock_name)
+    def lock_str
+      @lock_str ||= "#{ENV['WITH_ADVISORY_LOCK_PREFIX'].to_s}#{lock_name.to_s}"
     end
 
     def self.lock_stack
       Thread.current[:with_advisory_lock_stack] ||= []
     end
 
-    def lock_stack
-      self.class.lock_stack
-    end
+    delegate :lock_stack, to: 'self.class'
 
     def already_locked?
-      lock_stack.include? @lock_name
-    end
-
-    def advisory_lock_exists?(name)
-      raise NoMethodError, "method must be implemented in implementation subclasses"
+      lock_stack.include? lock_str
     end
 
     def with_advisory_lock_if_needed
@@ -56,12 +42,18 @@ module WithAdvisoryLock
       end
     end
 
+    def advisory_lock_exists?
+      acquired_lock = try_lock
+    ensure
+      release_lock if acquired_lock
+    end
+
     def yield_with_lock
       give_up_at = Time.now + @timeout_seconds if @timeout_seconds
-      while @timeout_seconds.nil? || Time.now < give_up_at do
+      begin
         if try_lock
           begin
-            lock_stack.push(lock_name)
+            lock_stack.push(lock_str)
             return yield
           ensure
             lock_stack.pop
@@ -72,8 +64,13 @@ module WithAdvisoryLock
           # Randomizing sleep time may help reduce contention.
           sleep(rand * 0.15 + 0.05)
         end
-      end
+      end while @timeout_seconds.nil? || Time.now < give_up_at
       false # failed to get lock in time.
     end
+
+    # The timestamp prevents AR from caching the result improperly, and is ignored.
+    def query_cache_buster
+      "AS t#{(Time.now.to_f * 1000).to_i}"
+    end
   end
 end

data/lib/with_advisory_lock/concern.rb

@@ -2,23 +2,12 @@
 # but rails autoloading is too clever by half. Pull requests are welcome.
 
 require 'active_support/concern'
-require 'with_advisory_lock/base'
-require 'with_advisory_lock/database_adapter_support'
-require 'with_advisory_lock/flock'
-require 'with_advisory_lock/mysql'
-require 'with_advisory_lock/postgresql'
 
 module WithAdvisoryLock
   module Concern
     extend ActiveSupport::Concern
 
-    def with_advisory_lock(lock_name, timeout_seconds=nil, &block)
-      self.class.with_advisory_lock(lock_name, timeout_seconds, &block)
-    end
-
-    def advisory_lock_exists?(lock_name)
-      self.class.advisory_lock_exists?(lock_name)
-    end
+    delegate :with_advisory_lock, :advisory_lock_exists?, to: 'self.class'
 
     module ClassMethods
       def with_advisory_lock(lock_name, timeout_seconds=nil, &block)
@@ -27,23 +16,23 @@ module WithAdvisoryLock
       end
 
       def advisory_lock_exists?(lock_name)
-        impl = impl_class.new(connection, lock_name, nil)
-        impl.advisory_lock_exists?(lock_name)
+        impl = impl_class.new(connection, lock_name, 0)
+        impl.already_locked? || !impl.yield_with_lock { true }
       end
 
       def current_advisory_lock
         WithAdvisoryLock::Base.lock_stack.first
       end
 
-    private
+      private
 
       def impl_class
-        das = WithAdvisoryLock::DatabaseAdapterSupport.new(connection)
-        impl_class = if das.postgresql?
+        case WithAdvisoryLock::DatabaseAdapterSupport.new(connection).adapter
+        when :postgresql
           WithAdvisoryLock::PostgreSQL
-        elsif das.mysql?
+        when :mysql
           WithAdvisoryLock::MySQL
-        else
+        else #sqlite
           WithAdvisoryLock::Flock
         end
       end

data/lib/with_advisory_lock/database_adapter_support.rb

@@ -15,5 +15,11 @@ module WithAdvisoryLock
     def sqlite?
       :sqlite3 == @sym_name
     end
+
+    def adapter
+      return :mysql if mysql?
+      return :postgresql if postgresql?
+      :sqlite3
+    end
   end
 end

data/lib/with_advisory_lock/flock.rb

@@ -5,8 +5,8 @@ module WithAdvisoryLock
 
     def filename
       @filename ||= begin
-        safe = @lock_name.to_s.gsub(/[^a-z0-9]/i, '')
-        fn = ".lock-#{safe}-#{stable_hashcode(@lock_name)}"
+        safe = lock_str.to_s.gsub(/[^a-z0-9]/i, '')
+        fn = ".lock-#{safe}-#{stable_hashcode(lock_str)}"
         # Let the user specify a directory besides CWD.
         ENV['FLOCK_DIR'] ? File.expand_path(fn, ENV['FLOCK_DIR']) : fn
       end

data/lib/with_advisory_lock/mysql.rb

@@ -1,9 +1,6 @@
-require 'with_advisory_lock/nested_advisory_lock_error'
 module WithAdvisoryLock
   class MySQL < Base
-
     # See http://dev.mysql.com/doc/refman/5.0/en/miscellaneous-functions.html#function_get-lock
-
     def try_lock
       unless lock_stack.empty?
         raise NestedAdvisoryLockError.new(
@@ -14,30 +11,27 @@ 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).
-      # 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
+      sql = "SELECT GET_LOCK(#{quoted_lock_str}, 0) #{query_cache_buster}"
+      connection.select_value(sql).to_i > 0
     end
 
     def release_lock
       # 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
+      # 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.
-      # 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
+      sql = "SELECT RELEASE_LOCK(#{quoted_lock_str}) #{query_cache_buster}"
+      connection.select_value(sql).to_i > 0
     end
 
+    # MySQL doesn't support nested locks:
     def already_locked?
-      lock_stack.last == @lock_name
+      lock_stack.last == lock_str
     end
 
-    def advisory_lock_exists?(name)
-      quoted_name = connection.quote(name)
-      # See http://dev.mysql.com/doc/refman/5.0/en/miscellaneous-functions.html#function_is-used-lock
-      sql = "SELECT IS_USED_LOCK(#{quoted_name})"
-      connection.select_value(sql).present?
+    # MySQL wants a string as the lock key.
+    def quoted_lock_str
+      connection.quote(lock_str)
     end
   end
 end

data/lib/with_advisory_lock/postgresql.rb

@@ -1,29 +1,27 @@
-
 module WithAdvisoryLock
   class PostgreSQL < Base
-
     # See http://www.postgresql.org/docs/9.1/static/functions-admin.html#FUNCTIONS-ADVISORY-LOCKS
-
     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
-      sql = "SELECT pg_try_advisory_lock(#{numeric_lock}), #{Time.now.to_f}"
-      "t" == connection.select_value(sql).to_s
+      # pg_try_advisory_lock will either obtain the lock immediately and return true
+      # or return false if the lock cannot be acquired immediately
+      sql = "SELECT pg_try_advisory_lock(#{lock_keys.join(',')}) #{query_cache_buster}"
+      't' == connection.select_value(sql).to_s
     end
 
     def release_lock
-      sql = "SELECT pg_advisory_unlock(#{numeric_lock}), #{Time.now.to_f}"
-      "t" == connection.select_value(sql).to_s
+      sql = "SELECT pg_advisory_unlock(#{lock_keys.join(',')}) #{query_cache_buster}"
+      't' == connection.select_value(sql).to_s
     end
 
-    def numeric_lock(name=lock_name)
-      stable_hashcode(name)
+    # PostgreSQL wants 2 32bit integers as the lock key.
+    def lock_keys
+      @lock_keys ||= begin
+        [stable_hashcode(lock_name), ENV['WITH_ADVISORY_LOCK_PREFIX']].map do |ea|
+          # pg advisory args must be 31 bit ints
+          ea.to_i & 0x7fffffff
+        end
+      end
     end
-
-    def advisory_lock_exists?(name)
-      sql = "SELECT 't'::text FROM pg_locks WHERE objid = #{numeric_lock(name)} AND locktype = 'advisory'"
-      "t" == connection.select_value(sql).to_s
-    end
-
   end
 end
+

data/lib/with_advisory_lock/version.rb

@@ -1,3 +1,3 @@
 module WithAdvisoryLock
-  VERSION = Gem::Version.new('1.0.0')
+  VERSION = Gem::Version.new('2.0.0')
 end

data/test/lock_test.rb

@@ -1,9 +1,7 @@
 require 'minitest_helper'
 
 describe 'class methods' do
-
   let(:lock_name) { "test lock #{rand(1024)}" }
-  let(:expected_lock_name) { "#{ENV['WITH_ADVISORY_LOCK_PREFIX']}#{lock_name}" }
 
   describe '.current_advisory_lock' do
     it "returns nil outside an advisory lock request" do
@@ -12,21 +10,30 @@ describe 'class methods' do
 
     it 'returns the name of the last lock acquired' do
       Tag.with_advisory_lock(lock_name) do
-        Tag.current_advisory_lock.must_equal expected_lock_name
+        Tag.current_advisory_lock.must_match /#{lock_name}/
       end
     end
   end
 
   describe '.advisory_lock_exists?' do
     it "returns false for an unacquired lock" do
-      Tag.advisory_lock_exists?(expected_lock_name).must_equal false
+      Tag.advisory_lock_exists?(lock_name).must_be_false
     end
 
     it 'returns the name of the last lock acquired' do
       Tag.with_advisory_lock(lock_name) do
-        Tag.advisory_lock_exists?(expected_lock_name).must_equal true
+        Tag.advisory_lock_exists?(lock_name).must_be_true
       end
     end
   end
 
-end if test_lock_exists?
+  describe "0 timeout" do
+    it 'attempts the lock exactly once with no timeout' do
+      block_was_yielded = false
+      Tag.with_advisory_lock(lock_name, 0) do
+        block_was_yielded = true
+      end
+      block_was_yielded.must_be_true
+    end
+  end
+end

data/test/minitest_helper.rb

@@ -2,28 +2,31 @@ require 'erb'
 require 'active_record'
 require 'with_advisory_lock'
 require 'tmpdir'
+require 'securerandom'
 
 db_config = File.expand_path("database.yml", File.dirname(__FILE__))
 ActiveRecord::Base.configurations = YAML::load(ERB.new(IO.read(db_config)).result)
 
 def env_db
-  ENV["DB"] || "mysql"
+  (ENV["DB"] || :mysql).to_sym
 end
 
+ENV["WITH_ADVISORY_LOCK_PREFIX"] ||= SecureRandom.base64
+
 ActiveRecord::Base.establish_connection(env_db)
 ActiveRecord::Migration.verbose = false
 
 require 'test_models'
+begin
+  require 'minitest'
+rescue LoadError => rails_four_zero_is_lame
+end
 require 'minitest/autorun'
 require 'minitest/great_expectations'
 require 'mocha/setup'
 
 Thread.abort_on_exception = true
 
-def test_lock_exists?
-  %w{mysql postgres}.include? env_db
-end
-
 class MiniTest::Spec
   before do
     ENV['FLOCK_DIR'] = Dir.mktmpdir

data/test/nesting_test.rb

@@ -26,7 +26,7 @@ describe "lock nesting" do
   end
 
   it "raises errors with MySQL when acquiring nested lock" do
-    skip unless env_db == 'mysql'
+    skip unless env_db == :mysql
     exc = proc {
       Tag.with_advisory_lock("first") do
         Tag.with_advisory_lock("second") do
@@ -37,7 +37,7 @@ describe "lock nesting" do
   end
 
   it "supports nested advisory locks with !MySQL" do
-    skip if env_db == 'mysql'
+    skip if env_db == :mysql
     impl = WithAdvisoryLock::Base.new(nil, nil, nil)
     impl.lock_stack.must_be_empty
     Tag.with_advisory_lock("first") do

data/test/parallelism_test.rb

@@ -1,97 +1,115 @@
 require 'minitest_helper'
 
-parallelism_is_broken = begin
-  # Rails < 3.2 has known bugs with parallelism
-  (ActiveRecord::VERSION::MAJOR <= 3 && ActiveRecord::VERSION::MINOR < 2) ||
-    # SQLite doesn't support parallel writes
-    ENV["DB"] =~ /sqlite/
-end
-
 describe "parallelism" do
-  def find_or_create_at(run_at, with_advisory_lock)
-    ActiveRecord::Base.connection.reconnect!
-    sleep(run_at - Time.now.to_f)
-    name = run_at.to_s
-    task = lambda do
+  class FindOrCreateWorker
+    def initialize(target, run_at, name, use_advisory_lock)
+      @thread = Thread.new do
+        ActiveRecord::Base.connection_pool.with_connection do
+          sleep((run_at - Time.now).to_f)
+          if use_advisory_lock
+            Tag.with_advisory_lock(name) { work(name) }
+          else
+            work(name)
+          end
+        end
+      end
+    end
+
+    def work(name)
       Tag.transaction do
-        Tag.find_by_name(name) || Tag.create(:name => name)
+        Tag.where(name: name).first_or_create
       end
     end
-    if with_advisory_lock
-      Tag.with_advisory_lock(name, nil, &task)
-    else
-      task.call
+
+    def join
+      @thread.join
     end
-    ActiveRecord::Base.connection.close if ActiveRecord::Base.connection.respond_to?(:close)
   end
 
-  def run_workers(with_advisory_lock)
-    skip if env_db == "sqlite"
-    @iterations.times do
-      time = (Time.now.to_i + 4).to_f
-      threads = @workers.times.collect do
-        Thread.new do
-          find_or_create_at(time, with_advisory_lock)
-        end
+  def run_workers
+    all_workers = []
+    @names = @iterations.times.map { |iter| "iteration ##{iter}" }
+    @names.each do |name|
+      wake_time = 1.second.from_now
+      workers = @workers.times.map do
+        FindOrCreateWorker.new(@target, wake_time, name, @use_advisory_lock)
       end
-      threads.each { |ea| ea.join }
+      workers.each(&:join)
+      all_workers += workers
     end
-    puts "Created #{Tag.all.size} (lock = #{with_advisory_lock})"
+    # Ensure we're still connected:
+    ActiveRecord::Base.connection_pool.connection
+    all_workers
   end
 
   before :each do
-    @iterations = 5
-    @workers = 5
+    ActiveRecord::Base.connection.reconnect!
+    @workers = 10
   end
 
-  it "parallel threads create multiple duplicate rows" do
-    run_workers(with_advisory_lock = false)
+  it "creates multiple duplicate rows without advisory locks" do
+    @use_advisory_lock = false
+    @iterations = 1
+    run_workers
     Tag.all.size.must_be :>, @iterations # <- any duplicated rows will make me happy.
     TagAudit.all.size.must_be :>, @iterations # <- any duplicated rows will make me happy.
     Label.all.size.must_be :>, @iterations # <- any duplicated rows will make me happy.
-  end
+  end unless env_db == :sqlite
 
-  it "parallel threads with_advisory_lock don't create multiple duplicate rows" do
-    run_workers(with_advisory_lock = true)
+  it "doesn't create multiple duplicate rows with advisory locks" do
+    @use_advisory_lock = true
+    @iterations = 10
+    run_workers
     Tag.all.size.must_equal @iterations # <- any duplicated rows will NOT make me happy.
     TagAudit.all.size.must_equal @iterations # <- any duplicated rows will NOT make me happy.
     Label.all.size.must_equal @iterations # <- any duplicated rows will NOT make me happy.
   end
+end
 
-  it "returns false if the lock wasn't acquirable" do
-    t1_acquired_lock = false
-    t1_return_value = nil
-    t1 = Thread.new do
-      ActiveRecord::Base.connection.reconnect!
-      t1_return_value = Label.with_advisory_lock("testing 1,2,3") do
-        t1_acquired_lock = true
-        sleep(0.3)
-        "boom"
+describe "separate thread tests" do
+  let(:lock_name) { "testing 1,2,3" }
+
+  before do
+    @t1_acquired_lock = false
+    @t1_return_value = nil
+
+    @t1 = Thread.new do
+      ActiveRecord::Base.connection_pool.with_connection do
+        @t1_return_value = Label.with_advisory_lock(lock_name) do
+          t1_acquired_lock = true
+          sleep(0.4)
+          't1 finished'
+        end
       end
     end
 
-    # Make sure the lock is acquired:
+    # Wait for the thread to acquire the lock:
     sleep(0.1)
+    ActiveRecord::Base.connection.reconnect!
+  end
 
-    # Now try to acquire the lock impatiently:
-    t2_acquired_lock = false
-    t2_return_value = nil
-    t2 = Thread.new do
-      ActiveRecord::Base.connection.reconnect!
-      t2_return_value = Label.with_advisory_lock("testing 1,2,3", 0.1) do
-        t2_acquired_lock = true
-        "not expected"
-      end
-    end
+  after do
+    @t1.join
+  end
+
+  it "#with_advisory_lock with a 0 timeout returns false immediately" do
+    response = Label.with_advisory_lock(lock_name, 0) {}
+    response.must_be_false
+  end
 
-    # Wait for them to finish:
-    t1.join
-    t2.join
+  it "#advisory_lock_exists? returns true when another thread has the lock" do
+    Tag.advisory_lock_exists?(lock_name).must_be_true
+  end
 
-    t1_acquired_lock.must_be_true
-    t1_return_value.must_equal "boom"
+  it "can re-establish the lock after the other thread releases it" do
+    @t1.join
+    @t1_return_value.must_equal 't1 finished'
 
-    t2_acquired_lock.must_be_false
-    t2_return_value.must_be_false
+    # We should now be able to acquire the lock immediately:
+    reacquired = false
+    Label.with_advisory_lock(lock_name, 0) do
+      reacquired = true
+    end.must_be_true
+    reacquired.must_be_true
   end
-end unless parallelism_is_broken
+end

data/test/test_models.rb

@@ -12,8 +12,8 @@ end
 
 class Tag < ActiveRecord::Base
   after_save do
-    TagAudit.create { |ea| ea.tag_name = name }
-    Label.create { |ea| ea.name = name }
+    TagAudit.create(tag_name: name)
+    Label.create(name: name)
   end
 end
 

data/tests.sh

@@ -1,10 +1,11 @@
-#!/bin/sh -e
-export BUNDLE_GEMFILE DB
+#!/bin/bash -e
+export DB
 
-for BUNDLE_GEMFILE in ci/Gemfile.rails-4.1.x ci/Gemfile.rails-3.2.x ; do
-  for DB in sqlite mysql postgresql
-  do
-    echo $DB $BUNDLE_GEMFILE `ruby -v`
-    bundle exec rake
+for RUBY in 2.1.2 jruby-1.7.12 ; do
+  rbenv local $RUBY
+  for DB in mysql postgresql sqlite ; do
+    echo "$DB | $(ruby -v)"
+    appraisal bundle update
+    appraisal rake test
   done
 done

data/with_advisory_lock.gemspec

@@ -18,14 +18,12 @@ Gem::Specification.new do |gem|
   gem.test_files    = gem.files.grep(%r{^test/})
   gem.require_paths = %w(lib)
 
-  gem.add_runtime_dependency 'activerecord', '>= 3.0.0'
+  gem.add_runtime_dependency 'activerecord', '>= 3.2'
 
   gem.add_development_dependency 'rake'
   gem.add_development_dependency 'yard'
   gem.add_development_dependency 'minitest'
   gem.add_development_dependency 'minitest-great_expectations'
   gem.add_development_dependency 'mocha'
-  gem.add_development_dependency 'mysql2'
-  gem.add_development_dependency 'pg'
-  gem.add_development_dependency 'sqlite3'
+  gem.add_development_dependency 'appraisal'
 end

metadata

@@ -1,139 +1,111 @@
 --- !ruby/object:Gem::Specification
 name: with_advisory_lock
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 2.0.0
 platform: ruby
 authors:
 - Matthew McEachen
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-01-16 00:00:00.000000000 Z
+date: 2014-07-09 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activerecord
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ! '>='
+    - - ">="
       - !ruby/object:Gem::Version
-        version: 3.0.0
+        version: '3.2'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ! '>='
+    - - ">="
       - !ruby/object:Gem::Version
-        version: 3.0.0
+        version: '3.2'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ! '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ! '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
   name: yard
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ! '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ! '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
   name: minitest
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ! '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ! '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
   name: minitest-great_expectations
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ! '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ! '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
   name: mocha
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ! '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ! '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: mysql2
+  name: appraisal
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ! '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ! '>='
-      - !ruby/object:Gem::Version
-        version: '0'
-- !ruby/object:Gem::Dependency
-  name: pg
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ! '>='
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ! '>='
-      - !ruby/object:Gem::Version
-        version: '0'
-- !ruby/object:Gem::Dependency
-  name: sqlite3
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ! '>='
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ! '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
 description: Advisory locking for ActiveRecord
@@ -143,17 +115,17 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- .gitignore
-- .travis.yml
+- ".gitignore"
+- ".travis.yml"
+- Appraisals
 - Gemfile
 - LICENSE.txt
 - README.md
 - Rakefile
-- ci/Gemfile.rails-3.0.x
-- ci/Gemfile.rails-3.1.x
-- ci/Gemfile.rails-3.2.x
-- ci/Gemfile.rails-4.0.x
-- ci/Gemfile.rails-4.1.x
+- gemfiles/activerecord_3.2.gemfile
+- gemfiles/activerecord_4.0.gemfile
+- gemfiles/activerecord_4.1.gemfile
+- gemfiles/activerecord_edge.gemfile
 - lib/with_advisory_lock.rb
 - lib/with_advisory_lock/base.rb
 - lib/with_advisory_lock/concern.rb
@@ -169,7 +141,6 @@ files:
 - test/minitest_helper.rb
 - test/nesting_test.rb
 - test/parallelism_test.rb
-- test/simple_parallel_test.rb
 - test/test_models.rb
 - tests.sh
 - with_advisory_lock.gemspec
@@ -183,17 +154,17 @@ require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ! '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ! '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.2.0
+rubygems_version: 2.3.0
 signing_key: 
 specification_version: 4
 summary: Advisory locking for ActiveRecord
@@ -204,6 +175,5 @@ test_files:
 - test/minitest_helper.rb
 - test/nesting_test.rb
 - test/parallelism_test.rb
-- test/simple_parallel_test.rb
 - test/test_models.rb
 has_rdoc: 

data/ci/Gemfile.rails-3.0.x

@@ -1,5 +0,0 @@
-source 'https://rubygems.org'
-gemspec :path => '..'
-
-gem 'activerecord', '~> 3.0.0'
-gem 'mysql2', '< 0.3.0' # See https://github.com/brianmario/mysql2/issues/155

data/ci/Gemfile.rails-3.1.x

@@ -1,4 +0,0 @@
-source 'https://rubygems.org'
-gemspec :path => '..'
-
-gem 'activerecord', '~> 3.1.0'

data/ci/Gemfile.rails-3.2.x

@@ -1,4 +0,0 @@
-source 'https://rubygems.org'
-gemspec :path => '..'
-
-gem 'activerecord', '~> 3.2.0'

data/ci/Gemfile.rails-4.0.x

@@ -1,4 +0,0 @@
-source 'https://rubygems.org'
-gemspec :path => '..'
-
-gem 'activerecord', '~> 4.0.0'

data/ci/Gemfile.rails-4.1.x

@@ -1,4 +0,0 @@
-source 'https://rubygems.org'
-gemspec :path => '..'
-
-gem 'activerecord', '~> 4.1.0.beta1'

data/test/simple_parallel_test.rb

@@ -1,37 +0,0 @@
-require 'minitest_helper'
-
-describe "prevents threads from accessing a resource concurrently" do
-  def assert_correct_parallel_behavior(lock_name)
-    times = ActiveSupport::OrderedHash.new
-    ActiveRecord::Base.connection_pool.disconnect!
-    t1 = Thread.new do
-      ActiveRecord::Base.connection.reconnect!
-      ActiveRecord::Base.with_advisory_lock(lock_name) do
-        times[:t1_acquire] = Time.now
-        sleep 0.5
-      end
-      times[:t1_release] = Time.now
-    end
-    sleep 0.1
-    t2 = Thread.new do
-      ActiveRecord::Base.connection.reconnect!
-      ActiveRecord::Base.with_advisory_lock(lock_name) do
-        times[:t2_acquire] = Time.now
-        sleep 1
-      end
-      times[:t2_release] = Time.now
-    end
-    t1.join
-    t2.join
-    times.keys.must_equal [:t1_acquire, :t1_release, :t2_acquire, :t2_release]
-    times[:t2_acquire].must_be :>, times[:t1_release]
-  end
-
-  it "with a string lock name" do
-    assert_correct_parallel_behavior("example lock name")
-  end
-
-  it "with a numeric lock name" do
-    assert_correct_parallel_behavior(1234)
-  end
-end