with_advisory_lock 0.0.10 → 0.0.11

checksums.yaml

@@ -1,15 +1,15 @@
 ---
 !binary "U0hBMQ==":
   metadata.gz: !binary |-
-    MjIyODVkMGEwYjYzNmI2YzdjMjcyYjFhZDM2MmY5Mzk1M2QxMWRiYg==
+    MmRkYzNlYTU4Njg0OTk1YmQ1OWI2NjgyNzJmYTRhMmNjMzQyZTM4Mw==
   data.tar.gz: !binary |-
-    MTEyMDI5YzlkZTQ0NmEwMjI3NWZjYmEyYjVlZjMyMzJlOTU3ZGE2OA==
-!binary "U0hBNTEy":
+    MTQyOTQ3MTdmMjRkYzA1NGU4OGI5M2I0NTVkNjg4YjVmMDM3ODMzNw==
+SHA512:
   metadata.gz: !binary |-
-    MjA4YmI5YTFjZDllNjYyM2RiMTJmNjNlZTZkNzFkNDJmMDQwYTViODc3NTE5
-    NDA1YTZiYTI0MzBlMzlkNjIwNWZjZTgxOGZmODIwZjI0NjM4Yzg3MjczY2Q1
-    YTI2MmZlMzNiOWEzMWU2MTgxOWY5ZmYwZWQ5MmE2ZjRjZTlhYjI=
+    N2Y2MzI5MjhmOTllZjgyODhhNjdlNjVlYjI0YTU1MGJlMmEzODgzNWViNGEy
+    NjUwNDVkMmFkZTE5NDY2NzNhYjgyOGE0N2QyNjM0ZWNjYzlhNjI1YTA4ZmQ3
+    MjUzYzc0NGUwYTk0NGNkOTQ5NTUwNmU1MGUxMmJhMjE4MDRlZDI=
   data.tar.gz: !binary |-
-    YWRiYjczMWRhMDdmMTQ3ZDNhODc2ZWNkYzJhNjFjOWViMWZkODA5YzM3OTk1
-    ZGZkNDQwY2Y4MTVlMTk0MWYwNGU1OTI4Y2Y4OWYyMjExOTAyODljODdkMTZm
-    MmI3NTdjY2QwNGU4NGNjNmMzMmFmYTM5ZWNiY2ZkNjBiZTczODY=
+    ODQ2MjkyMWUxNmEwOWE2NTlmMjFiZTE0NTE2ZWEyOTA5NGViMjA3YTE1OTJl
+    YWYwOTNiMGZjODcwY2M0NGVlMmZjYzNiNTMxNmM2YmZmODExZDU1N2VkODcx
+    YjA4MmVjNTk1MTIwYTNjMGE5Njg3MzlkOWQ0OWQwZDJiY2MyYjM=

data/.travis.yml

@@ -6,6 +6,7 @@ rvm:
   - 1.9.3
 
 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

data/README.md

@@ -1,6 +1,6 @@
 # with_advisory_lock
 
-Adds advisory locking (mutexes) to ActiveRecord 3.0, 3.1, 3.2, and 4.0.0 when used with
+Adds advisory locking (mutexes) to ActiveRecord 3.0, 3.1, 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).
 SQLite resorts to file locking.
@@ -9,6 +9,7 @@ SQLite resorts to file locking.
 [![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"?
 
@@ -43,6 +44,16 @@ 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.
 
+### Testing for the current lock status
+
+If you needed to check if the advisory lock is currently being held, you can call
+```Tag.advisory_lock_exists?("foo")```, but realize the lock can be acquired between the time you
+test for the lock, and the time you try to acquire the lock.
+
+If you want to see if the current Thread is holding a lock, you can call ```Tag.current_advisory_lock```
+which will return the name of the current lock. If no lock is currently held,
+```.current_advisory_lock``` returns ```nil```.
+
 ## Installation
 
 Add this line to your application's Gemfile:
@@ -118,6 +129,14 @@ end
 
 ## Changelog
 
+
+### 1.0.0
+
+* Releasing 1.0.0. The interface will be stable.
+* Added ```advisory_lock_exists?```. Thanks, [Sean Devine](https://github.com/barelyknown), for the
+  great pull request!
+* Added Travis test for Rails 4.1
+
 ### 0.0.10
 
 * Explicitly added MIT licensing to the gemspec.

data/ci/Gemfile.rails-4.0.x

@@ -1,5 +1,4 @@
 source 'https://rubygems.org'
 gemspec :path => '..'
 
-# rspec-rails reverts to 2.3.1 (old and broken) unless you fetch the whole rails enchilada:
-gem 'rails', '~> 4.0.0'
+gem 'activerecord', '~> 4.0.0'

data/ci/Gemfile.rails-4.1.x

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

data/lib/with_advisory_lock/base.rb

@@ -22,14 +22,22 @@ module WithAdvisoryLock
       connection.quote(lock_name)
     end
 
-    def lock_stack
+    def self.lock_stack
       Thread.current[:with_advisory_lock_stack] ||= []
     end
 
+    def lock_stack
+      self.class.lock_stack
+    end
+
     def already_locked?
       lock_stack.include? @lock_name
     end
 
+    def advisory_lock_exists?(name)
+      raise NoMethodError, "method must be implemented in implementation subclasses"
+    end
+
     def with_advisory_lock_if_needed
       if already_locked?
         yield

data/lib/with_advisory_lock/concern.rb

@@ -16,8 +16,28 @@ module WithAdvisoryLock
       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
+
     module ClassMethods
       def with_advisory_lock(lock_name, timeout_seconds=nil, &block)
+        impl = impl_class.new(connection, lock_name, timeout_seconds)
+        impl.with_advisory_lock_if_needed(&block)
+      end
+
+      def advisory_lock_exists?(lock_name)
+        impl = impl_class.new(connection, lock_name, nil)
+        impl.advisory_lock_exists?(lock_name)
+      end
+
+      def current_advisory_lock
+        WithAdvisoryLock::Base.lock_stack.first
+      end
+
+    private
+
+      def impl_class
         das = WithAdvisoryLock::DatabaseAdapterSupport.new(connection)
         impl_class = if das.postgresql?
           WithAdvisoryLock::PostgreSQL
@@ -26,8 +46,6 @@ module WithAdvisoryLock
         else
           WithAdvisoryLock::Flock
         end
-        impl = impl_class.new(connection, lock_name, timeout_seconds)
-        impl.with_advisory_lock_if_needed(&block)
       end
     end
   end

data/lib/with_advisory_lock/mysql.rb

@@ -32,5 +32,12 @@ module WithAdvisoryLock
     def already_locked?
       lock_stack.last == @lock_name
     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?
+    end
   end
 end

data/lib/with_advisory_lock/postgresql.rb

@@ -16,8 +16,14 @@ module WithAdvisoryLock
       "t" == connection.select_value(sql).to_s
     end
 
-    def numeric_lock
-      @numeric_lock ||= stable_hashcode(lock_name)
+    def numeric_lock(name=lock_name)
+      stable_hashcode(name)
     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('0.0.10')
+  VERSION = Gem::Version.new('0.0.11')
 end

data/test/concern_test.rb

@@ -8,4 +8,13 @@ describe "with_advisory_lock.concern" do
   it "adds with_advisory_lock to ActiveRecord instances" do
     assert Label.new.respond_to?(:with_advisory_lock)
   end
+
+  it "adds advisory_lock_exists? to ActiveRecord classes" do
+    assert Tag.respond_to?(:advisory_lock_exists?)
+  end
+
+  it "adds advisory_lock_exists? to ActiveRecord classes" do
+    assert Label.new.respond_to?(:advisory_lock_exists?)
+  end
+
 end

data/test/lock_test.rb

@@ -0,0 +1,32 @@
+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
+      Tag.current_advisory_lock.must_be_nil
+    end
+
+    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
+      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
+    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
+      end
+    end
+  end
+
+end if test_lock_exists?

data/test/minitest_helper.rb

@@ -20,6 +20,10 @@ 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

@@ -1,6 +1,7 @@
 require 'minitest_helper'
 
 describe "lock nesting" do
+  # This simplifies what we expect from the lock name:
   before :each do
     @prior_prefix = ENV['WITH_ADVISORY_LOCK_PREFIX']
     ENV['WITH_ADVISORY_LOCK_PREFIX'] = nil

data/tests.sh

@@ -1,14 +1,10 @@
 #!/bin/sh -e
-export BUNDLE_GEMFILE RMI DB
+export BUNDLE_GEMFILE DB
 
-for RMI in ree-1.8.7-2011.03 1.9.3-p327 ; do
-  for BUNDLE_GEMFILE in ci/Gemfile.rails-3.0.x ci/Gemfile.rails-3.1.x ci/Gemfile.rails-3.2.x ; do
-    rbenv local $RMI
-    bundle --quiet
-    for DB in sqlite mysql postgresql
-    do
-      echo $DB $BUNDLE_GEMFILE `ruby -v`
-      bundle exec rake
-    done
+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
   done
 done

data/with_advisory_lock.gemspec

@@ -6,12 +6,12 @@ require 'with_advisory_lock/version'
 Gem::Specification.new do |gem|
   gem.name          = "with_advisory_lock"
   gem.version       = WithAdvisoryLock::VERSION
-  gem.authors       = ["Matthew McEachen"]
-  gem.email         = ["matthew+github@mceachen.org"]
+  gem.authors       = ['Matthew McEachen']
+  gem.email         = %w(matthew+github@mceachen.org)
+  gem.homepage      = 'https://github.com/mceachen/with_advisory_lock'
+  gem.summary       = %q{Advisory locking for ActiveRecord}
   gem.description   = %q{Advisory locking for ActiveRecord}
-  gem.summary       = gem.description
   gem.license       = 'MIT'
-  gem.homepage      = ""
 
   gem.files         = `git ls-files`.split($/)
   gem.executables   = gem.files.grep(%r{^bin/}).map{ |f| File.basename(f) }

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: with_advisory_lock
 version: !ruby/object:Gem::Version
-  version: 0.0.10
+  version: 0.0.11
 platform: ruby
 authors:
 - Matthew McEachen
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-07-14 00:00:00.000000000 Z
+date: 2014-01-16 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activerecord
@@ -153,6 +153,7 @@ files:
 - ci/Gemfile.rails-3.1.x
 - ci/Gemfile.rails-3.2.x
 - ci/Gemfile.rails-4.0.x
+- ci/Gemfile.rails-4.1.x
 - lib/with_advisory_lock.rb
 - lib/with_advisory_lock/base.rb
 - lib/with_advisory_lock/concern.rb
@@ -164,6 +165,7 @@ files:
 - lib/with_advisory_lock/version.rb
 - test/concern_test.rb
 - test/database.yml
+- test/lock_test.rb
 - test/minitest_helper.rb
 - test/nesting_test.rb
 - test/parallelism_test.rb
@@ -171,7 +173,7 @@ files:
 - test/test_models.rb
 - tests.sh
 - with_advisory_lock.gemspec
-homepage: ''
+homepage: https://github.com/mceachen/with_advisory_lock
 licenses:
 - MIT
 metadata: {}
@@ -191,13 +193,14 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.0.3
+rubygems_version: 2.2.0
 signing_key: 
 specification_version: 4
 summary: Advisory locking for ActiveRecord
 test_files:
 - test/concern_test.rb
 - test/database.yml
+- test/lock_test.rb
 - test/minitest_helper.rb
 - test/nesting_test.rb
 - test/parallelism_test.rb