pond 0.2.0 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: c9254999a6eb11a5873947aa1fee8bc5ad326be3
-  data.tar.gz: fc080fdb56ada8713ffff8bbe2b82a535a4125c3
+SHA256:
+  metadata.gz: fb81d9b25548e6bf5597f1913abae8f6b23267935ed80046bac46c93b9009c9e
+  data.tar.gz: 0277ee3dc97174765982f652a17cd25aa0b036f76fedb9cbb2e74e68828fec23
 SHA512:
-  metadata.gz: aecc96803e996c38b4168fa287cd3f4f39eb0d8b2d448b9a6c36d9fa63fcb2cba14e2fc06f4377238d7bf6632410a1ebff38e460d8200c975249b77b1b9f7eae
-  data.tar.gz: ded459d09b79d4017db0e878a0cbccc44c99c47998a6224ebdb34ec8bd91dddf15763cda57d435a9f79f299fb0f316c1b2ed66de5b7223c25fb2bae1d91638b5
+  metadata.gz: 26b39d4fffd6d0bc73d67fb887cdff1cceb46f88b8b9a43995d88c871e43bae945f67d3c5622a0cfb046e746a479f8a82c79b8bb80eada804ce6edecf38d0815
+  data.tar.gz: c274760c15f6fb92b7a2f3c8e00a162ffc1dac5b2a1a940de9a6565083d34198c5d08d80cf3cfa3a530a9306f541b2b01ced8f05dacaa78378a356e9d8c189e8

data/CHANGELOG.md

@@ -1,3 +1,9 @@
+### 0.3.0 (2018-03-27)
+
+*   Support scoped checkouts.
+
+*   Use frozen string literals.
+
 ### 0.2.0 (2016-02-05)
 
 *   Add an option for a detach_if callable, which can contain logic to

data/lib/pond.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'monitor'
 
 require 'pond/version'
@@ -7,32 +9,41 @@ class Pond
 
   attr_reader :allocated, :available, :timeout, :collection, :maximum_size, :detach_if
 
-  def initialize(options = {}, &block)
+  DEFAULT_DETACH_IF = lambda { |_| false }
+
+  def initialize(
+    maximum_size: 10,
+    eager: false,
+    timeout: 1,
+    collection: :queue,
+    detach_if: DEFAULT_DETACH_IF,
+    &block
+  )
     @block   = block
     @monitor = Monitor.new
     @cv      = Monitor::ConditionVariable.new(@monitor)
 
-    maximum_size = options.fetch :maximum_size, 10
-
     @allocated = {}
-    @available = Array.new(options[:eager] ? maximum_size : 0, &block)
+    @available = Array.new(eager ? maximum_size : 0, &block)
 
-    self.timeout      = options.fetch :timeout, 1
-    self.collection   = options.fetch :collection, :queue
-    self.detach_if    = options.fetch :detach_if, lambda { |_| false }
+    self.timeout      = timeout
+    self.collection   = collection
+    self.detach_if    = detach_if
     self.maximum_size = maximum_size
   end
 
-  def checkout(&block)
-    if object = current_object
+  def checkout(scope: nil, &block)
+    raise "Can't checkout with a non-frozen scope" unless scope.frozen?
+
+    if object = current_object(scope: scope)
       yield object
     else
-      checkout_object(&block)
+      checkout_object(scope: scope, &block)
     end
   end
 
   def size
-    sync { @available.size + @allocated.size }
+    sync { @allocated.inject(@available.size){|sum, (h, k)| sum + k.length} }
   end
 
   def timeout=(timeout)
@@ -60,22 +71,22 @@ class Pond
 
   private
 
-  def checkout_object
-    lock_object
-    yield current_object
+  def checkout_object(scope:)
+    lock_object(scope: scope)
+    yield current_object(scope: scope)
   ensure
-    unlock_object
+    unlock_object(scope: scope)
   end
 
-  def lock_object
+  def lock_object(scope:)
     deadline = Time.now + @timeout
 
-    until current_object
+    until current_object(scope: scope)
       raise Timeout if (time_left = deadline - Time.now) < 0
 
       sync do
         if object = get_object(time_left)
-          set_current_object(object)
+          set_current_object(object, scope: scope)
         end
       end
     end
@@ -85,16 +96,18 @@ class Pond
     # call the instantiation block while we have the lock, since it may take a
     # long time to return. So, we set the checked-out object to the block as a
     # signal that it needs to be called.
-    set_current_object(@block.call) if current_object == @block
+    if current_object(scope: scope) == @block
+      set_current_object(@block.call, scope: scope)
+    end
   end
 
-  def unlock_object
+  def unlock_object(scope:)
     object               = nil
     detach_if            = nil
     should_return_object = nil
 
     sync do
-      object               = current_object
+      object               = current_object(scope: scope)
       detach_if            = self.detach_if
       should_return_object = object && object != @block && size <= maximum_size
     end
@@ -105,7 +118,7 @@ class Pond
     ensure
       sync do
         @available << object if detach_check_finished && should_return_object
-        @allocated.delete(Thread.current)
+        @allocated[scope].delete(Thread.current)
         @cv.signal
       end
     end
@@ -122,12 +135,12 @@ class Pond
     end
   end
 
-  def current_object
-    sync { @allocated[Thread.current] }
+  def current_object(scope:)
+    sync { (@allocated[scope] ||= {})[Thread.current] }
   end
 
-  def set_current_object(object)
-    sync { @allocated[Thread.current] = object }
+  def set_current_object(object, scope:)
+    sync { (@allocated[scope] ||= {})[Thread.current] = object }
   end
 
   def sync(&block)

data/lib/pond/version.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 class Pond
-  VERSION = '0.2.0'
+  VERSION = '0.3.0'
 end

data/spec/checkout_spec.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'spec_helper'
 
 describe Pond, "#checkout" do
@@ -20,25 +22,53 @@ describe Pond, "#checkout" do
 
     pond.checkout do |i|
       pond.available.should == []
-      pond.allocated.should == {Thread.current => 1}
+      pond.allocated.should == {nil => {Thread.current => 1}}
       i.should == 1
     end
 
     pond.available.should == [1]
-    pond.allocated.should == {}
+    pond.allocated.should == {nil => {}}
     pond.size.should == 1
 
     pond.checkout do |i|
       pond.available.should == []
-      pond.allocated.should == {Thread.current => 1}
+      pond.allocated.should == {nil => {Thread.current => 1}}
       i.should == 1
     end
 
     pond.available.should == [1]
-    pond.allocated.should == {}
+    pond.allocated.should == {nil => {}}
     pond.size.should == 1
   end
 
+  it "should checkout objects to the given scope, if any" do
+    int = 0
+    pond = Pond.new(eager: true) { int += 1 }
+    pond.size.should == 10
+    pond.available.should == [1, 2, 3, 4, 5, 6, 7, 8, 9, 10]
+
+    pond.checkout do |a|
+      pond.checkout do |b|
+        pond.checkout(scope: :blah) do |c|
+          pond.checkout(scope: :blah) do |d|
+            pond.checkout do |e|
+              [a, b, c, d, e].should == [1, 1, 2, 2, 1]
+            end
+          end
+        end
+      end
+    end
+
+    pond.available.should == [3, 4, 5, 6, 7, 8, 9, 10, 2, 1]
+  end
+
+  it "should throw an error if the passed scope is not frozen" do
+    int = 0
+    pond = Pond.new(eager: true) { int += 1 }
+
+    proc { pond.checkout(scope: String.new) }.should raise_error RuntimeError, "Can't checkout with a non-frozen scope"
+  end
+
   it "should not instantiate objects in excess of the specified maximum_size" do
     object = nil
     pond = Pond.new(:maximum_size => 1) { object = Object.new }
@@ -70,19 +100,19 @@ describe Pond, "#checkout" do
     q1.pop
 
     pond.size.should == 1
-    pond.allocated.should == {t => 1}
+    pond.allocated.should == {nil => {t => 1}}
     pond.available.should == []
 
     pond.checkout { |i| i.should == 2 }
 
     pond.size.should == 2
-    pond.allocated.should == {t => 1}
+    pond.allocated.should == {nil => {t => 1}}
     pond.available.should == [2]
 
     q2.push nil
     t.join
 
-    pond.allocated.should == {}
+    pond.allocated.should == {nil => {}}
     pond.available.should == [2, 1]
   end
 
@@ -108,7 +138,7 @@ describe Pond, "#checkout" do
   end
 
   it "should yield an object to only one thread when many are waiting" do
