async 0.13.0 → 0.14.0

data/lib/async/version.rb

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

data/lib/async/wrapper.rb

@@ -22,58 +22,74 @@ module Async
 	# Represents an asynchronous IO within a reactor.
 	class Wrapper
 		# @param io the native object to wrap.
-		# @param task [Task] the task that is managing this wrapper.
-		def initialize(io, task)
+		# @param reactor [Reactor] the reactor that is managing this wrapper, or not specified, it's looked up by way of {Task.current}.
+		# @param bound [Boolean] whether the underlying socket will be closed if the wrapper is closed.
+		def initialize(io, reactor = nil)
 			@io = io
-			@task = task
+			
+			@reactor = reactor || Task.current.reactor
 			@monitor = nil
 		end
 		
 		# The underlying native `io`.
 		attr :io
 		
-		# The task this wrapper is associated with.
-		attr :task
+		# The reactor this wrapper is associated with.
+		attr :reactor
 		
 		# Wait for the io to become readable.
-		def wait_readable
-			wait_any(:r)
+		def wait_readable(duration = nil)
+			wait_any(:r, duration)
 		end
 		
 		# Wait for the io to become writable.
-		def wait_writable
-			wait_any(:w)
+		def wait_writable(duration = nil)
+			wait_any(:w, duration)
 		end
 		
 		# Wait fo the io to become either readable or writable.
 		# @param interests [:r | :w | :rw] what events to wait for.
-		def wait_any(interests = :rw)
-			monitor(interests) do
-				Task.yield
-			end
+		# @param duration [Float] timeout after the given duration if not `nil`.
+		def wait_any(interests = :rw, duration = nil)
+			monitor(interests, duration)
 		end
 		
 		# Close the monitor.
 		def close
-			@monitor.close if @monitor
-			@monitor = nil
+			close_monitor
+			
+			@io.close if @io
 		end
 		
 		private
 		
+		def close_monitor
+			if @monitor
+				@monitor.close
+				@monitor = nil
+			end
+		end
+		
 		# Monitor the io for the given events
-		# @param interests [:r | :w | :rw] what events to wait for.
-		def monitor(interests)
+		def monitor(interests, duration = nil)
 			unless @monitor
-				@monitor = @task.register(@io, interests)
+				@monitor = @reactor.register(@io, interests)
 			else
 				@monitor.interests = interests
 			end
 			
 			@monitor.value = Fiber.current
 			
-			yield
+			# If the user requested an explicit timeout for this operation:
+			if duration
+				@reactor.timeout(duration) do
+					Task.yield
+				end
+			else
+				Task.yield
+			end
 			
+			return true
 		ensure
 			@monitor.value = nil if @monitor
 		end

data/spec/async/condition_spec.rb

@@ -21,7 +21,7 @@
 require 'async/condition'
 
 RSpec.describe Async::Condition do
-	include_context 'reactor'
+	include_context Async::RSpec::Reactor
 	
 	it 'should continue after condition is signalled' do
 		task = reactor.async do

data/spec/async/node_spec.rb

@@ -44,6 +44,23 @@ RSpec.describe Async::Node do
 		end
 	end
 	
+	describe '#print_hierarchy' do
+		let(:buffer) {StringIO.new}
+		let(:output) {buffer.string}
+		let(:lines) {output.lines}
+		
+		let!(:child) {Async::Node.new(subject)}
+		
+		it "can print hierarchy to bufffer" do
+			subject.print_hierarchy(buffer)
+			
+			expect(lines.count).to be 2
+			
+			expect(lines[0]).to be =~ /#<Async::Node:0x\h+>\n/
+			expect(lines[1]).to be =~ /\t#<Async::Node:0x\h+>\n/
+		end
+	end
+	
 	describe '#consume' do
 		let(:middle) {Async::Node.new(subject)}
 		let(:bottom) {Async::Node.new(middle)}
@@ -56,4 +73,24 @@ RSpec.describe Async::Node do
 			expect(bottom.parent).to be middle
 		end
 	end
+	
+	describe '#annotate' do
+		let(:annotation) {'reticulating splines'}
+		
+		it "should have no annotation by default" do
+			expect(subject.annotation).to be_nil
+		end
+		
+		it 'should output annotation when invoking #to_s' do
+			subject.annotate(annotation) do
+				expect(subject.to_s).to include(annotation)
+			end
+		end
+		
+		it 'can assign annotation' do
+			subject.annotate(annotation)
+			
+			expect(subject.annotation).to be == annotation
+		end
+	end
 end

data/spec/async/reactor/nested_spec.rb

@@ -20,7 +20,7 @@
 
 RSpec.describe Async::Reactor do
 	describe '::run (in existing reactor)' do
-		include_context "reactor"
+		include_context Async::RSpec::Reactor
 		
 		it "should nest reactor" do
 			outer_reactor = Async::Task.current.reactor

data/spec/async/reactor_spec.rb

@@ -41,7 +41,12 @@ RSpec.describe Async::Reactor do
 			state = :stopped
 		end
 		
-		subject.stop
+		subject.async do |task|
+			task.sleep(0.1)
+			task.reactor.stop
+		end
+		
+		subject.run
 		
 		expect(state).to be == :started
 	end
@@ -62,4 +67,20 @@ RSpec.describe Async::Reactor do
 		
 		expect{reactor.run}.to raise_error(RuntimeError, /closed/)
 	end
+	
+	describe '#async' do
+		include_context Async::RSpec::Reactor
+		
+		it "can pass in arguments" do
+			reactor.async(:arg) do |task, arg|
+				expect(arg).to be == :arg
+			end.wait
+		end
+	end
+	
+	describe '#to_s' do
+		it "shows stopped=" do
+			expect(subject.to_s).to include "stopped"
+		end
+	end
 end

data/spec/async/task_spec.rb

@@ -23,6 +23,39 @@ require 'benchmark'
 RSpec.describe Async::Task do
 	let(:reactor) {Async::Reactor.new}
 	
+	describe '#run' do
+		it "can't be invoked twice" do
+			task = reactor.async do |task|
+			end
+			
+			expect{task.run}.to raise_error(RuntimeError, /already running/)
+		end
+	end
+	
+	describe '#async' do
+		it "can start child async tasks" do
+			child = nil
+			
+			parent = reactor.async do |task|
+				child = task.async do
+					task.sleep(1)
+				end
+			end
+			
+			expect(parent).to_not be_nil
+			expect(child).to_not be_nil
+			expect(child.parent).to be parent
+		end
+		
+		it "can pass in arguments" do
+			reactor.async do |task|
+				task.async(:arg) do |task, arg|
+					expect(arg).to be == :arg
+				end.wait
+			end.wait
+		end
+	end
+	
 	describe '#stop' do
 		it "can be stopped" do
 			state = nil
@@ -95,7 +128,9 @@ RSpec.describe Async::Task do
 				reactor.run
 			end
 			
-			expect(time).to be_within(50).percent_of(duration)
+			# This is too unstable on travis.
+			# expect(time).to be_within(50).percent_of(duration)
+			expect(time).to be >= duration
 			expect(state).to be == :finished
 		end
 	end
@@ -182,4 +217,21 @@ RSpec.describe Async::Task do
 			expect(innocent_task).to be_finished
 		end
 	end
+	
+	describe '#to_s' do
+		it "should show running" do
+			apples_task = reactor.async do |task|
+				task.sleep(0.1)
+			end
+			
+			expect(apples_task.to_s).to include "running"
+		end
+		
+		it "should show complete" do
+			apples_task = reactor.async do |task|
+			end
+			
+			expect(apples_task.to_s).to include "complete"
+		end
+	end
 end

data/{lib/async/udp_socket.rb → spec/async/wrapper_spec.rb}

@@ -18,17 +18,33 @@
 # OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
 # THE SOFTWARE.
 
-require_relative 'socket'
+require 'benchmark'
 
-module Async
-	# Asynchronous UDP socket wrapper.
-	class UDPSocket < IPSocket
-		wraps ::UDPSocket
+RSpec.describe Async::Wrapper do
+	let(:pipe) {IO.pipe}
+	let(:input) {Async::Wrapper.new(pipe.last)}
+	let(:output) {Async::Wrapper.new(pipe.first)}
+	
+	describe '#wait_*' do
+		include_context Async::RSpec::Reactor
 		
-		# We pass `send` through directly, but in theory it might block. Internally, it uses sendto.
-		def_delegators :@io, :send
+		it "can wait for writability" do
+			expect(input.wait_writable(1)).to be_truthy
+			
+			input.close
+			output.close
+		end
 		
-		wrap_blocking_method :recvfrom, :recvfrom_nonblock
+		it "can wait for readability" do
+			reactor.async do
+				input.wait_writable(1)
+				input.io.write('Hello World')
+			end
+			
+			expect(output.wait_readable(1)).to be_truthy
+			
+			input.close
+			output.close
+		end
 	end
 end
-

data/spec/spec_helper.rb

@@ -18,42 +18,9 @@ end
 
 require "bundler/setup"
 require "async"
-require "async/tcp_socket"
-require "async/udp_socket"
 
-RSpec.shared_context "closes all io" do
-	def current_ios(gc: GC.start)
-		all_ios = ObjectSpace.each_object(IO).to_a.sort_by(&:object_id)
-		
-		# We are not interested in ios that have been closed already:
-		return all_ios.reject{|io| io.closed?}
-	end
-	
-	# We use around(:each) because it's the highest priority.
-	around(:each) do |example|
-		@system_ios = current_ios
-		
-		result = example.run
-		
-		expect(current_ios).to be == @system_ios
-		
-		result
-	end
-end
-
-RSpec.shared_context "reactor" do
-	let(:reactor) {Async::Task.current.reactor}
-	
-	around(:each) do |example|
-		Async::Reactor.run do
-			result = example.run
-			
-			return result if result.is_a? Exception
-		end
-	end
-	
-	include_context "closes all io"
-end
+# Shared rspec helpers:
+require "async/rspec"
 
 RSpec.configure do |config|
 	# Enable flags like --only-failures and --next-failure

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: async
 version: !ruby/object:Gem::Version
-  version: 0.13.0
+  version: 0.14.0
 platform: ruby
 authors:
 - Samuel Williams
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-04-17 00:00:00.000000000 Z
+date: 2017-05-24 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: nio4r
@@ -39,47 +39,47 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '4.1'
 - !ruby/object:Gem::Dependency
-  name: bundler
+  name: async-rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.3'
+        version: '1.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.3'
+        version: '1.0'
 - !ruby/object:Gem::Dependency
-  name: process-daemon
+  name: bundler
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.0.0
+        version: '1.3'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.0.0
+        version: '1.3'
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 3.4.0
+        version: '3.4'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 3.4.0
+        version: '3.4'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
@@ -113,19 +113,12 @@ files:
 - README.md
 - 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
 - lib/async/reactor.rb
-- lib/async/socket.rb
 - lib/async/task.rb
-- lib/async/tcp_socket.rb
-- lib/async/udp_socket.rb
-- lib/async/unix_socket.rb
 - lib/async/version.rb
 - lib/async/wrapper.rb
 - spec/async/condition_spec.rb
@@ -133,9 +126,7 @@ files:
 - spec/async/reactor/nested_spec.rb
 - spec/async/reactor_spec.rb
 - spec/async/task_spec.rb
-- spec/async/tcp_socket_spec.rb
-- spec/async/udp_socket_spec.rb
-- spec/async/unix_socket_spec.rb
+- spec/async/wrapper_spec.rb
 - spec/spec_helper.rb
 homepage: https://github.com/socketry/async
 licenses:
@@ -147,9 +138,9 @@ require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ">="
+  - - "~>"
     - !ruby/object:Gem::Version
-      version: 2.0.0
+      version: '2.0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
@@ -167,7 +158,5 @@ test_files:
 - spec/async/reactor/nested_spec.rb
 - spec/async/reactor_spec.rb
 - spec/async/task_spec.rb
-- spec/async/tcp_socket_spec.rb
-- spec/async/udp_socket_spec.rb
-- spec/async/unix_socket_spec.rb
+- spec/async/wrapper_spec.rb
 - spec/spec_helper.rb