locker 0.3.2 → 0.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 1623bce6a4448a47c0f7244284c37a68b40a9fb3
-  data.tar.gz: c4b81eada8d4cf229eda2854308da3f7a13d13d3
+  metadata.gz: 3af785ef3147f838f184baa9f7843efd53b8e825
+  data.tar.gz: 43c060bb7b1440a18c3c651dc5d348d072bf58cb
 SHA512:
-  metadata.gz: eb8b6a9996aeacd61f13101c8c84d0becdddd62caaaa2672f926934fb2f7ea2c5c403d50ff8ceb756c321bf2d9d77eaac2bc4c81ef9fc66bb220e8fa135543e7
-  data.tar.gz: 127921d87034603b81452a88bf578913f5b6cdaac722fd9bb8f05b43ba16c6e7ab05eab3c395b1297f72b8f6f097b538623342c357d36e8be3ca1c8b7b5d6135
+  metadata.gz: 44ebab072cb5ce6790ca98770f87ab47e31acdcf1f6c0f2d2a72682f3e7d87724532e7ba6ec2df8db520098cd28ed0fa61639fd4ce6e6161149d677dbaf78dac
+  data.tar.gz: f5268918d45c633d082f225bef6c69e5391d19e2e9b0a70163159ca5ed18172886203fe304c85ced60c9386ea7ee60fab4a7a9d275b989a41e68c46facf88b71

data/lib/locker/advisory.rb

@@ -13,11 +13,13 @@ class Locker
     def initialize(key, options={})
       raise ArgumentError, "key must be a string" unless key.is_a?(String)
 
-      @key       = key
-      @crc       = convert_to_crc(key)
-      @lockspace = (options[:lockspace] || 1)
-      @blocking  = !!options[:blocking]
-      @locked    = false
+      @key             = key
+      @crc             = convert_to_crc(key)
+      @lockspace       = (options[:lockspace] || 1)
+      @blocking        = !!options[:blocking]
+      @locked          = false
+      @block_timeout   = options[:block_timeout]
+      @block_spin_wait = options[:block_spin_wait] || 0.005
 
       if !@lockspace.is_a?(Integer) || @lockspace < MIN_LOCK || @lockspace > MAX_LOCK
         raise ArgumentError, "The :lockspace option must be an integer between #{MIN_LOCK} and #{MAX_LOCK}"
@@ -32,8 +34,13 @@ class Locker
     def run(&block)
       connection = ActiveRecord::Base.connection_pool.checkout
       connection.transaction :requires_new => true do
+        if @blocking && @block_timeout
+          break_at = Time.now + @block_timeout
+        end
+
         while !get(connection) && @blocking
-          sleep 0.005
+          break if break_at && break_at < Time.now
+          sleep @block_spin_wait
         end
 
         if @locked

data/lib/locker/version.rb

@@ -1,3 +1,3 @@
 class Locker
-  VERSION = "0.3.2"
+  VERSION = "0.4.0"
 end

data/spec/locker/advisory_spec.rb

@@ -72,6 +72,27 @@ describe Locker::Advisory do
       expect(lock1_result).to be true
       expect(lock2_result).to be true
     end
+
+    it "blocks with a timeout" do
+      started_at = Time.now
+      t1 = Thread.new do
+        Locker::Advisory.run("foo") do
+          sleep 2
+        end
+      end
+
+      t2 = Thread.new do
+        sleep 0.5
+        Locker::Advisory.run("foo", :blocking => true, :block_timeout => 1) do
+          sleep 10 # never hits this
+        end
+      end
+
+      expect(t1.value).to be(true)
+      expect(t2.value).to be(false)
+
+      expect(Time.now - started_at).to be < 2.5
+    end
   end
 
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: locker
 version: !ruby/object:Gem::Version
-  version: 0.3.2
+  version: 0.4.0
 platform: ruby
 authors:
 - Nathan Sutton
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-04-07 00:00:00.000000000 Z
+date: 2017-06-08 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activerecord
@@ -114,7 +114,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: locker
-rubygems_version: 2.4.8
+rubygems_version: 2.6.2
 signing_key: 
 specification_version: 4
 summary: Locker is a locking mechanism for limiting the concurrency of ruby code using