async-pool 0.3.3 → 0.3.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 91d47d29e5bb2e6a93668145c06b432ee26393019cb253d284ffb48cf2c8285b
-  data.tar.gz: 3b3d98e86aec3e783fa5ed98eb803d0f8efe382c0f4b32d518779c09ca736c2d
+  metadata.gz: 53496ca8f02b057c94d8cef37e92f7d14bb3d7062267ea53f363d5ca3c2ee7d4
+  data.tar.gz: b59bb3a498bb16b1306eea4b6bcb765efa60a479701f546a3c2b6785ff5203e1
 SHA512:
-  metadata.gz: 34260d06050fe9829ddd40c2a29444548707661262e34df4bd956f3f1a37dd34ab7f6a59cb78ae1acc7388951ec3777b52beff1fa8e2bf6426ad46214e724d21
-  data.tar.gz: f82218caa4733fec59c17ef9aff190e1617aee3049a16629ecfbc15b0c7e6618f1176f9f2bb26e2e67db0388b5f5dc7f164add84efd09f9e49c0776bb36a690d
+  metadata.gz: f53063512c044675725eed75b72346644a36c99704bf2f1559692420f7176b88063cb79200d4a24f19f8cd081be224e307a811d91dc8a94923cccb87cf850cc4
+  data.tar.gz: 366355082c92722989dd76607f611fd81f520844b8733e15872db4164a146bc2e257e40f316bc87c173a49b65d465e07cccdf459fea242b9c8445841c13f7580

data/lib/async/pool/controller.rb

@@ -32,9 +32,13 @@ module Async
 			end
 			
 			def initialize(constructor, limit: nil)
+				# All available resources:
 				@resources = {}
 				
+				# Resources which may be available to be acquired:
+				# This list may contain false positives, or resources which were okay but have since entered a state which is unusuable.
 				@available = []
+				
 				@notification = Async::Notification.new
 				
 				@limit = limit
@@ -45,7 +49,7 @@ module Async
 				@gardener = nil
 			end
 			
-			# @attr [Hash<Resource, Integer>] all allocated resources, and their associated usage.
+			# @attribute [Hash(Resource, Integer)] all allocated resources, and their associated usage.
 			attr :resources
 			
 			def size
@@ -66,6 +70,11 @@ module Async
 				return false
 			end
 			
+			# Whether there are available resources, i.e. whether {#acquire} can reuse an existing resource.
+			def available?
+				@available.any?
+			end
+			
 			# Wait until a pool resource has been freed.
 			def wait
 				@notification.wait
@@ -119,7 +128,9 @@ module Async
 				unused = []
 				
 				@resources.each do |resource, usage|
-					unused << resource if usage.zero?
+					if usage.zero?
+						unused << resource
+					end
 				end
 				
 				unused.each do |resource|
@@ -132,6 +143,14 @@ module Async
 					break if @resources.size <= retain
 				end
 				
+				# Update availability list:
+				@available.clear
+				@resources.each do |resource, usage|
+					if usage < resource.concurrency and resource.reusable?
+						@available << resource
+					end
+				end
+				
 				return unused.size
 			end
 			
@@ -170,11 +189,42 @@ module Async
 				end.join(";")
 			end
 			
+			def usage
+				@resources.count{|resource, usage| usage > 0}
+			end
+			
+			def free
+				@resources.count{|resource, usage| usage == 0}
+			end
+			
+			# @returns [Boolean] Whether the number of available resources is excessive and we should retire some.
+			def overflowing?
+				if @resources.any?
+					(self.free.to_f / @resources.size) > 0.5
+				end
+			end
+			
 			def reuse(resource)
 				Async.logger.debug(self) {"Reuse #{resource}"}
+				usage = @resources[resource]
+				
+				if usage.zero?
+					raise "Trying to reuse unacquired resource: #{resource}!"
+				end
+				
+				# We retire resources when adding to the @available list would overflow our pool:
+				if usage == 1
+					if overflowing?
+						return retire(resource)
+					end
+				end
+				
+				# If the resource was fully utilized, it now becomes available:
+				if usage == resource.concurrency
+					@available.push(resource)
+				end
 				
-				@resources[resource] -= 1
-				@available.push(resource)
+				@resources[resource] = usage - 1
 				
 				@notification.signal
 			end
@@ -194,6 +244,7 @@ module Async
 				return resource
 			end
 			
+			# @returns [Object] A new resource in a "used" state.
 			def create_resource
 				self.start_gardener
 				
@@ -201,18 +252,27 @@ module Async
 				if resource = @constructor.call
 					@resources[resource] = 1
 					
-					@available.push(resource) if resource.concurrency > 1
+					# Make the resource available if it can be used multiple times:
+					if resource.concurrency > 1
+						@available.push(resource)
+					end
 				end
 				
 				return resource
 			end
 			
+			# @returns [Object] An existing resource in a "used" state.
 			def available_resource
 				@guard.acquire do
 					while resource = @available.last
 						if usage = @resources[resource] and usage < resource.concurrency
 							if resource.viable?
-								@resources[resource] += 1
+								usage = (@resources[resource] += 1)
+								
+								if usage == resource.concurrency
+									# The resource is used up to it's limit:
+									@available.pop
+								end
 								
 								return resource
 							else
@@ -220,6 +280,7 @@ module Async
 								@available.pop
 							end
 						else
+							# The resource has been removed already, so skip it and remove it from the availability list.
 							@available.pop
 						end
 					end

data/lib/async/pool/version.rb

@@ -20,6 +20,6 @@
 
 module Async
 	module Pool
-		VERSION = "0.3.3"
+		VERSION = "0.3.4"
 	end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: async-pool
 version: !ruby/object:Gem::Version
-  version: 0.3.3
+  version: 0.3.4
 platform: ruby
 authors:
 - Samuel Williams
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2020-11-15 00:00:00.000000000 Z
+date: 2021-02-07 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: async