ar_lock 0.1.0 → 0.2.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: db283404486b781cd5d9208bcb164dcbec5ee3ec
+  data.tar.gz: c1dc98c45377586d05c2ec45a3f4cf75f65dd0b4
+SHA512:
+  metadata.gz: 204b456b525ac84293b34074b7eb2585d9c911e223d9208596d8dccc8eeb234fdfe07b74e2d5ab721e39dbdd53942b6e5cfb325319ba99306944aaab3e246de5
+  data.tar.gz: 66ce042d815aabb14699acf96467c47b94e369499a2a2707c3d2b4eb73035b9e3a983249dd47971f37ee2278a25062b1ece01d88f26d69e3bd63e776f206d05b

data/README.rdoc

@@ -1,4 +1,5 @@
 = ArLock for Rails3
+{<img src="https://codeclimate.com/github/InWork/ar_lock.png" />}[https://codeclimate.com/github/InWork/ar_lock]
 
 This Rails3 Gem implements an atomic locking model based on ActiveRecord.
 
@@ -6,46 +7,51 @@ This Rails3 Gem implements an atomic locking model based on ActiveRecord.
 
 Inside your Gemfile:
 
-  gem "ar_record"
+  gem "ar_lock"
 
 and then run:
 
 * bundle install
 
-=== Gem Dependencies
-
-Please check if all those requirements are satisfied on your environment.
-
-* rails >= 3.0.0
-
 === Inside your Application:
 
 Geting a lock is always an atomic operation. If you try to get more than one lock (by specifying an array), this is also executed atomic.
 
 ==== Get lock(s):
+Get one lock:
   Lock.get :lock_name
-or
+
+Get multiple locks as one atomic operation:
   Lock.get [:lock_name1, :lock_name2]
 
 optional you can specify a value (for example the user, which acquired the lock):
-  Lock.get :lock_name, :value => 'value'
-or
-  Lock.get [:lock_name1, :lock_name2], :value => 'value'
+  Lock.get :lock_name, value: 'value'
 
 You can let Lock.get block, until the lock was acquired:
-  Lock.get :lock_name, :blocking => true
-or
-  Lock.get [:lock_name1, :lock_name2], :blocking => true
+  Lock.get :lock_name, blocking: true
+
+If you do not want a lock which was already acquired will block your code:
+  Lock.get :lock_name, blocking: true, successful_if: :value_matches
+
+It is possible to force a lock. Values of already acquired locks will be overwriten by the given value.
+  Lock.get :lock_name, value: 'value', force: true
 
 ==== Release lock(s):
+Release one Lock:
   Lock.release :lock_name
-or
+
+Release multiple locks:
   Lock.release [:lock_name1, :lock_name2]
 
 Only release a lock, if the value matches:
-  Lock.release :lock_name, :value => 'value'
-or
-  Lock.release [:lock_name1, :lock_name2], :value => 'value'
+  Lock.release :lock_name, value: 'value'
+
+You can also release all locks at once:
+  Lock.release_all
+
+==== Get the value of a lock:
+To read the value of a lock:
+  Lock.get_value :lock_name
 
 == Generators
 
@@ -61,6 +67,8 @@ This will create a database migration:
 
   TIMESTAMP_add_ar_lock_table.rb
 
-== Copyright
+== License
+This project is licenced under the MIT license.
 
-Copyright (c) 2011 Philip Kurmann. See LICENSE for details.
+== Author
+Philip Kurmann (philip (at) kman.ch)

data/app/models/lock.rb

@@ -2,8 +2,9 @@ class Lock < ActiveRecord::Base
 
   # Get an atomic lock if value matches or is nil. Block until lock was successful if args[:blocking] was set to true
   def self.get name, args = {}
-    poll_time = args[:poll_time] || 10
-    until (lock = get_lock_for(name, args)) || args[:blocking] != true do
+    poll_time  = args[:poll_time] || 10
+    start_time = Time.now
+    until (lock = get_lock_for(name, args)) || args[:blocking] != true || (args[:timeout] && (Time.now - start_time) > args[:timeout]) do
       sleep poll_time
     end
     lock
@@ -69,7 +70,7 @@ private
   # Get an atomic lock if value matches or is nil
   def self.get_lock_for names, args = {}
     successful_if_value_matches = args[:successful_if].to_s == 'value_matches'
-    successful = false
+    successful                  = false
 
     if names
       # If names is a single string, transorm it to an array
@@ -108,7 +109,7 @@ private
           end
         end
 
-        # Wait some secound inside the transaction for debuging and testing purposes
+        # Wait some seconds inside the transaction for debuging and testing purposes
         sleep args[:debug_wait].to_i if args[:debug_wait]
       end
     end

data/lib/ar_lock/version.rb

@@ -1,3 +1,3 @@
 module ArLock
-  VERSION = "0.1.0"
+  VERSION = "0.2.0"
 end

metadata

@@ -1,15 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: ar_lock
 version: !ruby/object:Gem::Version
-  version: 0.1.0
-  prerelease: 
+  version: 0.2.0
 platform: ruby
 authors:
 - Philip Kurmann
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-07-19 00:00:00.000000000 Z
+date: 2015-01-26 00:00:00.000000000 Z
 dependencies: []
 description: Atomic lock model which stores its locks in the database.
 email:
@@ -18,7 +17,7 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- .gitignore
+- ".gitignore"
 - Gemfile
 - LICENSE
 - README.rdoc
@@ -31,26 +30,25 @@ files:
 - lib/generators/ar_lock/migration/templates/migration.rb
 homepage: ''
 licenses: []
+metadata: {}
 post_install_message: 
 rdoc_options: []
 require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
-  none: false
   requirements:
-  - - ! '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 required_rubygems_version: !ruby/object:Gem::Requirement
-  none: false
   requirements:
-  - - ! '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
 rubyforge_project: ar_lock
-rubygems_version: 1.8.24
+rubygems_version: 2.2.2
 signing_key: 
-specification_version: 3
+specification_version: 4
 summary: Atomic lock model implemented by Active Record
 test_files: []