async 2.6.2 → 2.6.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 7ca106126076f17e48b0374812121cb9d30bc9e5eac981b52407db946ce41e00
-  data.tar.gz: '0302068031a9aee009ec0fbf1a5045fdae48031f4c2f2ff1914f45c292dd6915'
+  metadata.gz: 85ce7982fbc951dc88c43f5c19fe6d8bbbdd9bfe4dac1d624dbbea07a5d7a6a5
+  data.tar.gz: 30efe433816cc976e2380332fe86baaa6b7175624d2d3cd9ee46c7c23781007b
 SHA512:
-  metadata.gz: 865d56ad3386151e7f417fe00343946be99ae60d620948718e28856aa59fc7f82e8ba28debebb3d025c3a852878456b940dc7e99a1f3a7591873ac7d3a139b2b
-  data.tar.gz: 90d108eb53e337ad33b8655c70aaeb22acc64eba534a7096cd9053938ab3654858e4a72a7d2872ffaaa7c708ba2049c629c30a7a00ace4b370f799e99da85525
+  metadata.gz: 612c391a6aaed9f793383023f1f29b304d72f1fbb391bc4c320e37ec651708c219026f2488466fcb3731d732d32a47822cd219fa754353f915e3263e7e5c66ce
+  data.tar.gz: 817645de248bf18e360a7b9d799e900ec3165a1fb16a42efcfa198379c1fb347285f1839fd92d835f0c1dafe08f2a26420b3326e68d6bb023ab2fedce1070f50

data/conduct.md

@@ -0,0 +1,133 @@
+
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+We as members, contributors, and leaders pledge to make participation in our
+community a harassment-free experience for everyone, regardless of age, body
+size, visible or invisible disability, ethnicity, sex characteristics, gender
+identity and expression, level of experience, education, socio-economic status,
+nationality, personal appearance, race, caste, color, religion, or sexual
+identity and orientation.
+
+We pledge to act and interact in ways that contribute to an open, welcoming,
+diverse, inclusive, and healthy community.
+
+## Our Standards
+
+Examples of behavior that contributes to a positive environment for our
+community include:
+
+* Demonstrating empathy and kindness toward other people
+* Being respectful of differing opinions, viewpoints, and experiences
+* Giving and gracefully accepting constructive feedback
+* Accepting responsibility and apologizing to those affected by our mistakes,
+  and learning from the experience
+* Focusing on what is best not just for us as individuals, but for the overall
+  community
+
+Examples of unacceptable behavior include:
+
+* The use of sexualized language or imagery, and sexual attention or advances of
+  any kind
+* Trolling, insulting or derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or email address,
+  without their explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Enforcement Responsibilities
+
+Community leaders are responsible for clarifying and enforcing our standards of
+acceptable behavior and will take appropriate and fair corrective action in
+response to any behavior that they deem inappropriate, threatening, offensive,
+or harmful.
+
+Community leaders have the right and responsibility to remove, edit, or reject
+comments, commits, code, wiki edits, issues, and other contributions that are
+not aligned to this Code of Conduct, and will communicate reasons for moderation
+decisions when appropriate.
+
+## Scope
+
+This Code of Conduct applies within all community spaces, and also applies when
+an individual is officially representing the community in public spaces.
+Examples of representing our community include using an official e-mail address,
+posting via an official social media account, or acting as an appointed
+representative at an online or offline event.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported to the community leaders responsible for enforcement at
+[INSERT CONTACT METHOD].
+All complaints will be reviewed and investigated promptly and fairly.
+
+All community leaders are obligated to respect the privacy and security of the
+reporter of any incident.
+
+## Enforcement Guidelines
+
+Community leaders will follow these Community Impact Guidelines in determining
+the consequences for any action they deem in violation of this Code of Conduct:
+
+### 1. Correction
+
+**Community Impact**: Use of inappropriate language or other behavior deemed
+unprofessional or unwelcome in the community.
+
+**Consequence**: A private, written warning from community leaders, providing
+clarity around the nature of the violation and an explanation of why the
+behavior was inappropriate. A public apology may be requested.
+
+### 2. Warning
+
+**Community Impact**: A violation through a single incident or series of
+actions.
+
+**Consequence**: A warning with consequences for continued behavior. No
+interaction with the people involved, including unsolicited interaction with
+those enforcing the Code of Conduct, for a specified period of time. This
+includes avoiding interactions in community spaces as well as external channels
+like social media. Violating these terms may lead to a temporary or permanent
+ban.
+
+### 3. Temporary Ban
+
+**Community Impact**: A serious violation of community standards, including
+sustained inappropriate behavior.
+
+**Consequence**: A temporary ban from any sort of interaction or public
+communication with the community for a specified period of time. No public or
+private interaction with the people involved, including unsolicited interaction
+with those enforcing the Code of Conduct, is allowed during this period.
+Violating these terms may lead to a permanent ban.
+
+### 4. Permanent Ban
+
+**Community Impact**: Demonstrating a pattern of violation of community
+standards, including sustained inappropriate behavior, harassment of an
+individual, or aggression toward or disparagement of classes of individuals.
+
+**Consequence**: A permanent ban from any sort of public interaction within the
+community.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage],
+version 2.1, available at
+[https://www.contributor-covenant.org/version/2/1/code_of_conduct.html][v2.1].
+
+Community Impact Guidelines were inspired by
+[Mozilla's code of conduct enforcement ladder][Mozilla CoC].
+
+For answers to common questions about this code of conduct, see the FAQ at
+[https://www.contributor-covenant.org/faq][FAQ]. Translations are available at
+[https://www.contributor-covenant.org/translations][translations].
+
+[homepage]: https://www.contributor-covenant.org
+[v2.1]: https://www.contributor-covenant.org/version/2/1/code_of_conduct.html
+[Mozilla CoC]: https://github.com/mozilla/diversity
+[FAQ]: https://www.contributor-covenant.org/faq
+[translations]: https://www.contributor-covenant.org/translations

data/lib/async/barrier.md

@@ -1,14 +1,15 @@
 A synchronization primitive, which allows one task to wait for a number of other tasks to complete. It can be used in conjunction with {Semaphore}.
 
+
 ## Example
 
 ~~~ ruby
 require 'async'
 require 'async/barrier'
 
+barrier = Async::Barrier.new
 Sync do
 	Console.logger.info("Barrier Example: sleep sort.")
-	barrier = Async::Barrier.new
 	
 	# Generate an array of 10 numbers:
 	numbers = 10.times.map{rand(10)}
@@ -26,6 +27,9 @@ Sync do
 	barrier.wait
 	
 	Console.logger.info("Sorted", sorted)
+ensure
+	# Ensure all the tasks are stopped when we exit:
+	barrier.stop
 end
 ~~~
 

data/lib/async/node.rb

@@ -1,7 +1,7 @@
 # frozen_string_literal: true
 
 # Released under the MIT License.
-# Copyright, 2017-2022, by Samuel Williams.
+# Copyright, 2017-2023, by Samuel Williams.
 # Copyright, 2017, by Kent Gruber.
 # Copyright, 2022, by Shannon Skipper.
 

data/lib/async/scheduler.rb

@@ -1,7 +1,7 @@
 # frozen_string_literal: true
 
 # Released under the MIT License.
-# Copyright, 2020-2022, by Samuel Williams.
+# Copyright, 2020-2023, by Samuel Williams.
 # Copyright, 2020, by Jun Jiang.
 # Copyright, 2021, by Julien Portalier.
 
@@ -41,7 +41,10 @@ module Async
 		end
 		
 		def scheduler_close
-			self.run
+			# If the execution context (thread) was handling an exception, we want to exit as quickly as possible:
+			unless $!
+				self.run
+			end
 		ensure
 			self.close
 		end
@@ -205,6 +208,7 @@ module Async
 		end
 		
 		# Run one iteration of the event loop.
+		# Does not handle interrupts.
 		# @parameter timeout [Float | Nil] The maximum timeout, or if nil, indefinite.
 		# @returns [Boolean] Whether there is more work to do.
 		def run_once(timeout = nil)
@@ -250,20 +254,35 @@ module Async
 			return true
 		end
 		
+		# Checks and clears the interrupted state of the scheduler.
+		# @returns [Boolean] Whether the reactor has been interrupted.
+		private def interrupted?
+			if @interrupted
+				@interrupted = false
+				return true
+			end
+			
+			if Thread.pending_interrupt?
+				return true
+			end
+			
+			return false
+		end
+		
 		# Run the reactor until all tasks are finished. Proxies arguments to {#async} immediately before entering the loop, if a block is provided.
 		def run(...)
 			Kernel::raise ClosedError if @selector.nil?
 			
 			initial_task = self.async(...) if block_given?
 			
-			@interrupted = false
-			
 			# In theory, we could use Exception here to be a little bit safer, but we've only shown the case for SignalException to be a problem, so let's not over-engineer this.
 			Thread.handle_interrupt(SignalException => :never) do
-				while self.run_once
-					if @interrupted || Thread.pending_interrupt?
-						break
-					end
+				while true
+					# If we are interrupted, we need to exit:
+					break if self.interrupted?
+					
+					# If we are finished, we need to exit:
+					break unless self.run_once
 				end
 			end
 			

data/lib/async/task.md

@@ -0,0 +1,30 @@
+A sequence of instructions, defined by a block, which is executed sequentially and managed by the scheduler. A task can be in one of the following states: `initialized`, `running`, `completed`, `failed`, `cancelled` or `stopped`.
+
+```mermaid
+stateDiagram-v2
+[*] --> Initialized
+Initialized --> Running : Run
+
+Running --> Completed : Return Value
+Running --> Failed : Exception
+
+Completed --> [*]
+Failed --> [*]
+
+Running --> Stopped : Stop
+Stopped --> [*]
+Completed --> Stopped : Stop
+Failed --> Stopped : Stop
+Initialized --> Stopped : Stop
+```
+
+## Example
+
+```ruby
+require 'async'
+
+# Create an asynchronous task that sleeps for 1 second:
+Async do |task|
+	sleep(1)
+end
+```

data/lib/async/task.rb

@@ -1,7 +1,7 @@
 # frozen_string_literal: true
 
 # Released under the 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, 2020, by Patrik Wenger.
@@ -37,26 +37,6 @@ module Async
 		end
 	end
 	
-	# Encapsulates the state of a running task and it's result.
-	#
-	# ```mermaid
-	# stateDiagram-v2
-	# [*] --> Initialized
-	# Initialized --> Running : Run
-	# 
-	# Running --> Completed : Return Value
-	# Running --> Failed : Exception
-	# 
-	# Completed --> [*]
-	# Failed --> [*]
-	# 
-	# Running --> Stopped : Stop
-	# Stopped --> [*]
-	# Completed --> Stopped : Stop
-	# Failed --> Stopped : Stop
-	# Initialized --> Stopped : Stop
-	# ```
-	#
 	# @public Since `stable-v1`.
 	class Task < Node
 		class FinishedError < RuntimeError

data/lib/async/version.rb

@@ -1,8 +1,8 @@
 # frozen_string_literal: true
 
 # Released under the MIT License.
-# Copyright, 2017-2022, by Samuel Williams.
+# Copyright, 2017-2023, by Samuel Williams.
 
 module Async
-	VERSION = "2.6.2"
+	VERSION = "2.6.3"
 end

data/license.md

@@ -20,6 +20,8 @@ Copyright, 2022, by Shannon Skipper.
 Copyright, 2022, by Masafumi Okura.  
 Copyright, 2022, by Trevor Turk.  
 Copyright, 2022, by Masayuki Yamamoto.  
+Copyright, 2023, by Leon Löchner.  
+Copyright, 2023, by Colin Kelley.  
 
 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

@@ -1,10 +1,14 @@
 # ![Async](logo.svg)
 
-Async is a composable asynchronous I/O framework for Ruby based on [io-event](https://github.com/socketry/io-event) and [timers](https://github.com/socketry/timers).
+Async is a composable asynchronous I/O framework for Ruby based on [io-event](https://github.com/socketry/io-event) and
+[timers](https://github.com/socketry/timers).
 
-> "Lately I've been looking into `async`, as one of my projects – [tus-ruby-server](https://github.com/janko/tus-ruby-server) – would really benefit from non-blocking I/O. It's really beautifully designed." *– [janko](https://github.com/janko)*
+> "Lately I've been looking into `async`, as one of my projects –
+> [tus-ruby-server](https://github.com/janko/tus-ruby-server) – would really benefit from non-blocking I/O. It's really
+> 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)
+[![Development
+Status](https://github.com/socketry/async/workflows/Test/badge.svg)](https://github.com/socketry/async/actions?workflow=Test)
 
 ## Features
 
@@ -15,7 +19,22 @@ Async is a composable asynchronous I/O framework for Ruby based on [io-event](ht
 
 ## Usage
 
-Please see the [project documentation](https://socketry.github.io/async).
+Please see the [project documentation](https://socketry.github.io/async/) for more details.
+
+  - [Getting Started](https://socketry.github.io/async/guides/getting-started/index) - This guide gives shows how to add
+    async to your project and run code asynchronously.
+
+  - [Asynchronous Tasks](https://socketry.github.io/async/guides/asynchronous-tasks/index) - This guide explains how
+    asynchronous tasks work and how to use them.
+
+  - [Event Loop](https://socketry.github.io/async/guides/event-loop/index) - This guide gives an overview of how the
+    event loop is implemented.
+
+  - [Compatibility](https://socketry.github.io/async/guides/compatibility/index) - This guide gives an overview of the
+    compatibility of Async with Ruby and other frameworks.
+
+  - [Best Practices](https://socketry.github.io/async/guides/best-practices/index) - This guide gives an overview of
+    best practices for using Async.
 
 ## Contributing
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: async
 version: !ruby/object:Gem::Version
-  version: 2.6.2
+  version: 2.6.3
 platform: ruby
 authors:
 - Samuel Williams
@@ -10,10 +10,12 @@ authors:
 - Devin Christensen
 - Kent Gruber
 - Brian Morearty
+- Colin Kelley
 - Jiang Jinyang
 - Julien Portalier
 - Jun Jiang
 - Ken Muryoi
+- Leon Löchner
 - Masafumi Okura
 - Masayuki Yamamoto
 - Olle Jonsson
@@ -56,7 +58,7 @@ cert_chain:
   Q2K9NVun/S785AP05vKkXZEFYxqG6EW012U4oLcFl5MySFajYXRYbuUpH6AY+HP8
   voD0MPg1DssDLKwXyt1eKD/+Fq0bFWhwVM/1XiAXL7lyYUyOq24KHgQ2Csg=
   -----END CERTIFICATE-----
-date: 2023-06-13 00:00:00.000000000 Z
+date: 2023-07-28 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: console
@@ -73,47 +75,47 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '1.10'
 - !ruby/object:Gem::Dependency
-  name: io-event
+  name: fiber-annotation
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '1.1'
+        version: '0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '1.1'
+        version: '0'
 - !ruby/object:Gem::Dependency
-  name: timers
+  name: io-event
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '4.1'
+        version: '1.1'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '4.1'
+        version: '1.1'
 - !ruby/object:Gem::Dependency
-  name: fiber-annotation
+  name: timers
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '4.1'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '4.1'
 - !ruby/object:Gem::Dependency
   name: bake-test
   requirement: !ruby/object:Gem::Requirement
@@ -218,6 +220,7 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- conduct.md
 - lib/async.rb
 - lib/async/barrier.md
 - lib/async/barrier.rb
@@ -232,6 +235,7 @@ files:
 - lib/async/scheduler.rb
 - lib/async/semaphore.md
 - lib/async/semaphore.rb
+- lib/async/task.md
 - lib/async/task.rb
 - lib/async/variable.rb
 - lib/async/version.rb
@@ -245,7 +249,8 @@ files:
 homepage: https://github.com/socketry/async
 licenses:
 - MIT
-metadata: {}
+metadata:
+  documentation_uri: https://socketry.github.io/async/
 post_install_message:
 rdoc_options: []
 require_paths: