with_advisory_lock 4.6.0 → 5.0.0

data/test/test_helper.rb

@@ -0,0 +1,52 @@
+# frozen_string_literal: true
+
+require 'erb'
+require 'active_record'
+require 'with_advisory_lock'
+require 'tmpdir'
+require 'securerandom'
+begin
+  require 'activerecord-trilogy-adapter'
+  ActiveSupport.on_load(:active_record) do
+    require "trilogy_adapter/connection"
+    ActiveRecord::Base.public_send :extend, TrilogyAdapter::Connection
+  end
+rescue LoadError
+  # do nothing
+end
+
+ActiveRecord::Base.configurations = {
+  default_env: {
+    url: ENV.fetch('DATABASE_URL', "sqlite3://#{Dir.tmpdir}/#{SecureRandom.hex}.sqlite3"),
+    properties: { allowPublicKeyRetrieval: true } # for JRuby madness
+  }
+}
+
+ENV['WITH_ADVISORY_LOCK_PREFIX'] ||= SecureRandom.hex
+
+ActiveRecord::Base.establish_connection
+
+def env_db
+  @env_db ||= ActiveRecord::Base.connection_db_config.adapter.to_sym
+end
+
+ActiveRecord::Migration.verbose = false
+
+require 'test_models'
+require 'minitest'
+require 'maxitest/autorun'
+require 'mocha/minitest'
+
+class GemTestCase < ActiveSupport::TestCase
+  setup do
+    ENV['FLOCK_DIR'] = Dir.mktmpdir
+    Tag.delete_all
+    TagAudit.delete_all
+    Label.delete_all
+  end
+  teardown do
+    FileUtils.remove_entry_secure ENV['FLOCK_DIR']
+  end
+end
+
+puts "Testing with #{env_db} database, ActiveRecord #{ActiveRecord.gem_version} and #{RUBY_ENGINE} #{RUBY_ENGINE_VERSION} as #{RUBY_VERSION}"

data/test/test_models.rb

@@ -1,12 +1,14 @@
-ActiveRecord::Schema.define(:version => 0) do
-  create_table "tags", :force => true do |t|
-    t.string "name"
+# frozen_string_literal: true
+
+ActiveRecord::Schema.define(version: 0) do
+  create_table 'tags', force: true do |t|
+    t.string 'name'
   end
-  create_table "tag_audits", :id => false, :force => true do |t|
-    t.string "tag_name"
+  create_table 'tag_audits', id: false, force: true do |t|
+    t.string 'tag_name'
   end
-  create_table "labels", :id => false, :force => true do |t|
-    t.string "name"
+  create_table 'labels', id: false, force: true do |t|
+    t.string 'name'
   end
 end
 

data/test/thread_test.rb

@@ -1,16 +1,17 @@
-require 'minitest_helper'
+# frozen_string_literal: true
 
-describe 'separate thread tests' do
-  let(:lock_name) { 'testing 1,2,3' } # OMG COMMAS
+require 'test_helper'
 
-  before do
+class SeparateThreadTest < GemTestCase
+  setup do
+    @lock_name = 'testing 1,2,3' # OMG COMMAS
     @mutex = Mutex.new
     @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_return_value = Label.with_advisory_lock(@lock_name) do
           @mutex.synchronize { @t1_acquired_lock = true }
           sleep
           't1 finished'
@@ -19,42 +20,42 @@ describe 'separate thread tests' do
     end
 
     # Wait for the thread to acquire the lock:
-    until @mutex.synchronize { @t1_acquired_lock } do
-      sleep(0.1)
-    end
+    sleep(0.1) until @mutex.synchronize { @t1_acquired_lock }
     ActiveRecord::Base.connection.reconnect!
   end
 
-  after do
+  teardown do
     @t1.wakeup if @t1.status == 'sleep'
     @t1.join
   end
 
-  it '#with_advisory_lock with a 0 timeout returns false immediately' do
-    response = Label.with_advisory_lock(lock_name, 0) do
-      fail 'should not be yielded to'
+  test '#with_advisory_lock with a 0 timeout returns false immediately' do
+    response = Label.with_advisory_lock(@lock_name, 0) do
+      raise 'should not be yielded to'
     end
-    response.must_be_false
+    assert_not(response)
   end
 
-  it '#with_advisory_lock yields to the provided block' do
-    @t1_acquired_lock.must_be_true
+  test '#with_advisory_lock yields to the provided block' do
+    assert(@t1_acquired_lock)
   end
 
-  it '#advisory_lock_exists? returns true when another thread has the lock' do
-    Tag.advisory_lock_exists?(lock_name).must_be_true
+  test '#advisory_lock_exists? returns true when another thread has the lock' do
+    assert(Tag.advisory_lock_exists?(@lock_name))
   end
 
-  it 'can re-establish the lock after the other thread releases it' do
+  test 'can re-establish the lock after the other thread releases it' do
     @t1.wakeup
     @t1.join
-    @t1_return_value.must_equal 't1 finished'
+    assert_equal('t1 finished', @t1_return_value)
 
     # We should now be able to acquire the lock immediately:
     reacquired = false
-    Label.with_advisory_lock(lock_name, 0) do
+    lock_result = Label.with_advisory_lock(@lock_name, 0) do
       reacquired = true
-    end.must_be_true
-    reacquired.must_be_true
+    end
+
+    assert(lock_result)
+    assert(reacquired)
   end
 end

data/test/transaction_test.rb

@@ -1,70 +1,68 @@
-require 'minitest_helper'
+# frozen_string_literal: true
 
-describe 'transaction scoping' do
+require 'test_helper'
+
+class TransactionScopingTest < GemTestCase
   def supported?
-    env_db == :postgresql
+    %i[postgresql jdbcpostgresql].include?(env_db)
   end
 
-  describe 'not supported' do
-    before do
-      skip if supported?
-    end
+  test 'raises an error when attempting to use transaction level locks if not supported' do
+    skip if supported?
 
-    it 'raises an error when attempting to use transaction level locks' do
-      Tag.transaction do
-        exception = proc {
-          Tag.with_advisory_lock 'test', transaction: true do
-            raise 'should not get here'
-          end
-        }.must_raise ArgumentError
-        exception.message.must_include 'not supported'
+    Tag.transaction do
+      exception = assert_raises(ArgumentError) do
+        Tag.with_advisory_lock 'test', transaction: true do
+          raise 'should not get here'
+        end
       end
+
+      assert_match(/#{Regexp.escape('not supported')}/, exception.message)
     end
   end
 
-  describe 'supported' do
-    before do
+  class PostgresqlTest < TransactionScopingTest
+    setup do
       skip unless env_db == :postgresql
+      @pg_lock_count = lambda do
+        ActiveRecord::Base.connection.select_value("SELECT COUNT(*) FROM pg_locks WHERE locktype = 'advisory';").to_i
+      end
     end
 
-    def pg_lock_count
-      ActiveRecord::Base.connection.select_value("SELECT COUNT(*) FROM pg_locks WHERE locktype = 'advisory';").to_i
-    end
-
-    specify 'session locks release after the block executes' do
+    test 'session locks release after the block executes' do
       Tag.transaction do
-        pg_lock_count.must_equal 0
+        assert_equal(0, @pg_lock_count.call)
         Tag.with_advisory_lock 'test' do
-          pg_lock_count.must_equal 1
+          assert_equal(1, @pg_lock_count.call)
         end
-        pg_lock_count.must_equal 0
+        assert_equal(0, @pg_lock_count.call)
       end
     end
 
-    specify 'session locks release when transaction fails inside block' do
+    test 'session locks release when transaction fails inside block' do
       Tag.transaction do
-        pg_lock_count.must_equal 0
+        assert_equal(0, @pg_lock_count.call)
 
-        exception = proc {
+        exception = assert_raises(ActiveRecord::StatementInvalid) do
           Tag.with_advisory_lock 'test' do
             Tag.connection.execute 'SELECT 1/0;'
           end
-        }.must_raise ActiveRecord::StatementInvalid
-        exception.message.must_include 'division by zero'
+        end
 
-        pg_lock_count.must_equal 0
+        assert_match(/#{Regexp.escape('division by zero')}/, exception.message)
+        assert_equal(0, @pg_lock_count.call)
       end
     end
 
-    specify 'transaction level locks hold until the transaction completes' do
+    test 'transaction level locks hold until the transaction completes' do
       Tag.transaction do
-        pg_lock_count.must_equal 0
+        assert_equal(0, @pg_lock_count.call)
         Tag.with_advisory_lock 'test', transaction: true do
-          pg_lock_count.must_equal 1
+          assert_equal(1, @pg_lock_count.call)
         end
-        pg_lock_count.must_equal 1
+        assert_equal(1, @pg_lock_count.call)
       end
-      pg_lock_count.must_equal 0
+      assert_equal(0, @pg_lock_count.call)
     end
   end
 end

data/with_advisory_lock.gemspec

@@ -1,29 +1,30 @@
-lib = File.expand_path('../lib', __FILE__)
-$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
-require 'with_advisory_lock/version'
+# frozen_string_literal: true
 
-Gem::Specification.new do |gem|
-  gem.name          = "with_advisory_lock"
-  gem.version       = WithAdvisoryLock::VERSION
-  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.license       = 'MIT'
+require 'English'
+require_relative 'lib/with_advisory_lock/version'
 
-  gem.files         = `git ls-files`.split($/)
-  gem.test_files    = gem.files.grep(%r{^test/})
-  gem.require_paths = %w(lib)
-  gem.required_ruby_version = '>= 2.2.10'
+Gem::Specification.new do |spec|
+  spec.name          = 'with_advisory_lock'
+  spec.version       = WithAdvisoryLock::VERSION
+  spec.authors       = ['Matthew McEachen', 'Abdelkader Boudih']
+  spec.email         = %w[matthew+github@mceachen.org terminale@gmail.com]
+  spec.homepage      = 'https://github.com/ClosureTree/with_advisory_lock'
+  spec.summary       = 'Advisory locking for ActiveRecord'
+  spec.description   = 'Advisory locking for ActiveRecord'
+  spec.license       = 'MIT'
 
-  gem.add_runtime_dependency 'activerecord', '>= 4.2'
+  spec.files         = `git ls-files`.split($INPUT_RECORD_SEPARATOR)
+  spec.test_files    = spec.files.grep(%r{^test/})
+  spec.require_paths = %w[lib]
+  spec.metadata      = { "rubyspecs_mfa_required" => "true" }
+  spec.required_ruby_version = '>= 2.7.0'
+  spec.metadata["yard.run"] = "yri"
 
+  spec.add_runtime_dependency 'activerecord', '>= 6.1'
 
-  gem.add_development_dependency 'yard'
-  gem.add_development_dependency 'minitest'
-  gem.add_development_dependency 'minitest-great_expectations'
-  gem.add_development_dependency 'minitest-reporters'
-  gem.add_development_dependency 'mocha'
-  gem.add_development_dependency 'appraisal'
+  spec.add_development_dependency 'appraisal'
+  spec.add_development_dependency 'maxitest'
+  spec.add_development_dependency 'minitest-reporters'
+  spec.add_development_dependency 'mocha'
+  spec.add_development_dependency 'yard'
 end

metadata

@@ -1,14 +1,15 @@
 --- !ruby/object:Gem::Specification
 name: with_advisory_lock
 version: !ruby/object:Gem::Version
-  version: 4.6.0
+  version: 5.0.0
 platform: ruby
 authors:
 - Matthew McEachen
-autorequire: 
+- Abdelkader Boudih
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2019-09-20 00:00:00.000000000 Z
+date: 2023-10-29 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activerecord
@@ -16,30 +17,16 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '4.2'
+        version: '6.1'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '4.2'
+        version: '6.1'
 - !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
+  name: appraisal
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -53,7 +40,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: minitest-great_expectations
+  name: maxitest
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -95,7 +82,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: appraisal
+  name: yard
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -111,52 +98,50 @@ dependencies:
 description: Advisory locking for ActiveRecord
 email:
 - matthew+github@mceachen.org
+- terminale@gmail.com
 executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- ".github/workflows/ci.yml"
 - ".gitignore"
 - ".tool-versions"
-- ".travis.yml"
 - Appraisals
 - CHANGELOG.md
 - Gemfile
 - LICENSE.txt
 - README.md
 - Rakefile
-- gemfiles/activerecord_4.2.gemfile
-- gemfiles/activerecord_5.0.gemfile
-- gemfiles/activerecord_5.1.gemfile
-- gemfiles/activerecord_5.2.gemfile
-- gemfiles/activerecord_6.0.gemfile
+- gemfiles/activerecord_6.1.gemfile
+- gemfiles/activerecord_7.0.gemfile
+- gemfiles/activerecord_7.1.gemfile
 - 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/failed_to_acquire_lock.rb
 - lib/with_advisory_lock/flock.rb
 - lib/with_advisory_lock/mysql.rb
-- lib/with_advisory_lock/mysql_no_nesting.rb
-- lib/with_advisory_lock/nested_advisory_lock_error.rb
 - lib/with_advisory_lock/postgresql.rb
 - 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/options_test.rb
 - test/parallelism_test.rb
 - test/shared_test.rb
+- test/test_helper.rb
 - test/test_models.rb
 - test/thread_test.rb
 - test/transaction_test.rb
-- tests.sh
 - with_advisory_lock.gemspec
-homepage: https://github.com/mceachen/with_advisory_lock
+homepage: https://github.com/ClosureTree/with_advisory_lock
 licenses:
 - MIT
-metadata: {}
-post_install_message: 
+metadata:
+  rubyspecs_mfa_required: 'true'
+  yard.run: yri
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -164,26 +149,25 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: 2.2.10
+      version: 2.7.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.3
-signing_key: 
+rubygems_version: 3.4.12
+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/options_test.rb
 - test/parallelism_test.rb
 - test/shared_test.rb
+- test/test_helper.rb
 - test/test_models.rb
 - test/thread_test.rb
 - test/transaction_test.rb

data/.travis.yml

@@ -1,38 +0,0 @@
-language: ruby
-
-services:
-  - postgresql
-  - mysql
-
-addons:
-  postgresql: "10"
-
-rvm:
-  - 2.6.4
-  - 2.5.6
-  - 2.4.7
-
-gemfile:
-  - gemfiles/activerecord_6.0.gemfile
-  - gemfiles/activerecord_5.2.gemfile
-  - gemfiles/activerecord_5.1.gemfile
-  - gemfiles/activerecord_5.0.gemfile
-  - gemfiles/activerecord_4.2.gemfile
-
-env:
-  global:
-    - WITH_ADVISORY_LOCK_PREFIX=$TRAVIS_JOB_ID
-  matrix:
-    - DB=postgresql
-    - DB=mysql MYSQL_VERSION=5.7
-    - DB=sqlite
-matrix:
-  exclude:
-    - rvm: 2.4.7
-      gemfile: gemfiles/activerecord_6.0.gemfile
-
-before_install:
-  - mysql -e 'create database with_advisory_lock_test'
-  - psql -c 'create database with_advisory_lock_test' -U postgres
-
-script: bundle exec rake --trace

data/gemfiles/activerecord_4.2.gemfile

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

data/gemfiles/activerecord_5.0.gemfile

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

data/gemfiles/activerecord_5.1.gemfile

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

data/lib/with_advisory_lock/mysql_no_nesting.rb

@@ -1,20 +0,0 @@
-module WithAdvisoryLock
-  # For MySQL < 5.7.5 that does not support nested locks
-  class MySQLNoNesting < MySQL
-    # 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(
-          "MySQL < 5.7.5 doesn't support nested Advisory Locks",
-          lock_stack.dup
-        )
-      end
-      super
-    end
-
-    # MySQL doesn't support nested locks:
-    def already_locked?
-      lock_stack.last == lock_stack_item
-    end
-  end
-end

data/lib/with_advisory_lock/nested_advisory_lock_error.rb

@@ -1,14 +0,0 @@
-module WithAdvisoryLock
-  class NestedAdvisoryLockError < StandardError
-    attr_accessor :lock_stack
-
-    def initialize(msg = nil, lock_stack = nil)
-      super(msg)
-      @lock_stack = lock_stack
-    end
-
-    def to_s
-      super + (lock_stack ? ": lock stack = #{lock_stack}" : '')
-    end
-  end
-end

data/test/database.yml

@@ -1,17 +0,0 @@
-sqlite:
-  adapter: <%= "jdbc" if defined? JRUBY_VERSION %>sqlite3
-  database: test/sqlite.db
-  timeout: 500
-  pool: 50
-postgresql:
-  adapter: postgresql
-  username: postgres
-  database: with_advisory_lock_test
-  min_messages: ERROR
-  pool: 50
-mysql:
-  adapter: mysql2
-  host: localhost
-  username: root
-  database: with_advisory_lock_test
-  pool: 50

data/test/minitest_helper.rb

@@ -1,40 +0,0 @@
-require 'erb'
-require 'active_record'
-require 'with_advisory_lock'
-require 'tmpdir'
-require 'securerandom'
-
-def env_db
-  (ENV['DB'] || :mysql).to_sym
-end
-
-db_config = File.expand_path('database.yml', File.dirname(__FILE__))
-ActiveRecord::Base.configurations = YAML::load(ERB.new(IO.read(db_config)).result)
-
-ENV['WITH_ADVISORY_LOCK_PREFIX'] ||= SecureRandom.hex
-
-ActiveRecord::Base.establish_connection(env_db)
-ActiveRecord::Migration.verbose = false
-
-require 'test_models'
-begin
-  require 'minitest'
-rescue LoadError
-  puts 'Failed to load the minitest gem; built-in version will be used.'
-end
-require 'minitest/autorun'
-require 'minitest/great_expectations'
-require 'mocha/setup'
-
-class MiniTest::Spec
-  before do
-    ENV['FLOCK_DIR'] = Dir.mktmpdir
-    Tag.delete_all
-    TagAudit.delete_all
-    Label.delete_all
-  end
-  after do
-    FileUtils.remove_entry_secure ENV['FLOCK_DIR']
-  end
-end
-