-    pond = Pond.new(:maximum_size => 1) { 2 }
+    pond = Pond.new(:maximum_size => 1, timeout: 360000) { 2 }
 
     q1, q2, q3 = Queue.new, Queue.new, Queue.new
 
@@ -227,7 +257,7 @@ describe Pond, "#checkout" do
       end
     end.should raise_error RuntimeError, "Blah!"
 
-    pond.allocated.should == {}
+    pond.allocated.should == {nil => {}}
     pond.available.should == [1]
   end
 
@@ -271,7 +301,7 @@ describe Pond, "#checkout" do
     pond.checkout { |i| i.should == 1 }
 
     pond.size.should == 1
-    pond.allocated.should == {}
+    pond.allocated.should == {nil => {}}
     pond.available.should == [1]
 
     error = true
@@ -280,6 +310,7 @@ describe Pond, "#checkout" do
       i.should == 1
 
       t = Thread.new do
+        Thread.current.report_on_exception = false
         pond.checkout{}
       end
 
@@ -287,7 +318,7 @@ describe Pond, "#checkout" do
     end
 
     pond.size.should == 1
-    pond.allocated.should == {}
+    pond.allocated.should == {nil => {}}
     pond.available.should == [1]
 
     error = false
@@ -303,7 +334,7 @@ describe Pond, "#checkout" do
     end
 
     pond.size.should == 2
-    pond.allocated.should == {}
+    pond.allocated.should == {nil => {}}
     pond.available.should == [2, 1]
   end
 
@@ -347,7 +378,7 @@ describe Pond, "#checkout" do
 
     q1.pop
     pond.available.should == []
-    pond.allocated.should == {t => 1}
+    pond.allocated.should == {nil => {t => 1}}
 
     # t is in the middle of invoking detach_if, we should still be able to
     # instantiate new objects and check them out.
@@ -392,6 +423,6 @@ describe Pond, "#checkout" do
     checked_out.should == 2
 
     pond.available.should == [3, 4, 5, 1]
-    pond.allocated.should == {}
+    pond.allocated.should == {nil => {}}
   end
 end

data/spec/config_spec.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'spec_helper'
 
 describe Pond, "configuration" do
@@ -105,13 +107,13 @@ describe Pond, "configuration" do
 
     pond.size.should == 1
     pond.available.should == []
-    pond.allocated.should == {t => 1}
+    pond.allocated.should == {nil => {t => 1}}
 
     q2.push nil
     t.join
 
     pond.size.should == 0
     pond.available.should == []
-    pond.allocated.should == {}
+    pond.allocated.should == {nil => {}}
   end
 end

data/spec/spec_helper.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'pond'
 
 RSpec.configure do |config|

data/spec/wrapper_spec.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'spec_helper'
 
 describe Pond::Wrapper do
@@ -25,7 +27,7 @@ describe Pond::Wrapper do
     id = @wrapper.id
 
     @pond.size.should == 1
-    @pond.allocated.should == {}
+    @pond.allocated.should == {nil => {}}
     @pond.available.map(&:id).should == [id]
   end
 
@@ -51,7 +53,7 @@ describe Pond::Wrapper do
 
       @wrapper.id.should == id1
 
-      @pond.allocated.keys.should == [Thread.current, t]
+      @pond.allocated[nil].keys.should == [Thread.current, t]
       @pond.available.should == []
 
       q2.push nil
@@ -61,7 +63,7 @@ describe Pond::Wrapper do
       @wrapper.id.should == id1
     end
   
-    @pond.allocated.should == {}
+    @pond.allocated.should == {nil => {}}
     @pond.available.map(&:id).should == [id2, id1]
   end
 end

data/tasks/stress.rake

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'pond'
 
 desc "Stress test the Pond gem to check for concurrency issues."
@@ -9,7 +11,7 @@ task :stress do
 
   pond = Pond.new(detach_if: detach_if) do
     raise "Bad Instantiation!" if rand < 0.05
-    "Good!"
+    "Good!".dup
   end
 
   threads =

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: pond
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.3.0
 platform: ruby
 authors:
 - Chris Hanks
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-02-05 00:00:00.000000000 Z
+date: 2018-03-27 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -94,7 +94,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.5.1
+rubygems_version: 2.7.3
 signing_key: 
 specification_version: 4
 summary: A simple, generic, thread-safe pool