async 1.16.0 → 1.17.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: d32f66a08662551d096e73d45b968db7ba3c1faac364dd30a6727e6b987fc060
-  data.tar.gz: daaecb80e3223b8fbd31798c6d45f8c7a03ec45544fceea966ffd1cdc075264a
+  metadata.gz: 1465ddfc74436e5ec289b69f97b4bb5993ef7bd6ceae9e55d79b8b2f78051829
+  data.tar.gz: 1dc342eed7d35d47f0a3ada58b03280a9702fd7307d604d33c3d97f976d398ed
 SHA512:
-  metadata.gz: 138843f67fa5d3d700a64d034d8ca70b826f26d48392e2f7bfd404bc77d6045ee7c492f823fb33263a1896a03988e57f9d6d0ba78c6ce7ab48ba48ee29a9460a
-  data.tar.gz: 3040bffa50775ca7fa3fde5dd1a6d6c4cde77ffcfd079fddc5118310ff9cf0057842b1525b8c9c0ec1b07192af56baf20e6298efaa359b2bb2c0e55bed948e5a
+  metadata.gz: bfb65f1ad102472c48e32702294e913285681c0bb3f661571ea00a83bf0a52e2e062deee33ffb18e359199ae287e4022c731032a48125815c7815d6c485dc44f
+  data.tar.gz: 7631a181a45af7ca658c4d8a65b3f1d029fc5ce7fba6c730680ca2fb0c7a462a8477f16d614b261b199fa1e7d2925ece05e4f5d94de45074c11c4789a8825aca

data/.travis.yml

@@ -20,6 +20,8 @@ matrix:
     - rvm: 2.4
     - rvm: 2.5
     - rvm: 2.6
+    - rvm: 2.6
+      gemfile: gems/event.gemfile
     - rvm: 2.6
       env: COVERAGE=PartialSummary,Coveralls
     - rvm: jruby-head

data/async.gemspec

@@ -24,7 +24,7 @@ Gem::Specification.new do |spec|
 	
 	spec.add_runtime_dependency "nio4r", "~> 2.3"
 	spec.add_runtime_dependency "timers", "~> 4.1"
-	spec.add_runtime_dependency "event", "~> 1.1"
+	spec.add_runtime_dependency "event", "~> 1.3"
 	
 	spec.add_development_dependency "async-rspec", "~> 1.1"
 	

data/gems/event.gemfile

@@ -0,0 +1,4 @@
+
+eval_gemfile("../Gemfile")
+
+gem 'event', '~> 1.1'

data/lib/async/logger.rb

@@ -19,7 +19,13 @@
 # THE SOFTWARE.
 
 require 'event/console'
+require_relative 'task'
 
 module Async
-	extend Event::Console
+	# @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 || Event::Console.logger
+	end
 end

data/lib/async/reactor.rb

@@ -42,13 +42,13 @@ module Async
 		# - When invoked at the top level, will create and run a reactor, and invoke
 		# the block as an asynchronous task. Will block until the reactor finishes
 		# running.
-		def self.run(*args, &block)
+		def self.run(*args, **options, &block)
 			if current = Task.current?
 				reactor = current.reactor
 				
-				return reactor.async(*args, &block)
+				return reactor.async(*args, **options, &block)
 			else
-				reactor = self.new
+				reactor = self.new(**options)
 				
 				begin
 					return reactor.run(*args, &block)
@@ -58,11 +58,12 @@ module Async
 			end
 		end
 		
-		def initialize(parent = nil, selector: NIO::Selector.new)
+		def initialize(parent = nil, selector: NIO::Selector.new, logger: nil)
 			super(parent)
 			
 			@selector = selector
 			@timers = Timers::Group.new
+			@logger = logger
 			
 			@ready = []
 			@running = []
@@ -70,6 +71,10 @@ module Async
 			@stopped = true
 		end
 		
+		def logger
+			@logger ||= Event::Console.logger
+		end
+		
 		def to_s
 			"<#{self.description} stopped=#{@stopped}>"
 		end
