polyphony 1.1.1 → 1.2

data/lib/polyphony/core/debug.rb

@@ -2,7 +2,7 @@
 module ::Kernel
   # Prints a trace message to `STDOUT`, bypassing the Polyphony backend.
   def trace(*args)
-    STDOUT.orig_write(format_trace(args))
+    $stdout.orig_write(format_trace(args))
   end
 
   # Formats a trace message.
@@ -20,12 +20,10 @@ module ::Kernel
 end
 
 module Polyphony
-
   # Trace provides tools for tracing the activity of the current thread's
   # backend.
   module Trace
     class << self
-
       # Starts tracing, emitting events converted to hashes to the given block.
       # If an IO instance is given, events are dumped to it instead.
       #
@@ -48,7 +46,7 @@ module Polyphony
         elsif block
           ->(*e) { block.(trace_event_info(e)) }
         else
-          raise "Please provide an io or a block"
+          raise 'Please provide an io or a block'
         end
       end
 
@@ -56,12 +54,12 @@ module Polyphony
       #
       # @param e [Array] event as emitted by the backend
       # @return [Hash] event hash
-      def trace_event_info(e)
+      def trace_event_info(event)
         {
           stamp: Time.now,
-          event: e[0]
+          event: event[0]
         }.merge(
-          send(:"event_props_#{e[0]}", e)
+          send(:"event_props_#{event[0]}", event)
         )
       end
 
@@ -69,10 +67,10 @@ module Polyphony
       #
       # @param e [Array] event array
       # @return [Hash] event hash
-      def event_props_block(e)
+      def event_props_block(event)
         {
-          fiber: e[1],
-          caller: e[2]
+          fiber:  event[1],
+          caller: event[2]
         }
       end
 
@@ -80,7 +78,7 @@ module Polyphony
       #
       # @param e [Array] event array
       # @return [Hash] event hash
-      def event_props_enter_poll(e)
+      def event_props_enter_poll(_event)
         {}
       end
 
@@ -88,7 +86,7 @@ module Polyphony
       #
       # @param e [Array] event array
       # @return [Hash] event hash
-      def event_props_leave_poll(e)
+      def event_props_leave_poll(_event)
         {}
       end
 
@@ -96,11 +94,11 @@ module Polyphony
       #
       # @param e [Array] event array
       # @return [Hash] event hash
-      def event_props_schedule(e)
+      def event_props_schedule(event)
         {
-          fiber: e[1],
-          value: e[2],
-          caller: e[4],
+          fiber:        event[1],
+          value:        event[2],
+          caller:       event[4],
           source_fiber: Fiber.current
         }
       end
@@ -109,10 +107,10 @@ module Polyphony
       #
       # @param e [Array] event array
       # @return [Hash] event hash
-      def event_props_spin(e)
+      def event_props_spin(event)
         {
-          fiber: e[1],
-          caller: e[2],
+          fiber:        event[1],
+          caller:       event[2],
           source_fiber: Fiber.current
         }
       end
@@ -121,10 +119,10 @@ module Polyphony
       #
       # @param e [Array] event array
       # @return [Hash] event hash
-      def event_props_terminate(e)
+      def event_props_terminate(event)
         {
-          fiber: e[1],
-          value: e[2],
+          fiber: event[1],
+          value: event[2]
         }
       end
 
@@ -132,11 +130,11 @@ module Polyphony
       #
       # @param e [Array] event array
       # @return [Hash] event hash
-      def event_props_unblock(e)
+      def event_props_unblock(event)
         {
-          fiber: e[1],
-          value: e[2],
-          caller: e[3],
+          fiber:  event[1],
+          value:  event[2],
+          caller: event[3]
         }
       end
 
@@ -170,12 +168,10 @@ module Polyphony
       #   generic_event_format
       # end
 
-
       # def event_format_schedule(e)
       #   "#{fiber_event_format} %<value>-24.24p %<caller>-120.120s <= %<origin_fiber>s"
       # end
 
-
       # def event_format_unblock(e)
       #   "#{fiber_event_format} %<value>-24.24p %<caller>-120.120s"
       # end
