async 1.25.0 → 1.26.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 0e483e124943c2ca198118249cfd157307afd86a6e9ead4b376be27ffc95b645
-  data.tar.gz: c460b159f280389b26237c41fd20bac56d9e5b2c525f884402f6170b85fd5053
+  metadata.gz: 72c4f7456b611f436a18f0d143ba5b4c9bb4c7882ad241f3ba251a139c020945
+  data.tar.gz: 4270eef8e1de0d08b953eb373a665d3fb8c0b9348e13d99ac6c61e7aead63db5
 SHA512:
-  metadata.gz: 482ff867811aa68736b37a50d83e5850f4a1f9a310274b8993898c5577136e7502f5c369a3c9bf4685380b88a71de2ff4ed04fbd92115e8918472522e92786ea
-  data.tar.gz: 37584a2af7140b2a4efa0fb60879e97ddae99879f97b137add7fb62662139300e280a9126cf24f559172ecb7ba1f2a6c21eb77adc317df9ae54f9ddb8378f928
+  metadata.gz: 359f4bcd33b438eca0518a00b77d336c25ab49ed3346180013bc135743d9a5447c178416680e5289085cbd9d75718772d7a06e25d44a0b0303cd35086da0c8f5
+  data.tar.gz: 420f280a2ed6d2cb4d363c6a4f80a695a1ad963ead1b040daa16ce9a18ceab9b8f3f6bcee707658a946acba3656f54578df9ed36e2bf8ffc0e6d151cdbbc9e9e

data/lib/async/barrier.rb

@@ -23,7 +23,7 @@
 require_relative 'task'
 
 module Async
-	# A semaphore is used to control access to a common resource in a concurrent system. A useful way to think of a semaphore as used in the real-world systems is as a record of how many units of a particular resource are available, coupled with operations to adjust that record safely (i.e. to avoid race conditions) as units are required or become free, and, if necessary, wait until a unit of the resource becomes available.
+	# A barrier is used to synchronize multiple tasks, waiting for them all to complete before continuing.
 	class Barrier
 		def initialize(parent: nil)
 			@tasks = []

data/lib/async/node.rb

@@ -20,49 +20,182 @@
 # OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
 # THE SOFTWARE.
 
-require 'set'
-
 module Async
+	# A double linked list.
+	class List
+		def initialize
+			@head = nil
+			@tail = nil
+			@size = 0
+		end
+		
+		attr :size
+		
+		attr_accessor :head
+		attr_accessor :tail
+		
+		# Inserts an item at the end of the list.
+		def insert(item)
+			unless @head
+				@head = item
+				@tail = item
+				
+				# Consistency:
+				item.head = nil
+				item.tail = nil
+			else
+				@tail.tail = item
+				item.head = @tail
+				
+				# Consistency:
+				item.tail = nil
+				
+				@tail = item
+			end
+			
+			@size += 1
+			
+			return self
+		end
+		
+		def delete(item)
+			if @head.equal?(item)
+				@head = @head.tail
+			else
+				item.head.tail = item.tail
+			end
+			
+			if @tail.equal?(item)
+				@tail = @tail.head
+			else
+				item.tail.head = item.head
+			end
+			
+			item.head = nil
+			item.tail = nil
+			
+			@size -= 1
+			
+			return self
+		end
+		
+		def each
+			return to_enum unless block_given?
+			
+			item = @head
+			while item
+				# We store the tail pointer so we can remove the current item from the linked list:
+				tail = item.tail
+				yield item
+				item = tail
+			end
+		end
+		
+		def include?(needle)
+			self.each do |item|
+				return true if needle.equal?(item)
+			end
+			
+			return false
+		end
+		
+		def first
+			@head
+		end
+		
+		def last
+			@tail
+		end
+		
+		def empty?
+			@head.nil?
+		end
+		
+		def nil?
+			@head.nil?
+		end
+	end
+	
+	private_constant :List
+	
+	class Children < List
+		def initialize
+			super
+			
+			@transient_count = 0
+		end
+		
+		# Does this node have (direct) transient children?
+		def transients?
+			@transient_count > 0
+		end
+		
+		def insert(item)
+			if item.transient?
+				@transient_count += 1
+			end
+			
+			super
+		end
+		
+		def delete(item)
+			if item.transient?
+				@transient_count -= 1
+			end
+			
+			super
+		end
+		
+		def finished?
+			@size == @transient_count
+		end
+	end
+	
 	# Represents a node in a tree, used for nested {Task} instances.
 	class Node
 		# Create a new node in the tree.
 		# @param parent [Node, nil] This node will attach to the given parent.
 		def initialize(parent = nil, annotation: nil, transient: false)
