async 1.22.2 → 1.23.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 61d9644a199a84c93e9b9212c31e210343aebd41af6fd62647d600c72658248d
-  data.tar.gz: a275b10657182f96c8ce5578321774b4def1c50374cf0f602387e1a2312e8c36
+  metadata.gz: 1dc28a8cd53cda6b82492cf8a1ed3c2a7786f4f6a29da3935be00298e25eaaea
+  data.tar.gz: c70dfa854738d6eccd197f322312ed1ea810378428b08fba18ca24076a5d98d4
 SHA512:
-  metadata.gz: 4c6d818ec258c64b8d1d2f46bb90360024d114829110a8f4bce27ec740b6d33781b8b5a11a622e28a680a212a91f5550b94ecd34ee3e8e0624937bb290757d8a
-  data.tar.gz: c530521f3102302be5127d3b46a50162682a07beb632c21a281776d33a1b36a15ffc40042d05584c6d36fd8be2732f3ab364bf4149f2a27cc623a541d40c6580
+  metadata.gz: d305bdc4e707ba26b602809669ba8972017be01b7a599e98c471bf969e434a05b5ef725b3853793f7a82a2e7dc13c89231e383d6b06ffbadb966d77eaa36015a
+  data.tar.gz: 58673e31ac2e10e82062fd2def69e040c7780bf6179eb5092bed365ef3564a61d1553a63b45a151b53b64fe43cea4d7139fe0e844b7755083b13436c0008fd42

data/README.md

@@ -307,6 +307,23 @@ Due to limitations within Ruby and the nature of this library, it is not possibl
 
 Blocking Ruby methods such as `pop` in the `Queue` class require access to their own threads and will not yield control back to the reactor which can result in a deadlock.  As a substitute for the standard library `Queue`, the `Async::Queue` class can be used.
 
+## Conventions
+
+### Nesting Tasks
+
+`Async::Barrier` and `Async::Semaphore` are designed to be compatible with each other, and with other tasks that nest `#async` invocations. There are other similar situations where you may want to pass in a parent task, e.g. `Async::IO::Endpoint#bind`.
+
+```ruby
+barrier = Async::Barrier.new
+semaphore = Async::Semaphore.new(2)
+
+semaphore.async(parent: barrier) do
+	# ...
+end
+```
+
+A `parent:` in this context is anything that responds to `#async` in the same way that `Async::Task` responds to `#async`. In situations where you strictly depend on the interface of `Async::Task`, use the `task: Task.current` pattern.
+
 ## Contributing
 
 1. Fork it

data/lib/async/barrier.rb

@@ -46,8 +46,9 @@ module Async
 			@tasks.empty?
 		end
 		
+		# Wait for tasks in FIFO order.
 		def wait
-			while task = @tasks.pop
+			while task = @tasks.shift
 				task.wait
 			end
 		end

data/lib/async/node.rb

@@ -71,6 +71,10 @@ module Async
 			"\#<#{description}>"
 		end
 		
+		def inspect
+			to_s
+		end
+		
 		# Change the parent of this node.
 		# @param parent [Node, nil] the parent to attach to, or nil to detach.
 		# @return [self]

data/lib/async/reactor.rb

@@ -88,7 +88,7 @@ module Async
 		end
 		
 		def to_s
-			"<#{self.description} stopped=#{@stopped}>"
+			"\#<#{self.description} (#{@stopped ? 'stopped' : 'running'})>"
 		end
 		
 		# @attr stopped [Boolean]
@@ -131,7 +131,7 @@ module Async
 			
 			return monitor
 		end
-	
+		
 		# Stop the reactor at the earliest convenience. Can be called from a different thread safely.
 		# @return [void]
 		def stop
@@ -169,7 +169,7 @@ module Async
 			initial_task = self.async(*args, &block) if block_given?
 			
 			until @stopped
-				# logger.debug(self) {"@ready = #{@ready} @running = #{@running}"}
+				logger.debug(self) {"@ready = #{@ready} @running = #{@running}"}
 				
 				if @ready.any?
 					# running used to correctly answer on `finished?`, and to reuse Array object.
@@ -200,7 +200,7 @@ module Async
 					interval = 0
 				end
 				
-				# logger.debug(self) {"Selecting with #{@children&.size} children with interval = #{interval.inspect}..."}
+				logger.debug(self) {"Selecting with #{@children&.size} children with interval = #{interval ? interval.round(2) : 'infinite'}..."}
 				if monitors = @selector.select(interval)
 					monitors.each do |monitor|
 						monitor.value.resume

data/lib/async/semaphore.rb

@@ -79,14 +79,14 @@ module Async
 			end
 		end
 		