@@ -188,7 +184,6 @@ module Polyphony
       #   "#{fiber_event_format} #{' ' * 24} %<caller>-120.120s"
       # end
 
-
       # def event_format_spin(e)
       #   "#{fiber_event_format} #{' ' * 24} %<caller>-120.120s <= %<origin_fiber>s"
       # end

data/lib/polyphony/core/exceptions.rb

@@ -1,7 +1,6 @@
 # frozen_string_literal: true
 
 module Polyphony
-
   # Base exception class for interrupting fibers. These exceptions allow control
   # of fibers. BaseException exceptions can encapsulate a value and thus provide
   # a way to interrupt long-running blocking operations while still passing a
@@ -9,7 +8,6 @@ module Polyphony
   # cancel scope in order to allow correct bubbling of exceptions through nested
   # cancel scopes.
   class BaseException < ::Exception
-
     # Exception value, used mainly for `MoveOn` exceptions.
     attr_reader :value
 
@@ -39,7 +37,6 @@ module Polyphony
 
   # Interjection is used to run arbitrary code on arbitrary fibers at any point
   class Interjection < BaseException
-
     # Initializes an Interjection with the given proc.
     #
     # @param proc [Proc] interjection proc

data/lib/polyphony/core/sync.rb

@@ -1,11 +1,9 @@
 # frozen_string_literal: true
 
 module Polyphony
-
   # Implements mutex lock for synchronizing access to a shared resource. This
   # class replaces the stock `Thread::Mutex` class.
   class Mutex
-
     # Initializes a new mutex.
     def initialize
       @store = Queue.new
@@ -130,7 +128,6 @@ module Polyphony
 
   # Implements a fiber-aware ConditionVariable
   class ConditionVariable
-
     # Initializes the condition variable.
     def initialize
       @queue = Polyphony::Queue.new

data/lib/polyphony/core/thread_pool.rb

@@ -3,10 +3,8 @@
 require 'etc'
 
 module Polyphony
-
   # Implements a pool of threads
   class ThreadPool
-
     # The pool size.
     attr_reader :size
 
@@ -79,9 +77,7 @@ module Polyphony
 
     # Runs a processing loop on a worker thread.
     def thread_loop
-      while true
-        run_queued_task
-      end
+      run_queued_task while true
     end
 
     # Runs the first queued task in the task queue.

data/lib/polyphony/core/throttler.rb

@@ -3,7 +3,6 @@
 module Polyphony
   # Implements general-purpose throttling
   class Throttler
-
     # Initializes a throttler instance with the given rate.
     #
     # @param rate [Number] throttler rate in times per second

data/lib/polyphony/core/timer.rb

@@ -1,13 +1,11 @@
 # frozen_string_literal: true
 
 module Polyphony
-
   # Implements a common timer for running multiple timeouts. This class may be
   # used to reduce the timer granularity in case a large number of timeouts is
   # used concurrently. This class basically provides the same methods as global
   # methods concerned with timeouts, such as `#cancel_after`, `#every` etc.
   class Timer
-
     # Initializes a new timer with the given resolution.
     #
     # @param tag [any] tag to use for the timer's fiber
@@ -31,7 +29,7 @@ module Polyphony
     def sleep(duration)
       fiber = Fiber.current
       @timeouts[fiber] = {
-        interval: duration,
+        interval:     duration,
         target_stamp: now + duration
       }
       Polyphony.backend_wait_event(true)
@@ -58,9 +56,9 @@ module Polyphony
     def every(interval)
       fiber = Fiber.current
       @timeouts[fiber] = {
-        interval: interval,
+        interval:,
         target_stamp: now + interval,
-        recurring: true
+        recurring:    true
       }
       while true
         Polyphony.backend_wait_event(true)
@@ -113,9 +111,9 @@ module Polyphony
     def cancel_after(interval, with_exception: Polyphony::Cancel)
       fiber = Fiber.current
       @timeouts[fiber] = {
-        interval: interval,
+        interval:,
         target_stamp: now + interval,
-        exception: with_exception
+        exception:    with_exception
       }
       yield
     ensure
