db_lock 0.7 → 0.8.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 3494b2768567c673a466817880e0d5d8170371b463b16e1d764c7e9a29819303
-  data.tar.gz: 1129de916ae216947ab91383f34af010a63adccc996f12bfc9b5a1ba2b706785
+  metadata.gz: 1503d17317cf5228fe01da6a352ec350c2a4cbe0818ffbb92fd9cef52e0358f1
+  data.tar.gz: bee5dee60e1e58f3fb6b70d0d9f28383ac8dd4b915989bae98ed4db91d8389a6
 SHA512:
-  metadata.gz: b8194e0c7d778d734503fe0716cfc2dca17524961538cae5b5267ac7ba331f8d34752932970a70fa0b83e2398ff9d8ff6bf6434acf9104437ee1d59a1e0cc7d9
-  data.tar.gz: 2568337c2863e5f76e1c7f38a672885d73f8936ec9b1e45981da3ac964900269b66dc379dc737a68fec24dc42c79f05ff404357c90981a194be3fa5caeea5b4e
+  metadata.gz: aac77d25cf15fb0e7bc1c334cc2ceb677f06d7b905e32b349ef1442bd12361264fe737b8da5bfeb409a44b64e589e826a794b732962f9c157afddbc84b97f847
+  data.tar.gz: bea10e12220d6a98aab6a98731116a2f3b113ffe5a6087f58c8561ba7e9fdbe9e9b0b206da1d25f079c672f27dd18c8708d56f6a8ca57f56f623cd49397ee671

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)
+[![Build Status](https://travis-ci.org/mkon/db_lock.svg?branch=master)](https://travis-ci.org/mkon/db_lock)
+
 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.rb

@@ -3,7 +3,7 @@ require 'digest/md5'
 module DBLock
   extend self
 
-  autoload :Adapter, "db_lock/adapter"
+  autoload :Adapter, 'db_lock/adapter'
 
   class AlreadyLocked < StandardError; end
 
@@ -16,12 +16,11 @@ module DBLock
 
   module Lock
     extend self
-
-    def get(name, timeout=0)
+    def get(name, timeout = 0)
       timeout = timeout.to_f # catches nil
-      timeout = 0 if timeout < 0
+      timeout = 0 if timeout.negative?
       raise "Invalid lock name: #{name.inspect}" if name.empty?
-      raise AlreadyLocked.new("Already lock in progress") if locked?
+      raise AlreadyLocked, 'Already lock in progress' if locked?
 
       name = generate_lock_name(name)
 
@@ -29,12 +28,10 @@ module DBLock
         @locked = true
         yield
       else
-        raise AlreadyLocked.new("Unable to obtain lock '#{name}' within #{timeout} seconds") unless locked?
+        raise AlreadyLocked, "Unable to obtain lock '#{name}' within #{timeout} seconds" unless locked?
       end
     ensure
-      if locked?
-        Adapter.release(name)
-      end
+      Adapter.release(name) if locked?
       @locked = false
     end
 
@@ -45,9 +42,7 @@ module DBLock
     private
 
     def generate_lock_name(name)
-      if (name[0] == "." && defined? Rails)
-        name = "#{Rails.application.class.parent_name}.#{Rails.env}#{name}"
-      end
+      name = "#{Rails.application.class.parent_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
       if name.length > 64

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/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/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: db_lock
 version: !ruby/object:Gem::Version
-  version: '0.7'
+  version: 0.8.0
 platform: ruby
 authors:
 - mkon
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-04-30 00:00:00.000000000 Z
+date: 2020-04-01 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: '4.2'
     - - "<"
       - !ruby/object:Gem::Version
-        version: '6'
+        version: '7'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '3.0'
+        version: '4.2'
     - - "<"
       - !ruby/object:Gem::Version
-        version: '6'
+        version: '7'
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
@@ -44,8 +44,36 @@ 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: 0.78.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 0.78.0
+- !ruby/object:Gem::Dependency
+  name: rubocop-rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 1.37.1
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 1.37.1
+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,9 +82,7 @@ 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
@@ -83,8 +109,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.7.5
+rubygems_version: 3.1.2
 signing_key: 
 specification_version: 4
 summary: Obtain manual db/mysql locks

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_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