@@ -91,8 +96,8 @@ module Async
 		#
 		# @yield [Task] Executed within the task.
 		# @return [Task] The task that was scheduled into the reactor.
-		def async(*args, &block)
-			task = Task.new(self, &block)
+		def async(*args, **options, &block)
+			task = Task.new(self, **options, &block)
 			
 			# I want to take a moment to explain the logic of this.
 			# When calling an async block, we deterministically execute it until the
@@ -103,7 +108,7 @@ module Async
 			# - Avoid overhead if no blocking operation is performed.
 			task.run(*args)
 			
-			# Async.logger.debug "Initial execution of task #{fiber} complete (#{result} -> #{fiber.alive?})..."
+			# logger.debug "Initial execution of task #{fiber} complete (#{result} -> #{fiber.alive?})..."
 			return task
 		end
 		
@@ -175,7 +180,7 @@ module Async
 					interval = 0
 				end
 				
-				# Async.logger.debug(self) {"Updating #{@children.count} children..."}
+				# logger.debug(self) {"Updating #{@children.count} children..."}
 				# As timeouts may have been updated, and caused fibers to complete, we should check this.
 				
 				# If there is nothing to do, then finish:
@@ -183,7 +188,7 @@ module Async
 					return initial_task
 				end
 				
-				# Async.logger.debug(self) {"Selecting with #{@children.count} fibers interval = #{interval.inspect}..."}
+				# logger.debug(self) {"Selecting with #{@children.count} fibers interval = #{interval.inspect}..."}
 				if monitors = @selector.select(interval)
 					monitors.each do |monitor|
 						monitor.value.resume
@@ -193,7 +198,7 @@ module Async
 			
 			return initial_task
 		ensure
-			Async.logger.debug(self) {"Exiting run-loop because #{$! ? $! : 'finished'}."}
+			logger.debug(self) {"Exiting run-loop because #{$! ? $! : 'finished'}."}
 			
 			@stopped = true
 		end

data/lib/async/task.rb

@@ -57,8 +57,7 @@ module Async
 		# Create a new task.
 		# @param reactor [Async::Reactor] the reactor this task will run within.
 		# @param parent [Async::Task] the parent task.
-		# @param propagate_exceptions [Boolean] whether exceptions raised in the task will propagate up the reactor stack.
-		def initialize(reactor, parent = Task.current?, &block)
+		def initialize(reactor, parent = Task.current?, logger: nil, &block)
 			super(parent || reactor)
 			
 			@reactor = reactor
@@ -67,6 +66,8 @@ module Async
 			@result = nil
 			@finished = nil
 			
+			@logger = logger
+			
 			@fiber = make_fiber(&block)
 		end
 		
@@ -74,6 +75,10 @@ module Async
 			"<#{self.description} #{@status}>"
 		end
 		
+		def logger
+			@logger ||= @parent&.logger
+		end
+		
 		# @attr ios [Reactor] The reactor the task was created within.
 		attr :reactor
 		def_delegators :@reactor, :with_timeout, :timeout, :sleep
@@ -100,8 +105,8 @@ module Async
 			end
 		end
 		
-		def async(*args, &block)
-			task = Task.new(@reactor, self, &block)
+		def async(*args, **options, &block)
+			task = Task.new(@reactor, self, **options, &block)
 			
 			task.run(*args)
 			
@@ -181,9 +186,9 @@ module Async
 				raise
 			elsif @finished.nil?
 				# If no one has called wait, we log this as an error:
-				Async.logger.error(self) {$!}
+				logger.error(self) {$!}
 			else
-				Async.logger.debug(self) {$!}
+				logger.debug(self) {$!}
 			end
 		end
 		
@@ -198,7 +203,7 @@ module Async
 				begin
 					@result = yield(self, *args)
 					@status = :complete
-					# Async.logger.debug("Task #{self} completed normally.")
+					# logger.debug("Task #{self} completed normally.")
 				rescue Stop
 					stop!
 				rescue StandardError => error
@@ -206,7 +211,7 @@ module Async
 				rescue Exception => exception
 					fail!(exception, true)
 				ensure