@@ -166,9 +164,9 @@ module Polyphony
     def move_on_after(interval, with_value: nil)
       fiber = Fiber.current
       @timeouts[fiber] = {
-        interval: interval,
+        interval:,
         target_stamp: now + interval,
-        exception: [Polyphony::MoveOn, with_value]
+        exception:    [Polyphony::MoveOn, with_value]
       }
       yield
     rescue Polyphony::MoveOn => e

data/lib/polyphony/extensions/exception.rb

@@ -3,7 +3,6 @@
 # Extensions to the Exception class
 class ::Exception
   class << self
-
     # Set to true to disable sanitizing the backtrace (to remove frames occuring
     # in the Polyphony code itself.)
     attr_accessor :__disable_sanitized_backtrace__

data/lib/polyphony/extensions/fiber.rb

@@ -119,7 +119,7 @@ class ::Fiber
   def cancel(exception = Polyphony::Cancel)
     return if @running == false
 
-    value = (Class === exception) ? exception.new : exception
+    value = exception.is_a?(Class) ? exception.new : exception
     schedule value
     self
   end
@@ -143,7 +143,7 @@ class ::Fiber
   #
   # @param graceful [bool] Whether to perform a graceful shutdown
   # @return [Fiber] self
-  def terminate(graceful = false)
+  def terminate(graceful: false)
     return if @running == false
 
     @graceful_shutdown = graceful
@@ -265,7 +265,7 @@ class ::Fiber
   #
   # @param graceful [bool] whether to perform a graceful termination
   # @return [Fiber] self
-  def terminate_all_children(graceful = false)
+  def terminate_all_children(graceful: false)
     return self unless @children
 
     e = Polyphony::Terminate.new
@@ -283,23 +283,24 @@ class ::Fiber
   def await_all_children
     return unless @children && !@children.empty?
 
-    Fiber.await(*@children.keys.reject { |c| c.dead? })
+    Fiber.await(@children.keys.reject(&:dead?))
   end
 
   # Terminates and blocks until all child fibers have terminated.
   #
   # @return [Fiber] self
-  def shutdown_all_children(graceful = false)
+  def shutdown_all_children(graceful: false)
     return self unless @children
 
     pending = []
-    @children.keys.each do |c|
+    child_fibers = @children.keys
+    child_fibers.each do |c|
       next if c.dead?
 
-      c.terminate(graceful)
+      c.terminate(graceful:)
       pending << c
     end
-    Fiber.await(*pending)
+    Fiber.await(pending)
     self
   end
 
@@ -308,7 +309,8 @@ class ::Fiber
   # @param parent [Fiber] new parent
   # @return [Fiber] self
   def attach_all_children_to(parent)
-    @children&.keys.each { |c| c.attach_to(parent) }
+    child_fibers = @children&.keys
+    child_fibers&.each { |c| c.attach_to(parent) }
     self
   end
 
@@ -361,7 +363,7 @@ class ::Fiber
   # @param child_fiber [Fiber] child fiber to be removed
   # @return [Fiber] self
   def remove_child(child_fiber)
-    @children.delete(child_fiber) if @children
+    @children&.delete(child_fiber)
     self
   end
 
@@ -382,7 +384,7 @@ class ::Fiber
     @parent = parent
     @caller = caller
     @block = block
-    Thread.backend.trace(:spin, self, Kernel.caller[1..-1])
+    Thread.backend.trace(:spin, self, Kernel.caller[1..])
     schedule
     self
   end
@@ -405,7 +407,7 @@ class ::Fiber
     finalize(e.value)
   rescue Exception => e
     e.source_fiber = self
-    finalize(e, true)
+    finalize(e, uncaught_exception: true)
   end
 
   # Performs setup for a "raw" Fiber created using Fiber.new. Note that this
@@ -446,7 +448,7 @@ class ::Fiber
   # @param result [any] return value
   # @param uncaught_exception [Exception, nil] uncaught exception
   # @return [false]
