db_lock 0.7 → 0.8.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 3494b2768567c673a466817880e0d5d8170371b463b16e1d764c7e9a29819303
-  data.tar.gz: 1129de916ae216947ab91383f34af010a63adccc996f12bfc9b5a1ba2b706785
+  metadata.gz: f59c12f3f279febb7c5350a2b4b6638d222bc50beeb038563a59afac4efa4328
+  data.tar.gz: 499be9d47073117184c99fdebf1f398eb2b50cb0aa5cd7e082fa55945033e263
 SHA512:
-  metadata.gz: b8194e0c7d778d734503fe0716cfc2dca17524961538cae5b5267ac7ba331f8d34752932970a70fa0b83e2398ff9d8ff6bf6434acf9104437ee1d59a1e0cc7d9
-  data.tar.gz: 2568337c2863e5f76e1c7f38a672885d73f8936ec9b1e45981da3ac964900269b66dc379dc737a68fec24dc42c79f05ff404357c90981a194be3fa5caeea5b4e
+  metadata.gz: c447141d577b1baa3fef43abd12ee20941603a0659b281514d58b6f797bfec611743c71f7a08b07d1a054417647313dca4847774b3314e2db21ca2f8779e084f
+  data.tar.gz: 941c56299b884aa698b6e9d1bbfa18ea83555dc77f2965a73b21cf6cf0f66a718ec68eb2c681a6ed6a13c0d428e896bce8e40ddef5ca49cc5a010cfafa43afd9

data/README.md

@@ -1,5 +1,8 @@
 # DBLock
 
+[![Gem Version](https://badge.fury.io/rb/db_lock.svg)](https://badge.fury.io/rb/db_lock)
+[![Tests](https://github.com/mkon/db_lock/actions/workflows/test.yml/badge.svg)](https://github.com/mkon/db_lock/actions/workflows/test.yml)
+
 Gem to obtain and release manual db locks. This can be utilized for example to make sure that certain rake tasks do not run in parallel on the same database (for example when cron jobs run for too long or are accidentally started multiple times). Currently only supports:
 
 - MySQL
@@ -23,7 +26,7 @@ end
 
 Before the code block is executed, it will attempt to acquire a mysql db lock for X seconds (5 in this example). If this fails it will raise an `DBLock::AlreadyLocked` error. The lock is released after the block is executed, even if the block raised an error itself.
 
-The current implementation uses a class variable to store lock state so it is not thread save when using multiple threads to aquire/release locks.
+The current implementation uses a class variable to store lock state so it is not thread-safe when using multiple threads to acquire/release locks.
 
 ## Smart lock name
 
@@ -35,13 +38,13 @@ If the lock name exceeds 64 characters, it will be replaced with a lock name of
 
 Bundle with the adapter you want to use, for example
 
-```
-bundle --with mysql2
+```bash
+$ bundle --with mysql
 ```
 
 Run rspec with the database url env variables set. It will only run the specs it can run and skip the others.
 
 For example
-```
-MYSQL_URL=mysql2://root:dummy@localhost/test SQLSERVER_URL=sqlserver://root:dummy@localhost/test rspec
+```bash
+$ MYSQL_URL=mysql2://root:dummy@localhost/test SQLSERVER_URL=sqlserver://root:dummy@localhost/test rspec
 ```

data/lib/db_lock/adapter/mysql.rb

@@ -1,14 +1,14 @@
 module DBLock
   module Adapter
     class MYSQL < Base
-      def lock(name, timeout=0)
-        sql = sanitize_sql_array "SELECT GET_LOCK(?, ?)", name, timeout
+      def lock(name, timeout = 0)
+        sql = sanitize_sql_array 'SELECT GET_LOCK(?, ?)', name, timeout
         res = connection.select_one sql
         (res && res.values.first == 1)
       end
 
       def release(name)
-        sql = sanitize_sql_array "SELECT RELEASE_LOCK(?)", name
+        sql = sanitize_sql_array 'SELECT RELEASE_LOCK(?)', name
         res = connection.select_one sql
         (res && res.values.first == 1)
       end

data/lib/db_lock/adapter/sqlserver.rb

@@ -1,16 +1,22 @@
 module DBLock
   module Adapter
     class Sqlserver < Base
-      def lock(name, timeout=0)
-        connection.execute_procedure 'sp_getapplock', Resource: name, LockMode: 'Exclusive', LockOwner: 'Session', LockTimeout: (timeout*1000).to_i, DbPrincipal: 'public'
+      def lock(name, timeout = 0)
+        connection.execute_procedure 'sp_getapplock', Resource: name,
+                                                      LockMode: 'Exclusive',
+                                                      LockOwner: 'Session',
+                                                      LockTimeout: (timeout * 1000).to_i,
+                                                      DbPrincipal: 'public'
         lock = connection.raw_connection.return_code
-        lock == 0
+        lock.zero?
       end
 
       def release(name)
-        connection.execute_procedure 'sp_releaseapplock', Resource: name, LockOwner: 'Session', DbPrincipal: 'public'
+        connection.execute_procedure 'sp_releaseapplock', Resource: name,
+                                                          LockOwner: 'Session',
+                                                          DbPrincipal: 'public'
         lock = connection.raw_connection.return_code
-        lock == 0
+        lock.zero?
       end
     end
   end

data/lib/db_lock/adapter.rb

@@ -2,9 +2,9 @@ module DBLock
   module Adapter
     extend self
 
-    autoload :Base, "db_lock/adapter/base"
-    autoload :MYSQL, "db_lock/adapter/mysql"
-    autoload :Sqlserver, "db_lock/adapter/sqlserver"
+    autoload :Base, 'db_lock/adapter/base'
+    autoload :MYSQL, 'db_lock/adapter/mysql'
+    autoload :Sqlserver, 'db_lock/adapter/sqlserver'
 
     delegate :lock, :release, to: :implementation
 

data/lib/db_lock/lock.rb

@@ -0,0 +1,51 @@
+require 'digest/md5'
+
+module DBLock
+  module Lock
+    extend self
+
+    # rubocop:disable Metrics/AbcSize
+    def get(name, timeout = 0)
+      timeout = timeout.to_f # catches nil
+      timeout = 0 if timeout.negative?
+
+      raise "Invalid lock name: #{name.inspect}" if name.empty?
+      raise AlreadyLocked, 'Already lock in progress' if locked?
+
+      name = generate_lock_name(name)
+
+      if Adapter.lock(name, timeout)
+        @locked = true
+        yield
+      else
+        raise AlreadyLocked, "Unable to obtain lock '#{name}' within #{timeout} seconds" unless locked?
+      end
+    ensure
+      Adapter.release(name) if locked?
+      @locked = false
+    end
+    # rubocop:enable Metrics/AbcSize
+
+    def locked?
+      @locked ||= false
+    end
+
+    private
+
+    def generate_lock_name(name)
+      name = "#{rails_app_name}.#{Rails.env}#{name}" if name[0] == '.' && defined? Rails
+      # reduce lock names of > 64 chars in size
+      # MySQL 5.7 only supports 64 chars max, there might be similar limitations elsewhere
+      name = "#{name.chars.first(15).join}-#{Digest::MD5.hexdigest(name)}-#{name.chars.last(15).join}" if name.length > 64
+      name
+    end
+
+    def rails_app_name
+      if Gem::Version.new(Rails.version) >= Gem::Version.new('6.0.0')
+        Rails.application.class.module_parent_name
+      else
+        Rails.application.class.parent_name
+      end
+    end
+  end
+end

data/lib/db_lock/version.rb

@@ -1,3 +1,3 @@
 module DBLock
-  VERSION = "0.7"
+  VERSION = '0.8.2'.freeze
 end

data/lib/db_lock.rb

@@ -3,7 +3,8 @@ require 'digest/md5'
 module DBLock
   extend self
 
-  autoload :Adapter, "db_lock/adapter"
+  autoload :Adapter, 'db_lock/adapter'
+  autoload :Lock, 'db_lock/lock'
 
   class AlreadyLocked < StandardError; end
 
@@ -13,47 +14,4 @@ module DBLock
     # this must be an active record base object or subclass
     @db_handler || ActiveRecord::Base
   end
-
-  module Lock
-    extend self
-
-    def get(name, timeout=0)
-      timeout = timeout.to_f # catches nil
-      timeout = 0 if timeout < 0
-      raise "Invalid lock name: #{name.inspect}" if name.empty?
-      raise AlreadyLocked.new("Already lock in progress") if locked?
-
-      name = generate_lock_name(name)
-
-      if Adapter.lock(name, timeout)
-        @locked = true
-        yield
-      else
-        raise AlreadyLocked.new("Unable to obtain lock '#{name}' within #{timeout} seconds") unless locked?
-      end
-    ensure
-      if locked?
-        Adapter.release(name)
-      end
-      @locked = false
-    end
-
-    def locked?
-      @locked ||= false
-    end
-
-    private
-
-    def generate_lock_name(name)
-      if (name[0] == "." && defined? Rails)
-        name = "#{Rails.application.class.parent_name}.#{Rails.env}#{name}"
-      end
-      # reduce lock names of > 64 chars in size
-      # MySQL 5.7 only supports 64 chars max, there might be similar limitations elsewhere
-      if name.length > 64
-        name = "#{name.chars.first(15).join}-#{Digest::MD5.hexdigest(name)}-#{name.chars.last(15).join}"
-      end
-      name
-    end
-  end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: db_lock
 version: !ruby/object:Gem::Version
-  version: '0.7'
+  version: 0.8.2
 platform: ruby
 authors:
 - mkon
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2018-04-30 00:00:00.000000000 Z
+date: 2022-05-03 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activerecord
@@ -16,20 +16,20 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '3.0'
+        version: '5.2'
     - - "<"
       - !ruby/object:Gem::Version
-        version: '6'
+        version: '7.1'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '3.0'
+        version: '5.2'
     - - "<"
       - !ruby/object:Gem::Version
-        version: '6'
+        version: '7.1'
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
@@ -44,8 +44,50 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '3.7'
-description: Obtain manual db locks to guard blocks of code from parallel execution.
-  Currently only supports mysql and ms-sql-server.
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 1.28.2
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 1.28.2
+- !ruby/object:Gem::Dependency
+  name: rubocop-rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 2.10.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 2.10.0
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  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'
+description: Obtain manual db locks to guard blocks of code from parallel execution.Currently
+  only supports mysql and ms-sql-server.
 email:
 - konstantin@munteanu.de
 executables: []
@@ -54,21 +96,19 @@ extra_rdoc_files: []
 files:
 - MIT-LICENSE
 - README.md
-- config/database_mssql.yml
-- config/database_mssql_example.yml
-- config/database_mysql.yml
-- config/database_mysql_example.yml
 - lib/db_lock.rb
 - lib/db_lock/adapter.rb
 - lib/db_lock/adapter/base.rb
 - lib/db_lock/adapter/mysql.rb
 - lib/db_lock/adapter/sqlserver.rb
+- lib/db_lock/lock.rb
 - lib/db_lock/version.rb
 homepage: https://github.com/mkon/db_lock
 licenses:
 - MIT
-metadata: {}
-post_install_message: 
+metadata:
+  rubygems_mfa_required: 'true'
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -76,16 +116,18 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '0'
+      version: '2.7'
+  - - "<"
+    - !ruby/object:Gem::Version
+      version: '3.1'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.7.5
-signing_key: 
+rubygems_version: 3.2.15
+signing_key:
 specification_version: 4
 summary: Obtain manual db/mysql locks
 test_files: []

data/config/database_mssql.yml

@@ -1,17 +0,0 @@
-# rename/copy to database.yml and adjust to your local settings
-
-base: &base
-  adapter: sqlserver
-  host: 192.168.99.100
-  port: 50012
-  encoding: utf8
-  reconnect: false
-  pool: 5
-  username: root
-  password: dummy
-
-development:
-  <<: *base
-
-test:
-  <<: *base

data/config/database_mssql_example.yml

@@ -1,17 +0,0 @@
-# rename/copy to database.yml and adjust to your local settings
-
-base: &base
-  adapter: sqlserver
-  host: 192.168.99.100
-  port: 50012
-  encoding: utf8
-  reconnect: false
-  pool: 5
-  username: root
-  password: dummy
-
-development:
-  <<: *base
-
-test:
-  <<: *base

data/config/database_mysql.yml

@@ -1,14 +0,0 @@
-base: &base
-  adapter: mysql2
-  host: localhost
-  encoding: utf8
-  reconnect: false
-  pool: 5
-  username: root
-  password: dummy
-
-development:
-  <<: *base
-
-test:
-  <<: *base

data/config/database_mysql_example.yml

@@ -1,16 +0,0 @@
-# rename/copy to database.yml and adjust to your local settings
-
-base: &base
-  adapter: mysql2
-  host: localhost
-  encoding: utf8
-  reconnect: false
-  pool: 5
-  username: root
-  password: dummy
-
-development:
-  <<: *base
-
-test:
-  <<: *base