-					# Async.logger.debug("Task #{self} closing: #{$!}")
+					# logger.debug("Task #{self} closing: #{$!}")
 					finish!
 				end
 			end

data/lib/async/version.rb

@@ -19,5 +19,5 @@
 # THE SOFTWARE.
 
 module Async
-	VERSION = "1.16.0"
+	VERSION = "1.17.0"
 end

data/spec/async/logger_spec.rb

@@ -0,0 +1,63 @@
+# 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.
+
+require 'async'
+require 'async/logger'
+require 'event/capture'
+
+RSpec.describe 'Async.logger' do
+	let(:name) {"nested"}
+	let(:message) {"Talk is cheap. Show me the code."}
+	
+	let(:capture) {Event::Capture.new}
+	let(:logger) {Event::Logger.new(capture, name: name)}
+	
+	it "can use nested logger" do
+		Async(logger: logger) do |task|
+			expect(task.logger).to be == logger
+			logger.warn message
+		end.wait
+		
+		expect(capture.events.last).to include({
+			severity: :warn,
+			name: name,
+			subject: message,
+		})
+	end
+	
+	it "can change nested logger" do
+		Async do |parent|
+			parent.async(logger: logger) do |task|
+				expect(task.logger).to be == logger
+				expect(Async.logger).to be == logger
+			end.wait
+		end.wait
+	end
+	
+	it "can use parent logger" do
+		Async(logger: logger) do |parent|
+			child = parent.async{|task| task.yield}
+			
+			expect(parent.logger).to be == logger
+			expect(child.logger).to be == logger
+			expect(Async.logger).to be == logger
+		end.wait
+	end
+end

data/spec/async/task_spec.rb

@@ -86,7 +86,7 @@ RSpec.describe Async::Task do
 			task = nil
 			
 			expect do
-				task = reactor.async(propagate_exceptions: false) do |task|
+				task = reactor.async do |task|
 					raise "boom"
 				end
 			end.to_not raise_exception
@@ -98,7 +98,7 @@ RSpec.describe Async::Task do
 		
 		it "won't consume non-StandardError exceptions" do
 			expect do
-				reactor.async(propagate_exceptions: false) do |task|
+				reactor.async do |task|
 					raise SignalException.new(:TERM)
 				end
 			end.to raise_exception(SignalException, /TERM/)
@@ -300,7 +300,7 @@ RSpec.describe Async::Task do
 		it "will raise exceptions when checking result" do
 			error_task = nil
 			
-			error_task = reactor.async(propagate_exceptions: false) do |task|
+			error_task = reactor.async do |task|
 				raise RuntimeError, "brain not provided"
 			end
 			
@@ -312,7 +312,7 @@ RSpec.describe Async::Task do
 		it "will propagate exceptions after async operation" do
 			error_task = nil
 			
-			error_task = reactor.async(propagate_exceptions: false) do |task|
+			error_task = reactor.async do |task|
 				task.sleep(0.1)
 				
 				raise "boom"

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: async
 version: !ruby/object:Gem::Version
-  version: 1.16.0
+  version: 1.17.0
 platform: ruby
 authors:
 - Samuel Williams
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-03-14 00:00:00.000000000 Z
+date: 2019-03-22 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: nio4r
@@ -44,14 +44,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.1'
+        version: '1.3'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.1'
+        version: '1.3'
 - !ruby/object:Gem::Dependency
   name: async-rspec
   requirement: !ruby/object:Gem::Requirement
@@ -146,6 +146,7 @@ files:
 - examples/callback/loop.rb
 - examples/fibers.rb
 - examples/sleep_sort.rb
+- gems/event.gemfile
 - lib/async.rb
 - lib/async/clock.rb
 - lib/async/condition.rb
@@ -167,6 +168,7 @@ files:
 - 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
@@ -197,7 +199,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.2
+rubygems_version: 3.0.3
 signing_key: 
 specification_version: 4
 summary: Async is an asynchronous I/O framework based on nio4r.
@@ -205,6 +207,7 @@ test_files:
 - 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