db_lock 0.4 → 0.5.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 7230e5421d955e3ed7e9903b2a730bcde5200bb4
-  data.tar.gz: 551309356ff9e36e28a657f5d981d5dd5fd8cec0
+  metadata.gz: 19334766edb61a395f630243e0bec6c53827ddbf
+  data.tar.gz: 325f88fddbc51047c70be06820e398f5c01ea935
 SHA512:
-  metadata.gz: 5a4778d48baed0e2cd1c80e7473c8a5146cf3a9376a1635568b115bc69e8d687407e2ab5aae8d2ccffd2ce6e1c87208ba8f3e08cff0ddd27042289175e07ed68
-  data.tar.gz: 8e16aa30a9f515abe1f4628642e30495dbc0fc6dde3a74ec7e14dfd501e640e7fb198412ef658451c611d7293696b8b19a2d610dc7e8b3d4bd975aa60ac2299f
+  metadata.gz: 10f2acba08e807842a1ec99187f21619b1c2a051bdec0eb92e035ea5034e309fe5081297ac4adde3a9cf221168d9014931859dac75e6dac0660e25bbaf3cc11e
+  data.tar.gz: 40463f4ec1e2765239f583d73a3d00ef5516a616fcc4526dd9fc9cc9be278f4347face79d1bfe5a0681d03918aa75bf7f27cf8df031f2fb89dbb1623162cfcc7

data/README.md

@@ -1,6 +1,9 @@
 # DBLock
 
-Gem to obtain and release manual mysql 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).
+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
+- Microsoft SQL Server
 
 ## Installation
 
@@ -29,4 +32,4 @@ If you prefix the lock with a `.` in a Rails application, `.` will be automatica
 
 ## Development
 
-You will have to rename/copy `config/database_example.yml` to `config/database.yml` and adjust it to your local settings.
+You will have to rename/copy `config/database_mysql_example.yml` to `config/database_mysql.yml` and adjust it to your local settings. Same with the MS SQL configuration file.

data/config/database_mssql.yml

@@ -0,0 +1,17 @@
+# 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

@@ -0,0 +1,17 @@
+# 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/lib/db_lock/adapter/base.rb

@@ -0,0 +1,17 @@
+module DBLock
+  module Adapter
+    class Base
+      include Singleton
+
+      private
+
+      def connection
+        DBLock.db_handler.connection
+      end
+
+      def sanitize_sql_array(*args)
+        DBLock.db_handler.send(:sanitize_sql_array, args)
+      end
+    end
+  end
+end

data/lib/db_lock/adapter/mssql.rb

@@ -0,0 +1,17 @@
+module DBLock
+  module Adapter
+    class MSSQL < Base
+      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
+      end
+
+      def release(name)
+        connection.execute_procedure 'sp_releaseapplock', Resource: name, LockOwner: 'Session', DbPrincipal: 'public'
+        lock = connection.raw_connection.return_code
+        lock == 0
+      end
+    end
+  end
+end

data/lib/db_lock/adapter/mysql.rb

@@ -0,0 +1,17 @@
+module DBLock
+  module Adapter
+    class MYSQL < Base
+      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
+        res = connection.select_one sql
+        (res && res.values.first == 1)
+      end
+    end
+  end
+end

data/lib/db_lock/adapter.rb

@@ -0,0 +1,22 @@
+module DBLock
+  module Adapter
+    extend self
+
+    autoload :Base, "db_lock/adapter/base"
+    autoload :MSSQL, "db_lock/adapter/mssql"
+    autoload :MYSQL, "db_lock/adapter/mysql"
+
+    delegate :lock, :release, to: :implementation
+
+    def implementation
+      case DBLock.db_handler.connection.adapter_name.downcase
+      when 'mysql2'
+        MYSQL.instance
+      when 'sqlserver'
+        MSSQL.instance
+      else
+        raise "#{DBLock.db_handler.connection.adapter_name} is not implemented"
+      end
+    end
+  end
+end

data/lib/db_lock/version.rb

@@ -1,3 +1,3 @@
 module DBLock
-  VERSION = "0.4"
+  VERSION = "0.5.1"
 end

data/lib/db_lock.rb

@@ -1,6 +1,17 @@
 module DBLock
+  extend self
+
+  autoload :Adapter, "db_lock/adapter"
+
   class AlreadyLocked < StandardError; end
 
+  attr_accessor :db_handler
+
+  def db_handler
+    # this must be an active record base object or subclass
+    @db_handler || ActiveRecord::Base
+  end
+
   class Lock
     class << self
       def get(name, timeout=0)
@@ -11,17 +22,15 @@ module DBLock
 
         name = prefixed_lock_name(name)
 
-        sql = ActiveRecord::Base.send(:sanitize_sql_array, ["SELECT GET_LOCK(?, ?)", name, timeout])
-        lock = ActiveRecord::Base.connection.execute(sql)
-        if @locked = (lock and lock.first and lock.first[0] == 1)
+        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?
-          sql = ActiveRecord::Base.send(:sanitize_sql_array, ["SELECT RELEASE_LOCK(?)", name])
-          ActiveRecord::Base.connection.execute(sql)
+          Adapter.release(name)
         end
         @locked = false
       end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: db_lock
 version: !ruby/object:Gem::Version
-  version: '0.4'
+  version: 0.5.1
 platform: ruby
 authors:
 - mkon
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-05-16 00:00:00.000000000 Z
+date: 2016-06-28 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activerecord
@@ -50,16 +50,50 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '3'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '5'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '3'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '5'
+- !ruby/object:Gem::Dependency
+  name: tiny_tds
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+- !ruby/object:Gem::Dependency
+  name: activerecord-sqlserver-adapter
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.2'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.2'
 description: Obtain manual db locks to guard blocks of code from parallel execution.
-  Currently only supports mysql.
+  Currently only supports mysql and ms-sql-server.
 email:
 - konstantin@munteanu.de
 executables: []
@@ -68,9 +102,15 @@ extra_rdoc_files: []
 files:
 - MIT-LICENSE
 - README.md
-- config/database.yml
-- config/database_example.yml
+- 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/mssql.rb
+- lib/db_lock/adapter/mysql.rb
 - lib/db_lock/version.rb
 homepage: https://github.com/mkon/db_lock
 licenses:
@@ -92,7 +132,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.2.2
+rubygems_version: 2.5.1
 signing_key: 
 specification_version: 4
 summary: Obtain manual db/mysql locks