Ensure timeout_after yields duration.

Author: ioquatix

lib/async/reactor.rb

@@ -34,7 +34,6 @@ def initialize(...)
 			Fiber.set_scheduler(self)
 		end
 
-		alias with_timeout timeout_after
 		public :sleep
 	end
 end

lib/async/scheduler.rb

@@ -282,10 +282,10 @@ def fiber(...)
 
 		# Invoke the block, but after the specified timeout, raise {TimeoutError} in any currenly blocking operation. If the block runs to completion before the timeout occurs or there are no non-blocking operations after the timeout expires, the code will complete without any exception.
 		# @parameter duration [Numeric] The time in seconds, in which the task should complete.
-		def timeout_after(timeout, exception = TimeoutError, message = "execution expired", &block)
+		def with_timeout(duration, exception = TimeoutError, message = "execution expired", &block)
 			fiber = Fiber.current
 
-			timer = @timers.after(timeout) do
+			timer = @timers.after(duration) do
 				if fiber.alive?
 					fiber.raise(exception, message)
 				end
@@ -295,5 +295,11 @@ def timeout_after(timeout, exception = TimeoutError, message = "execution expire
 		ensure
 			timer.cancel if timer
 		end
+		
+		def timeout_after(duration, exception, message, &block)
+			with_timeout(duration, exception, message) do |timer|
+				yield duration
+			end
+		end
 	end
 end

lib/async/task.rb

@@ -92,9 +92,9 @@ def sleep(duration = nil)
 			super
 		end
 
-		# @deprecated Replaced by {Scheduler#timeout_after}.
-		def with_timeout(timeout, exception = TimeoutError, message = "execution expired", &block)
-			Fiber.scheduler.timeout_after(timeout, exception, message, &block)
+		# Execute the given block of code, raising the specified exception if it exceeds the given duration during a non-blocking operation.
+		def with_timeout(duration, exception = TimeoutError, message = "execution expired", &block)
+			Fiber.scheduler.with_timeout(duration, exception, message, &block)
 		end
 
 		# Yield back to the reactor and allow other fibers to execute.

spec/async/scheduler/timeout_spec.rb

@@ -0,0 +1,35 @@
+# Copyright, 2021, 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/scheduler'
+
+require 'timeout'
+
+RSpec.describe Async::Scheduler, if: Async::Scheduler.supported? do
+	include_context Async::RSpec::Reactor
+	
+	describe ::Timeout do
+		it "can invoke timeout and receive timeout as block argument" do
+			::Timeout.timeout(1.0) do |duration|
+				expect(duration).to be == 1.0
+			end
+		end
+	end
+end