-		# Release the semaphore. Must match up with a corresponding call to `acquire`.
+		# Release the semaphore. Must match up with a corresponding call to `acquire`. Will release waiting fibers in FIFO order.
 		def release
 			@count -= 1
 			
-			available = @waiting.pop(@limit - @count)
-			
-			available.each do |fiber|
-				fiber.resume if fiber.alive?
+			while (@limit - @count) > 0 and fiber = @waiting.shift
+				if fiber.alive?
+					fiber.resume
+				end
 			end
 		end
 		

data/lib/async/task.rb

@@ -85,7 +85,7 @@ module Async
 		end
 		
 		def to_s
-			"<#{self.description} #{@status}>"
+			"\#<#{self.description} (#{@status})>"
 		end
 		
 		def logger
@@ -149,7 +149,7 @@ module Async
 		
 		# Stop the task and all of its children.
 		# @return [void]
-		def stop
+		def stop(later = false)
 			if self.stopped?
 				# If we already stopped this task... don't try to stop it again:
 				return
@@ -157,7 +157,11 @@ module Async
 			
 			if self.running?
 				if self.current?
-					raise Stop, "Stopping current fiber!"
+					if later
+						@reactor << Stop::Later.new(self)
+					else
+						raise Stop, "Stopping current task!"
+					end
 				elsif @fiber&.alive?
 					begin
 						@fiber.resume(Stop.new)
@@ -235,9 +239,12 @@ module Async
 		end
 		
 		def stop!
-			# logger.debug(self) {"Task was stopped with #{@children.size} children!"}
+			# logger.debug(self) {"Task was stopped with #{@children&.size.inspect} children!"}
 			@status = :stopped
-			@children&.each(&:stop)
+			
+			@children&.each do |child|
+				child.stop(true)
+			end
 		end
 		
 		def make_fiber(&block)

data/lib/async/version.rb

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

data/spec/async/barrier_spec.rb

@@ -75,6 +75,20 @@ RSpec.describe Async::Barrier do
 			
 			expect(subject).to be_empty
 		end
+		
+		it 'waits for tasks in order' do
+			order = []
+			
+			5.times do |i|
+				subject.async do
+					order << i
+				end
+			end
+			
+			subject.wait
+			
+			expect(order).to be == [0, 1, 2, 3, 4]
+		end
 	end
 	
 	context 'with semaphore' do

data/spec/async/condition_examples.rb

@@ -51,6 +51,23 @@ RSpec.shared_examples Async::Condition do
 		subject.signal
 	end
 	
+	it 'resumes tasks in order' do
+		order = []
+		
+		5.times do |i|
+			task = reactor.async do
+				subject.wait
+				order << i
+			end
+		end
+		
+		subject.signal
+		
+		reactor.yield
+		
+		expect(order).to be == [0, 1, 2, 3, 4]
+	end
+	
 	context "with timeout" do
 		before do
 			@state = nil

data/spec/async/notification_spec.rb

@@ -18,6 +18,7 @@
 # OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
 # THE SOFTWARE.
 
+require 'async/rspec'
 require 'async/notification'
 
 require_relative 'condition_examples'

data/spec/async/task_spec.rb

@@ -181,6 +181,19 @@ RSpec.describe Async::Task do
 			expect(task).to be_stopped
 		end
 		
+		it "can stop current task using exception" do
+			state = nil
+			
+			task = reactor.async do |task|
+				state = :started
+				raise Async::Stop, "I'm finished."
+				state = :finished
+			end
+			
+			expect(state).to be == :started
+			expect(task).to be_stopped
+		end
+		
 		it "should stop direct child" do
 			parent_task = child_task = nil
 			
@@ -205,6 +218,35 @@ RSpec.describe Async::Task do
 			expect(child_task).to_not be_alive
 		end
 		
+		it "can stop nested parent" do
+			parent_task = nil
+			children_tasks = []
+			
+			reactor.async do |task|
+				parent_task = task
+				
+				reactor.async do |task|
+					children_tasks << task
+					task.sleep(2)
+				end
+				
+				reactor.async do |task|
+					children_tasks << task
+					task.sleep(1)
+					parent_task.stop
+				end
+				
+				reactor.async do |task|
+					children_tasks << task
+					task.sleep(2)
+				end
+			end
+			
+			reactor.run
+			
+			expect(parent_task).to_not be_alive
+		end
+		
 		it "should not remove running task" do
 			top_task = middle_task = bottom_task = nil
 			

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: async
 version: !ruby/object:Gem::Version
-  version: 1.22.2
+  version: 1.23.0
 platform: ruby
 authors:
 - Samuel Williams
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-10-10 00:00:00.000000000 Z
+date: 2019-10-15 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: nio4r