-			@children = nil
 			@parent = nil
-			
-			# The number of transient children:
-			@transients = 0
+			@children = nil
 			
 			@annotation = annotation
 			@object_name = nil
 			
 			@transient = transient
 			
+			@head = nil
+			@tail = nil
+			
 			if parent
-				self.parent = parent
+				parent.add_child(self)
 			end
 		end
 		
+		# You should not directly rely on these pointers but instead use `#children`.
+		# List pointers:
+		attr_accessor :head
+		attr_accessor :tail
+		
 		# @attr parent [Node, nil]
 		attr :parent
 		
-		# @attr children [Set<Node>] Optional list of children.
+		# @attr children [List<Node>] Optional list of children.
 		attr :children
 		
 		# A useful identifier for the current node.
 		attr :annotation
 		
+		# Whether there are children?
+		def children?
+			@children != nil && !@children.empty?
+		end
+		
 		# Is this node transient?
 		def transient?
 			@transient
 		end
 		
-		# Does this node have (direct) transient children?
-		def transients?
-			@transients > 0
-		end
-		
 		def annotate(annotation)
 			if block_given?
 				previous_annotation = @annotation
@@ -95,13 +228,12 @@ module Async
 			return if @parent.equal?(parent)
 			
 			if @parent
-				@parent.reap(self)
+				@parent.delete_child(self)
 				@parent = nil
 			end
 			
 			if parent
-				@parent = parent
-				@parent.add_child(self)
+				parent.add_child(self)
 			end
 			
 			return self
@@ -112,52 +244,42 @@ module Async
 		end
 		
 		protected def add_child child
-			@children ||= Set.new
-			@children << child
-			
-			if child.transient?
-				@transients += 1
-			end
+			@children ||= Children.new
+			@children.insert(child)
+			child.set_parent(self)
+		end
+		
+		protected def delete_child(child)
+			@children.delete(child)
+			child.set_parent(nil)
 		end
 		
 		# Whether the node can be consumed safely. By default, checks if the
 		# children set is empty.
 		# @return [Boolean]
 		def finished?
-			@children.nil? || @children.empty? || (@children.size == @transients)
+			@children.nil? || @children.finished?
 		end
 		
 		# If the node has a parent, and is {finished?}, then remove this node from
 		# the parent.
 		def consume
-			if @parent && finished?
-				@parent.reap(self)
+			if parent = @parent and finished?
+				parent.delete_child(self)
 				
-				# After reaping self, children are all moved elsewhere.
-				@children = nil
-				@transients = 0
-				
-				@parent.consume
-				@parent = nil
-			end
-		end
-		
-		# Remove a given child node.
-		# @param child [Node]
-		def reap(child)
-			@children.delete(child)
-			
-			if child.transient?
-				@transients -= 1
-			end
-			
-			child.children&.each do |grand_child|
-				if grand_child.finished?
-					grand_child.set_parent(nil)
-				else
-					grand_child.set_parent(self)
-					add_child(grand_child)
+				if @children
+					@children.each do |child|
+						if child.finished?
+							delete_child(child)
+						else
+							parent.add_child(child)
+						end
+					end
+					
+					@children = nil
 				end
+				
+				parent.consume
 			end
 		end
 		

data/lib/async/queue.rb

@@ -34,7 +34,11 @@ module Async
 		
 		attr :items
 		
