async-pool 0.3.11 → 0.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 2b18ddc4cbc74698b642f3196160fe5a59b93ae0484d25a84da43cd1b2a9c90d
-  data.tar.gz: 668b970b18cae244620c289909f72d9fcfe1bef70771ddaa9a9a251615fbfd08
+  metadata.gz: 90ad67ae4201f83d1a5c9767b425ce1223d0b4d9c068a1046c98948875ec4c15
+  data.tar.gz: 84b8d54ad04302b935f65ca5e13c5929bda43bcf95754db9568f4c99ae7d5e92
 SHA512:
-  metadata.gz: cb6353d6ca63c11516d67183f722ff50e78428a86112d7e6fbb097f3706b02cbefa0768e0c38de64f662882ee70bdd8555f9c3d9654810a88fecf7284213495b
-  data.tar.gz: 211e98500aa73c4a1fa6ca0bc944f39e859c3383e08b323a396b0fbd245239fe36804482f9d896aeb555097c8b79eecd4df393f643905964eb136a6a0a98c742
+  metadata.gz: 3871fcd341afbc5db9af1f6e70ff6b58aeca070f9f8e89a5c4680e20feb33baa4c5d4c946bf2378fc526fa2dc021648ba0ec2b34b08a0de6cf2205ea6065b88f
+  data.tar.gz: 32f66fb6d31ab5413dd104061fd0afc8b3fdfb07d1644a3d315ac40c469cb985d976da393e9b54fb13fd6fff5b5a2680f7c0f00a506c52c735a068e074f890d1

data/lib/async/pool/controller.rb

@@ -1,22 +1,8 @@
-# Copyright, 2017, by Samuel G. D. Williams. <http://www.codeotaku.com>
-# 
-# Permission is hereby granted, free of charge, to any person obtaining a copy
-# of this software and associated documentation files (the "Software"), to deal
-# in the Software without restriction, including without limitation the rights
-# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
-# copies of the Software, and to permit persons to whom the Software is
-# furnished to do so, subject to the following conditions:
-# 
-# The above copyright notice and this permission notice shall be included in
-# all copies or substantial portions of the Software.
-# 
-# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
-# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
-# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
-# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
-# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
-# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
-# THE SOFTWARE.
+# frozen_string_literal: true
+
+# Released under the MIT License.
+# Copyright, 2019-2022, by Samuel Williams.
+# Copyright, 2020, by Simon Perepelitsa.
 
 require 'console/logger'
 
@@ -31,7 +17,16 @@ module Async
 				self.new(block, **options)
 			end
 			
-			def initialize(constructor, limit: nil, concurrency: nil)
+			def initialize(constructor, limit: nil, concurrency: (limit || 1), policy: nil)
+				@constructor = constructor
+				@limit = limit
+				
+				# This semaphore is used to limit the number of concurrent tasks which are creating new resources.
+				@guard = Async::Semaphore.new(concurrency)
+				
+				@policy = policy
+				@gardener = nil
+				
 				# All available resources:
 				@resources = {}
 				
@@ -39,24 +34,28 @@ module Async
 				# This list may contain false positives, or resources which were okay but have since entered a state which is unusuable.
 				@available = []
 				
+				# Used to signal when a resource has been released:
 				@notification = Async::Notification.new
-				
-				@limit = limit
-				
-				@constructor = constructor
-				
-				# Set the concurrency to be the same as the limit for maximum performance:
-				if limit
-					concurrency ||= limit
-				else
-					concurrency ||= 1
-				end
-				
-				@guard = Async::Semaphore.new(concurrency)
-				
-				@gardener = nil
 			end
 			
+			# @attribute [Proc] The constructor used to create new resources.
+			attr :constructor
+			
+			# @attribute [Integer] The maximum number of resources that this pool can have at any given time.
+			attr_accessor :limit
+			
+			# @attribute [Integer] The maximum number of concurrent tasks that can be creating a new resource.
+			def concurrency
+				@guard.limit
+			end
+			
+			def concurrency= value
+				@guard.limit = value
+			end
+			
+			# @attribute [Policy] The pool policy.
+			attr_accessor :policy
+			
 			# @attribute [Hash(Resource, Integer)] all allocated resources, and their associated usage.
 			attr :resources
 			
@@ -112,6 +111,8 @@ module Async
 				if resource.reusable?
 					processed = reuse(resource)
 				end
+				
+				# @policy.released(self, resource)
 			ensure
 				retire(resource) unless processed
 			end
@@ -119,8 +120,15 @@ module Async
 			def close
 				@available.clear
 				
-				@resources.each_key(&:close)
-				@resources.clear
+				while pair = @resources.shift
+					resource, usage = pair
+					
+					if usage > 0
+						Console.logger.warn(self, resource: resource, usage: usage) {"Closing resource while still in use!"}
+					end
+					
+					resource.close
+				end
 				
 				@gardener&.stop
 			end
@@ -139,12 +147,14 @@ module Async
 			def prune(retain = 0)
 				unused = []
 				
+				# This code must not context switch:
 				@resources.each do |resource, usage|
 					if usage.zero?
 						unused << resource
 					end
 				end
 				
+				# It's okay for this to context switch:
 				unused.each do |resource|
 					if block_given?
 						yield resource
@@ -186,7 +196,15 @@ module Async
 				Async(transient: true, annotation: "#{self.class} Gardener") do |task|
 					@gardener = task
 					
-					Task.yield
+					while true
+						if @policy
+							@policy.call(self)
+						else
+							Task.yield
+						end
+						
+						self.wait
+					end
 				ensure
 					@gardener = nil
 					self.close
@@ -198,18 +216,18 @@ module Async
 			end
 			
 			def availability_string
-				@resources.collect do |resource,usage|
+				@resources.collect do |resource, usage|
 					"#{usage}/#{resource.concurrency}#{resource.viable? ? nil : '*'}/#{resource.count}"
 				end.join(";")
 			end
 			
-			def usage
-				@resources.count{|resource, usage| usage > 0}
-			end
-			
-			def free
-				@resources.count{|resource, usage| usage == 0}
-			end
+			# def usage
+			# 	@resources.count{|resource, usage| usage > 0}
+			# end
+			#
+			# def free
+			# 	@resources.count{|resource, usage| usage == 0}
+			# end
 			
 			def reuse(resource)
 				Console.logger.debug(self) {"Reuse #{resource}"}
@@ -260,6 +278,8 @@ module Async
 					end
 				end
 				
+				# @policy.created(self, resource)
+				
 				return resource
 			end
 			
@@ -277,7 +297,9 @@ module Async
 				raise
 			end
 			
-			private def get_resource
+			private
+			
+			def get_resource
 				while resource = @available.last
 					if usage = @resources[resource] and usage < resource.concurrency
 						if resource.viable?

data/lib/async/pool/resource.rb

@@ -1,22 +1,7 @@
-# Copyright, 2017, by Samuel G. D. Williams. <http://www.codeotaku.com>
-# 
-# Permission is hereby granted, free of charge, to any person obtaining a copy
-# of this software and associated documentation files (the "Software"), to deal
-# in the Software without restriction, including without limitation the rights
-# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
-# copies of the Software, and to permit persons to whom the Software is
-# furnished to do so, subject to the following conditions:
-# 
-# The above copyright notice and this permission notice shall be included in
-# all copies or substantial portions of the Software.
-# 
-# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
-# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
-# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
-# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
-# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
-# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
-# THE SOFTWARE.
+# frozen_string_literal: true
+
+# Released under the MIT License.
+# Copyright, 2019-2022, by Samuel Williams.
 
 require 'console/logger'
 

data/lib/async/pool/version.rb

@@ -1,25 +1,10 @@
-# Copyright, 2017, by Samuel G. D. Williams. <http://www.codeotaku.com>
-# 
-# Permission is hereby granted, free of charge, to any person obtaining a copy
-# of this software and associated documentation files (the "Software"), to deal
-# in the Software without restriction, including without limitation the rights
-# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
-# copies of the Software, and to permit persons to whom the Software is
-# furnished to do so, subject to the following conditions:
-# 
-# The above copyright notice and this permission notice shall be included in
-# all copies or substantial portions of the Software.
-# 
-# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
-# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
-# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
-# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
-# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
-# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
-# THE SOFTWARE.
+# frozen_string_literal: true
+
+# Released under the MIT License.
+# Copyright, 2019-2022, by Samuel Williams.
 
 module Async
 	module Pool