-  def finalize(result, uncaught_exception = false)
+  def finalize(result, uncaught_exception: false)
     result, uncaught_exception = finalize_children(result, uncaught_exception)
     Thread.backend.trace(:terminate, self, result)
     @result = result
@@ -468,7 +470,7 @@ class ::Fiber
   # @param uncaught_exception [Exception, nil] uncaught exception
   # @return [Array] array containing result and uncaught exception if any
   def finalize_children(result, uncaught_exception)
-    shutdown_all_children(graceful_shutdown?)
+    shutdown_all_children(graceful: graceful_shutdown?)
     [result, uncaught_exception]
   rescue Exception => e
     [e, true]
@@ -486,7 +488,7 @@ class ::Fiber
     end
 
     if uncaught_exception && @parent
-      parent_is_monitor = @monitors&.has_key?(@parent)
+      parent_is_monitor = @monitors&.key?(@parent)
       @parent.schedule_with_priority(result) unless parent_is_monitor
     end
 
@@ -532,12 +534,23 @@ class ::Fiber
     # terminates with an uncaught exception, `Fiber.await` will await all the
     # other fibers to terminate, then reraise the exception.
     #
-    # @param fibers [Array<Fiber>] fibers to wait for
-    # @return [Array<any>] return values of given fibers
+    # This method can be called with multiple fibers as multiple arguments, or
+    # with a single array containing one or more fibers.
+    #
+    # @overload Fiber.await(f1, f2, ...)
+    #   @param fibers [Array<Fiber>] fibers to wait for
+    #   @return [Array<any>] return values of given fibers
+    # @overload Fiber.await(fibers)
+    #   @param fibers [Array<Fiber>] fibers to wait for
+    #   @return [Array<any>] return values of given fibers
     def await(*fibers)
       return [] if fibers.empty?
 
-      current_fiber = self.current
+      if (first = fibers.first).is_a?(Array)
+        fibers = first
+      end
+
+      current_fiber = Fiber.current
       mailbox = current_fiber.monitor_mailbox
       results = {}
       fibers.each do |f|
@@ -553,16 +566,18 @@ class ::Fiber
       while !fibers.empty?
         (fiber, result) = mailbox.shift
         next unless fibers.include?(fiber)
+
         fibers.delete(fiber)
         current_fiber.remove_child(fiber) if fiber.parent == current_fiber
         if result.is_a?(Exception)
           exception ||= result
-          fibers.each { |f| f.terminate }
+          fibers.each(&:terminate)
         else
           results[fiber] = result
         end
       end
       raise exception if exception
+
       results.values
     end
     alias_method :join, :await
@@ -576,7 +591,7 @@ class ::Fiber
     def select(*fibers)
       return nil if fibers.empty?
 
-      current_fiber = self.current
+      current_fiber = Fiber.current
       mailbox = current_fiber.monitor_mailbox
       fibers.each do |f|
         if f.dead?
@@ -591,11 +606,9 @@ class ::Fiber
         next unless fibers.include?(fiber)
 
         fibers.each { |f| f.unmonitor(current_fiber) }
-        if result.is_a?(Exception)
-          raise result
-        else
-          return [fiber, result]
-        end
+        raise result if result.is_a?(Exception)
+
+        return [fiber, result]
       end
     end
 
@@ -629,7 +642,7 @@ class ::Fiber
       fiber.tag = :oob
       fiber.thread = Thread.current
       location = block.source_location
-      fiber.set_caller(["#{location.join(':')}"])
+      fiber.set_caller([location.join(':')])
     end
   end
 
@@ -651,11 +664,11 @@ class ::Fiber
     restart = opts[:restart]
     return nil unless block || restart
 
-    error_only = !!opts[:on_error]
+    error_only = opts[:on_error]
     restart_always = (restart == :always) || (restart == true)
     restart_on_error = restart == :on_error
 
-    ->(f, r) do
+    lambda do |f, r|
       is_error = r.is_a?(Exception)
       block.(f, r) if block && (!error_only || is_error)
       f.restart if restart_always || (restart_on_error && is_error)