active_record_mutex 3.2.0 → 3.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 34e4fb422fbe0336eee934df7fdeb49843c4b0335fe4222db9d8df1728b7d477
-  data.tar.gz: c3dc8c6fe86409160ded37ed5941cef3033d03b82e60c630c950ade50fc1d901
+  metadata.gz: cf654fec02b6d69bd364a26520e1ee2308988193b2938ff514e61bb202661a42
+  data.tar.gz: f4cdcb9803f4db880ccda320bef2ca58c680be9365ca696069afd7c1781968c3
 SHA512:
-  metadata.gz: bd1437072b603f1dd5641d70970fe3bd2a24e77862a88d035222b4b1c0c360eb99ce14a573be87fc2e331e85955283262380be09c709e3bad936944a36b6615a
-  data.tar.gz: 2f4528e9a7d63ce3e2f9584f0b0099c783b07bf518174fd50c107237e0ad994fed77519f408ef27daa3aa752d3df1452fdc7a0139a312c21fe6d708d77cc5f0c
+  metadata.gz: bb44138a04d61609b26bd89dcc4ab663231768d4c9763b215c42161974705ed65a0bd2aa1fd911b2b0dabf2f5792ea842c93366d6b4432bbbf55fd317cf4bb7d
+  data.tar.gz: c0bb4dfdbd775a767690881bf3e2973caf70aa454c765d7ef4294b5853bdd05af09e7c9e712deece3d3b1d3b604a5aebe3e211765363eb19cf966015af0bc4ae

data/CHANGES.md

@@ -1,5 +1,44 @@
 # Changes
 
+## 2026-01-02 v3.3.0
+
+- Updated `all_images` development dependency from version **0.6** to
+  **0.11.2** in `active_record_mutex.gemspec`
+- Enabled MariaDB TLS peer verification disable option via environment variable
+  in `.all_images.yml`
+- Added `yaml-dev` and `openssl-dev` packages to Alpine package installation in
+  `.all_images.yml`
+- Updated Ruby gem system and installed `bundler` and `gem_hadar` using `gem
+  update --system` and `gem install`
+- Replaced `bundle install --full-index` with `bundle update --all` and `bundle
+  install --jobs=$(getconf _NPROCESSORS_ONLN)`
+- Added `ruby:4.0-alpine` image configuration to the test suite
+- Updated `s.date` from **2024-10-16** to **1980-01-02**
+- Updated `s.rubygems_version` from **3.5.18** to **4.0.2**
+- Updated `gem_hadar` development dependency from version **~> 1.19** to **>=
+  2.16.3**
+- Added `changelog` block in `Rakefile` to specify `CHANGES.md` as the
+  changelog filename
+- Removed binary detection config in file discovery
+- Updated Docker image for Ruby **3.4**
+- Added support for Ruby **3.4**-alpine images
+- Removed support for Ruby **3.2**-alpine images
+- Added fenced codeblocks for syntax highlighter hints in README.md
+
+## 2024-10-16 v3.2.1
+
+* Refactor DatabaseMutex implementation:
+  * Change `@name` and `mutex.name` to downcase and freeze values
+  * Update tests to reflect new behavior
+
+## 2024-10-16 v3.2.0
+
+* DatabaseMutex improvements:
+  * Improved lock name generation in `lock_name` method.
+  * Modified SQL queries to use `lock_name` instead of `internal_name`.
+  * Added `lock_exists?` and `test_all_mutexes` methods for testing mutex
+    creation and querying.
+
 ## 2024-10-16 v3.1.0
 
 * Changes for **3.1.0**:

data/README.md

@@ -1,4 +1,4 @@
-# ActiveRecord::Mutex
+# ActiveRecord Database Mutex
 
 ## Description
 
@@ -10,11 +10,16 @@ ruby processes (also on different hosts) via the connected database.
 
 You can use rubygems to fetch the gem and install it for you:
 
-    # gem install active_record_mutex
+```bash
+gem install active_record_mutex
+```
 
 You can also put this line into your Gemfile
 
-    gem 'active_record_mutex'
+```ruby
+# Gemfile
+gem 'active_record_mutex'
+```
 
 ## Usage
 
@@ -22,25 +27,31 @@ You can also put this line into your Gemfile
 
 To synchronize on a specific ActiveRecord instance you can do this:
 
-    class Foo < ActiveRecord::Base
-    end
+```ruby
+class Foo < ActiveRecord::Base
+end
 
-    foo = Foo.find(666)
-    foo.mutex.synchronize do
-      # Critical section of code here
-    end
+foo = Foo.find(666)
+foo.mutex.synchronize do
+  # Critical section of code here
+end
+```
 
 If you want more control over the mutex and/or give it a special name you can
 create Mutex instance like this:
 
