async 2.21.1 → 2.21.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 6dda1de8f976c85bf6dcbd0156c27c30f85f88d5ffaf32f3397b9838aa920bab
-  data.tar.gz: 0f09cde08880db4456bc03e9a4351903b9a96ca7099e7305c76fdee7f8edc0ed
+  metadata.gz: 2cc69a2f9c734662ef143958e58fc4c9af45d7a05a0910570457c328fb488fca
+  data.tar.gz: b1149b22d3dc693e411efa942fe36841f7ce9120050b370addc309e270ba7965
 SHA512:
-  metadata.gz: 980cd5e5832ddd71846785e10b23d18d11cb1f0eee33ccbdf33ed40feb4ac51dd99f7cf3d7f93055d0ad52de2abe0103c1b433d41f5bac1728c04435e35655db
-  data.tar.gz: d9c7c1c69e49acd89738f44900502bc83aea08341b84a9f8d9e02588261889a24a935dfa6509394514a575a4b17d8dcf0ca512518e8b0e089369a8fd37b44d52
+  metadata.gz: f8930f0303101bc429bc7cc9f9120e516699559af0ee1b73af95c957e9bc3c1cfd9dcca45ce14a99ed86d78fc4a2cce6eb77f64f46fbde2db61d028aa4c89739
+  data.tar.gz: 359e97fb5805e6b7bef879aad71df0f72a53584b806c30f4a5a52e1f26f4dce1e9e21f20b01c5d79fb714857d53d78232c2c209ce959c806b81b358f63aa452b

data/lib/async/limited_queue.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+# Released under the MIT License.
+# Copyright, 2024, by Samuel Williams.
+
+# The implementation lives in `queue.rb` but later we may move it here for better autoload/inference.
+require_relative "queue"

data/lib/async/queue.rb

@@ -45,7 +45,9 @@ module Async
 		end
 		
 		# Compatibility with {::Queue#push}.
-		alias << push
+		def <<(item)
+			self.push(item)
+		end
 		
 		# Add multiple items to the queue.
 		def enqueue(*items)
@@ -64,7 +66,9 @@ module Async
 		end
 		
 		# Compatibility with {::Queue#pop}.
-		alias pop dequeue
+		def pop
+			self.dequeue
+		end
 		
 		# Process each item in the queue.
 		#
@@ -125,7 +129,7 @@ module Async
 		# If the queue is full, this method will block until there is space available.
 		#
 		# @parameter item [Object] The item to add to the queue.
-		def <<(item)
+		def push(item)
 			while limited?
 				@full.wait
 			end

data/lib/async/task.rb

@@ -181,7 +181,10 @@ module Async
 			@status == :completed
 		end
 		
-		alias complete? completed?
+		# Alias for {#completed?}.
+		def complete?
+			self.completed?
+		end
 		
 		# @attribute [Symbol] The status of the execution of the task, one of `:initialized`, `:running`, `:complete`, `:stopped` or `:failed`.
 		attr :status

data/lib/async/variable.rb

@@ -31,7 +31,10 @@ module Async
 			condition.signal(value)
 		end
 		
-		alias value= resolve
+		# Alias for {#resolve}.
+		def value=(value)
+			self.resolve(value)
+		end
 		
 		# Whether the value has been resolved.
 		#
@@ -48,6 +51,9 @@ module Async
 			return @value
 		end
 		
-		alias value wait
+		# Alias for {#wait}.
+		def value
+			self.wait
+		end
 	end
 end

data/lib/async/version.rb

@@ -4,5 +4,5 @@
 # Copyright, 2017-2024, by Samuel Williams.
 
 module Async
-	VERSION = "2.21.1"
+	VERSION = "2.21.3"
 end

data/lib/async/worker_pool.rb

@@ -10,6 +10,7 @@ module Async
 	#
 	# @private
 	class WorkerPool
+		# Used to augment the scheduler to add support for blocking operations.
 		module BlockingOperationWait
 			# Wait for the given work to be executed.
 			#
@@ -23,7 +24,11 @@ module Async
 			end
 		end
 		
+		# Execute the given work in a background thread.
 		class Promise
+			# Create a new promise.
+			#
+			# @parameter work [Proc] The work to be done.
 			def initialize(work)
 				@work = work
 				@state = :pending
@@ -33,6 +38,7 @@ module Async
 				@thread = nil
 			end
 			
+			# Execute the work and resolve the promise.
 			def call
 				work = nil
 				
@@ -67,6 +73,7 @@ module Async
 				end
 			end
 			
+			# Cancel the work and raise an exception in the background thread.
 			def cancel
 				return unless @work
 				
@@ -77,6 +84,9 @@ module Async
 				end
 			end
 			
+			# Wait for the work to be done.
+			#
+			# @returns [Object] The result of the work.
 			def wait
 				@guard.synchronize do
 					while @state == :pending
@@ -92,19 +102,22 @@ module Async
 			end
 		end
 		
-		# A handle to the work being done.
+		# A background worker thread.
 		class Worker
+			# Create a new worker.
 			def initialize
 				@work = ::Thread::Queue.new
 				@thread = ::Thread.new(&method(:run))
 			end
 			
+			# Execute work until the queue is closed.
 			def run
 				while work = @work.pop
 					work.call
 				end
 			end
 			
+			# Close the worker thread.
 			def close
 				if thread = @thread
 					@thread = nil

data/lib/traces/provider/async/task.rb

@@ -8,20 +8,31 @@ require "traces/provider"
 
 Traces::Provider(Async::Task) do
 	def schedule(&block)
+		# If we are not actively tracing anything, then we can skip this:
+		unless Traces.active?
+			return super(&block)
+		end
+		
 		unless self.transient?
 			trace_context = Traces.trace_context
 		end
 		
+		attributes = {
+			# We use the instance variable as it corresponds to the user-provided block.
+			"block" => @block,
+			"transient" => self.transient?,
+		}
+		
+		# Run the trace in the context of the child task:
 		super do
 			Traces.trace_context = trace_context
 			
 			if annotation = self.annotation
-				attributes = {
-					"annotation" => annotation
-				}
+				attributes["annotation"] = annotation
 			end
 			
 			Traces.trace("async.task", attributes: attributes) do
+				# Yes, this is correct, we already called super above:
 				yield
 			end
 		end

data/readme.md

@@ -7,6 +7,7 @@ Async is a composable asynchronous I/O framework for Ruby based on [io-event](ht
 > beautifully designed." *– [janko](https://github.com/janko)*
 
 [![Development Status](https://github.com/socketry/async/workflows/Test/badge.svg)](https://github.com/socketry/async/actions?workflow=Test)
+[<img src="https://api.gitsponsors.com/api/badge/img?id=87380483" height="20"/>](https://api.gitsponsors.com/api/badge/link?p=U4gCxvzG7eUksiJSe0MSlPHWWhBYryqj6i48tx5L7/r/2NgkAToKb6dEm31bAftU3H+7BVwk3VhUBtE4GHqHJTPfWPR6xo2BQVoT15rFAGAsLFgdT2kKopIfCGV/QDOm7BrkodS2//R7NUMksAdaCQ==)
 
 ## Features
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: async
 version: !ruby/object:Gem::Version
-  version: 2.21.1
+  version: 2.21.3
 platform: ruby
 authors:
 - Samuel Williams
@@ -31,7 +31,6 @@ authors:
 - Sokolov Yura
 - Stefan Wrobel
 - Trevor Turk
-autorequire:
 bindir: bin
 cert_chain:
 - |
@@ -63,7 +62,7 @@ cert_chain:
   Q2K9NVun/S785AP05vKkXZEFYxqG6EW012U4oLcFl5MySFajYXRYbuUpH6AY+HP8
   voD0MPg1DssDLKwXyt1eKD/+Fq0bFWhwVM/1XiAXL7lyYUyOq24KHgQ2Csg=
   -----END CERTIFICATE-----
-date: 2024-11-27 00:00:00.000000000 Z
+date: 2025-01-31 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: console
@@ -99,22 +98,42 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.6'
-    - - ">="
+        version: '1.7'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.7'
+- !ruby/object:Gem::Dependency
+  name: traces
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.6.5
+        version: '0.15'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.6'
-    - - ">="
+        version: '0.15'
+- !ruby/object:Gem::Dependency
+  name: metrics
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.12'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.6.5
-description:
-email:
+        version: '0.12'
 executables: []
 extensions: []
 extra_rdoc_files: []
@@ -127,6 +146,7 @@ files:
 - lib/async/condition.rb
 - lib/async/console.rb
 - lib/async/idler.rb
+- lib/async/limited_queue.rb
 - lib/async/list.rb
 - lib/async/node.rb
 - lib/async/notification.rb
@@ -160,7 +180,6 @@ metadata:
   documentation_uri: https://socketry.github.io/async/
   funding_uri: https://github.com/sponsors/ioquatix/
   source_code_uri: https://github.com/socketry/async.git
-post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -175,8 +194,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.5.22
-signing_key:
+rubygems_version: 3.6.2
 specification_version: 4
 summary: A concurrency framework for Ruby.
 test_files: []