with_advisory_lock 5.0.0 → 5.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 784812e261b5a57a5d3da8c878e536949245b29372b40b2baf15a52d7c65b854
-  data.tar.gz: ba2f6fc8bf78c89d56635c4f56500117f79a443404d3574d8b54b2a45d1811de
+  metadata.gz: d65989d7502660ac5cbebd51a589fc49fb76bbeae5abb13814cb79a711fdaae8
+  data.tar.gz: 2eea1e741e2fdb100d3170ddce8c38b1d0fc59dc98f6340be51d6d5bde0591a4
 SHA512:
-  metadata.gz: bb7dc11c1f206639943daa363a4d917bfe93792e7db764c7860ef68151e99defaa03f58640fae0480b566e3d4a0697695f5b60ae8af09838bb176979c328d8ae
-  data.tar.gz: 10132a0c47ed8070a0661a7b6ae0409be76ef14693be65c12a8e8cdd9c5a506ba25c60bda264f7c60bd92952e4cd4c5513a5e566a3e0d757f0ab6fc4311ffcd5
+  metadata.gz: 8358a8783df5bcf9bd49507fc6e59d56aeaec8febd3978a4f9178950c88b254ec76925e3caa9f9f2ee18d7bc15d186512b3790dd1ba602a38fa6d1a877570887
+  data.tar.gz: d179cc20743f15a671ad822fd21e04e808336382d2eed318439e7b9c5ae9283ff4abf0576e5b0c274946863033f403d27280dfec84b3e3e4ff20f832ca62bcb5

data/.github/workflows/ci-mysql5.yml

@@ -0,0 +1,61 @@
+name: CI Mysql 5.7
+on:
+  pull_request:
+    branches:
+      - master
+concurrency:
+  group: ci-mysql5-${{ github.head_ref }}
+  cancel-in-progress: true
+
+jobs:
+  minitest:
+    runs-on: ubuntu-latest
+    name: CI Mysql 5.7 Ruby ${{ matrix.ruby }} / Rails ${{ matrix.rails }} / Adapter ${{ matrix.adapter }}
+    services:
+      mysql:
+        image: mysql/mysql-server:5.7
+        ports:
+          - 3306
+        env:
+          MYSQL_USER: with_advisory
+          MYSQL_PASSWORD: with_advisory_pass
+          MYSQL_DATABASE: with_advisory_lock_test
+          MYSQL_ROOT_HOST: '%'
+    strategy:
+      fail-fast: false
+      matrix:
+        ruby:
+#          - '3.2'
+#          - '3.1'
+#          - '3.0'
+#          - '2.7'
+          - '3.3'
+          - 'truffleruby'
+        rails:
+          - 7.1
+          - "7.0"
+          - 6.1
+        adapter:
+          - mysql2
+          - trilogy
+        include:
+          - ruby: jruby
+            rails: 6.1
+            adapter: jdbcmysql
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v4
+      - name: Setup Ruby
+        uses: ruby/setup-ruby@v1
+        with:
+          ruby-version: ${{ matrix.ruby }}
+          bundler-cache: true
+          rubygems: latest
+        env:
+          BUNDLE_GEMFILE:  gemfiles/activerecord_${{ matrix.rails }}.gemfile
+      - name: Test
+        env:
+          BUNDLE_GEMFILE: gemfiles/activerecord_${{ matrix.rails }}.gemfile
+          DATABASE_URL: ${{ matrix.adapter }}://with_advisory:with_advisory_pass@0:${{ job.services.mysql.ports[3306] }}/with_advisory_lock_test
+          WITH_ADVISORY_LOCK_PREFIX: ${{ github.run_id }}
+        run: bundle exec rake

data/.github/workflows/ci-mysql8.yml

@@ -0,0 +1,62 @@
+name: CI Mysql 8.0
+on:
+  pull_request:
+    branches:
+      - master
+
+concurrency:
+  group: ci-mysql8-${{ github.head_ref }}
+  cancel-in-progress: true
+
+jobs:
+  minitest:
+    runs-on: ubuntu-latest
+    name: CI Mysql 8.0 Ruby ${{ matrix.ruby }} / Rails ${{ matrix.rails }} / Adapter ${{ matrix.adapter }}
+    services:
+      mysql:
+        image: mysql/mysql-server
+        ports:
+          - 3306
+        env:
+          MYSQL_USER: with_advisory
+          MYSQL_PASSWORD: with_advisory_pass
+          MYSQL_DATABASE: with_advisory_lock_test
+          MYSQL_ROOT_HOST: '%'
+    strategy:
+      fail-fast: false
+      matrix:
+        ruby:
+#          - '3.2'
+#          - '3.1'
+#          - '3.0'
+#          - '2.7'
+          - '3.3'
+          - 'truffleruby'
+        rails:
+          - 7.1
+          - "7.0"
+          - 6.1
+        adapter:
+          - mysql2
+#          - trilogy://with_advisory:with_advisory_pass@0/with_advisory_lock_test  Trilogy is not supported by mysql 8 with new encryption
+        include:
+          - ruby: jruby
+            rails: 6.1
+            adapter: jdbcmysql
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v4
+      - name: Setup Ruby
+        uses: ruby/setup-ruby@v1
+        with:
+          ruby-version: ${{ matrix.ruby }}
+          bundler-cache: true
+          rubygems: latest
+        env:
+          BUNDLE_GEMFILE:  gemfiles/activerecord_${{ matrix.rails }}.gemfile
+      - name: Test
+        env:
+          BUNDLE_GEMFILE: gemfiles/activerecord_${{ matrix.rails }}.gemfile
+          DATABASE_URL: ${{ matrix.adapter }}://with_advisory:with_advisory_pass@0:${{ job.services.mysql.ports[3306] }}/with_advisory_lock_test
+          WITH_ADVISORY_LOCK_PREFIX: ${{ github.run_id }}
+        run: bundle exec rake

