with_advisory_lock 4.6.0 → 7.0.1

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: with_advisory_lock
 version: !ruby/object:Gem::Version
-  version: 4.6.0
+  version: 7.0.1
 platform: ruby
 authors:
 - Matthew McEachen
-autorequire: 
+- Abdelkader Boudih
 bindir: bin
 cert_chain: []
-date: 2019-09-20 00:00:00.000000000 Z
+date: 1980-01-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activerecord
@@ -16,44 +16,30 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '4.2'
+        version: '7.2'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '4.2'
+        version: '7.2'
 - !ruby/object:Gem::Dependency
-  name: yard
+  name: zeitwerk
   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
+        version: '2.7'
+  type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '2.7'
 - !ruby/object:Gem::Dependency
-  name: minitest-great_expectations
+  name: maxitest
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -95,7 +81,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: appraisal
+  name: yard
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -111,52 +97,92 @@ dependencies:
 description: Advisory locking for ActiveRecord
 email:
 - matthew+github@mceachen.org
+- terminale@gmail.com
 executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- ".github/workflows/ci.yml"
+- ".github/workflows/release.yml"
 - ".gitignore"
+- ".release-please-manifest.json"
+- ".ruby-version"
 - ".tool-versions"
-- ".travis.yml"
-- Appraisals
 - CHANGELOG.md
 - Gemfile
 - LICENSE.txt
+- Makefile
 - 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
+- bin/console
+- bin/rails
+- bin/sanity
+- bin/sanity_check
+- bin/setup
+- bin/setup_test_db
+- bin/test_connections
+- docker-compose.yml
 - 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/mysql_no_nesting.rb
-- lib/with_advisory_lock/nested_advisory_lock_error.rb
-- lib/with_advisory_lock/postgresql.rb
+- lib/with_advisory_lock/core_advisory.rb
+- lib/with_advisory_lock/failed_to_acquire_lock.rb
+- lib/with_advisory_lock/jruby_adapter.rb
+- lib/with_advisory_lock/lock_stack_item.rb
+- lib/with_advisory_lock/mysql_advisory.rb
+- lib/with_advisory_lock/postgresql_advisory.rb
+- lib/with_advisory_lock/result.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_models.rb
-- test/thread_test.rb
-- test/transaction_test.rb
-- tests.sh
+- release-please-config.json
+- test/dummy/Rakefile
+- test/dummy/app/controllers/application_controller.rb
+- test/dummy/app/models/application_record.rb
+- test/dummy/app/models/label.rb
+- test/dummy/app/models/mysql_label.rb
+- test/dummy/app/models/mysql_record.rb
+- test/dummy/app/models/mysql_tag.rb
+- test/dummy/app/models/mysql_tag_audit.rb
+- test/dummy/app/models/tag.rb
+- test/dummy/app/models/tag_audit.rb
+- test/dummy/config.ru
+- test/dummy/config/application.rb
+- test/dummy/config/boot.rb
+- test/dummy/config/database.yml
+- test/dummy/config/environment.rb
+- test/dummy/config/routes.rb
+- test/dummy/db/schema.rb
+- test/dummy/db/secondary_schema.rb
+- test/dummy/lib/tasks/db.rake
+- test/sanity_check_test.rb
+- test/test_helper.rb
+- test/with_advisory_lock/concern_test.rb
+- test/with_advisory_lock/lock_test.rb
+- test/with_advisory_lock/multi_adapter_test.rb
+- test/with_advisory_lock/mysql_release_lock_test.rb
+- test/with_advisory_lock/parallelism_test.rb
+- test/with_advisory_lock/postgresql_race_condition_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/mceachen/with_advisory_lock
+homepage: https://github.com/ClosureTree/with_advisory_lock
 licenses:
 - MIT
-metadata: {}
-post_install_message: 
+metadata:
+  rubygems_mfa_required: 'true'
+  yard.run: yri
+  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
+post_install_message: "⚠️  IMPORTANT: Total rewrite in Rust/COBOL! ⚠️\n\nNow that
+  I got your attention...\n\nThis version contains a complete internal rewrite. While
+  the public API \nremains the same, please test thoroughly before upgrading production
+  systems.\n\nNew features:\n- Mixed adapters are now fully supported! You can use
+  PostgreSQL and MySQL\n  in the same application with different models.\n\nBreaking
+  changes:\n- SQLite support has been removed\n- MySQL 5.7 is no longer supported
+  (use MySQL 8+)\n- Rails 7.1 is no longer supported (use Rails 7.2+)\n- Private APIs
+  have been removed (Base, DatabaseAdapterSupport, etc.)\n\nIf your code relies on
+  private APIs or unsupported databases, lock to an \nolder version or update your
+  code accordingly.\n"
 rdoc_options: []
 require_paths:
 - lib
@@ -164,26 +190,14 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: 2.2.10
+      version: 3.3.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.6.9
 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_models.rb
-- test/thread_test.rb
-- test/transaction_test.rb
+test_files: []

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/Appraisals

@@ -1,29 +0,0 @@
-appraise "activerecord-4.2" do
-  gem "activerecord", "~> 4.2.0"
-  platforms :ruby do
-      gem "pg", "~> 0.21"
-      gem "mysql2", "< 0.5"
-      gem "sqlite3", "~> 1.3.6"
-  end
-end
-
-appraise "activerecord-5.0" do
-  gem "activerecord", "~> 5.0.0"
-  platforms :ruby do
-    gem "sqlite3", "~> 1.3.6"
-  end
-end
-
-appraise "activerecord-5.1" do
-  gem "activerecord", "~> 5.1.0"
-  gem "sqlite3", "~> 1.3.6"
-end
-
-appraise "activerecord-5.2" do
-  gem "activerecord", "~> 5.1.0"
-  gem "sqlite3", "~> 1.3.6"
-end
-
-appraise "activerecord-6.0" do
-  gem "activerecord", "~> 6.0.0"
-end

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/gemfiles/activerecord_5.2.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/gemfiles/activerecord_6.0.gemfile

@@ -1,19 +0,0 @@
-# This file was generated by Appraisal
-
-source "https://rubygems.org"
-
-gem "activerecord", "~> 6.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/lib/with_advisory_lock/base.rb

@@ -1,104 +0,0 @@
-require 'zlib'
-
-module WithAdvisoryLock
-  class Result
-    attr_reader :result
-
-    def initialize(lock_was_acquired, result = false)
-      @lock_was_acquired = lock_was_acquired
-      @result = result
-    end
-
-    def lock_was_acquired?
-      @lock_was_acquired
-    end
-  end
-
-  FAILED_TO_LOCK = Result.new(false)
-
-  LockStackItem = Struct.new(:name, :shared)
-
-  class Base
-    attr_reader :connection, :lock_name, :timeout_seconds, :shared, :transaction
-
-    def initialize(connection, lock_name, options)
-      options = { timeout_seconds: options } unless options.respond_to?(:fetch)
-      options.assert_valid_keys :timeout_seconds, :shared, :transaction
-
-      @connection = connection
-      @lock_name = lock_name
-      @timeout_seconds = options.fetch(:timeout_seconds, nil)
-      @shared = options.fetch(:shared, false)
-      @transaction = options.fetch(:transaction, false)
-    end
-
-    def lock_str
-      @lock_str ||= "#{ENV['WITH_ADVISORY_LOCK_PREFIX']}#{lock_name}"
-    end
-
-    def lock_stack_item
-      @lock_stack_item ||= LockStackItem.new(lock_str, shared)
-    end
-
-    def self.lock_stack
-      # access doesn't need to be synchronized as it is only accessed by the current thread.
-      Thread.current[:with_advisory_lock_stack] ||= []
-    end
-    delegate :lock_stack, to: 'self.class'
-
-    def already_locked?
-      lock_stack.include? lock_stack_item
-    end
-
-    def with_advisory_lock_if_needed(&block)
-      if already_locked?
-        Result.new(true, yield)
-      elsif timeout_seconds == 0
-        yield_with_lock(&block)
-      else
-        yield_with_lock_and_timeout(&block)
-      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_and_timeout(&block)
-      give_up_at = Time.now + @timeout_seconds if @timeout_seconds
-      while @timeout_seconds.nil? || Time.now < give_up_at
-        r = yield_with_lock(&block)
-        return r if r.lock_was_acquired?
-        # Randomizing sleep time may help reduce contention.
-        sleep(rand(0.05..0.15))
-      end
-      FAILED_TO_LOCK
-    end
-
-    def yield_with_lock
-      if try_lock
-        begin
-          lock_stack.push(lock_stack_item)
-          result = block_given? ? yield : nil
-          Result.new(true, result)
-        ensure
-          lock_stack.pop
-          release_lock
-        end
-      else
-        FAILED_TO_LOCK
-      end
-    end
-
-    # Prevent AR from caching results improperly
-    def unique_column_name
-      "t#{SecureRandom.hex}"
-    end
-  end
-end

data/lib/with_advisory_lock/database_adapter_support.rb

