async 2.3.0 → 2.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: d60db4d677d9cb4ed92f654f19ca17a4dab336002ba44290a80545b1f25e9154
-  data.tar.gz: 9e84c874ef477cd0de6a86022c87a3fe92ae9276ddd3c4f4ccfd9d6600be0672
+  metadata.gz: '0496bec665a4c9cb59cc9f52e0f75e8c122ff66b2daddaa0aa6e83022e5e8928'
+  data.tar.gz: 2e0c3995dc1de72fee48942eecf96b14fa08f8e0d78083fba96be455a0ffdeab
 SHA512:
-  metadata.gz: 7dd4367c1abb5cc79bf635a34b5819522e7f8363c385f69c995fe23d6fd4d7f6fc6a07784c789afbad0ff1ff6726d6d11899dd9b0a87ae582e9f78711c0ab346
-  data.tar.gz: 0cbef57bb4896a06b11a95f318ad8a0d87435b70f591abc73bb8c7bf76773a341aba47399ef59a813f3d87f32f57112d070081db8598d4d58967f13ac26b4c61
+  metadata.gz: cac34c61bf2bde2775d0abbf4185fdecc07f6540ba18017c90ce38ef6d72d95397e09c65b8d9f25f8e3a1ead9635180b38d6666525c00384810c796c6c92d629
+  data.tar.gz: 39778867ad4784cf5f44d164f2d97f52d2cc43b869f267242ef5d9d588f626cc656bb01d7f935a8237f9f83ff50bf9b1371032f50ffb5bc39a1af80e2be89adc

data/lib/async/barrier.md

@@ -7,6 +7,7 @@ require 'async'
 require 'async/barrier'
 
 Sync do
+	Console.logger.info("Barrier Example: sleep sort.")
 	barrier = Async::Barrier.new
 	
 	# Generate an array of 10 numbers:
@@ -31,6 +32,7 @@ end
 ### Output
 
 ~~~
-0.0s     info: Sorted
-             | [0, 0, 0, 0, 1, 2, 2, 3, 6, 6]
+0.0s     info: Barrier Example: sleep sort.
+9.0s     info: Sorted
+             | [3, 3, 3, 4, 4, 5, 5, 5, 8, 9]
 ~~~

data/lib/async/list.rb

@@ -15,11 +15,27 @@ module Async
 		
 		# Print a short summary of the list.
 		def to_s
-			"#<#{self.class.name} size=#{@size}>"
+			sprintf("#<%s:0x%x size=%d>", self.class.name, object_id, @size)
 		end
 		
 		alias inspect to_s
 		
+		# Fast, safe, unbounded accumulation of children.
+		def to_a
+			items = []
+			current = self
+			
+			while current.tail != self
+				unless current.tail.is_a?(Iterator)
+					items << current.tail
+				end
+				
+				current = current.tail
+			end
+			
+			return items
+		end
+		
 		# Points at the end of the list.
 		attr_accessor :head
 		
@@ -118,30 +134,46 @@ module Async
 		
 		# @returns [Boolean] Returns true if the list is empty.
 		def empty?
-			@tail.equal?(self)
+			@size == 0
 		end
 		
+		# def validate!(node = nil)
+		# 	previous = self
+		# 	current = @tail
+		# 	found = node.equal?(self)
+			
+		# 	while true
+		# 		break if current.equal?(self)
+				
+		# 		if current.head != previous
+		# 			raise "Invalid previous linked list node!"
+		# 		end
+				
+		# 		if current.is_a?(List) and !current.equal?(self)
+		# 			raise "Invalid list in list node!"
+		# 		end
+				
+		# 		if node
+		# 			found ||= current.equal?(node)
+		# 		end
+				
+		# 		previous = current
+		# 		current = current.tail
+		# 	end
+			
+		# 	if node and !found
+		# 		raise "Node not found in list!"
+		# 	end
+		# end
+		
 		# Iterate over each node in the linked list. It is generally safe to remove the current node, any previous node or any future node during iteration.
 		#
 		# @yields {|node| ...} Yields each node in the list.
 		# @returns [List] Returns self.
-		def each
+		def each(&block)
 			return to_enum unless block_given?
 			
-			current = self
-			
-			while true
-				node = current.tail
-				# binding.irb if node.nil? && !node.equal?(self)
-				break if node.equal?(self)
-				
-				yield node
-				
-				# If the node has deleted itself or any subsequent node, it will no longer be the next node, so don't use it for continued traversal:
-				if current.tail.equal?(node)
-					current = node
-				end
-			end
+			Iterator.each(self, &block)
 			
 			return self
 		end
@@ -160,22 +192,117 @@ module Async
 		
 		# @returns [Node] Returns the first node in the list, if it is not empty.
 		def first
-			unless @tail.equal?(self)
-				@tail
+			# validate!
+			
+			current = @tail
+			
+			while !current.equal?(self)
+				if current.is_a?(Iterator)
+					current = current.tail
+				else
+					return current
+				end
 			end
+			
+			return nil
 		end
 		
 		# @returns [Node] Returns the last node in the list, if it is not empty.
 		def last
-			unless @head.equal?(self)
-				@head
+			# validate!
+			
+			current = @head
+			
+			while !current.equal?(self)
+				if current.is_a?(Iterator)
+					current = current.head
+				else
+					return current
+				end
 			end
+			
+			return nil
 		end
-	end
-	
-	# A linked list Node.
-	class List::Node
-		attr_accessor :head
-		attr_accessor :tail
+		
+		def shift
+			if node = first
+				remove!(node)
+			end
+		end
+		
+		# A linked list Node.
+		class Node
+			attr_accessor :head
+			attr_accessor :tail
+			
+			alias inspect to_s
+		end
+		
+		class Iterator < Node
+			def initialize(list)
+				@list = list
+				
+				# Insert the iterator as the first item in the list:
+				@tail = list.tail
+				@tail.head = self
+				list.tail = self
+				@head = list
+			end
+			
+			def remove!
+				@head.tail = @tail
+				@tail.head = @head
+				@head = nil
+				@tail = nil
+				@list = nil
+			end
+			
+			def move_next
+				# Move to the next item (which could be an iterator or the end):
+				@tail.head = @head
+				@head.tail = @tail
+				@head = @tail
+				@tail = @tail.tail
+				@head.tail = self
+				@tail.head = self
+			end
+			
+			def move_current
+				while true
+					# Are we at the end of the list?
+					if @tail.equal?(@list)
+						return nil
+					end
+					
+					if @tail.is_a?(Iterator)
+						move_next
+					else
+						return @tail
+					end
+				end
+			end
+			
+			def each
+				while current = move_current
+					yield current
+					
+					if current.equal?(@tail)
+						move_next
+					end
+				end
+			end
+			
+			def self.each(list, &block)
+				return if list.empty?
+				
+				iterator = Iterator.new(list)
+				
+				iterator.each(&block)
+			ensure
+				iterator&.remove!
+			end
+		end
+		
+		private_constant :Iterator
 	end
 end

data/lib/async/node.rb

@@ -187,13 +187,12 @@ module Async
 			if parent = @parent and finished?
 				parent.remove_child(self)
 				
+				# If we have children, then we need to move them to our the parent if they are not finished:
 				if @children
-					@children.each do |child|
+					while child = @children.shift
 						if child.finished?
-							remove_child(child)
+							child.set_parent(nil)
 						else
-							# In theory we don't need to do this... because we are throwing away the list. However, if you don't correctly update the list when moving the child to the parent, it foobars the enumeration, and subsequent nodes will be skipped, or in the worst case you might start enumerating the parents nodes.
-							remove_child(child)
 							parent.add_child(child)
 						end
 					end

data/lib/async/semaphore.rb

@@ -1,7 +1,7 @@
 # frozen_string_literal: true
 
 # Released under the MIT License.
-# Copyright, 2018-2022, by Samuel Williams.
+# Copyright, 2018-2023, by Samuel Williams.
 
 require_relative 'list'
 
@@ -28,6 +28,25 @@ module Async
 		# The tasks waiting on this semaphore.
 		attr :waiting
 		
+		# Allow setting the limit. This is useful for cases where the semaphore is used to limit the number of concurrent tasks, but the number of tasks is not known in advance or needs to be modified.
+		#
+		# On increasing the limit, some tasks may be immediately resumed. On decreasing the limit, some tasks may execute until the count is < than the limit. 
+		#
+		# @parameter limit [Integer] The new limit.
+		def limit= limit
+			difference = limit - @limit
+			@limit = limit
+			
+			# We can't suspend 
+			if difference > 0
+				difference.times do
+					break unless node = @waiting.first
+					
+					node.resume
+				end
+			end
+		end
+		
 		# Is the semaphore currently acquired?
 		def empty?
 			@count.zero?

data/lib/async/task.rb

@@ -263,7 +263,7 @@ module Async
 			self.root.resume(@fiber)
 		end
 		
-		# Finish the current task, and all bound bound IO objects.
+		# Finish the current task, moving any children to the parent.
 		def finish!
 			# Allow the fiber to be recycled.
 			@fiber = nil

data/lib/async/version.rb

@@ -4,5 +4,5 @@
 # Copyright, 2017-2022, by Samuel Williams.
 
 module Async
-	VERSION = "2.3.0"
+	VERSION = "2.4.0"
 end

data/license.md

@@ -1,6 +1,6 @@
 # MIT License
 
-Copyright, 2017-2022, by Samuel Williams.  
+Copyright, 2017-2023, by Samuel Williams.  
 Copyright, 2017, by Kent Gruber.  
 Copyright, 2017, by Devin Christensen.  
 Copyright, 2018, by Sokolov Yura.  
@@ -17,6 +17,9 @@ Copyright, 2020, by Jun Jiang.
 Copyright, 2020-2022, by Bruno Sutic.  
 Copyright, 2021, by Julien Portalier.  
 Copyright, 2022, by Shannon Skipper.  
+Copyright, 2022, by Masafumi Okura.  
+Copyright, 2022, by Trevor Turk.  
+Copyright, 2022, by Masayuki Yamamoto.  
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

data/readme.md

@@ -42,27 +42,3 @@ We welcome contributions to this project.
   - [falcon](https://github.com/socketry/falcon) — A rack compatible server built on top of `async-http`.
   - [rubydns](https://github.com/ioquatix/rubydns) — An easy to use Ruby DNS server.
   - [slack-ruby-bot](https://github.com/slack-ruby/slack-ruby-bot) — A client for making slack bots.
-
-## License
-
-Released under the MIT license.
-
-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.

metadata

@@ -1,27 +1,29 @@
 --- !ruby/object:Gem::Specification
 name: async
 version: !ruby/object:Gem::Version
-  version: 2.3.0
+  version: 2.4.0
 platform: ruby
 authors:
 - Samuel Williams
 - Bruno Sutic
-- Devin Christensen
 - Jeremy Jung
+- Devin Christensen
 - Kent Gruber
-- jeremyjung
 - Brian Morearty
 - Jiang Jinyang
 - Julien Portalier
+- Jun Jiang
+- Ken Muryoi
+- Masafumi Okura
+- Masayuki Yamamoto
 - Olle Jonsson
 - Patrik Wenger
 - Ryan Musgrave
 - Salim Semaoune
 - Shannon Skipper
-- Sokolov Yura aka funny_falcon
+- Sokolov Yura
 - Stefan Wrobel
-- jasl
-- muryoimpl
+- Trevor Turk
 autorequire:
 bindir: bin
 cert_chain:
@@ -54,7 +56,7 @@ cert_chain:
   Q2K9NVun/S785AP05vKkXZEFYxqG6EW012U4oLcFl5MySFajYXRYbuUpH6AY+HP8
   voD0MPg1DssDLKwXyt1eKD/+Fq0bFWhwVM/1XiAXL7lyYUyOq24KHgQ2Csg=
   -----END CERTIFICATE-----
-date: 2022-12-04 00:00:00.000000000 Z
+date: 2023-03-01 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: console
@@ -259,7 +261,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.3.7
+rubygems_version: 3.4.7
 signing_key:
 specification_version: 4
 summary: A concurrency framework for Ruby.