-    my_mutex = ActiveRecord::DatabaseMutex.for('my_mutex')
+```ruby
+my_mutex = ActiveRecord::DatabaseMutex.for('my_mutex')
+``````
 
 Now you can send all messages directly to the Mutex instance or use the custom
 mutex instance to `synchronize` method calls or other operations:
 
-    my_mutex.synchronize do
-      # Critical section of code here
-    end
+```ruby
+my_mutex.synchronize do
+  # Critical section of code here
+end
+```
 
 ### Low-Level Demonstration: Multiple Process Example
 
@@ -51,50 +62,54 @@ rather to illustrate the underlying behavior.
 If two processes are connected to the same database, configured via e.g.
 `DATABASE_URL=mysql2://root@127.0.0.1:3336/test` and this is process 1:
 
-    # process1.rb
-    …
-    mutex = ActiveRecord::DatabaseMutex.for('my_mutex')
+```ruby
+# process1.rb
+…
+mutex = ActiveRecord::DatabaseMutex.for('my_mutex')
 
-    lock_result1 = mutex.lock(timeout: 5)
-    puts "Process 1: Lock acquired (first): #{lock_result1}"
+lock_result1 = mutex.lock(timeout: 5)
+puts "Process 1: Lock acquired (first): #{lock_result1}"
 
-    puts "Process 1: Waiting for 10s"
-    sleep(10)
+puts "Process 1: Waiting for 10s"
+sleep(10)
 
-    lock_result2 = mutex.lock(timeout: 5)
-    puts "Process 1: Lock acquired (second): #{lock_result2}"
+lock_result2 = mutex.lock(timeout: 5)
+puts "Process 1: Lock acquired (second): #{lock_result2}"
 
-    mutex.unlock # first
-    mutex.unlock # second
+mutex.unlock # first
+mutex.unlock # second
 
-    puts "Process 1: Unlocked the mutex twice"
+puts "Process 1: Unlocked the mutex twice"
 
-    puts "Process 1: Waiting for 10s"
-    sleep(10)
+puts "Process 1: Waiting for 10s"
+sleep(10)
 
-    puts "Process 1: Exiting"
+puts "Process 1: Exiting"
+```
 
 and this process 2:
 
-    # process2.rb
-    …
-    mutex = ActiveRecord::DatabaseMutex.for('my_mutex')
+```ruby
+# process2.rb
+…
+mutex = ActiveRecord::DatabaseMutex.for('my_mutex')
 
-    begin
-      lock_result3 = mutex.lock(timeout: 5)
-      puts "Process 2: Lock acquired (first): #{lock_result3}"
-    rescue ActiveRecord::DatabaseMutex::MutexLocked
-      puts "Process 2: Mutex locked by another process, waiting..."
-    end
+begin
+  lock_result3 = mutex.lock(timeout: 5)
+  puts "Process 2: Lock acquired (first): #{lock_result3}"
+rescue ActiveRecord::DatabaseMutex::MutexLocked
+  puts "Process 2: Mutex locked by another process, waiting..."
+end
 
-    puts "Process 2: Waiting for 10s"
-    sleep(10)
+puts "Process 2: Waiting for 10s"
+sleep(10)
 
-    puts "Process 2: Trying to lock again"
-    lock_result4 = mutex.lock(timeout: 5)
-    puts "Process 2: Lock acquired (second): #{lock_result4}"
+puts "Process 2: Trying to lock again"
+lock_result4 = mutex.lock(timeout: 5)
+puts "Process 2: Lock acquired (second): #{lock_result4}"
 
-    puts "Process 2: Exiting"
+puts "Process 2: Exiting"
+```
 
 Running these processes in parallel will output the following:
 
@@ -120,15 +135,21 @@ files, `.envrc` (`direnv allow`) and `docker-compose.yml`
 First start mysql in docker via `docker compose up -d` and configure your
 environment via `direnv allow` as before and then run
 
-    rake test
+```bash
+rake test
+```
 
 or with coverage:
 
-    rake test START_SIMPLECOV=1
+```bash
+rake test START_SIMPLECOV=1
+```
 
 To test for different ruby versions in docker, run:
 
-    all_images
+```bash
+all_images
+```
 
 ## Download
 

data/Rakefile

@@ -19,10 +19,14 @@ GemHadar do
   readme      'README.md'
   licenses    << 'GPL-2'
 
