with_advisory_lock 0.0.8 → 0.0.9

checksums.yaml

@@ -1,15 +1,15 @@
 ---
 !binary "U0hBMQ==":
   metadata.gz: !binary |-
-    YzA3MTE5YzM5MzkwMjJmZjRjOWFhMTc1ZjA0ZGNmNWFlNTE1NjM4MQ==
+    ODk5MWVhZjFhZmQxMzJmZjhhYWUzNTdkYWUxODNkYjM3OTRlZmFkOQ==
   data.tar.gz: !binary |-
-    ZGViZjU2NzczOGYyMTVkZDJjYWRmZjYwMTMwOWQwMDlkNDI1ZDc3Yw==
+    MWI3YWVkNzI0ZDc5YzdkMmE3MDg1NGU5YjkyNjNmYjZiYjU4OWIzYg==
 !binary "U0hBNTEy":
   metadata.gz: !binary |-
-    NDNmYWE3ZmNhZGFlZDU3ODQzMzAyODdlNTAxZjdkZTFkYzk2NDM2N2I0Mjhm
-    YTE0OGM0MmZlNDY1ZWMyN2YzNmZmYTIzOWE5ODRhODFjZmE2MjY5MDNkNmY2
-    Y2M2ZmNhOWVkNGVjNzI3MDczZmVjN2IxZTI0NjcwYmUzYzI2MmE=
+    MzBjOTlmZTVlNWRhZmM4NzMwODliNTFkODNiNDk1OGYzNzlhOWU2YjVhYTBj
+    OWM1M2IwOTljMWE5YTQzOWFjNWQ3M2Y1YWFiMWNjZDk0ZDA3YWRiZWRiYWNm
+    MGFkZTBlOTgxMzcwMWIzNjQyMGIwNzA2NjYxODJlYzJjZTQ3YWQ=
   data.tar.gz: !binary |-
-    NmY4MDdkOTM1NzkxODU1N2NiN2U0N2Q2MTNiYTk0YjU4NGFmZTY2NDA4NjEz
-    MWU5ODZhYTFkYWUwZGE4MmE4ZjZhNWU5ZGY5NDZkYzkxZjA3MGVmODgxOTEz
-    MDM3ZDYwNTk5YTg1NjNkY2M1MWI5MDYxYzkwM2E0MzI2ZjllMzA=
+    MDIwM2Q2YTFlNmI5NjQyMWMwZjRhZjlmZWZiOTU5YzQwN2VjMjZjZjEwMDlm
+    N2FjMzcxY2U1ODgwMWFkZWM3ZDBlMmEwYTgwM2MwOTcyZjUzZjExZjExNWM4
+    ZGYxNDMyMjBhZjQyYTgwZDYyNmM3ZGIxMzkzMjY4ZjM5NGIxMTc=

data/.travis.yml

@@ -2,22 +2,21 @@ language: ruby
 
 rvm:
   - 2.0.0
-  - 1.8.7
+#  - 1.8.7
   - 1.9.3
 
 gemfile:
-# TODO: reenable once tests pass with 4.0
   - ci/Gemfile.rails-4.0.x
   - ci/Gemfile.rails-3.2.x
-  - ci/Gemfile.rails-3.1.x
-  - ci/Gemfile.rails-3.0.x
+#  - ci/Gemfile.rails-3.1.x
+#  - ci/Gemfile.rails-3.0.x
 
 env:
   - DB=sqlite
   - DB=mysql
   - DB=postgresql
 
-script: bundle exec rake
+script: WITH_ADVISORY_LOCK_PREFIX=$TRAVIS_JOB_ID bundle exec rake --trace
 
 before_script:
   - mysql -e 'create database with_advisory_lock_test'

data/README.md

@@ -6,6 +6,8 @@ or [PostgreSQL](http://www.postgresql.org/docs/9.1/static/functions-admin.html#F
 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)
 
 ## What's an "Advisory Lock"?
 
@@ -115,6 +117,16 @@ end
 
 ## Changelog
 
