async-worker 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 99178fd374238f9b06532823b7df6379a1910556af9b8b7ffa6bbc31b5908594
+  data.tar.gz: 927dd858f3fc051bb31e5dd326ae7f33e7196bd005c639e5700090fb0451aa5f
+SHA512:
+  metadata.gz: 1bd42b5ada43a451741f49141764a7bc1838f3107a7e982fea025318bfb14a3fccbea22f01a18d2305e6b013b632ccc7df8b76375bf772143f397af677f77893
+  data.tar.gz: 776051b39eb57b26c8e6085419493579d8376c0bcc5f45b80d98eead7fcec06d7efd95465b843fd118977e06795826db3af6dab0e8ee52936c02b974b756fe67

data/.gitignore

@@ -0,0 +1,11 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+
+# rspec failure tracking
+.rspec_status

data/.rspec

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

data/.travis.yml

@@ -0,0 +1,19 @@
+language: ruby
+sudo: false
+dist: trusty
+cache: bundler
+
+matrix:
+  include:
+    - rvm: 2.2
+    - rvm: 2.3
+    - rvm: 2.4
+    - rvm: 2.5
+    - rvm: jruby-head
+      env: JRUBY_OPTS="--debug -X+O"
+    - rvm: ruby-head
+    - rvm: rbx-3
+  allow_failures:
+    - rvm: ruby-head
+    - rvm: jruby-head
+    - rvm: rbx-3

data/Gemfile

@@ -0,0 +1,6 @@
+source "https://rubygems.org"
+
+git_source(:github) {|repo_name| "https://github.com/#{repo_name}" }
+
+# Specify your gem's dependencies in async-worker.gemspec
+gemspec

data/Gemfile.lock

@@ -0,0 +1,49 @@
+PATH
+  remote: .
+  specs:
+    async-worker (0.1.0)
+      async (~> 1.0)
+      async-io (~> 1.3)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    async (1.5.0)
+      nio4r (~> 2.0)
+      timers (~> 4.1)
+    async-io (1.7.0)
+      async (~> 1.3)
+    async-rspec (1.3.1)
+      rspec (~> 3.0)
+    diff-lcs (1.3)
+    hitimes (1.2.6)
+    nio4r (2.3.0)
+    rake (10.5.0)
+    rspec (3.7.0)
+      rspec-core (~> 3.7.0)
+      rspec-expectations (~> 3.7.0)
+      rspec-mocks (~> 3.7.0)
+    rspec-core (3.7.1)
+      rspec-support (~> 3.7.0)
+    rspec-expectations (3.7.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.7.0)
+    rspec-mocks (3.7.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.7.0)
+    rspec-support (3.7.1)
+    timers (4.1.2)
+      hitimes
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  async-rspec (~> 1.0)
+  async-worker!
+  bundler (~> 1.16)
+  rake (~> 10.0)
+  rspec (~> 3.0)
+
+BUNDLED WITH
+   1.16.1

data/README.md