@@ -1,63 +0,0 @@
-module WithAdvisoryLock
-  class DatabaseAdapterSupport
-    # Caches nested lock support by MySQL reported version
-    @@mysql_nl_cache       = {}
-    @@mysql_nl_cache_mutex = Mutex.new
-
-    def initialize(connection)
-      @connection = connection
-      @sym_name   = connection.adapter_name.downcase.to_sym
-    end
-
-    def mysql?
-      %i[mysql mysql2].include? @sym_name
-    end
-
-    # Nested lock support for MySQL was introduced in 5.7.5
-    # Checking by version number is complicated by MySQL compatible DBs (like MariaDB) having their own versioning schemes
-    # Therefore, we check for nested lock support by simply trying a nested lock, then testing and caching the outcome
-    def mysql_nested_lock_support?
-      return false unless mysql?
-
-      # We select the MySQL version this way and cache on it, as MySQL will report versions like "5.7.5", and MariaDB will
-      # report versions like "10.3.8-MariaDB", which allow us to cache on features without introducing problems.
-      version = @connection.select_value("SELECT version()")
-
-      @@mysql_nl_cache_mutex.synchronize do
-        return @@mysql_nl_cache[version] if @@mysql_nl_cache.keys.include?(version)
-
-        lock_1 = "\"nested-test-1-#{SecureRandom.hex}\""
-        lock_2 = "\"nested-test-2-#{SecureRandom.hex}\""
-
-        get_1  = @connection.select_value("SELECT GET_LOCK(#{lock_1}, 0) AS t#{SecureRandom.hex}")
-        get_2  = @connection.select_value("SELECT GET_LOCK(#{lock_2}, 0) AS t#{SecureRandom.hex}")
-
-        # Both locks should succeed in old and new MySQL versions with "1"
-        raise RuntimeError, "Unexpected nested lock acquire result #{get_1}, #{get_2}" unless [get_1, get_2] == [1, 1]
-
-        release_1 = @connection.select_value("SELECT RELEASE_LOCK(#{lock_1}) AS t#{SecureRandom.hex}")
-        release_2 = @connection.select_value("SELECT RELEASE_LOCK(#{lock_2}) AS t#{SecureRandom.hex}")
-
-        # In MySQL <  5.7.5 release_1 will return  nil (not currently locked) and release_2 will return 1 (successfully unlocked)
-        # In MySQL >= 5.7.5 release_1 and release_2 will return 1 (both successfully unlocked)
-        # See https://dev.mysql.com/doc/refman/5.7/en/miscellaneous-functions.html#function_get-lock for more
-        @@mysql_nl_cache[version] = case [release_1, release_2]
-                                    when [1, 1]
-                                      true
-                                    when [nil, 1]
-                                      false
-                                    else
-                                      raise RuntimeError, "Unexpected nested lock release result #{release_1}, #{release_2}"
-                                    end
-      end
-    end
-
-    def postgresql?
-      %i[postgresql empostgresql postgis].include? @sym_name
-    end
-
-    def sqlite?
-      :sqlite3 == @sym_name
-    end
-  end
-end

data/lib/with_advisory_lock/flock.rb

@@ -1,32 +0,0 @@
-require 'fileutils'
-
-module WithAdvisoryLock
-  class Flock < Base
-    def filename
-      @filename ||= begin
-        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
-    end
-
-    def file_io
-      @file_io ||= begin
-        FileUtils.touch(filename)
-        File.open(filename, 'r+')
-      end
-    end
-
-    def try_lock
-      if transaction
-        raise ArgumentError, 'transaction level locks are not supported on SQLite'
-      end
-      0 == file_io.flock((shared ? File::LOCK_SH : File::LOCK_EX) | File::LOCK_NB)
-    end
-
-    def release_lock
-      0 == file_io.flock(File::LOCK_UN)
-    end
-  end
-end

data/lib/with_advisory_lock/mysql.rb

@@ -1,27 +0,0 @@
-module WithAdvisoryLock
-  # MySQL > 5.7.5 supports nested locks
-  class MySQL < Base
-    # See https://dev.mysql.com/doc/refman/5.7/en/miscellaneous-functions.html#function_get-lock
-    def try_lock
-      raise ArgumentError, 'shared locks are not supported on MySQL' if shared
-      if transaction
-        raise ArgumentError, 'transaction level locks are not supported on MySQL'
-      end
-      execute_successful?("GET_LOCK(#{quoted_lock_str}, 0)")
-    end
-
-    def release_lock
-      execute_successful?("RELEASE_LOCK(#{quoted_lock_str})")
-    end
-
-    def execute_successful?(mysql_function)
-      sql = "SELECT #{mysql_function} AS #{unique_column_name}"
-      connection.select_value(sql).to_i > 0
-    end
-
-    # MySQL wants a string as the lock key.
-    def quoted_lock_str
-      connection.quote(lock_str)
-    end
-  end
-end

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