async 1.25.1 → 1.27.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 70efaa49b29fd36596f22f7796c475610955cc63836725b00775f6c1025aa976
-  data.tar.gz: d5e7987bcb581c20b3ac17fba0ef803a61f154ec107b55ad01220c16ae2a32e6
+  metadata.gz: 1d1048beb05a88fed1922f32624f61bf5ed8b1e70c2bd9b0e0c17bfad60aa359
+  data.tar.gz: 0eb19742b401a5ffb95286c766cf68e3159e3b94f57b8fd4272f1038c5dabc00
 SHA512:
-  metadata.gz: d47987f2b355ab4dff7e06443787190dc8567abe30391b3a0a2dde55efb4592c14af94b42f52cf2b7f6e35d9868bb1f2cfbdd23cb9abddb4c1ba34a97cf0dab9
-  data.tar.gz: 014fa5e68d7fb509f6120cbce6e07f75d6c17c86b8d5dcc93278555c4e11ea27a2a8883ba8193359aeed1ab3d5303d92e30b053cf840aa31c0b4f9b002d7c5d4
+  metadata.gz: 9c21be88e7a5eea9e6a0380f49eabd47e06522e204b61bb97fc9085053c3e800182a51a83cec001a1bc8533a3f3ff48d1cb1b0987aa15587fbb53ea9209777b6
+  data.tar.gz: 79ed71d369b9bda125239835befe60d2842f33e0cd3ed3b6ebadbf996dccf43cc2605b33119ceaf4ac8bb0e602671efb06665660c20e2702f983cb6a8459208c

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/clock.rb

@@ -21,7 +21,7 @@
 # THE SOFTWARE.
 
 module Async
-	module Clock
+	class Clock
 		# Get the current elapsed monotonic time.
 		def self.now
 			::Process.clock_gettime(::Process::CLOCK_MONOTONIC)
@@ -35,5 +35,37 @@ module Async
 			
 			return self.now - start_time
 		end
+		
+		def self.start
+			self.new.tap(&:start!)
+		end
+		
+		def initialize(total = 0)
+			@total = total
+			@started = nil
+		end
+		
+		def start!
+			@started ||= Clock.now
+		end
+		
+		def stop!
+			if @started
+				@total += (Clock.now - @started)
+				@started = nil
+			end
+			
+			return @total
+		end
+		
+		def total
+			total = @total
+			
+			if @started
+				total += (Clock.now - @started)
+			end
+			
+			return total
+		end
 	end
 end

data/lib/async/logger.rb

@@ -24,10 +24,5 @@ require 'console'
 require_relative 'task'
 
 module Async
-	# @return the current logger, either the active tasks logger, or the global event console logger.
-	def self.logger
-		if task = Task.current?
-			task.logger
-		end || Console.logger
-	end
+	extend Console
 end

data/lib/async/node.rb

@@ -72,8 +72,7 @@ module Async
 			end
 			
 			item.head = nil
-			# Don't do this, because it will break enumeration.
-			# item.tail = nil
+			item.tail = nil
 			
 			@size -= 1
 			
@@ -85,8 +84,10 @@ module Async
 			
 			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 = item.tail
+				item = tail
 			end
 		end
 		
@@ -216,6 +217,10 @@ module Async
 			end
 		end
 		
+		def backtrace(*arguments)
+			nil
+		end
+		
 		def to_s
 			"\#<#{description}>"
 		end
@@ -296,9 +301,23 @@ module Async
 			@children&.each(&:stop)
 		end
 		
-		def print_hierarchy(out = $stdout)
+		def print_hierarchy(out = $stdout, backtrace: true)
 			self.traverse do |node, level|
-				out.puts "#{"\t" * level}#{node}"
+				indent = "\t" * level
+				
+				out.puts "#{indent}#{node}"
+				
+				print_backtrace(out, indent, node) if backtrace
+			end
+		end
+		
+		private
+		
+		def print_backtrace(out, indent, node)
+			if backtrace = node.backtrace
+				backtrace.each_with_index do |line, index|
+					out.puts "#{indent}#{index.zero? ? "→ " : "  "}#{line}"
+				end
 			end
 		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
@@ -87,7 +87,7 @@ module Async
 		end
 		
 		def logger
-			@logger ||= Console.logger
+			@logger || Console.logger
 		end
 		
 		def to_s
@@ -98,9 +98,6 @@ module Async
 			@children.nil?
 		end
 		
-		# TODO Remove these in next major release. They are too confusing to use correctly.
-		def_delegators :@timers, :every, :after
-		
 		# Start an asynchronous task within the specified reactor. The task will be
 		# executed until the first blocking call, at which point it will yield and
 		# and this method will return.
@@ -223,10 +220,10 @@ module Async
 		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(*arguments, &block)
+		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!
@@ -266,7 +263,7 @@ module Async
 		def sleep(duration)
 			fiber = Fiber.current
 			
-			timer = self.after(duration) do
+			timer = @timers.after(duration) do
 				if fiber.alive?
 					fiber.resume
 				end
@@ -283,7 +280,7 @@ module Async
 		def with_timeout(timeout, exception = TimeoutError)
 			fiber = Fiber.current
 			
-			timer = self.after(timeout) do
+			timer = @timers.after(timeout) do
 				if fiber.alive?
 					error = exception.new("execution expired")
 					fiber.resume error

data/lib/async/task.rb

@@ -86,16 +86,23 @@ module Async
 			@fiber = make_fiber(&block)
 		end
 		
+		if Fiber.current.respond_to?(:backtrace)
+			def backtrace(*arguments)
+				@fiber.backtrace(*arguments)
+			end
+		end
+		
 		def to_s
 			"\#<#{self.description} (#{@status})>"
 		end
 		
 		def logger
-			@logger ||= @parent&.logger
+			@logger || Console.logger
 		end
 		
 		# @attr ios [Reactor] The reactor the task was created within.
 		attr :reactor
+		
 		def_delegators :@reactor, :with_timeout, :timeout, :sleep
 		
 		# Yield back to the reactor and allow other fibers to execute.
@@ -226,7 +233,7 @@ module Async
 		private
 		
 		# This is a very tricky aspect of tasks to get right. I've modelled it after `Thread` but it's slightly different in that the exception can propagate back up through the reactor. If the user writes code which raises an exception, that exception should always be visible, i.e. cause a failure. If it's not visible, such code fails silently and can be very difficult to debug.
-		# As an explcit choice, the user can start a task which doesn't propagate exceptions. This only applies to `StandardError` and derived tasks. This allows tasks to internally capture their error state which is raised when invoking `Task#result` similar to how `Thread#join` works. This mode makes `Async::Task` behave more like a promise, and you would need to ensure that someone calls `Task#result` otherwise you might miss important errors.
+		# As an explcit choice, the user can start a task which doesn't propagate exceptions. This only applies to `StandardError` and derived tasks. This allows tasks to internally capture their error state which is raised when invoking `Task#result` similar to how `Thread#join` works. This mode makes {ruby Async::Task} behave more like a promise, and you would need to ensure that someone calls `Task#result` otherwise you might miss important errors.
 		def fail!(exception = nil, propagate = true)
 			@status = :failed
 			@result = exception
@@ -289,6 +296,7 @@ module Async
 		def set!
 			# This is actually fiber-local:
 			Thread.current[:async_task] = self
+			Console.logger = @logger if @logger
 		end
 	end
 end

data/lib/async/version.rb

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

metadata

@@ -1,57 +1,57 @@
 --- !ruby/object:Gem::Specification
 name: async
 version: !ruby/object:Gem::Version
-  version: 1.25.1
+  version: 1.27.0
 platform: ruby
 authors:
 - Samuel Williams
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2020-04-25 00:00:00.000000000 Z
+date: 2020-11-13 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.10'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '2.3'
+        version: '1.10'
 - !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
   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: benchmark-ips
+  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,68 +109,39 @@ 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: rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '3.6'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !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"
+        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 +159,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 +179,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: []