async-pool 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: df755b3a1ec23182af37b80f498c301e42b0e333c97e663b4f065453c66d36cd
+  data.tar.gz: 1af8d6d7b3f67fcaad73527dbf278133813564ff152c0733cdf4e7da88704334
+SHA512:
+  metadata.gz: 941097d316256c77a43a700468ad8dbd2549a3c433c1a8393913fbeb72d06886b6f0f59d1689902b3ea923e02a2e90ee3dd9269cb14a6b619160aa025d864a80
+  data.tar.gz: a8d87b81f9ec2942d9bb7547b712d239df6fe072f39eb9c6d3d6bc81b16c8a76a79f3ff3fe0746ab7bc8428228fcf391d8a05d7606b13729de878dae80185c96

data/.editorconfig

@@ -0,0 +1,6 @@
+root = true
+
+[*]
+indent_style = tab
+indent_size = 2
+

data/.gitignore

@@ -0,0 +1,13 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+
+# rspec failure tracking
+.rspec_status
+.covered.db

data/.rspec

@@ -0,0 +1,3 @@
+--format documentation
+--warnings
+--require spec_helper

data/.travis.yml

@@ -0,0 +1,20 @@
+language: ruby
+dist: xenial
+cache: bundler
+
+matrix:
+  include:
+    - rvm: 2.3
+    - rvm: 2.4
+    - rvm: 2.5
+    - rvm: 2.6
+    - rvm: 2.6
+      env: COVERAGE=BriefSummary,Coveralls
+    - rvm: ruby-head
+    - rvm: truffleruby
+    - rvm: jruby-head
+      env: JRUBY_OPTS="--debug -X+O"
+  allow_failures:
+    - rvm: ruby-head
+    - rvm: truffleruby
+    - rvm: jruby-head

data/Gemfile

@@ -0,0 +1,3 @@
+source 'https://rubygems.org'
+
+gemspec

data/README.md

@@ -0,0 +1,72 @@
+# Async::Pool
+
+Provides support for connection pooling both singleplex and multiplex resources.
+
+[![Build Status](https://travis-ci.com/socketry/async-pool.svg)](https://travis-ci.com/socketry/async-pool)
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'async-pool'
+```
+
+And then execute:
+
+	$ bundle
+
+Or install it yourself as:
+
+	$ 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
+
+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
+
+## License
+
+Released under the MIT license.
+
+Copyright, 2019, 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.

data/Rakefile

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new
+
+task :default => :spec

data/async-pool.gemspec

@@ -0,0 +1,28 @@
+
+require_relative 'lib/async/pool/version'
+
+Gem::Specification.new do |spec|
+	spec.name          = "async-pool"
+	spec.version       = Async::Pool::VERSION
+	spec.authors       = ["Samuel Williams"]
+	spec.email         = ["samuel.williams@oriontransfer.co.nz"]
+	
+	spec.summary       = "A Redis client library."
+	spec.homepage      = "https://github.com/socketry/async-pool"
+	
+	spec.files         = `git ls-files -z`.split("\x0").reject do |f|
+		f.match(%r{^(test|spec|features)/})
+	end
+	
+	spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+	spec.require_paths = ["lib"]
+	
+	spec.add_dependency("async", "~> 1.8")
+	
+	spec.add_development_dependency "async-rspec", "~> 1.1"
+	
+	spec.add_development_dependency "covered"
+	spec.add_development_dependency "bundler"
+	spec.add_development_dependency "rspec", "~> 3.6"
+	spec.add_development_dependency "rake"
+end

data/lib/async/pool.rb

@@ -0,0 +1,23 @@
+# 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.
+
+require_relative 'pool/version'
+
+require_relative 'pool/controller'

data/lib/async/pool/controller.rb

@@ -0,0 +1,208 @@
+# 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.
+
+require 'async/logger'
+
+require 'async/notification'
+require 'async/semaphore'
+
+module Async
+	module Pool
+		class Controller
+			def self.wrap(**options, &block)
+				self.new(block, **options)
+			end
+			
+			def initialize(constructor, limit: nil)
+				@resources = {}
+				@available = Async::Notification.new
+				
+				@limit = limit
+				
+				@constructor = constructor
+				@guard = Async::Semaphore.new(1)
+			end
+			
+			# @attr [Hash<Resource, Integer>] all allocated resources, and their associated usage.
+			attr :resources
+			
+			# Whether the pool has any active resources.
+			def active?
+				!@resources.empty?
+			end
+			
+			# Whether there are resources which are currently in use.
+			def busy?
+				@resources.collect do |_, usage|
+					return true if usage > 0
+				end
+				
+				return false
+			end
+			
+			# Wait until a pool resource has been freed.
+			def wait
+				@available.wait
+			end
+			
+			def empty?
+				@resources.empty?
+			end
+			
+			def acquire
+				resource = wait_for_resource
+				
+				return resource unless block_given?
+				
+				begin
+					yield resource
+				ensure
+					release(resource)
+				end
+			end
+			
+			# Make the resource resources and let waiting tasks know that there is something resources.
+			def release(resource)
+				# A resource that is not good should also not be reusable.
+				if resource.reusable?
+					reuse(resource)
+				else
+					retire(resource)
+				end
+			end
+			
+			def close
+				@resources.each_key(&:close)
+				@resources.clear
+			end
+			
+			def to_s
+				if @resources.empty?
+					"\#<#{self.class}(#{usage_string})>"
+				else
+					"\#<#{self.class}(#{usage_string}) #{availability_string}>"
+				end
+			end
+			
+			# Retire (and close) all unused resources. If a block is provided, it should implement the desired functionality for unused resources.
+			# @param retain [Integer] the minimum number of resources to retain.
+			# @yield resource [Resource] unused resources.
+			def prune(retain = 0)
+				unused = []
+				
+				@resources.each do |resource, usage|
+					unused << resource if usage.zero?
+				end
+				
+				unused.each do |resource|
+					if block_given?
+						yield resource
+					else
+						retire(resource)
+					end
+					
+					break if @resources.size <= retain
+				end
+				
+				return unused.size
+			end
+			
+			def retire(resource)
+				Async.logger.debug(self) {"Retire #{resource}"}
+				
+				@resources.delete(resource)
+				
+				resource.close
+				
+				@available.signal
+			end
+			
+			protected
+			
+			def usage_string
+				"#{@resources.size}/#{@limit || '∞'}"
+			end
+			
+			def availability_string
+				@resources.collect do |resource,usage|
+					"#{usage}/#{resource.concurrency}#{resource.viable? ? nil : '*'}/#{resource.count}"
+				end.join(";")
+			end
+			
+			def reuse(resource)
+				Async.logger.debug(self) {"Reuse #{resource}"}
+				
+				@resources[resource] -= 1
+				
+				@available.signal
+			end
+			
+			def wait_for_resource
+				# If we fail to create a resource (below), we will end up waiting for one to become resources.
+				until resource = available_resource
+					@available.wait
+				end
+				
+				Async.logger.debug(self) {"Wait for resource #{resource}"}
+				
+				# if resource.concurrency > 1
+				# 	@available.signal
+				# end
+				
+				return resource
+			end
+			
+			def create_resource
+				# This might return nil, which means creating the resource failed.
+				if resource = @constructor.call
+					@resources[resource] = 1
+				end
+				
+				return resource
+			end
+			
+			def available_resource
+				# TODO This is a linear search... not ideal, but simple for now.
+				@resources.each do |resource, count|
+					if count < resource.concurrency
+						# We want to use this resource... but is it connected?
+						if resource.viable?
+							@resources[resource] += 1
+							
+							return resource
+						else
+							retire(resource)
+						end
+					end
+				end
+				
+				@guard.acquire do
+					if @limit.nil? or @resources.size < @limit
+						Async.logger.debug(self) {"No resources resources, allocating new one..."}
+						
+						return create_resource
+					end
+				end
+				
+				return nil
+			end
+		end
+	end
+end

data/lib/async/pool/resource.rb

@@ -0,0 +1,70 @@
+# 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.
+
+require 'async/logger'
+
+require 'async/notification'
+require 'async/semaphore'
+
+module Async
+	module Pool
+		# The basic interface required by a pool resource.
+		class Resource
+			# Constructs a resource.
+			def self.call
+				self.new
+			end
+			
+			def initialize(concurrency = 1)
+				@concurrency = concurrency
+				@closed = false
+				@count = 0
+			end
+			
+			# @attr [Integer] The concurrency of this resource, 1 (singleplex) or more (multiplex).
+			attr :concurrency
+			
+			# @attr [Integer] The number of times this resource has been used.
+			attr :count
+			
+			# Whether this resource can be acquired.
+			# @return [Boolean] whether the resource can actually be used.
+			def viable?
+				!@closed
+			end
+			
+			# Whether the resource has been closed by the user.
+			# @return [Boolean] whether the resource has been closed or has failed.
+			def closed?
+				@closed
+			end
+			
+			# Close the resource explicitly, e.g. the pool is being closed.
+			def close
+				@closed = true
+			end
+			
+			# Whether this resource can be reused. Used when releasing resources back into the pool.
+			def reusable?
+				!@closed
+			end
+		end
+	end
+end

data/lib/async/pool/version.rb

@@ -0,0 +1,25 @@
+# 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.
+
+module Async
+	module Pool
+		VERSION = "0.1.0"
+	end
+end

metadata

@@ -0,0 +1,138 @@
+--- !ruby/object:Gem::Specification
+name: async-pool
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Samuel Williams
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2019-12-22 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: async
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.8'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.8'
+- !ruby/object:Gem::Dependency
+  name: async-rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.1'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.1'
+- !ruby/object:Gem::Dependency
+  name: covered
+  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'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  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'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.6'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.6'
+- !ruby/object:Gem::Dependency
+  name: rake
+  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:
+- samuel.williams@oriontransfer.co.nz
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".editorconfig"
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- Gemfile
+- README.md
+- Rakefile
+- async-pool.gemspec
+- lib/async/pool.rb
+- lib/async/pool/controller.rb
+- lib/async/pool/resource.rb
+- lib/async/pool/version.rb
+homepage: https://github.com/socketry/async-pool
+licenses: []
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.0.4
+signing_key: 
+specification_version: 4
+summary: A Redis client library.
+test_files: []