-		def enqueue item
+		def empty?
+			@items.empty?
+		end
+		
+		def enqueue(item)
 			@items.push(item)
 			
 			self.signal unless self.empty?

data/lib/async/reactor.rb

@@ -50,10 +50,10 @@ module Async
 				
 				return reactor.async(*arguments, **options, &block)
 			else
-				reactor = self.new(**options)
+				reactor = self.new
 				
 				begin
-					return reactor.run(*arguments, &block)
+					return reactor.run(*arguments, **options, &block)
 				ensure
 					reactor.close
 				end
@@ -91,11 +91,11 @@ module Async
 		end
 		
 		def to_s
-			"\#<#{self.description} #{@children&.size || 0} children #{stopped? ? 'stopped' : 'running'}>"
+			"\#<#{self.description} #{@children&.size || 0} children (#{stopped? ? 'stopped' : 'running'})>"
 		end
 		
 		def stopped?
-			@children.nil? || @children.empty?
+			@children.nil?
 		end
 		
 		# TODO Remove these in next major release. They are too confusing to use correctly.
@@ -222,13 +222,11 @@ module Async
 			return true
 		end
 		
-		# Run the reactor until either all tasks complete or {#pause} or {#stop} is
-		# invoked. Proxies arguments to {#async} immediately before entering the
-		# loop, if a block is provided.
-		def run(*arguments, &block)
+		# Run the reactor until all tasks are finished. Proxies arguments to {#async} immediately before entering the loop, if a block is provided.
+		def run(*arguments, **options, &block)
 			raise RuntimeError, 'Reactor has been closed' if @selector.nil?
 			
-			initial_task = self.async(*arguments, &block) if block_given?
+			initial_task = self.async(*arguments, **options, &block) if block_given?
 			
 			while self.run_once
 				# Round and round we go!
@@ -239,12 +237,19 @@ module Async
 			logger.debug(self) {"Exiting run-loop because #{$! ? $! : 'finished'}."}
 		end
 		
+		def stop(later = true)
+			@children&.each do |child|
+				# We don't want this process to propagate `Async::Stop` exceptions, so we schedule tasks to stop later.
+				child.stop(later)
+			end
+		end
+		
 		# Stop each of the children tasks and close the selector.
 		# 
 		# @return [void]
 		def close
 			# This is a critical step. Because tasks could be stored as instance variables, and since the reactor is (probably) going out of scope, we need to ensure they are stopped. Otherwise, the tasks will belong to a reactor that will never run again and are not stopped.
-			self.stop
+			self.stop(false)
 			
 			@selector.close
 			@selector = nil
@@ -255,7 +260,7 @@ module Async
 		def closed?
 			@selector.nil?
 		end
-	
+		
 		# Put the calling fiber to sleep for a given ammount of time.
 		# @param duration [Numeric] The time in seconds, to sleep for.
 		def sleep(duration)

data/lib/async/version.rb

@@ -21,5 +21,5 @@
 # THE SOFTWARE.
 
 module Async
-	VERSION = "1.25.0"
+	VERSION = "1.26.2"
 end

metadata

@@ -1,57 +1,57 @@
 --- !ruby/object:Gem::Specification
 name: async
 version: !ruby/object:Gem::Version
-  version: 1.25.0
+  version: 1.26.2
 platform: ruby
 authors:
 - Samuel Williams
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2020-04-23 00:00:00.000000000 Z
+date: 2020-06-11 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
-  name: nio4r
+  name: console
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '2.3'
+        version: '1.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '2.3'
+        version: '1.0'
 - !ruby/object:Gem::Dependency
-  name: timers
+  name: nio4r
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '4.1'
+        version: '2.3'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '4.1'
+        version: '2.3'
 - !ruby/object:Gem::Dependency
-  name: console
+  name: timers
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.0'
+        version: '4.1'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.0'
+        version: '4.1'
 - !ruby/object:Gem::Dependency
   name: async-rspec
   requirement: !ruby/object:Gem::Requirement
@@ -67,19 +67,33 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '1.1'
 - !ruby/object:Gem::Dependency
-  name: covered
+  name: bake-bundler
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '0.10'
+        version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '0.10'
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: bake-modernize
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
@@ -95,21 +109,21 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: rspec
+  name: covered
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.6'
+        version: '0.10'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.6'
+        version: '0.10'
 - !ruby/object:Gem::Dependency
-  name: bake-bundler
+  name: benchmark-ips
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -122,41 +136,26 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
-description: "\t\tAsync is a modern concurrency framework for Ruby. It implements
-  the\n\t\treactor pattern, providing both non-blocking I/O and timer events.\n"
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.6'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.6'
+description:
 email:
-- samuel.williams@oriontransfer.co.nz
 executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- ".editorconfig"
-- ".github/workflows/development.yml"
-- ".gitignore"
-- ".rspec"
-- ".yardopts"
-- Gemfile
-- Guardfile
-- README.md
-- Rakefile
-- async.gemspec
-- bake.rb
-- benchmark/async_vs_lightio.rb
-- benchmark/fiber_count.rb
-- benchmark/rubies/README.md
-- benchmark/rubies/benchmark.rb
-- benchmark/thread_count.rb
-- benchmark/thread_vs_fiber.rb
-- examples/async_method.rb
-- examples/callback/loop.rb
-- examples/capture/README.md
-- examples/capture/capture.rb
-- examples/fibers.rb
-- examples/queue/producer.rb
-- examples/sleep_sort.rb
-- examples/stop/condition.rb
-- examples/stop/sleep.rb
-- gems/event.gemfile
 - lib/async.rb
 - lib/async/barrier.rb
 - lib/async/clock.rb
@@ -174,35 +173,11 @@ files:
 - lib/async/wrapper.rb
 - lib/kernel/async.rb
 - lib/kernel/sync.rb
-- logo.png
-- logo.svg
-- papers/1982 Grossman.pdf
-- papers/1987 ODell.pdf
-- spec/async/barrier_spec.rb
-- spec/async/chainable_async_examples.rb
-- spec/async/clock_spec.rb
-- spec/async/condition_examples.rb
-- spec/async/condition_spec.rb
-- spec/async/logger_spec.rb
-- spec/async/node_spec.rb
-- spec/async/notification_spec.rb
-- spec/async/performance_spec.rb
-- spec/async/queue_spec.rb
-- spec/async/reactor/nested_spec.rb
-- spec/async/reactor_spec.rb
-- spec/async/semaphore_spec.rb
-- spec/async/task_spec.rb
-- spec/async/wrapper_spec.rb
-- spec/async_spec.rb
-- spec/enumerator_spec.rb
-- spec/kernel/async_spec.rb
-- spec/kernel/sync_spec.rb
-- spec/spec_helper.rb
 homepage: https://github.com/socketry/async
 licenses:
 - MIT
 metadata: {}
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -218,27 +193,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubygems_version: 3.1.2
-signing_key: 
+signing_key:
 specification_version: 4
-summary: Async is an concurrency framework based for Ruby.
-test_files:
-- spec/async/barrier_spec.rb
-- spec/async/chainable_async_examples.rb
-- spec/async/clock_spec.rb
-- spec/async/condition_examples.rb
-- spec/async/condition_spec.rb
-- spec/async/logger_spec.rb
-- spec/async/node_spec.rb
-- spec/async/notification_spec.rb
-- spec/async/performance_spec.rb
-- spec/async/queue_spec.rb
-- spec/async/reactor/nested_spec.rb
-- spec/async/reactor_spec.rb
-- spec/async/semaphore_spec.rb
-- spec/async/task_spec.rb
-- spec/async/wrapper_spec.rb
-- spec/async_spec.rb
-- spec/enumerator_spec.rb
-- spec/kernel/async_spec.rb
-- spec/kernel/sync_spec.rb
-- spec/spec_helper.rb
+summary: A concurrency framework for Ruby.
+test_files: []