redpear 0.9.0 → 0.9.1

data/lib/redpear/store/lock.rb

@@ -24,7 +24,9 @@ class Redpear::Store::Lock < Redpear::Store::Base
     conn.get key
   end
 
-  # Creates a lock and yields a transaction. Example:
+  # Creates a lock and yields a transaction.
+  #
+  # @example
   #
   #   sender    = Redpear::Store::Hash.new "accounts:sender", connection
   #   recipient = Redpear::Store::Hash.new "accounts:recipient", connection
@@ -41,6 +43,7 @@ class Redpear::Store::Lock < Redpear::Store::Base
   # @option [Integer] wait_timeout
   #   Wait for `wait_timeout` seconds to obtain a lock, before timing out. Defaults to 2.
   # @yield [] processes the block within the lock
+  # @raise [Redpear::Store::Lock::LockTimeout] timeout error if lock cannot be ontained
   def lock(options = {})
     options   = self.class.default_options.merge(options)
     result    = nil
@@ -67,6 +70,52 @@ class Redpear::Store::Lock < Redpear::Store::Base
     purge! if timestamp && timestamp > Time.now.to_f
   end
 
+  # Conditional locking. Performs a transaction if lock can be acquired.
+  # @param [Hash] options - see #lock
+  # @yield [] processes the block within the lock
+  # @return [Boolean] true if successful
+  def lock?(options = {}, &block)
+    lock(options, &block)
+    true
+  rescue LockTimeout
+    false
+  end
+
+  # Reserves a lock and yields a transaction, but only if not reserved by
+  # someone else. This is useful when processes can be triggered by concurrent
+  # threads, but should only be executed once.
+  #
+  # @example Calling `execute_once` method only once
+  #
+  #   def execute_once
+  #     # Do something
+  #   end
+  #
+  #   t1 = Thread.new do
+  #     lock = Redpear::Store::Lock.new "locks:reservation", connection
+  #     lock.reserve(60) { execute_once } # Reserve for max. 60 seconds
+  #   end
+  #
+  #   t2 = Thread.new do
+  #     lock = Redpear::Store::Lock.new "locks:reservation", connection
+  #     lock.reserve(60) { execute_once }
+  #   end
+  #
+  #   t1.join
+  #   t2.join
+  #
+  # @param [Integer] seconds the number of seconds
+  # @param [Hash] options
+  # @option [Boolean] options :clear
+  #   Clear the lock after execution, defaults to false
+  # @yield [] processes the block within the lock
+  def reserve(seconds, options = {})
+    timestamp = to_time(seconds).to_f
+    yield if lock_obtained?(timestamp) || expired_lock_obtained?(timestamp)
+  ensure
+    purge! if options[:clear]
+  end
+
   protected
 
     # @param [Float] timestamp

data/lib/redpear/version.rb

@@ -2,7 +2,7 @@ module Redpear
   module VERSION #:nodoc:
     MAJOR = 0
     MINOR = 9
-    TINY  = 0
+    TINY  = 1
     PRE   = nil
 
     STRING = [MAJOR, MINOR, TINY, PRE].compact.join('.')

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: redpear
 version: !ruby/object:Gem::Version
-  version: 0.9.0
+  version: 0.9.1
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-07-07 00:00:00.000000000 Z
+date: 2012-07-13 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: redis
@@ -129,30 +129,30 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- lib/redpear.rb
 - lib/redpear/connection.rb
-- lib/redpear/schema.rb
-- lib/redpear/store/lock.rb
-- lib/redpear/store/set.rb
-- lib/redpear/store/base.rb
-- lib/redpear/store/value.rb
-- lib/redpear/store/sorted_set.rb
-- lib/redpear/store/enumerable.rb
-- lib/redpear/store/hash.rb
-- lib/redpear/store/counter.rb
-- lib/redpear/store/list.rb
-- lib/redpear/concern.rb
-- lib/redpear/store.rb
-- lib/redpear/model.rb
 - lib/redpear/schema/column.rb
-- lib/redpear/schema/score.rb
 - lib/redpear/schema/index.rb
 - lib/redpear/schema/collection.rb
+- lib/redpear/schema/score.rb
+- lib/redpear/concern.rb
+- lib/redpear/store.rb
 - lib/redpear/model/factory_girl.rb
 - lib/redpear/model/finders.rb
-- lib/redpear/model/machinist.rb
 - lib/redpear/model/expiration.rb
+- lib/redpear/model/machinist.rb
 - lib/redpear/version.rb
-- lib/redpear.rb
+- lib/redpear/store/lock.rb
+- lib/redpear/store/enumerable.rb
+- lib/redpear/store/counter.rb
+- lib/redpear/store/hash.rb
+- lib/redpear/store/base.rb
+- lib/redpear/store/value.rb
+- lib/redpear/store/list.rb
+- lib/redpear/store/set.rb
+- lib/redpear/store/sorted_set.rb
+- lib/redpear/model.rb
+- lib/redpear/schema.rb
 homepage: https://github.com/bsm/redpear
 licenses: []
 post_install_message: