async 0.10.0 → 0.11.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: f28936ef28f1828e6216b5c9bd1186a89f7037c1
-  data.tar.gz: c1319a57b9fc689dc77f6bea15a682759affa3b5
+  metadata.gz: 1747c272a59477827b3ca9e4a3b1a27bbe995b92
+  data.tar.gz: 418f2d203b464d91e75b2f0a55a3288927af4418
 SHA512:
-  metadata.gz: 2e6ab3277515b79065c95cb9d88a6ffd7f56c86c2cfe1c5ecbe8145807d9d07d658f76dcf6b3c614aea5d4c370ac85f08966ff7fd3e0f549a1383f70aebbd254
-  data.tar.gz: 42687f2385510e39e7403cdeaf39b487468564295b360f5f1edff07097d06b3e65af8d2c7821ae31fc1d683b53a497a022ea838f0afd3758388b6c23d9a073ad
+  metadata.gz: 3a065e73686d2175ec2b6d605fc81b3ab085ae4b3f4e944d10cef60e15abaa202518a37136b88fa3bb142c5ef0947872b4fdcbe181012211c60ebb3de67811cd
+  data.tar.gz: ff5236af82d181c055930c64116f7dca549748c148de866a6148305b52ad1bb8a5b70a0038f2fa0d49f23bfe108dd9d096c1cfd862e2151ed45e4d25bb80a758

data/.editorconfig

@@ -0,0 +1,5 @@
+root = true
+
+[*]
+indent_style = tab
+indent_size = 4

data/README.md

@@ -37,6 +37,55 @@ Or install it yourself as:
 
 	$ gem install async
 
+## Usage
+
+Implementing an asynchronous client/server is easy:
+
+```ruby
+#!/usr/bin/env ruby
+
+require 'async'
+require 'async/tcp_socket'
+
+def echo_server
+	Async::Reactor.run do |task|
+		# This is a synchronous block within the current task:
+		task.with(TCPServer.new('localhost', 9000)) do |server|
+			
+			# This is an asynchronous block within the current reactor:
+			task.reactor.with(server.accept) do |client|
+				data = client.read(512)
+				
+				task.sleep(rand)
+				
+				client.write(data)
+			end while true
+		end
+	end
+end
+
+def echo_client(data)
+	Async::Reactor.run do |task|
+		Async::TCPServer.connect('localhost', 9000) do |socket|
+			socket.write(data)
+			puts "echo_client: #{socket.read(512)}"
+		end
+	end
+end
+
+Async::Reactor.run do
+	# Start the echo server:
+	server = echo_server
+	
+	5.times.collect do |i|
+		echo_client("Hello World #{i}")
+	end.each(&:wait) # Wait until all clients are finished.
+	
+	# Terminate the server and all tasks created within it's async scope:
+	server.stop
+end
+```
+
 ## Supported Ruby Versions
 
 This library aims to support and is [tested against][travis] the following Ruby

data/async.gemspec

@@ -23,7 +23,7 @@ Gem::Specification.new do |spec|
 	
 	spec.required_ruby_version = ">= 2.2.6"
 
-	spec.add_runtime_dependency "nio4r", "~> 2"
+	spec.add_runtime_dependency "nio4r"
 	spec.add_runtime_dependency "timers", "~> 4.1"
 	
 	spec.add_development_dependency "bundler", "~> 1.3"

data/examples/echo.rb

@@ -0,0 +1,40 @@
+#!/usr/bin/env ruby
+
+require 'async'
+require 'async/tcp_socket'
+
+def echo_server
+	Async::Reactor.run do |task|
+		# This is a synchronous block within the current task:
+		task.with(TCPServer.new('localhost', 9000)) do |server|
+			
+			# This is an asynchronous block within the current reactor:
+			task.reactor.with(server.accept) do |client|
+				data = client.read(512)
+				
+				task.sleep(rand)
+				
+				client.write(data)
+			end while true
+		end
+	end
+end
+
+def echo_client(data)
+	Async::Reactor.run do |task|
+		Async::TCPServer.connect('localhost', 9000) do |socket|
+			socket.write(data)
+			puts "echo_client: #{socket.read(512)}"
+		end
+	end
+end
+
+Async::Reactor.run do
+	server = echo_server
+	
+	5.times.collect do |i|
+		echo_client("Hello World #{i}")
+	end.each(&:wait)
+	
+	server.stop
+end

data/lib/async/condition.rb

@@ -0,0 +1,44 @@
+# 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 'fiber'
+require 'forwardable'
+
+require_relative 'node'
+
+module Async
+	class Condition
+		def initialize
+			@waiting = []
+		end
+		
+		def wait
+			@waiting << Fiber.current
+			
+			Task.yield
+		end
+		
+		def signal(value)
+			while task = @waiting.pop
+				task.resume(value)
+			end
+		end
+	end
+end

data/lib/async/reactor.rb

@@ -162,9 +162,7 @@ module Async
 				end
 			end
 			
-			result = Fiber.yield
-			
-			raise result if result.is_a? Exception
+			Task.yield
 		ensure
 			timer.cancel if timer
 		end

data/lib/async/task.rb

@@ -22,6 +22,7 @@ require 'fiber'
 require 'forwardable'
 
 require_relative 'node'
+require_relative 'condition'
 
 module Async
 	class Interrupt < Exception
@@ -30,6 +31,20 @@ module Async
 	class Task < Node
 		extend Forwardable
 		
+		def self.yield
+			if block_given?
+				result = yield
+			else
+				result = Fiber.yield
+			end
+			
+			if result.is_a? Exception
+				raise result
+			else
+				return result
+			end
+		end
+		
 		def initialize(ios, reactor)
 			if parent = Task.current?
 				super(parent)
@@ -46,6 +61,8 @@ module Async
 			@status = :running
 			@result = nil
 			
+			@condition = nil
+			
 			@fiber = Fiber.new do
 				set!
 				
@@ -56,7 +73,8 @@ module Async
 				rescue Interrupt
 					@status = :interrupted
 					# Async.logger.debug("Task #{self} interrupted: #{$!}")
-				rescue Exception
+				rescue Exception => error
+					@result = error
 					@status = :failed
 					# Async.logger.debug("Task #{self} failed: #{$!}")
 					raise
@@ -84,10 +102,21 @@ module Async
 		
 		def run
 			@fiber.resume
-				
-			return @fiber
 		end
 		
+		def result
+			raise RuntimeError.new("Cannot wait on own fiber") if Fiber.current.equal?(@fiber)
+			
+			if running?
+				@condition ||= Condition.new
+				@condition.wait
+			else
+				Task.yield {@result}
+			end
+		end
+		
+		alias wait result
+		
 		def stop
 			@children.each(&:stop)
 			
@@ -122,6 +151,10 @@ module Async
 			Thread.current[:async_task]
 		end
 		
+		def running?
+			@status == :running
+		end
+		
 		# Whether we can remove this node from the reactor graph.
 		def finished?
 			super && @status != :running
@@ -132,6 +165,10 @@ module Async
 			@ios = []
 			
 			consume
+			
+			if @condition
+				@condition.signal(@result)
+			end
 		end
 		
 		private

data/lib/async/version.rb

@@ -19,5 +19,5 @@
 # THE SOFTWARE.
 
 module Async
-	VERSION = "0.10.0"
+	VERSION = "0.11.0"
 end

data/lib/async/wrapper.rb

@@ -55,11 +55,7 @@ module Async
 		
 		def wait_any(interests = :rw)
 			monitor(interests) do
-				# Async.logger.debug "Fiber #{Fiber.current} yielding..."
-				result = Fiber.yield
-				
-				# Async.logger.debug "Fiber #{Fiber.current} resuming with result #{result}..."
-				raise result if result.is_a? Exception
+				Task.yield
 			end
 		end
 		

data/spec/async/task_spec.rb

@@ -133,4 +133,53 @@ RSpec.describe Async::Task do
 			expect(state).to be == :finished
 		end
 	end
+	
+	describe '#wait' do
+		it "will wait on another task to complete" do
+			result = nil
+			
+			apples_task = reactor.async do |task|
+				task.sleep(0.1)
+				
+				:apples
+			end
+			
+			oranges_task = reactor.async do |task|
+				task.sleep(0.01)
+				
+				:oranges
+			end
+			
+			fruit_salad_task = reactor.async do |task|
+				result = [apples_task.result, oranges_task.result]
+			end
+			
+			reactor.run
+			
+			expect(result).to be == [:apples, :oranges]
+		end
+		
+		it "will propagate exceptions" do
+			error_task = nil
+			
+			error_task = reactor.async do |task|
+				task.sleep(0.1)
+				
+				raise ArgumentError.new("It simply wasn't good enough")
+			end
+			
+			innocent_task = reactor.async do |task|
+				expect{error_task.result}.to raise_error(ArgumentError, /wasn't good enough/)
+			end
+			
+			begin
+				reactor.run
+			rescue Exception
+				retry
+			end
+			
+			expect(error_task).to be_finished
+			expect(innocent_task).to be_finished
+		end
+	end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: async
 version: !ruby/object:Gem::Version
-  version: 0.10.0
+  version: 0.11.0
 platform: ruby
 authors:
 - Samuel Williams
@@ -14,16 +14,16 @@ dependencies:
   name: nio4r
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '2'
+        version: '0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '2'
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: timers
   requirement: !ruby/object:Gem::Requirement
@@ -103,6 +103,7 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- ".editorconfig"
 - ".gitignore"
 - ".rspec"
 - ".travis.yml"
@@ -112,7 +113,9 @@ files:
 - Rakefile
 - async.gemspec
 - examples/aio.rb
+- examples/echo.rb
 - lib/async.rb
+- lib/async/condition.rb
 - lib/async/io.rb
 - lib/async/logger.rb
 - lib/async/node.rb