+  changelog do
+    filename 'CHANGES.md'
+  end
+
   dependency             'mysql2',       '~> 0.3'
   dependency             'activerecord', '>= 4.0'
   dependency             'ostruct',      '~> 0.6'
-  development_dependency 'all_images',   '~> 0.6'
+  development_dependency 'all_images',   '>= 0.11.2'
   development_dependency 'test-unit',    '~> 3.0'
   development_dependency 'debug'
   development_dependency 'simplecov'

data/active_record_mutex.gemspec

@@ -1,14 +1,14 @@
 # -*- encoding: utf-8 -*-
-# stub: active_record_mutex 3.2.0 ruby lib
+# stub: active_record_mutex 3.3.0 ruby lib
 
 Gem::Specification.new do |s|
   s.name = "active_record_mutex".freeze
-  s.version = "3.2.0".freeze
+  s.version = "3.3.0".freeze
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0".freeze) if s.respond_to? :required_rubygems_version=
   s.require_paths = ["lib".freeze]
   s.authors = ["Florian Frank".freeze]
-  s.date = "2024-10-16"
+  s.date = "1980-01-02"
   s.description = "Mutex that can be used to synchronise ruby processes via an ActiveRecord datababase connection. (Only Mysql is supported at the moment.)".freeze
   s.email = "flori@ping.de".freeze
   s.extra_rdoc_files = ["README.md".freeze, "lib/active_record/database_mutex.rb".freeze, "lib/active_record/database_mutex/implementation.rb".freeze, "lib/active_record/database_mutex/version.rb".freeze, "lib/active_record/mutex.rb".freeze, "lib/active_record_mutex.rb".freeze]
@@ -16,14 +16,14 @@ Gem::Specification.new do |s|
   s.homepage = "http://github.com/flori/active_record_mutex".freeze
   s.licenses = ["GPL-2".freeze]
   s.rdoc_options = ["--title".freeze, "ActiveRecordMutex - Implementation of a Mutex for Active Record".freeze, "--main".freeze, "README.md".freeze]
-  s.rubygems_version = "3.5.18".freeze
+  s.rubygems_version = "4.0.2".freeze
   s.summary = "Implementation of a Mutex for Active Record".freeze
   s.test_files = ["test/database_mutex_test.rb".freeze, "test/test_helper.rb".freeze]
 
   s.specification_version = 4
 
-  s.add_development_dependency(%q<gem_hadar>.freeze, ["~> 1.19".freeze])
-  s.add_development_dependency(%q<all_images>.freeze, ["~> 0.6".freeze])
+  s.add_development_dependency(%q<gem_hadar>.freeze, [">= 2.16.3".freeze])
+  s.add_development_dependency(%q<all_images>.freeze, [">= 0.11.2".freeze])
   s.add_development_dependency(%q<test-unit>.freeze, ["~> 3.0".freeze])
   s.add_development_dependency(%q<debug>.freeze, [">= 0".freeze])
   s.add_development_dependency(%q<simplecov>.freeze, [">= 0".freeze])

data/lib/active_record/database_mutex/implementation.rb

@@ -20,9 +20,10 @@ module ActiveRecord
       #
       # @raise [ ArgumentError ] if no **name** option is provided in the options hash.
       def initialize(opts = {})
-        @name = opts[:name].to_s
+        @name = opts[:name].to_s.downcase
         @name.size != 0 or raise ArgumentError, "mutex requires a nonempty :name argument"
-        internal_name # create/check internal_name
+        @name.freeze
+        lock_name # create/check internal_name and lock_name
       end
 
       # Returns the name of this mutex as given via the constructor argument.
@@ -35,7 +36,8 @@ module ActiveRecord
       def internal_name
         @internal_name and return @internal_name
         encoded_name = ?$ + Digest::MD5.base64digest([ self.class.name, name ] * ?#).
-          delete('^A-Za-z0-9+/').gsub(/[+\/]/, ?+ => ?_, ?/ => ?.)
+          delete('^A-Za-z0-9+/').gsub(/[+\/]/, ?+ => ?_, ?/ => ?.).
+          downcase.freeze
         if encoded_name.size <= 64
           @internal_name = encoded_name
         else
@@ -50,8 +52,11 @@ module ActiveRecord
       #
       # @return [ String ] the generated lock name
       def lock_name
+        @lock_name and return @lock_name
         prefix_name = name.gsub(/[^[:print:]]/, '')[0, 32]
-        prefix_name + ?= + internal_name
+        @lock_name = prefix_name + ?= + internal_name
+        @lock_name.downcase!
+        @lock_name.freeze
       end
 
       # The synchronize method attempts to acquire a mutex lock for the given name

data/lib/active_record/database_mutex/version.rb

@@ -1,6 +1,6 @@
 module ActiveRecord::DatabaseMutex
   # ActiveRecord::DatabaseMutex version
-  VERSION         = '3.2.0'
+  VERSION         = '3.3.0'
   VERSION_ARRAY   = VERSION.split('.').map(&:to_i) # :nodoc:
   VERSION_MAJOR   = VERSION_ARRAY[0] # :nodoc:
   VERSION_MINOR   = VERSION_ARRAY[1] # :nodoc:

data/test/database_mutex_test.rb

@@ -25,7 +25,7 @@ class DatabaseMutexTest < Test::Unit::TestCase
     old, ENV['RAILS_ENV'] = ENV['RAILS_ENV'], nil
     mutex = Foo.mutex
     assert_kind_of ActiveRecord::DatabaseMutex::Implementation, mutex
-    assert_equal Foo.name, mutex.name
+    assert_equal Foo.name.downcase, mutex.name
   ensure
     ENV['RAILS_ENV'] = old
   end
@@ -34,7 +34,7 @@ class DatabaseMutexTest < Test::Unit::TestCase
     old, ENV['RAILS_ENV'] = ENV['RAILS_ENV'], 'test'
     mutex = Foo.mutex
     assert_kind_of ActiveRecord::DatabaseMutex::Implementation, mutex
-    assert_equal "#{Foo.name}@test", mutex.name
+    assert_equal "#{Foo.name}@test".downcase, mutex.name
   ensure
     ENV['RAILS_ENV'] = old
   end
@@ -47,7 +47,7 @@ class DatabaseMutexTest < Test::Unit::TestCase
     assert_equal true, instance.save
     mutex = instance.mutex
     assert_kind_of ActiveRecord::DatabaseMutex::Implementation, mutex
-    assert_equal "#{instance.id}@#{Foo.name}", mutex.name
+    assert_equal "#{instance.id}@#{Foo.name}".downcase, mutex.name
   end
 
   def test_factory_method_for
@@ -56,6 +56,7 @@ class DatabaseMutexTest < Test::Unit::TestCase
   end
 
   private def lock_exists?(string)
+    string = string.downcase
     ActiveRecord::Base.all_mutexes.map(&:OBJECT_NAME).any? {
       _1.include?(string)
     }
@@ -73,7 +74,7 @@ class DatabaseMutexTest < Test::Unit::TestCase
 
   def test_create
     mutex = Implementation.new(:name => 'Create')
-    assert_equal 'Create', mutex.name
+    assert_equal 'create', mutex.name
   end
 
   def test_lock
@@ -284,11 +285,11 @@ class DatabaseMutexTest < Test::Unit::TestCase
 
   def test_internal_name
     mutex = Implementation.new(:name => (250..255).map(&:chr) * '')
-    assert_equal '$3i3xQvUrNPGyH6kaIOkiPw', mutex.send(:internal_name)
+    assert_equal '$3i3xqvurnpgyh6kaiokipw', mutex.send(:internal_name)
   end
 
   def test_counter_name
     mutex = Implementation.new(:name => (250..255).map(&:chr) * '')
-    assert_equal '@$3i3xQvUrNPGyH6kaIOkiPw', mutex.send(:counter)
+    assert_equal '@$3i3xqvurnpgyh6kaiokipw', mutex.send(:counter)
   end
 end

metadata

@@ -1,43 +1,42 @@
 --- !ruby/object:Gem::Specification
 name: active_record_mutex
 version: !ruby/object:Gem::Version
-  version: 3.2.0
+  version: 3.3.0
 platform: ruby
 authors:
 - Florian Frank
-autorequire:
 bindir: bin
 cert_chain: []
-date: 2024-10-16 00:00:00.000000000 Z
+date: 1980-01-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: gem_hadar
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '1.19'
+        version: 2.16.3
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '1.19'
+        version: 2.16.3
 - !ruby/object:Gem::Dependency
   name: all_images
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '0.6'
+        version: 0.11.2
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '0.6'
+        version: 0.11.2
 - !ruby/object:Gem::Dependency
   name: test-unit
   requirement: !ruby/object:Gem::Requirement
@@ -156,7 +155,6 @@ homepage: http://github.com/flori/active_record_mutex
 licenses:
 - GPL-2
 metadata: {}
-post_install_message:
 rdoc_options:
 - "--title"
 - ActiveRecordMutex - Implementation of a Mutex for Active Record
@@ -175,8 +173,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.5.18
-signing_key:
+rubygems_version: 4.0.2
 specification_version: 4
 summary: Implementation of a Mutex for Active Record
 test_files: