async 1.10.0 → 1.10.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: fc6f62aa8e36dcfa1864f1b34d6f81b220583b511b1e81843cca29ba57669160
-  data.tar.gz: 0fb3bdc83efe1d7ebb06594d7b85c481d8934e1ba0a73a2858a6e1b772ef2971
+  metadata.gz: e0b789abc06e34991f2e29573f377f4c5c2fdc6c11d3d22b33d524ec82a73e23
+  data.tar.gz: eafd1a24553091204bf1bf6f0340b9221ae27b28873acf1e3201db3f6859cf3f
 SHA512:
-  metadata.gz: 6b9881a10f81214fbea511eb8d4c7fd1d96af8e92dfebb6452604fe4d6ae35dfa667fbace3c600c25ecdbccb6cfdba6dacbc7bba058051a7e7c7d4de4ceb2941
-  data.tar.gz: 3db5a1c721168949e2aef7dae62aab8efc48e960124e894c112245a7174ccea0487e47fb1794750c5434ed192e357cbd19b705b9ebd72992a4b03801754e254d
+  metadata.gz: fcc907cf78c1c61a01acf1ee54473c80c73456796d372e7940104aafaed78c1cb8b7a506185227ebcf74fe1d54116c882f1f4fb5039920f9df4f678ef3c2193f
+  data.tar.gz: d9c4d25e9b9dc60367954a803a9581ac865550bccf229471a7a9cfc171e8d4b50ee2df5c35ed71116f6947c367f8072a7c9ca506e26322f131ace226e816dd14

data/.travis.yml

@@ -21,9 +21,11 @@ matrix:
     - rvm: 2.6
     - rvm: jruby-head
       env: JRUBY_OPTS="--debug -X+O"
+    - rvm: truffleruby
     - rvm: ruby-head
     - rvm: rbx-3
   allow_failures:
     - rvm: ruby-head
     - rvm: jruby-head
     - rvm: rbx-3
+    - rvm: truffleruby

data/README.md

@@ -105,28 +105,11 @@ end
 
 As tasks run synchronously until they yield back to the reactor, you can guarantee this model works correctly. While in theory `IO#autoclose` allows you to automatically close file descriptors when they go out of scope via the GC, it may produce unpredictable behavour (exhaustion of file descriptors, flushing data at odd times), so it's not recommended.
 
-## Supported Ruby Versions
+## Caveats
 
-This library aims to support and is [tested against][travis] the following Ruby
-versions:
+### Enumerators
 
-* Ruby 2.2+
-* JRuby 9.1.6.0+
-
-If something doesn't work on one of these versions, it's a bug.
-
-This library may inadvertently work (or seem to work) on other Ruby versions,
-however support will only be provided for the versions listed above.
-
-If you would like this library to support another Ruby version or
-implementation, you may volunteer to be a maintainer. Being a maintainer
-entails making sure all tests run and pass on that implementation. When
-something breaks on your implementation, you will be responsible for providing
-patches in a timely fashion. If critical issues for a particular implementation
-exist at the time of a major release, support for that Ruby version may be
-dropped.
-
-[travis]: http://travis-ci.org/socketry/async
+Due to limitations within Ruby and the nature of this library, it is not possible to use `to_enum` on methods which invoke asynchronous behavior. We hope to [fix this issue in the future](https://github.com/socketry/async/issues/23).
 
 ## Contributing
 

data/Rakefile

@@ -6,14 +6,18 @@ RSpec::Core::RakeTask.new(:test)
 task :default => :test
 
 def clone_and_test(name)
-	sh("git clone https://git@github.com/socketry/#{name}")
+	path = "external/#{name}"
+	FileUtils.rm_rf path
+	FileUtils.mkdir_p path
+	
+	sh("git clone https://git@github.com/socketry/#{name} #{path}")
 	
 	# I tried using `bundle config --local local.async ../` but it simply doesn't work.
-	File.open("#{name}/Gemfile", "a") do |file| 
-		file.puts('gem "async", path: "../"')
+	File.open("#{path}/Gemfile", "a") do |file| 
+		file.puts('gem "async", path: "../../"')
 	end
 	
-	sh("cd #{name} && bundle install && bundle exec rake test")
+	sh("cd #{path} && bundle install && bundle exec rake test")
 end
 
 task :external do

data/lib/async/reactor.rb

@@ -65,6 +65,7 @@ module Async
 			@timers = Timers::Group.new
 			
 			@ready = []
+			@running = []
 			
 			@stopped = true
 		end
@@ -135,7 +136,7 @@ module Async
 		end
 		
 		def finished?
-			super && @ready.empty?
+			super && @ready.empty? && @running.empty?
 		end
 		
 		# Run the reactor until either all tasks complete or {#stop} is invoked.
@@ -149,15 +150,21 @@ module Async
 			initial_task = async(*args, &block) if block_given?
 			
 			@timers.wait do |interval|
-				if @ready.any?
-					@ready.each do |fiber|
+				# running used to correctly answer on `finished?`, and to reuse Array object.
+				@running, @ready = @ready, @running
+				if @running.any?
+					@running.each do |fiber|
 						fiber.resume if fiber.alive?
 					end
-					
-					@ready.clear
-					
-					# The above tasks may schedule, cancel or affect timers in some way. We need to compute a new wait interval for the blocking selector call below:
-					interval = @timers.wait_interval
+					@running.clear
+
+					# if there are tasks ready to execute, don't sleep.
+					if @ready.any?
+						interval = 0
+					else
+						# The above tasks may schedule, cancel or affect timers in some way. We need to compute a new wait interval for the blocking selector call below:
+						interval = @timers.wait_interval
+					end
 				end
 				
 				# - nil: no timers

data/lib/async/version.rb

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

data/lib/async/wrapper.rb

@@ -50,6 +50,9 @@ module Async
 		end
 		
 		def resume(*args)
+			# It's possible that the monitor was closed before calling resume.
+			return unless @monitor
+			
 			readiness = @monitor.readiness
 			
 			if @readable and (readiness == :r or readiness == :rw)

data/spec/async/wrapper_spec.rb

@@ -78,6 +78,24 @@ RSpec.describe Async::Wrapper do
 			expect(input.wait_writable).to be_truthy
 		end
 		
+		it "can be cancelled while waiting to be readable" do
+			reactor.async do
+				expect do
+					input.wait_readable
+				end.to raise_error(Async::Wrapper::Cancelled)
+			end
+			
+			# This reproduces the race condition that can occur if two tasks are resumed in sequence.
+			
+			# Resume task 1 which closes IO:
+			output.close
+			
+			# Resume task 2:
+			expect do
+				output.resume
+			end.to_not raise_error
+		end
+		
 		it "can be cancelled" do
 			reactor.async do
 				expect do

data/spec/enumerator_spec.rb

@@ -0,0 +1,81 @@
+# Copyright, 2018, by Samuel G. D. Williams. <http://www.codeotaku.com>
+# Copyright, 2018, by Sokolov Yura aka funny-falcon
+# 
+# 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.
+
+RSpec.describe Enumerator do
+	def some_yielder(task)
+		yield 1
+		task.sleep(0.002)
+		yield 2
+	end
+
+	def enum(task)
+		to_enum(:some_yielder, task)
+	end
+
+	it "should play well with Enumerator as internal iterator" do
+		# no fiber really used in internal iterator,
+		# but let this test be here for completness
+		ar = nil
+		Async::Reactor.run do |task|
+			ar = enum(task).to_a
+		end
+		expect(ar).to be == [1, 2]
+	end
+
+	it "should play well with Enumerator as external iterator", pending: "expected failure" do
+		ar = []
+		Async::Reactor.run do |task|
+			en = enum(task)
+			ar << en.next
+			ar << en.next
+			ar << begin en.next rescue $! end
+		end
+		expect(ar[0]).to be == 1
+		expect(ar[1]).to be == 2
+		expect(ar[2]).to be_a StopIteration
+	end
+
+	it "should play well with Enumerator.zip(Enumerator) method", pending: "expected failure" do
+		Async::Reactor.run do |task|
+			ar = [:a, :b, :c, :d].each.zip(enum(task))
+			expect(ar).to be == [[:a, 1], [:b, 2], [:c, nil], [:d, nil]]
+		end
+	end
+
+	it "should play with explicit Fiber usage", pending: "expected failure" do
+		ar = []
+		Async::Reactor.run do |task|
+			fib = Fiber.new {
+				Fiber.yield 1
+				task.sleep(0.002)
+				Fiber.yield 2
+			}
+			ar << fib.resume
+			ar << fib.resume
+			ar << fib.resume
+			ar << begin en.next rescue $! end
+		end
+		expect(ar[0]).to be == 1
+		expect(ar[1]).to be == 2
+		expect(ar[2]).to be nil
+		expect(ar[3]).to be_a FiberError
+	end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: async
 version: !ruby/object:Gem::Version
-  version: 1.10.0
+  version: 1.10.1
 platform: ruby
 authors:
 - Samuel Williams
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-06-12 00:00:00.000000000 Z
+date: 2018-08-06 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: nio4r
@@ -149,6 +149,7 @@ files:
 - spec/async/semaphore_spec.rb
 - spec/async/task_spec.rb
 - spec/async/wrapper_spec.rb
+- spec/enumerator_spec.rb
 - spec/spec_helper.rb
 homepage: https://github.com/socketry/async
 licenses:
@@ -188,4 +189,5 @@ test_files:
 - spec/async/semaphore_spec.rb
 - spec/async/task_spec.rb
 - spec/async/wrapper_spec.rb
+- spec/enumerator_spec.rb
 - spec/spec_helper.rb