@@ -0,0 +1,81 @@
+# Async::Worker
+
+Provides a thread-pool backed work queue for executing blocking operations in a non-blocking fashion using [async].
+
+[async]: https://github.com/socketry/async
+
+[![Build Status](https://secure.travis-ci.org/socketry/async-worker.svg)](http://travis-ci.org/socketry/async-worker)
+[![Code Climate](https://codeclimate.com/github/socketry/async-worker.svg)](https://codeclimate.com/github/socketry/async-worker)
+[![Coverage Status](https://coveralls.io/repos/socketry/async-worker/badge.svg)](https://coveralls.io/r/socketry/async-worker)
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'async-worker'
+```
+
+And then execute:
+
+	$ bundle
+
+Or install it yourself as:
+
+	$ gem install async-worker
+
+## Usage
+
+Create a pool and execute jobs using it:
+
+```ruby
+Async::Reactor.run do |task|
+	# Make a pool with two workers:
+	pool = Async::Worker::Pool.new(2)
+	
+	tasks = 5.times.collect do
+		task.async do
+			# Add the work to the queue and wait for it to complete:
+			pool.async do
+				sleep 0.1
+			end
+		end
+	end
+	
+	tasks.each(&:wait)
+	
+	pool.close
+end
+```
+
+## 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, 2017, by [Samuel G. D. Williams](http://www.codeotaku.com/samuel-williams).
+
+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 ACTWorkerN OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTWorkerN 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(:test)
+
+task :default => :test

data/async-worker.gemspec

@@ -0,0 +1,27 @@
+
+require_relative "lib/async/worker/version"
+
+Gem::Specification.new do |spec|
+	spec.name = "async-worker"
+	spec.version = Async::Worker::VERSION
+	spec.authors = ["Samuel Williams"]
+	spec.email = ["samuel.williams@oriontransfer.co.nz"]
+
+	spec.summary = "Non-blocking thread-pool based workers for blocking operations."
+	spec.homepage = "https://github.com/socketry/async-worker"
+
+	spec.files = `git ls-files`.split($/)
+	spec.executables = spec.files.grep(%r{^bin/}).map{ |f| File.basename(f) }
+	spec.test_files = spec.files.grep(%r{^(test|spec|features)/})
+	spec.require_paths = ["lib"]
+	spec.has_rdoc = "yard"
+
+	spec.add_dependency 'async', '~> 1.0'
+	spec.add_dependency 'async-io', '~> 1.3'
+	
+	spec.add_development_dependency "async-rspec", "~> 1.0"
+	
+	spec.add_development_dependency "bundler", "~> 1.16"
+	spec.add_development_dependency "rake", "~> 10.0"
+	spec.add_development_dependency "rspec", "~> 3.0"
+end

data/bug.rb

@@ -0,0 +1,27 @@
+#!/usr/bin/env ruby
+
+require 'thread'
+
+puts RUBY_VERSION
+
+100.times.collect do
+	Thread.new do
+		mutex = Mutex.new
+		input, output = IO.pipe
+		
+		worker = Thread.new do
+			sleep(0.1)
+			# mutex.synchronize do
+				output.syswrite('.')
+			# end
+		end
+		
+		input.read(1)
+		
+		# mutex.synchronize do
+			input.close
+			output.close
+		# end
+		worker.join
+	end
+end.each(&:join)

data/lib/async/worker.rb

@@ -0,0 +1,22 @@
+# Copyright, 2018, 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 'worker/version'
+require_relative 'worker/pool'

data/lib/async/worker/notification.rb

@@ -0,0 +1,61 @@
+# Copyright, 2018, 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/io/generic'
+
+require 'thread'
+
+module Async
+	module Worker
+		# A cross-thread notification pipe.
+		class Notification
+			def initialize
+				pipe = ::IO.pipe
+				
+				@mutex = Mutex.new
+				@input = pipe.first
+				@output = pipe.last
+			end
+			
+			def close
+				# Due to bugs in MRI, we need to synchronize this.
+				@mutex.synchronize do
+					@input.close
+					@output.close
+				end
+			end
+			
+			# Wait for signal to be called.
+			# @return [Object]
+			def wait
+				wrapper = Async::IO::Generic.new(@input)
+				wrapper.read(1)
+			end
+			
+			# Signal to a given task that it should resume operations.
+			# @return [void]
+			def signal
+				@mutex.synchronize do
+					@output.syswrite(".")
+				end
+			end
+		end
+	end
+end

data/lib/async/worker/pool.rb

@@ -0,0 +1,78 @@
+# Copyright, 2018, 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/reactor'
+require 'thread'
+
+require_relative 'notification'
+
+module Async
+	module Worker
+		class Pool
+			def initialize(workers = 4)
+				@threads = []
+				
+				@queue = Thread::Queue.new
+				
+				workers.times {create_worker}
+			end
+			
+			def close
+				@queue.close
+				@threads.each(&:join)
+			end
+			
+			def async(&block)
+				notification = Notification.new
+				
+				result = nil
+				
+				job = lambda do
+					begin
+						result = block.call
+					rescue Exception
+						result = $!
+					ensure
+						notification.signal
+					end
+				end
+				
+				@queue << job
+				
+				notification.wait
+				notification.close
+				
+				return result
+			end
+			
+			private
+			
+			def create_worker
+				thread = Thread.new do
+					while job = @queue.pop
+						job.call
+					end
+				end
+				
+				@threads << thread
+			end
+		end
+	end
+end

data/lib/async/worker/version.rb

@@ -0,0 +1,25 @@
+# Copyright, 2018, 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 Worker
+		VERSION = "0.1.0"
+	end
+end

data/spec/async/worker_spec.rb

@@ -0,0 +1,30 @@
+
+require 'benchmark'
+
+RSpec.describe Async::Worker do
+	include_context Async::RSpec::Reactor
+	
+	let(:count) {20}
+	
+	it "can execute work in parallel" do
+		task = Async::Task.current
+		pool = Async::Worker::Pool.new(count)
+		
+		tasks = []
+		
+		duration = Benchmark.realtime do
+			count.times do
+				tasks << task.async do
+					pool.async do
+						sleep 0.1
+					end
+				end
+			end
+			
+			tasks.each(&:wait)
+		end
+		
+		expect(duration).to be_within(0.01).of(0.1)
+		pool.close
+	end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,32 @@
+
+if ENV['COVERAGE'] || ENV['TRAVIS']
+	begin
+		require 'simplecov'
+		
+		SimpleCov.start do
+			add_filter "/spec/"
+		end
+		
+		if ENV['TRAVIS']
+			require 'coveralls'
+			Coveralls.wear!
+		end
+	rescue LoadError
+		warn "Could not load simplecov: #{$!}"
+	end
+end
+
+require "bundler/setup"
+require "async/worker"
+
+# Shared rspec helpers:
+require "async/rspec"
+
+RSpec.configure do |config|
+	# Enable flags like --only-failures and --next-failure
+	config.example_status_persistence_file_path = ".rspec_status"
+
+	config.expect_with :rspec do |c|
+		c.syntax = :expect
+	end
+end

metadata

@@ -0,0 +1,144 @@
+--- !ruby/object:Gem::Specification
+name: async-worker
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Samuel Williams
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2018-04-12 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: async
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+- !ruby/object:Gem::Dependency
+  name: async-io
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.3'
+- !ruby/object:Gem::Dependency
+  name: async-rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.16'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.16'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+description: 
+email:
+- samuel.williams@oriontransfer.co.nz
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- Gemfile
+- Gemfile.lock
+- README.md
+- Rakefile
+- async-worker.gemspec
+- bug.rb
+- lib/async/worker.rb
+- lib/async/worker/notification.rb
+- lib/async/worker/pool.rb
+- lib/async/worker/version.rb
+- spec/async/worker_spec.rb
+- spec/spec_helper.rb
+homepage: https://github.com/socketry/async-worker
+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: []
+rubyforge_project: 
+rubygems_version: 2.7.6
+signing_key: 
+specification_version: 4
+summary: Non-blocking thread-pool based workers for blocking operations.
+test_files:
+- spec/async/worker_spec.rb
+- spec/spec_helper.rb