data/.github/workflows/ci-postgresql.yml

@@ -0,0 +1,64 @@
+name: CI Postgresql
+on:
+  pull_request:
+    branches:
+      - master
+concurrency:
+    group: ci-postgresql-${{ github.head_ref }}
+    cancel-in-progress: true
+
+jobs:
+  minitest:
+    runs-on: ubuntu-latest
+    name: CI Postgresql Ruby ${{ matrix.ruby }} / Rails ${{ matrix.rails }} / Adapter ${{ matrix.adapter }}
+    services:
+      postgres:
+        image: 'postgres:16-alpine'
+        ports:
+         - '5432'
+        env:
+          POSTGRES_USER: with_advisory
+          POSTGRES_PASSWORD: with_advisory_pass
+          POSTGRES_DB: with_advisory_lock_test
+        options: >-
+          --health-cmd pg_isready
+          --health-interval 10s
+          --health-timeout 5s
+          --health-retries 5
+    strategy:
+      fail-fast: false
+      matrix:
+        ruby:
+#          - '3.2'
+#          - '3.1'
+#          - '3.0'
+#          - '2.7'
+          - '3.3'
+          - 'truffleruby'
+        rails:
+          - 7.1
+          - "7.0"
+          - 6.1
+        adapter:
+          - postgres
+        include:
+          - ruby: jruby
+            rails: 6.1
+            adapter: jdbcpostgresql
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v4
+      - name: Setup Ruby
+        uses: ruby/setup-ruby@v1
+        with:
+          ruby-version: ${{ matrix.ruby }}
+          bundler-cache: true
+          rubygems: latest
+        env:
+          BUNDLE_GEMFILE:  gemfiles/activerecord_${{ matrix.rails }}.gemfile
+      - name: Test
+        env:
+          BUNDLE_GEMFILE:  gemfiles/activerecord_${{ matrix.rails }}.gemfile
+          DATABASE_URL: ${{ matrix.adapter }}://with_advisory:with_advisory_pass@localhost:${{ job.services.postgres.ports[5432] }}/with_advisory_lock_test
+          WITH_ADVISORY_LOCK_PREFIX: ${{ github.run_id }}
+        run: bundle exec rake

data/.github/workflows/ci-sqlite3.yml

@@ -0,0 +1,54 @@
+name: CI Sqlite3
+
+on:
+  pull_request:
+    branches:
+      - master
+
+concurrency:
+  group: ci-sqlite3-${{ github.head_ref }}
+  cancel-in-progress: true
+
+jobs:
+  minitest:
+    runs-on: ubuntu-latest
+    name: CI Sqlite3 Ruby ${{ matrix.ruby }} / Rails ${{ matrix.rails }} / Adapter ${{ matrix.adapter }}
+    strategy:
+      fail-fast: false
+      matrix:
+        ruby:
+#          - '3.2'
+#          - '3.1'
+#          - '3.0'
+#          - '2.7'
+          - '3.3'
+          - 'truffleruby'
+        rails:
+          - 7.1
+          - "7.0"
+          - 6.1
+        adapter:
+          - sqlite3
+        include:
+          - ruby: jruby
+            rails: 6.1
+            adapter: jdbcsqlite3
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v4
+
+      - name: Setup Ruby
+        uses: ruby/setup-ruby@v1
+        with:
+          ruby-version: ${{ matrix.ruby }}
+          bundler-cache: true
+          rubygems: latest
+        env:
+          BUNDLE_GEMFILE: gemfiles/activerecord_${{ matrix.rails }}.gemfile
+
+      - name: Test
+        env:
+          BUNDLE_GEMFILE: gemfiles/activerecord_${{ matrix.rails }}.gemfile
+          DATABASE_URL: ${{ matrix.adapter }}:///tmp/test.sqlite3
+          WITH_ADVISORY_LOCK_PREFIX: ${{ github.run_id }}
+        run: bundle exec rake

data/.github/workflows/release.yml

@@ -0,0 +1,17 @@
+name: release-please
+
+on:
+  push:
+    branches:
+      - master
+  workflow_dispatch:
+
+permissions:
+  contents: write
+  pull-requests: write
+
+jobs:
+  release-please:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: googleapis/release-please-action@v4

