async-await 0.7.0 → 0.8.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: bb18ada12c5c9f610552caf9497fea312501470bb22280bd5053d16cb1fc2e5d
-  data.tar.gz: 908a0ec28c62ee51fd8fbbb47513d4102553a9afd596cd4297c00654dd961f22
+  metadata.gz: d27b16c1a38a595f31ccfbe742c2d29712ac97b4b9c56ab64e6a793b0b52291f
+  data.tar.gz: fd996d7db069e959fc9572ac4ec58a931e99fdc41e5c543eb5caf1e94d16051d
 SHA512:
-  metadata.gz: ae3e7f82650b4ef2af5a392f5b5e22bc0eaec2a38b0de10bbd1e15d0c7dd56d711cc5c9584145adfbb5e30ca8834064ee905ba8b014e6383461706e19b6483f0
-  data.tar.gz: b154981442ff02d51337e201ff965eea85282c47c47d6065a09057e96c0b21b81a129a3a8ee5b9e8c753b55a8a514c1b80f7ad4d2763d148d2b00dd388f145c0
+  metadata.gz: 3b7a82fe11c667443425e3da84cf349a010a9bf598fffe85e00e72cfb4598e92f30cc0bebbb8ca76af7c441e64b2709ba2648aa16254c1de7d2cba4bd7c97f38
+  data.tar.gz: 699dccb7567f8b139d06661e117500989c55071c99c50724243d9e6a8e43e6c2eb70d6cbebd5c81428adfc51227c3d128a0888a1226ee04be166754fbc458a70

data/lib/async/await/enumerable.rb

@@ -1,25 +1,35 @@
 # frozen_string_literal: true
 
 # Released under the MIT License.
-# Copyright, 2020-2024, by Samuel Williams.
+# Copyright, 2020-2025, by Samuel Williams.
 
-require 'async'
+require "async"
 
 module Async
 	module Await
+		# Provide asynchronous methods for enumerables.
 		module Enumerable
+			# This method is used to map the elements of an enumerable collection asynchronously.
+			#
+			# @parameter parent [Interface(:async)] The parent to use for creating new tasks.
+			# @yields {|item| ...} The block to execute for each element in the collection.
 			def async_map(parent: nil, &block)
 				Sync do |task|
 					parent ||= task
 					
 					self.map do |*arguments|
-						parent.async do
+						parent.async(finished: false) do
 							yield(*arguments)
 						end
 					end.map(&:wait)
 				end
 			end
 			
+			# This method is used to iterate over the elements of an enumerable collection asynchronously.
+			#
+			# @parameter parent [Interface(:async)] The parent to use for creating new tasks.
+			# @yields {|item| ...} The block to execute for each element in the collection.
+			# @return [self] The original enumerable collection.
 			def async_each(parent: nil, &block)
 				Sync do |task|
 					parent ||= task

data/lib/async/await/version.rb

@@ -5,6 +5,6 @@
 
 module Async
 	module Await
-		VERSION = "0.7.0"
+		VERSION = "0.8.0"
 	end
 end

data/lib/async/await.rb

@@ -1,16 +1,22 @@
 # frozen_string_literal: true
 
 # Released under the MIT License.
-# Copyright, 2017-2024, by Samuel Williams.
+# Copyright, 2017-2025, by Samuel Williams.
 
-require_relative 'await/version'
+require_relative "await/version"
 
+# @namespace
 module Async
+	# Provide a way to wrap methods so that they can be run synchronously or asynchronously in an event loop.
 	module Await
+		# A hook that is called when the module is included in a class in order to provide the class with the methods defined in this module.
 		def self.included(klass)
 			klass.extend(self)
 		end
 		
+		# Wrap the method with the given name in a block that will run the method synchronously in an event loop.
+		#
+		# @parameter name [Symbol] The name of the method to wrap.
 		def sync(name)
 			original_method = instance_method(name)
 			
@@ -25,8 +31,13 @@ module Async
 					end.wait
 				end
 			end
+			
+			return name
 		end
 		
+		# Wrap the method with the given name in a block that will run the method asynchronously in an event loop.
+		#
+		# @parameter name [Symbol] The name of the method to wrap.
 		def async(name)
 			original_method = instance_method(name)
 			
@@ -37,6 +48,8 @@ module Async
 					original_method.bind(self).call(*arguments, &block)
 				end
 			end
+			
+			return name
 		end
 	end
 end

data/license.md

@@ -1,6 +1,6 @@
 # MIT License
 
-Copyright, 2017-2024, by Samuel Williams.  
+Copyright, 2017-2025, by Samuel Williams.  
 Copyright, 2018, by Kent 'picat' Gruber.  
 Copyright, 2020, by Olle Jonsson.  
 

data/readme.md

@@ -4,43 +4,11 @@ Implements the async/await pattern for Ruby using [async](https://github.com/soc
 
 [![Development Status](https://github.com/socketry/async-await/workflows/Test/badge.svg)](https://github.com/socketry/async-await/actions?workflow=Test)
 
-## Installation
-
-``` shell
-bundle add async-await
-```
-
 ## Usage
 
-In any asynchronous context (e.g. a reactor), simply use the `await` function like so:
-
-``` ruby
-require 'async/await'
-
-class Coop
-	include Async::Await
-	
-	async def count_chickens(area_name)
-		3.times do |i|
-			sleep rand
-			
-			puts "Found a chicken in the #{area_name}!"
-		end
-	end
-
-	async def count_all_chickens
-		# These methods all run at the same time.
-		count_chickens("garden")
-		count_chickens("house")
-		
-		# We wait for the result
-		count_chickens("tree").wait
-	end
-end
-
-coop = Coop.new
-coop.count_all_chickens
-```
+Please see the [project documentation](https://socketry.github.io/async-await/) for more details.
+
+  - [Getting Started](https://socketry.github.io/async-await/guides/getting-started/index) - This guide explains how to use `async-await` for implementing some common concurrency patterns.
 
 ## Contributing
 
@@ -54,8 +22,8 @@ We welcome contributions to this project.
 
 ### Developer Certificate of Origin
 
-This project uses the [Developer Certificate of Origin](https://developercertificate.org/). All contributors to this project must agree to this document to have their contributions accepted.
+In order to protect users of this project, we require all contributors to comply with the [Developer Certificate of Origin](https://developercertificate.org/). This ensures that all contributions are properly licensed and attributed.
 
-### Contributor Covenant
+### Community Guidelines
 
-This project is governed by the [Contributor Covenant](https://www.contributor-covenant.org/). All contributors and participants agree to abide by its terms.
+This project is best served by a collaborative and respectful environment. Treat each other professionally, respect differing viewpoints, and engage constructively. Harassment, discrimination, or harmful behavior is not tolerated. Communicate clearly, listen actively, and support one another. If any issues arise, please inform the project maintainers.

metadata

@@ -1,13 +1,12 @@
 --- !ruby/object:Gem::Specification
 name: async-await
 version: !ruby/object:Gem::Version
-  version: 0.7.0
+  version: 0.8.0
 platform: ruby
 authors:
 - Samuel Williams
 - Kent 'picat' Gruber
 - Olle Jonsson
-autorequire:
 bindir: bin
 cert_chain:
 - |
@@ -39,7 +38,7 @@ cert_chain:
   Q2K9NVun/S785AP05vKkXZEFYxqG6EW012U4oLcFl5MySFajYXRYbuUpH6AY+HP8
   voD0MPg1DssDLKwXyt1eKD/+Fq0bFWhwVM/1XiAXL7lyYUyOq24KHgQ2Csg=
   -----END CERTIFICATE-----
-date: 2024-06-04 00:00:00.000000000 Z
+date: 2025-04-09 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: async
@@ -55,8 +54,6 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
-description:
-email:
 executables: []
 extensions: []
 extra_rdoc_files: []
@@ -70,8 +67,8 @@ homepage: https://github.com/socketry/async-await
 licenses:
 - MIT
 metadata:
+  documentation_uri: https://socketry.github.io/async-await/
   source_code_uri: https://github.com/socketry/async-await.git
-post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -86,8 +83,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.5.3
-signing_key:
+rubygems_version: 3.6.2
 specification_version: 4
 summary: Implements the async/await pattern on top of async :)
 test_files: []