+### 0.0.9
+
+* Merged in Postgis Adapter Support to address [issue 7](https://github.com/mceachen/with_advisory_lock/issues/7)
+  Thanks for the pull request, [Abdelkader Boudih](https://github.com/seuros)!
+* The database switching code had to be duplicated by [Closure Tree](https://github.com/mceachen/closure_tree),
+  so I extracted a new ```WithAdvisoryLock::DatabaseAdapterSupport``` one-trick pony.
+* Builds were failing on Travis, so I introduced a global lock prefix that can be set with the
+  ```WITH_ADVISORY_LOCK_PREFIX``` environment variable. I'm not going to advertise this feature yet.
+  It's a secret. Only you and I know, now. *shhh*
+
 ### 0.0.8
 
 * Addressed [issue 5](https://github.com/mceachen/with_advisory_lock/issues/5) by

data/ci/Gemfile.rails-4.0.x

@@ -2,4 +2,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.rc2'
+gem 'rails', '~> 4.0.0'

data/lib/with_advisory_lock/base.rb

@@ -1,3 +1,5 @@
+require 'zlib'
+
 module WithAdvisoryLock
   class Base
     attr_reader :connection, :lock_name, :timeout_seconds
@@ -5,6 +7,14 @@ 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
 
@@ -28,6 +38,16 @@ module WithAdvisoryLock
       end
     end
 
+    def stable_hashcode(input)
+      if input.is_a? Numeric
+        input.to_i
+      else
+        # Ruby MRI's String#hash is randomly seeded as of Ruby 1.9 so
+        # make sure we use a deterministic hash.
+        Zlib.crc32(input.to_s)
+      end
+    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

data/lib/with_advisory_lock/concern.rb

@@ -1,13 +1,12 @@
 # Tried desperately to monkeypatch the polymorphic connection object,
 # but rails autoloading is too clever by half. Pull requests are welcome.
 
-# Think of this module as a hipster, using "case" ironically.
-
+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'
-require 'with_advisory_lock/flock'
-require 'active_support/concern'
 
 module WithAdvisoryLock
   module Concern
@@ -18,19 +17,18 @@ module WithAdvisoryLock
     end
 
     module ClassMethods
-
       def with_advisory_lock(lock_name, timeout_seconds=nil, &block)
-        impl_class = case (connection.adapter_name.downcase)
-          when "postgresql", "empostgresql"
-            WithAdvisoryLock::PostgreSQL
-          when "mysql", "mysql2"
-            WithAdvisoryLock::MySQL
-          else
-            WithAdvisoryLock::Flock
+        das = WithAdvisoryLock::DatabaseAdapterSupport.new(connection)
+        impl_class = if das.postgresql?
+          WithAdvisoryLock::PostgreSQL
+        elsif das.mysql?
+          WithAdvisoryLock::MySQL
+        else
+          WithAdvisoryLock::Flock
         end
         impl = impl_class.new(connection, lock_name, timeout_seconds)
         impl.with_advisory_lock_if_needed(&block)
       end
     end
   end
-end
+end

data/lib/with_advisory_lock/database_adapter_support.rb

@@ -0,0 +1,19 @@
+module WithAdvisoryLock
+  class DatabaseAdapterSupport
+    def initialize(connection)
+      @sym_name = connection.adapter_name.downcase.to_sym
+    end
+
+    def mysql?
+      [:mysql, :mysql2].include? @sym_name
+    end
+
+    def postgresql?
+      [:postgresql, :empostgresql, :postgis].include? @sym_name
+    end
+
+    def sqlite?
+      :sqlite3 == @sym_name
+    end
+  end
+end

data/lib/with_advisory_lock/flock.rb

@@ -5,8 +5,8 @@ module WithAdvisoryLock
 
     def filename
       @filename ||= begin
-        safe = @lock_name.gsub(/[^a-z0-9]/i, '')
-        fn = ".lock-#{safe}-#{@lock_name.to_s.hash}"
+        safe = @lock_name.to_s.gsub(/[^a-z0-9]/i, '')
+        fn = ".lock-#{safe}-#{stable_hashcode(@lock_name)}"
         # 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/postgresql.rb

@@ -1,4 +1,3 @@
-require 'zlib'
 
 module WithAdvisoryLock
   class PostgreSQL < Base
@@ -18,15 +17,7 @@ module WithAdvisoryLock
     end
 
     def numeric_lock
-      @numeric_lock ||= begin
-        if lock_name.is_a? Numeric
-          lock_name.to_i
-        else
-          # 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
+      @numeric_lock ||= stable_hashcode(lock_name)
     end
   end
 end

data/lib/with_advisory_lock/version.rb

@@ -1,3 +1,3 @@
 module WithAdvisoryLock
-  VERSION = "0.0.8"
+  VERSION = Gem::Version.new('0.0.9')
 end

data/test/nesting_test.rb

@@ -1,6 +1,15 @@
 require 'minitest_helper'
 
 describe "lock nesting" do
+  before :each do
+    @prior_prefix = ENV['WITH_ADVISORY_LOCK_PREFIX']
+    ENV['WITH_ADVISORY_LOCK_PREFIX'] = nil
+  end
+
+  after :each do
+    ENV['WITH_ADVISORY_LOCK_PREFIX'] = @prior_prefix
+  end
+
   it "doesn't request the same lock twice" do
     impl = WithAdvisoryLock::Base.new(nil, nil, nil)
     impl.lock_stack.must_be_empty
@@ -16,7 +25,7 @@ describe "lock nesting" do
   end
 
   it "raises errors with MySQL when acquiring nested lock" do
-    skip if env_db != 'mysql'
+    skip unless env_db == 'mysql'
     exc = proc {
       Tag.with_advisory_lock("first") do
         Tag.with_advisory_lock("second") do

data/test/{simplest_test.rb → simple_parallel_test.rb}

@@ -1,12 +1,12 @@
 require 'minitest_helper'
 
-describe "simplest" do
-  it "should prevent threads from accessing a resource concurrently" do
+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("simplest test") do
+      ActiveRecord::Base.with_advisory_lock(lock_name) do
         times[:t1_acquire] = Time.now
         sleep 0.5
       end
@@ -15,7 +15,7 @@ describe "simplest" do
     sleep 0.1
     t2 = Thread.new do
       ActiveRecord::Base.connection.reconnect!
-      ActiveRecord::Base.with_advisory_lock("simplest test") do
+      ActiveRecord::Base.with_advisory_lock(lock_name) do
         times[:t2_acquire] = Time.now
         sleep 1
       end
@@ -26,4 +26,12 @@ describe "simplest" do
     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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: with_advisory_lock
 version: !ruby/object:Gem::Version
-  version: 0.0.8
+  version: 0.0.9
 platform: ruby
 authors:
 - Matthew McEachen
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-06-22 00:00:00.000000000 Z
+date: 2013-06-26 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activerecord
@@ -156,6 +156,7 @@ files:
 - lib/with_advisory_lock.rb
 - lib/with_advisory_lock/base.rb
 - lib/with_advisory_lock/concern.rb
+- lib/with_advisory_lock/database_adapter_support.rb
 - lib/with_advisory_lock/flock.rb
 - lib/with_advisory_lock/mysql.rb
 - lib/with_advisory_lock/nested_advisory_lock_error.rb
@@ -166,7 +167,7 @@ files:
 - test/minitest_helper.rb
 - test/nesting_test.rb
 - test/parallelism_test.rb
-- test/simplest_test.rb
+- test/simple_parallel_test.rb
 - test/test_models.rb
 - tests.sh
 - with_advisory_lock.gemspec
@@ -199,6 +200,6 @@ test_files:
 - test/minitest_helper.rb
 - test/nesting_test.rb
 - test/parallelism_test.rb
-- test/simplest_test.rb
+- test/simple_parallel_test.rb
 - test/test_models.rb
 has_rdoc: