db_lock 0.2 → 0.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 6d6e7ea22f5605c0ff4757bd887d09e7476fb0c6
-  data.tar.gz: b6f3b247ca65f396f25500ef2fb5483d26a038dd
+  metadata.gz: b31aa49ced9bf1f6fc1ae0ebc3018a7feb1e3738
+  data.tar.gz: 8de321f98a12ad5da8dd5906e7a2753e0e13b7e2
 SHA512:
-  metadata.gz: 3c36da7eec8ecbfce5d44180e04f09b0d647ec6d9c9279fa38f64d81d6e47e4e969abc17ddeeaa36a4268719df7f5f50a7ee5f92563e0726544946defdd3b37b
-  data.tar.gz: 36c3032bd368110e2fe002c75a2b4735bc262fd87ba6c1f34a55c8a3aad5d6854a380a880cc34e2e88a8f41d1492d8d6b462e73fe2c477a41edc12daba97daf4
+  metadata.gz: 701e854fdb2411b7754e2adad66f9441a16a2dcab2c0331424b2b45de3f7bea6ca8e08bdd5c67f1d18069cd5e4696b2af1cb33eb6659d7b1c70b04b682bfbd88
+  data.tar.gz: b686dd636d4e69708112fbac457525ecd5f692f0152d132752c8250e64d2c6bdfae5a1f71deedde790b685388f8b5019f2fb686a41aa9f3de4435a03e8fd8423

data/README.md

@@ -1,6 +1,6 @@
 # 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 exampel when corn jobs run for too long or are accidnetially started multiple times).
+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).
 
 ## Installation
 
@@ -18,8 +18,15 @@ DBLock::Lock.get('name_of_lock', 5) do
 end
 ```
 
-Before the code block is executed, it will attempt to aquire 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.
+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.
 
 ## Smart lock name
 
-If you prefix the lock with a `.` in a Rails application, `.` will be automatically replaced with `YourAppName.`.
+If you prefix the lock with a `.` in a Rails application, `.` will be automatically replaced with `YourAppName.environment` (production/development/etc).
+
+
+## Development
+
+You will have to rename/copy `config/database_example.yml` to `config/database.yml` and adjust it to your local settings.

data/config/database.yml

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

data/config/database_example.yml

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

data/lib/db_lock/version.rb

@@ -1,3 +1,3 @@
 module DBLock
-  VERSION = "0.2"
+  VERSION = "0.3"
 end

data/lib/db_lock.rb

@@ -6,17 +6,23 @@ module DBLock
       def get(name, timeout=0)
         timeout = timeout.to_i # catches nil
         timeout = 0 if timeout < 0
-        raise "invalid lock name: #{name.inspect}" if !name or name.to_s.length == 0
+        raise "Invalid lock name: #{name.inspect}" if name.empty?
         raise AlreadyLocked.new("Already lock in progress") if locked?
+
         name = prefixed_lock_name(name)
-        res = ActiveRecord::Base.connection.execute("SELECT GET_LOCK('#{name}', #{timeout})")
-        if @locked = (res and res.first and res.first[0] == 1)
+
+        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)
           yield
         else
-          raise AlreadyLocked.new("Unable to obtain lock '#{name}' within #{timeout} seconds") unless @locked
+          raise AlreadyLocked.new("Unable to obtain lock '#{name}' within #{timeout} seconds") unless locked?
         end
       ensure
-        ActiveRecord::Base.connection.execute("SELECT RELEASE_LOCK('#{name}')") if @locked
+        if locked?
+          sql = ActiveRecord::Base.send(:sanitize_sql_array, ["SELECT RELEASE_LOCK(?)", name])
+          ActiveRecord::Base.connection.execute(sql)
+        end
         @locked = false
       end
 
@@ -24,14 +30,10 @@ module DBLock
         @locked ||= false
       end
 
-    private
+      private
 
       def prefixed_lock_name(name)
-        if name[0] == "." and defined? Rails
-          name = "#{Rails.application.class.parent_name}#{name}"
-        else
-          name
-        end
+        (name[0] == "." && defined? Rails) ? "#{Rails.application.class.parent_name}.#{Rails.env}#{name}" : name
       end
     end
   end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: db_lock
 version: !ruby/object:Gem::Version
-  version: '0.2'
+  version: '0.3'
 platform: ruby
 authors:
 - mkon
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-08-14 00:00:00.000000000 Z
+date: 2015-04-13 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activerecord
@@ -44,6 +44,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: mysql2
+  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.
 email:
@@ -54,6 +68,8 @@ extra_rdoc_files: []
 files:
 - MIT-LICENSE
 - README.md
+- config/database.yml
+- config/database_example.yml
 - lib/db_lock.rb
 - lib/db_lock/version.rb
 homepage: https://github.com/mkon/db_lock