data/.release-please-manifest.json

@@ -0,0 +1 @@
+{".":"5.3.0"}

data/.ruby-version

@@ -0,0 +1,2 @@
+3.4.4
+

data/.tool-versions

@@ -1 +1 @@
-ruby 3.0.5
+ruby 3.4.4

data/CHANGELOG.md

@@ -1,5 +1,46 @@
 ## Changelog
 
+## [5.3.0](https://github.com/ClosureTree/with_advisory_lock/compare/with_advisory_lock/v5.2.0...with_advisory_lock/v5.3.0) (2025-04-25)
+
+
+### Features
+
+* add #current_advisory_locks method ([#111](https://github.com/ClosureTree/with_advisory_lock/issues/111)) ([ccbd3b2](https://github.com/ClosureTree/with_advisory_lock/commit/ccbd3b23465f7fa1fc3800334159986c31d5c351))
+
+## [5.2.0](https://github.com/ClosureTree/with_advisory_lock/compare/with_advisory_lock/v5.1.0...with_advisory_lock/v5.2.0) (2025-04-24)
+
+
+### Features
+
+* use current connnection instead of the one in ActiveRecord::Base ([#90](https://github.com/ClosureTree/with_advisory_lock/issues/90)) ([c28a172](https://github.com/ClosureTree/with_advisory_lock/commit/c28a172a5a64594448b6090501fc0b8cbace06f6))
+
+
+### Bug Fixes
+
+* Removed MySQL unused lock variable and broaden SQLite detection. ([#94](https://github.com/ClosureTree/with_advisory_lock/issues/94)) ([f818a18](https://github.com/ClosureTree/with_advisory_lock/commit/f818a181dde6711c8439c4cbf67c4525a09d346e))
+
+## [5.1.0](https://github.com/ClosureTree/with_advisory_lock/compare/with_advisory_lock/v5.0.1...with_advisory_lock/v5.1.0) (2024-01-21)
+
+
+### Features
+
+* use zeitwerk loader instead of ActiveSupport::Autoload ([b5082fd](https://github.com/ClosureTree/with_advisory_lock/commit/b5082fddacacacff48139f5bf509601a37945a0e))
+
+## 5.0.1 (2024-01-21)
+
+
+### Features
+
+* add release workflow ([5d32520](https://github.com/ClosureTree/with_advisory_lock/commit/5d325201c82974991381a9fbc4d1714c9739dc4f))
+* add ruby 3.1 test/support ([#60](https://github.com/ClosureTree/with_advisory_lock/issues/60)) ([514f042](https://github.com/ClosureTree/with_advisory_lock/commit/514f0420d957ef30911a00d54685385bec5867c3))
+* Add testing for activerecord 7.1 and support for trilogy adapter ([#77](https://github.com/ClosureTree/with_advisory_lock/issues/77)) ([69c23fe](https://github.com/ClosureTree/with_advisory_lock/commit/69c23fe09887fc5d97ac7b0194825c21efe244a5))
+* add truffleruby support ([#62](https://github.com/ClosureTree/with_advisory_lock/issues/62)) ([ec34bd4](https://github.com/ClosureTree/with_advisory_lock/commit/ec34bd448e3505e5df631daaf47bb83f2f5316dc))
+
+
+### Bug Fixes
+
+* User may sometimes pass in non-strings, such as integers ([#55](https://github.com/ClosureTree/with_advisory_lock/issues/55)) ([9885597](https://github.com/ClosureTree/with_advisory_lock/commit/988559747363ef00958fcf782317e76c40ffa2a3))
+
 ### 5.0.0
 - Drop support for EOL rubies and activerecord (ruby below 2.7 and activerecord below 6.1).
 - Allow lock name to be integer

data/LICENSE.txt

@@ -1,6 +1,6 @@
-Copyright (c) 2013 Matthew McEachen
-
-MIT License
+SPDX-License-Identifier: MIT
+SPDX-FileCopyrightText: 2013 Matthew McEachen 
+SPDX-FileCopyrightText: 2013-2025 Abdelkader Boudih
 
 Permission is hereby granted, free of charge, to any person obtaining
 a copy of this software and associated documentation files (the
@@ -19,4 +19,4 @@ MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
 NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
 LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
 OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
-WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/Makefile

@@ -0,0 +1,14 @@
+.PHONY: test-pg test-mysql
+
+test-pg:
+	docker compose up -d pg
+	sleep 10 # give some time for the service to start
+	DATABASE_URL=postgres://with_advisory:with_advisory_pass@localhost/with_advisory_lock_test appraisal rake test
+
+test-mysql:
+	docker compose up -d mysql
+	sleep 10 # give some time for the service to start
+	DATABASE_URL=mysql2://with_advisory:with_advisory_pass@0.0.0.0:3306/with_advisory_lock_test appraisal rake test
+
+
+test: test-pg test-mysql

data/docker-compose.yml

@@ -0,0 +1,20 @@
+version: "3.9"
+services:
+  pg:
+    image: postgres:16
+    environment:
+      POSTGRES_USER: with_advisory
+      POSTGRES_PASSWORD: with_advisory_pass
+      POSTGRES_DB: with_advisory_lock_test
+    ports:
+      - "5432:5432"
+  mysql:
+    image: mysql:8
+    environment:
+      MYSQL_USER: with_advisory
+      MYSQL_PASSWORD: with_advisory_pass
+      MYSQL_DATABASE: with_advisory_lock_test
+      MYSQL_RANDOM_ROOT_PASSWORD: "yes"
+      MYSQL_ROOT_HOST: '%'
+    ports:
+      - "3306:3306"

data/lib/with_advisory_lock/base.rb

@@ -36,7 +36,7 @@ module WithAdvisoryLock
     end
 
     def lock_str
-      @lock_str ||= "#{ENV['WITH_ADVISORY_LOCK_PREFIX']}#{lock_name}"
+      @lock_str ||= "#{ENV[LOCK_PREFIX_ENV]}#{lock_name}"
     end
 
     def lock_stack_item
@@ -56,7 +56,7 @@ module WithAdvisoryLock
     def with_advisory_lock_if_needed(&block)
       if disable_query_cache
         return lock_and_yield do
-          ActiveRecord::Base.uncached(&block)
+          connection.uncached(&block)
         end
       end
 
@@ -79,7 +79,7 @@ module WithAdvisoryLock
       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)
+        Zlib.crc32(input.to_s, 0)
       end
     end
 

data/lib/with_advisory_lock/concern.rb

@@ -1,7 +1,5 @@
 # frozen_string_literal: true
 
-require 'active_support/concern'
-
 module WithAdvisoryLock
   module Concern
     extend ActiveSupport::Concern
@@ -15,9 +13,7 @@ module WithAdvisoryLock
 
       def with_advisory_lock!(lock_name, options = {}, &block)
         result = with_advisory_lock_result(lock_name, options, &block)
-        unless result.lock_was_acquired?
-          raise WithAdvisoryLock::FailedToAcquireLock, lock_name
-        end
+        raise WithAdvisoryLock::FailedToAcquireLock, lock_name unless result.lock_was_acquired?
 
         result.result
       end
@@ -37,6 +33,10 @@ module WithAdvisoryLock
         lock_stack_key && lock_stack_key[0]
       end
 
+      def current_advisory_locks
+        WithAdvisoryLock::Base.lock_stack.map(&:name)
+      end
+
       private
 
       def impl_class

data/lib/with_advisory_lock/database_adapter_support.rb

@@ -2,25 +2,22 @@
 
 module WithAdvisoryLock
   class DatabaseAdapterSupport
-    # Caches nested lock support by MySQL reported version
-    @@mysql_nl_cache       = {}
-    @@mysql_nl_cache_mutex = Mutex.new
-
+    attr_reader :adapter_name
     def initialize(connection)
       @connection = connection
-      @sym_name   = connection.adapter_name.downcase.to_sym
+      @adapter_name   = connection.adapter_name.downcase.to_sym
     end
 
     def mysql?
-      %i[mysql2 trilogy].include? @sym_name
+      %i[mysql2 trilogy].include? adapter_name
     end
 
     def postgresql?
-      %i[postgresql empostgresql postgis].include? @sym_name
+      %i[postgresql empostgresql postgis].include? adapter_name
     end
 
     def sqlite?
-      @sym_name == :sqlite3
+      [:sqlite3, :sqlite].include? adapter_name
     end
   end
 end

data/lib/with_advisory_lock/failed_to_acquire_lock.rb

@@ -1,7 +1,9 @@
+# frozen_string_literal: true
+
 module WithAdvisoryLock
   class FailedToAcquireLock < StandardError
     def initialize(lock_name)
       super("Failed to acquire lock #{lock_name}")
     end
   end
-end
+end

data/lib/with_advisory_lock/mysql.rb

@@ -2,7 +2,8 @@
 
 module WithAdvisoryLock
   class MySQL < Base
-    # See https://dev.mysql.com/doc/refman/5.7/en/miscellaneous-functions.html#function_get-lock
+    # See https://dev.mysql.com/doc/refman/5.7/en/locking-functions.html
+    # See https://dev.mysql.com/doc/refman/8.0/en/locking-functions.html
     def try_lock
       raise ArgumentError, 'shared locks are not supported on MySQL' if shared
       raise ArgumentError, 'transaction level locks are not supported on MySQL' if transaction
@@ -15,8 +16,12 @@ module WithAdvisoryLock
     end
 
     def execute_successful?(mysql_function)
-      sql = "SELECT #{mysql_function} AS #{unique_column_name}"
-      connection.select_value(sql).to_i.positive?
+      execute_query(mysql_function) == 1
+    end
+
+    def execute_query(mysql_function)
+      sql = "SELECT #{mysql_function}"
+      connection.query_value(sql)
     end
 
     # MySQL wants a string as the lock key.

data/lib/with_advisory_lock/postgresql.rb

@@ -2,42 +2,65 @@
 
 module WithAdvisoryLock
   class PostgreSQL < Base
-    # See http://www.postgresql.org/docs/9.1/static/functions-admin.html#FUNCTIONS-ADVISORY-LOCKS
+    # See https://www.postgresql.org/docs/16/functions-admin.html#FUNCTIONS-ADVISORY-LOCKS
+
+    # MRI returns 't', jruby returns true. YAY!
+    LOCK_RESULT_VALUES = ['t', true].freeze
+    PG_ADVISORY_UNLOCK = 'pg_advisory_unlock'
+    PG_TRY_ADVISORY = 'pg_try_advisory'
+    ERROR_MESSAGE_REGEX = / ERROR: +current transaction is aborted,/
+
     def try_lock
-      pg_function = "pg_try_advisory#{transaction ? '_xact' : ''}_lock#{shared ? '_shared' : ''}"
-      execute_successful?(pg_function)
+      execute_successful?(advisory_try_lock_function(transaction))
     end
 
     def release_lock
       return if transaction
 
-      pg_function = "pg_advisory_unlock#{shared ? '_shared' : ''}"
-      execute_successful?(pg_function)
+      execute_successful?(advisory_unlock_function)
     rescue ActiveRecord::StatementInvalid => e
-      raise unless e.message =~ / ERROR: +current transaction is aborted,/
+      raise unless e.message =~ ERROR_MESSAGE_REGEX
 
       begin
         connection.rollback_db_transaction
-        execute_successful?(pg_function)
+        execute_successful?(advisory_unlock_function)
       ensure
         connection.begin_db_transaction
       end
     end
 
+    def advisory_try_lock_function(transaction_scope)
+      [
+        'pg_try_advisory',
+        transaction_scope ? '_xact' : nil,
+        '_lock',
+        shared ? '_shared' : nil
+      ].compact.join
+    end
+
+    def advisory_unlock_function
+      [
+        'pg_advisory_unlock',
+        shared ? '_shared' : nil
+      ].compact.join
+    end
+
     def execute_successful?(pg_function)
+      result = connection.select_value(prepare_sql(pg_function))
+      LOCK_RESULT_VALUES.include?(result)
+    end
+
+    def prepare_sql(pg_function)
       comment = lock_name.to_s.gsub(%r{(/\*)|(\*/)}, '--')
-      sql = "SELECT #{pg_function}(#{lock_keys.join(',')}) AS #{unique_column_name} /* #{comment} */"
-      result = connection.select_value(sql)
-      # MRI returns 't', jruby returns true. YAY!
-      ['t', true].include?(result)
+      "SELECT #{pg_function}(#{lock_keys.join(',')}) AS #{unique_column_name} /* #{comment} */"
     end
 
     # PostgreSQL wants 2 32bit integers as the lock key.
     def lock_keys
-      @lock_keys ||= [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
+      @lock_keys ||= [
+        stable_hashcode(lock_name),
+        ENV[LOCK_PREFIX_ENV]
+      ].map { |ea| ea.to_i & 0x7fffffff }
     end
   end
 end

data/lib/with_advisory_lock/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module WithAdvisoryLock
-  VERSION = Gem::Version.new('5.0.0')
+  VERSION = Gem::Version.new('5.3.0')
 end

data/lib/with_advisory_lock.rb

@@ -1,16 +1,16 @@
 require 'with_advisory_lock/version'
 require 'active_support'
-require_relative 'with_advisory_lock/failed_to_acquire_lock'
+require 'zeitwerk'
 
-module WithAdvisoryLock
-  extend ActiveSupport::Autoload
+loader = Zeitwerk::Loader.for_gem
+loader.inflector.inflect(
+  'mysql' => 'MySQL',
+  'postgresql' => 'PostgreSQL',
+  )
+loader.setup
 
-  autoload :Concern
-  autoload :Base
-  autoload :DatabaseAdapterSupport
-  autoload :Flock
-  autoload :MySQL, 'with_advisory_lock/mysql'
-  autoload :PostgreSQL, 'with_advisory_lock/postgresql'
+module WithAdvisoryLock
+  LOCK_PREFIX_ENV = 'WITH_ADVISORY_LOCK_PREFIX'.freeze
 end
 
 ActiveSupport.on_load :active_record do

data/release-please-config.json

@@ -0,0 +1,9 @@
+{
+  "release-type": "ruby",
+  "packages": {
+    ".": {
+      "release-type": "ruby",
+      "package-name": "with_advisory_lock"
+    }
+  }
+}

data/test/test_helper.rb

@@ -17,7 +17,8 @@ end
 
 ActiveRecord::Base.configurations = {
   default_env: {
-    url: ENV.fetch('DATABASE_URL', "sqlite3://#{Dir.tmpdir}/#{SecureRandom.hex}.sqlite3"),
+    url: ENV.fetch('DATABASE_URL', "sqlite3://#{Dir.tmpdir}/with_advisory_lock_test#{RUBY_VERSION}-#{ActiveRecord.gem_version}.sqlite3"),
+    pool: 20,
     properties: { allowPublicKeyRetrieval: true } # for JRuby madness
   }
 }
@@ -38,15 +39,28 @@ require 'maxitest/autorun'
 require 'mocha/minitest'
 
 class GemTestCase < ActiveSupport::TestCase
+
+  parallelize(workers: 1)
+  def adapter_support
+    @adapter_support ||= WithAdvisoryLock::DatabaseAdapterSupport.new(ActiveRecord::Base.connection)
+  end
+  def is_sqlite3_adapter?; adapter_support.sqlite?; end
+  def is_mysql_adapter?; adapter_support.mysql?; end
+  def is_postgresql_adapter?; adapter_support.postgresql?; end
+
   setup do
-    ENV['FLOCK_DIR'] = Dir.mktmpdir
-    Tag.delete_all
-    TagAudit.delete_all
-    Label.delete_all
+    ENV['FLOCK_DIR'] = Dir.mktmpdir if is_sqlite3_adapter?
+    ApplicationRecord.connection.truncate_tables(
+      Tag.table_name,
+      TagAudit.table_name,
+      Label.table_name
+    )
   end
+
   teardown do
-    FileUtils.remove_entry_secure ENV['FLOCK_DIR']
+    FileUtils.remove_entry_secure(ENV['FLOCK_DIR'], true) if is_sqlite3_adapter?
   end
 end
 
 puts "Testing with #{env_db} database, ActiveRecord #{ActiveRecord.gem_version} and #{RUBY_ENGINE} #{RUBY_ENGINE_VERSION} as #{RUBY_VERSION}"
+puts "Connection Pool size: #{ActiveRecord::Base.connection_pool.size}"

data/test/test_models.rb

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
-ActiveRecord::Schema.define(version: 0) do
+ActiveRecord::Schema.define(version: 1) do
   create_table 'tags', force: true do |t|
     t.string 'name'
   end
@@ -12,15 +12,19 @@ ActiveRecord::Schema.define(version: 0) do
   end
 end
 
-class Tag < ActiveRecord::Base
+class ApplicationRecord < ActiveRecord::Base
+  self.abstract_class = true
+end
+
+class Tag < ApplicationRecord
   after_save do
     TagAudit.create(tag_name: name)
     Label.create(name: name)
   end
 end
 
-class TagAudit < ActiveRecord::Base
+class TagAudit < ApplicationRecord
 end
 
-class Label < ActiveRecord::Base
+class Label < ApplicationRecord
 end

data/test/with_advisory_lock/base_test.rb

@@ -0,0 +1,9 @@
+require 'test_helper'
+
+class WithAdvisoryLockBaseTest < GemTestCase
+  test 'should support advisory_locks_enabled' do
+    skip if is_sqlite3_adapter?
+
+    assert Tag.connection.advisory_locks_enabled?
+  end
+end

data/test/{concern_test.rb → with_advisory_lock/concern_test.rb}

@@ -22,12 +22,12 @@ end
 
 class ActiveRecordQueryCacheTest < GemTestCase
   test 'does not disable quary cache by default' do
-    ActiveRecord::Base.expects(:uncached).never
+    Tag.connection.expects(:uncached).never
     Tag.with_advisory_lock('lock') { Tag.first }
   end
 
   test 'can disable ActiveRecord query cache' do
-    ActiveRecord::Base.expects(:uncached).once
+    Tag.connection.expects(:uncached).once
     Tag.with_advisory_lock('a-lock', disable_query_cache: true) { Tag.first }
   end
 end

data/test/{lock_test.rb → with_advisory_lock/lock_test.rb}

@@ -77,4 +77,35 @@ class LockTest < GemTestCase
 
     assert_equal(expected, actual)
   end
+
+  test 'current_advisory_locks returns empty array outside an advisory lock request' do
+    assert_equal([], Tag.current_advisory_locks)
+  end
+
+  test 'current_advisory_locks returns an array with names of the acquired locks' do
+    Tag.with_advisory_lock(@lock_name) do
+      locks = Tag.current_advisory_locks
+      assert_equal(1, locks.size)
+      assert_match(/#{@lock_name}/, locks.first)
+    end
+  end
+
+  test 'current_advisory_locks returns array of all nested lock names' do
+    first_lock = 'outer lock'
+    second_lock = 'inner lock'
+
+    Tag.with_advisory_lock(first_lock) do
+      Tag.with_advisory_lock(second_lock) do
+        locks = Tag.current_advisory_locks
+        assert_equal(2, locks.size)
+        assert_match(/#{first_lock}/, locks.first)
+        assert_match(/#{second_lock}/, locks.last)
+      end
+
+      locks = Tag.current_advisory_locks
+      assert_equal(1, locks.size)
+      assert_match(/#{first_lock}/, locks.first)
+    end
+    assert_equal([], Tag.current_advisory_locks)
+  end
 end

data/test/{parallelism_test.rb → with_advisory_lock/parallelism_test.rb}

@@ -15,7 +15,7 @@ class FindOrCreateWorker
 
   def work_later
     sleep
-    ActiveRecord::Base.connection_pool.with_connection do
+    ApplicationRecord.connection_pool.with_connection do
       if @use_advisory_lock
         Tag.with_advisory_lock(@name) { work }
       else
@@ -46,11 +46,11 @@ class ParallelismTest < GemTestCase
       workers.each(&:join)
     end
     # Ensure we're still connected:
-    ActiveRecord::Base.connection_pool.connection
+    ApplicationRecord.connection_pool.connection
   end
 
   setup do
-    ActiveRecord::Base.connection.reconnect!
+    ApplicationRecord.connection.reconnect!
     @workers = 10
   end
 

data/test/{shared_test.rb → with_advisory_lock/shared_test.rb}

@@ -24,7 +24,7 @@ class SharedTestWorker
   private
 
   def work
-    ActiveRecord::Base.connection_pool.with_connection do
+    Tag.connection_pool.with_connection do
       Tag.with_advisory_lock('test', timeout_seconds: 0, shared: @shared) do
         @locked = true
         sleep 0.01 until @cleanup
@@ -117,7 +117,7 @@ class SupportedEnvironmentTest < SharedLocksTest
     end
 
     def pg_lock_modes
-      ActiveRecord::Base.connection.select_values("SELECT mode FROM pg_locks WHERE locktype = 'advisory';")
+      Tag.connection.select_values("SELECT mode FROM pg_locks WHERE locktype = 'advisory';")
     end
 
     test 'allows shared lock to be upgraded to an exclusive lock' do

data/test/{thread_test.rb → with_advisory_lock/thread_test.rb}

@@ -10,7 +10,7 @@ class SeparateThreadTest < GemTestCase
     @t1_return_value = nil
 
     @t1 = Thread.new do
-      ActiveRecord::Base.connection_pool.with_connection do
+      Label.connection_pool.with_connection do
         @t1_return_value = Label.with_advisory_lock(@lock_name) do
           @mutex.synchronize { @t1_acquired_lock = true }
           sleep
@@ -21,7 +21,7 @@ class SeparateThreadTest < GemTestCase
 
     # Wait for the thread to acquire the lock:
     sleep(0.1) until @mutex.synchronize { @t1_acquired_lock }
-    ActiveRecord::Base.connection.reconnect!
+    Label.connection.reconnect!
   end
 
   teardown do

data/test/{transaction_test.rb → with_advisory_lock/transaction_test.rb}

@@ -25,7 +25,7 @@ class TransactionScopingTest < GemTestCase
     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
+        ApplicationRecord.connection.select_value("SELECT COUNT(*) FROM pg_locks WHERE locktype = 'advisory';").to_i
       end
     end
 

data/with_advisory_lock.gemspec

@@ -16,11 +16,16 @@ Gem::Specification.new do |spec|
   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.metadata      = { 'rubygems_mfa_required' => 'true' }
   spec.required_ruby_version = '>= 2.7.0'
-  spec.metadata["yard.run"] = "yri"
+  spec.metadata['yard.run'] = 'yri'
+
+  spec.metadata['homepage_uri'] = spec.homepage
+  spec.metadata['source_code_uri'] = 'https://github.com/ClosureTree/with_advisory_lock'
+  spec.metadata['changelog_uri'] = 'https://github.com/ClosureTree/with_advisory_lock/blob/master/CHANGELOG.md'
 
   spec.add_runtime_dependency 'activerecord', '>= 6.1'
+  spec.add_runtime_dependency 'zeitwerk', '>= 2.6'
 
   spec.add_development_dependency 'appraisal'
   spec.add_development_dependency 'maxitest'

metadata

@@ -1,15 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: with_advisory_lock
 version: !ruby/object:Gem::Version
-  version: 5.0.0
+  version: 5.3.0
 platform: ruby
 authors:
 - Matthew McEachen
 - Abdelkader Boudih
-autorequire:
 bindir: bin
 cert_chain: []
-date: 2023-10-29 00:00:00.000000000 Z
+date: 1980-01-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activerecord
@@ -25,6 +24,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '6.1'
+- !ruby/object:Gem::Dependency
+  name: zeitwerk
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '2.6'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '2.6'
 - !ruby/object:Gem::Dependency
   name: appraisal
   requirement: !ruby/object:Gem::Requirement
@@ -103,15 +116,23 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- ".github/workflows/ci.yml"
+- ".github/workflows/ci-mysql5.yml"
+- ".github/workflows/ci-mysql8.yml"
+- ".github/workflows/ci-postgresql.yml"
+- ".github/workflows/ci-sqlite3.yml"
+- ".github/workflows/release.yml"
 - ".gitignore"
+- ".release-please-manifest.json"
+- ".ruby-version"
 - ".tool-versions"
 - Appraisals
 - CHANGELOG.md
 - Gemfile
 - LICENSE.txt
+- Makefile
 - README.md
 - Rakefile
+- docker-compose.yml
 - gemfiles/activerecord_6.1.gemfile
 - gemfiles/activerecord_7.0.gemfile
 - gemfiles/activerecord_7.1.gemfile
@@ -124,24 +145,28 @@ files:
 - lib/with_advisory_lock/mysql.rb
 - lib/with_advisory_lock/postgresql.rb
 - lib/with_advisory_lock/version.rb
-- test/concern_test.rb
-- test/lock_test.rb
-- test/nesting_test.rb
-- test/options_test.rb
-- test/parallelism_test.rb
-- test/shared_test.rb
+- release-please-config.json
 - test/test_helper.rb
 - test/test_models.rb
-- test/thread_test.rb
-- test/transaction_test.rb
+- test/with_advisory_lock/base_test.rb
+- test/with_advisory_lock/concern_test.rb
+- test/with_advisory_lock/lock_test.rb
+- test/with_advisory_lock/nesting_test.rb
+- test/with_advisory_lock/options_test.rb
+- test/with_advisory_lock/parallelism_test.rb
+- test/with_advisory_lock/shared_test.rb
+- test/with_advisory_lock/thread_test.rb
+- test/with_advisory_lock/transaction_test.rb
 - with_advisory_lock.gemspec
 homepage: https://github.com/ClosureTree/with_advisory_lock
 licenses:
 - MIT
 metadata:
-  rubyspecs_mfa_required: 'true'
+  rubygems_mfa_required: 'true'
   yard.run: yri
-post_install_message:
+  homepage_uri: https://github.com/ClosureTree/with_advisory_lock
+  source_code_uri: https://github.com/ClosureTree/with_advisory_lock
+  changelog_uri: https://github.com/ClosureTree/with_advisory_lock/blob/master/CHANGELOG.md
 rdoc_options: []
 require_paths:
 - lib
@@ -156,18 +181,18 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.4.12
-signing_key:
+rubygems_version: 3.6.7
 specification_version: 4
 summary: Advisory locking for ActiveRecord
 test_files:
-- test/concern_test.rb
-- test/lock_test.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
+- test/with_advisory_lock/base_test.rb
+- test/with_advisory_lock/concern_test.rb
+- test/with_advisory_lock/lock_test.rb
+- test/with_advisory_lock/nesting_test.rb
+- test/with_advisory_lock/options_test.rb
+- test/with_advisory_lock/parallelism_test.rb
+- test/with_advisory_lock/shared_test.rb
+- test/with_advisory_lock/thread_test.rb
+- test/with_advisory_lock/transaction_test.rb

data/.github/workflows/ci.yml

@@ -1,80 +0,0 @@
----
-name: CI
-
-on:
-  pull_request:
-    branches:
-      - master
-
-jobs:
-  minitest:
-    runs-on: ubuntu-latest
-    services:
-      mysql:
-        image: mysql/mysql-server:5.7
-        ports:
-          - "3306:3306"
-        env:
-          MYSQL_ROOT_PASSWORD: root
-          MYSQL_DATABASE: with_advisory_lock_test
-          MYSQL_ROOT_HOST: '%'
-      postgres:
-        image: 'postgres:14-alpine'
-        ports: ['5432:5432']
-        env:
-          POSTGRES_USER: closure_tree
-          POSTGRES_PASSWORD: closure_tree
-          POSTGRES_DB: with_advisory_lock_test
-        options: >-
-          --health-cmd pg_isready
-          --health-interval 10s
-          --health-timeout 5s
-          --health-retries 5
-
-    strategy:
-      fail-fast: false
-      matrix:
-        ruby:
-          - '3.2'  
-          - '3.1'
-          - '3.0'
-          - '2.7'
-          - 'truffleruby'
-        rails:
-          - activerecord_7.1
-          - activerecord_7.0
-          - activerecord_6.1
-        adapter:
-          - sqlite3:///tmp/test.sqlite3
-          - mysql2://root:root@0/with_advisory_lock_test
-          - trilogy://root:root@0/with_advisory_lock_test
-          - postgres://closure_tree:closure_tree@0/with_advisory_lock_test
-        include:
-          - ruby: jruby
-            rails: activerecord_6.1
-            adapter: jdbcmysql://root:root@0/with_advisory_lock_test
-          - ruby: jruby
-            rails: activerecord_6.1
-            adapter: jdbcsqlite3:///tmp/test.sqlite3
-          - ruby: jruby
-            rails: activerecord_6.1
-            adapter: jdbcpostgresql://closure_tree:closure_tree@0/with_advisory_lock_test
-    steps:
-      - name: Checkout
-        uses: actions/checkout@v4
-
-      - name: Setup Ruby
-        uses: ruby/setup-ruby@v1
-        with:
-          ruby-version: ${{ matrix.ruby }}
-          bundler-cache: true
-          rubygems: latest
-        env:
-          BUNDLE_GEMFILE:  gemfiles/${{ matrix.rails }}.gemfile
-
-      - name: Test
-        env:
-          BUNDLE_GEMFILE: gemfiles/${{ matrix.rails }}.gemfile
-          DATABASE_URL: ${{ matrix.adapter }}
-          WITH_ADVISORY_LOCK_PREFIX: ${{ github.run_id }}
-        run: bundle exec rake