-		VERSION = "0.3.11"
+		VERSION = "0.4.0"
 	end
 end

data/lib/async/pool.rb

@@ -1,23 +1,7 @@
-# Copyright, 2017, by Samuel G. D. Williams. <http://www.codeotaku.com>
-# 
-# Permission is hereby granted, free of charge, to any person obtaining a copy
-# of this software and associated documentation files (the "Software"), to deal
-# in the Software without restriction, including without limitation the rights
-# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
-# copies of the Software, and to permit persons to whom the Software is
-# furnished to do so, subject to the following conditions:
-# 
-# The above copyright notice and this permission notice shall be included in
-# all copies or substantial portions of the Software.
-# 
-# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
-# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
-# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
-# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
-# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
-# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
-# THE SOFTWARE.
+# frozen_string_literal: true
 
-require_relative 'pool/version'
+# Released under the MIT License.
+# Copyright, 2019-2022, by Samuel Williams.
 
+require_relative 'pool/version'
 require_relative 'pool/controller'

data/license.md

@@ -0,0 +1,23 @@
+# MIT License
+
+Copyright, 2019-2023, by Samuel Williams.  
+Copyright, 2020, by Simon Perepelitsa.  
+Copyright, 2021, by Olle Jonsson.  
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

data/readme.md

@@ -0,0 +1,54 @@
+# Async::Pool
+
+Provides support for connection pooling both singleplex and multiplex resources.
+
+[![Development Status](https://github.com/socketry/async-pool/workflows/Test/badge.svg)](https://github.com/socketry/async-pool/actions?workflow=Test)
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+``` ruby
+gem 'async-pool'
+```
+
+And then execute:
+
+``` bash
+$ bundle
+```
+
+Or install it yourself as:
+
+``` bash
+$ gem install async-pool
+```
+
+## Usage
+
+`Async::Pool::Controller` provides support for both singleplex (one stream at a time) and multiplex resources (multiple streams at a time).
+
+`Async::Pool::Resource` is provided as an interface and to document how to use the pools. However, you wouldn't need to use this in practice and just implement the appropriate interface on your own objects.
+
+``` ruby
+pool = Async::Pool::Controller.new(Async::Pool::Resource)
+
+pool.acquire do |resource|
+	# resource is implicitly released when exiting the block.
+end
+
+resource = pool.acquire
+
+# Return the resource back to the pool:
+pool.release(resource)
+```
+
+## Contributing
+
+We welcome contributions to this project.
+
+1.  Fork it.
+2.  Create your feature branch (`git checkout -b my-new-feature`).
+3.  Commit your changes (`git commit -am 'Add some feature'`).
+4.  Push to the branch (`git push origin my-new-feature`).
+5.  Create new Pull Request.

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: async-pool
 version: !ruby/object:Gem::Version
-  version: 0.3.11
+  version: 0.4.0
 platform: ruby
 authors:
 - Samuel Williams
@@ -39,7 +39,7 @@ cert_chain:
   Q2K9NVun/S785AP05vKkXZEFYxqG6EW012U4oLcFl5MySFajYXRYbuUpH6AY+HP8
   voD0MPg1DssDLKwXyt1eKD/+Fq0bFWhwVM/1XiAXL7lyYUyOq24KHgQ2Csg=
   -----END CERTIFICATE-----
-date: 2022-08-17 00:00:00.000000000 Z
+date: 2023-03-12 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: async
@@ -56,19 +56,33 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '1.25'
 - !ruby/object:Gem::Dependency
-  name: async-rspec
+  name: bake-test
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '1.1'
+        version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: bake-test-external
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '1.1'
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
@@ -98,19 +112,33 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: rspec
+  name: sus
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.6'
+        version: '0.15'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.6'
+        version: '0.15'
+- !ruby/object:Gem::Dependency
+  name: sus-fixtures-async
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 description:
 email:
 executables: []
@@ -121,6 +149,8 @@ files:
 - lib/async/pool/controller.rb
 - lib/async/pool/resource.rb
 - lib/async/pool/version.rb
+- license.md
+- readme.md
 homepage: https://github.com/socketry/async-pool
 licenses:
 - MIT
@@ -141,7 +171,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.1.6
+rubygems_version: 3.4.7
 signing_key:
 specification_version: 4
 summary: A singleplex and multiplex resource pool for implementing robust clients.