backports 3.18.2 → 3.21.0

data/lib/backports/3.0.0/hash/transform_keys.rb

@@ -0,0 +1,48 @@
+class Hash
+  unless ({}.transform_keys(:x => 1) rescue false)
+    require 'backports/2.5.0/hash/transform_keys'
+    require 'backports/tools/alias_method_chain'
+
+    def transform_keys_with_hash_arg(hash = not_given = true, &block)
+      return to_enum(:transform_keys) { size } if not_given && !block
+
+      return transform_keys_without_hash_arg(&block) if not_given
+
+      h = {}
+      if block_given?
+        each do |key, value|
+          h[hash.fetch(key) { yield key }] = value
+        end
+      else
+        each do |key, value|
+          h[hash.fetch(key, key)] = value
+        end
+      end
+      h
+    end
+    Backports.alias_method_chain self, :transform_keys, :hash_arg
+
+    def transform_keys_with_hash_arg!(hash = not_given = true, &block)
+      return enum_for(:transform_keys!) { size } if not_given && !block
+
+      return transform_keys_without_hash_arg!(&block) if not_given
+
+      h = {}
+      begin
+        if block_given?
+          each do |key, value|
+            h[hash.fetch(key) { yield key }] = value
+          end
+        else
+          each do |key, value|
+            h[hash.fetch(key, key)] = value
+          end
+        end
+      ensure
+        replace(h)
+      end
+      self
+    end
+    Backports.alias_method_chain self, :transform_keys!, :hash_arg
+  end
+end

data/lib/backports/3.0.0/ractor.rb

@@ -0,0 +1,19 @@
+if RUBY_VERSION < '2'
+  warn 'Ractor not backported to Ruby 1.x'
+elsif defined?(Ractor.current)
+  # all good
+else
+  # Cloner:
+  require_relative '../2.4.0/hash/transform_values'
+  require_relative '../2.5.0/hash/transform_keys'
+  # Queues & FilteredQueue
+  require_relative '../2.3.0/queue/close'
+
+  class Ractor
+  end
+
+  module Backports
+    Ractor = ::Ractor
+  end
+  require_relative '../ractor/ractor'
+end

data/lib/backports/3.0.0/symbol.rb

@@ -0,0 +1,3 @@
+require 'backports/tools/require_relative_dir'
+
+Backports.require_relative_dir

data/lib/backports/3.0.0/symbol/name.rb

@@ -0,0 +1,11 @@
+unless Symbol.method_defined? :name
+  def Backports.symbol_names
+    @symbol_names ||= ObjectSpace::WeakMap.new
+  end
+
+  class Symbol
+    def name
+      Backports.symbol_names[self] ||= to_s.freeze
+    end
+  end
+end

data/lib/backports/3.0.rb

@@ -0,0 +1 @@
+require 'backports/3.0.0'

data/lib/backports/ractor/cloner.rb

@@ -0,0 +1,103 @@
+# shareable_constant_value: literal
+
+using ::RubyNext if defined?(::RubyNext)
+
+module Backports
+  class Ractor
+    class Cloner
+      class << self
+        def deep_clone(obj)
+          return obj if Ractor.ractor_shareable_self?(obj, false) { false }
+
+          new.deep_clone(obj)
+        end
+
+        private :new
+      end
+
+      def initialize
+        @processed = {}.compare_by_identity
+        @changed = nil
+      end
+
+      def deep_clone(obj)
+        result = process(obj) do |r|
+          copy_contents(r)
+        end
+        return result if result
+
+        Ractor.ractor_mark_set_shareable(@processed)
+        obj
+      end
+
+      # Yields a deep copy.
+      # If no deep copy is needed, `obj` is returned and
+      # nothing is yielded
+      private def clone_deeper(obj)
+        return obj if Ractor.ractor_shareable_self?(obj, false) { false }
+
+        result = process(obj) do |r|
+          copy_contents(r)
+        end
+        return obj unless result
+
+        yield result if block_given?
+        result
+      end
+
+      # Yields if `obj` is a new structure
+      # Returns the deep copy, or `false` if no deep copy is needed
+      private def process(obj)
+        @processed.fetch(obj) do
+          # For recursive structures, assume that we'll need a duplicate.
+          # If that's not the case, we will have duplicated the whole structure
+          # for nothing...
+          @processed[obj] = result = obj.dup
+          changed = track_change { yield result }
+          return false if obj.frozen? && !changed
+
+          @changed = true
+          result.freeze if obj.frozen?
+
+          result
+        end
+      end
+
+      # returns if the block called `deep clone` and that the deep copy was needed
+      private def track_change
+        prev = @changed
+        @changed = false
+        yield
+        @changed
+      ensure
+        @changed = prev
+      end
+
+      # modifies in place `obj` by calling `deep clone` on its contents
+      private def copy_contents(obj)
+        case obj
+        when ::Hash
+          if obj.default
+            clone_deeper(obj.default) do |copy|
+              obj.default = copy
+            end
+          end
+          obj.transform_keys! { |key| clone_deeper(key) }
+          obj.transform_values! { |value| clone_deeper(value) }
+        when ::Array
+          obj.map! { |item| clone_deeper(item) }
+        when ::Struct
+          obj.each_pair do |key, item|
+            clone_deeper(item) { |copy| obj[key] = copy }
+          end
+        end
+        obj.instance_variables.each do |var|
+          clone_deeper(obj.instance_variable_get(var)) do |copy|
+            obj.instance_variable_set(var, copy)
+          end
+        end
+      end
+    end
+    private_constant :Cloner
+  end
+end

data/lib/backports/ractor/errors.rb

@@ -0,0 +1,20 @@
+# shareable_constant_value: literal
+
+module Backports
+  class Ractor
+    class ClosedError < ::StopIteration
+    end
+
+    class Error < ::StandardError
+    end
+
+    class RemoteError < Error
+      attr_reader :ractor
+
+      def initialize(message = nil)
+        @ractor = Ractor.current
+        super
+      end
+    end
+  end
+end

data/lib/backports/ractor/filtered_queue.rb

@@ -0,0 +1,205 @@
+# shareable_constant_value: literal
+
+module Backports
+  # Like ::Queue, but with
+  # - filtering
+  # - timeout
+  # - raises on closed queues
+  #
+  # Independent from other Ractor related backports.
+  class FilteredQueue
+    CONSUME_ON_ESCAPE = true
+
+    class ClosedQueueError < ::ClosedQueueError
+    end
+
+    class TimeoutError < ::ThreadError
+    end
+
+    class Message
+      # Not using Struct as we want comparision by identity
+      attr_reader :value
+      attr_accessor :reserved
+
+      def initialize(value)
+        @value = value
+        @reserved = false
+      end
+    end
+    private_constant :Message
+
+    attr_reader :num_waiting
+
+    # Timeout processing based on https://spin.atomicobject.com/2017/06/28/queue-pop-with-timeout-fixed/
+    def initialize
+      @mutex = ::Mutex.new
+      @queue = []
+      @closed = false
+      @received = ::ConditionVariable.new
+      @num_waiting = 0
+    end
+
+    def close
+      @mutex.synchronize do
+        @closed = true
+        @received.broadcast
+      end
+      self
+    end
+
+    def closed?
+      @closed
+    end
+
+    def <<(x)
+      @mutex.synchronize do
+        ensure_open
+        @queue << Message.new(x)
+        @received.signal
+      end
+      self
+    end
+    alias_method :push, :<<
+
+    def clear
+      @mutex.synchronize do
+        @queue.clear
+      end
+      self
+    end
+
+    def pop(timeout: nil, &block)
+      msg = nil
+      exclude = [] if block # exclusion list of messages rejected by this call
+      timeout_time = timeout + Time.now.to_f if timeout
+      while true do # rubocop:disable Style/InfiniteLoop, Style/WhileUntilDo
+        @mutex.synchronize do
+          reenter if reentrant?
+          msg = acquire!(timeout_time, exclude)
+          return consume!(msg).value unless block
+        end
+        return msg.value if filter?(msg, &block)
+      end
+    end
+
+    def empty?
+      avail = @mutex.synchronize do
+        available!
+      end
+
+      !avail
+    end
+
+    protected def timeout_value
+      raise self.class::TimeoutError, "timeout elapsed"
+    end
+
+    protected def closed_queue_value
+      ensure_open
+    end
+
+    # @return if outer message should be consumed or not
+    protected def reenter
+      true
+    end
+
+    ### private section
+    #
+    # bang methods require synchronization
+
+    # @returns:
+    # * true if message consumed (block result truthy or due to reentrant call)
+    # * false if rejected
+    private def filter?(msg)
+      consume = self.class::CONSUME_ON_ESCAPE
+      begin
+        reentered = consume_on_reentry(msg) do
+          consume = !!(yield msg.value)
+        end
+        reentered ? reenter : consume
+      ensure
+        commit(msg, consume) unless reentered
+      end
+    end
+
+    # @returns msg
+    private def consume!(msg)
+      @queue.delete(msg)
+    end
+
+    private def reject!(msg)
+      msg.reserved = false
+      @received.broadcast
+    end
+
+    private def commit(msg, consume)
+      @mutex.synchronize do
+        if consume
+          consume!(msg)
+        else
+          reject!(msg)
+        end
+      end
+    end
+
+    private def consume_on_reentry(msg)
+      q_map = current_filtered_queues
+      if (outer_msg = q_map[self])
+        commit(outer_msg, reenter)
+      end
+      q_map[self] = msg
+      begin
+        yield
+      ensure
+        reentered = !q_map.delete(self)
+      end
+      reentered
+    end
+
+    private def reentrant?
+      !!current_filtered_queues[self]
+    end
+
+    # @returns Hash { FilteredQueue => Message }
+    private def current_filtered_queues
+      t = Thread.current
+      t.thread_variable_get(:backports_currently_filtered_queues) or
+        t.thread_variable_set(:backports_currently_filtered_queues, {}.compare_by_identity)
+    end
+
+    # private methods assume @mutex synchonized
+    # adds to exclude list
+    private def acquire!(timeout_time, exclude = nil)
+      while true do # rubocop:disable Style/InfiniteLoop, Style/WhileUntilDo
+        if (msg = available!(exclude))
+          msg.reserved = true
+          exclude << msg if exclude
+          return msg
+        end
+        return closed_queue_value if @closed
+        # wait for element or timeout
+        if timeout_time
+          remaining_time = timeout_time - ::Time.now.to_f
+          return timeout_value if remaining_time <= 0
+        end
+        begin
+          @num_waiting += 1
+          @received.wait(@mutex, remaining_time)
+        ensure
+          @num_waiting -= 1
+        end
+      end
+    end
+
+    private def available!(exclude = nil)
+      @queue.find do |msg|
+        next if exclude && exclude.include?(msg)
+        !msg.reserved
+      end
+    end
+
+    private def ensure_open
+      raise self.class::ClosedQueueError, 'queue closed' if @closed
+    end
+  end
+end

data/lib/backports/ractor/queues.rb

@@ -0,0 +1,66 @@
+# shareable_constant_value: literal
+
+require_relative 'filtered_queue'
+
+module Backports
+  class Ractor
+    # Standard ::Queue but raises if popping and closed
+    class BaseQueue < FilteredQueue
+      ClosedQueueError = Ractor::ClosedError
+
+      # yields message (if any)
+      def pop_non_blocking
+        yield pop(timeout: 0)
+      rescue TimeoutError
+        nil
+      end
+    end
+
+    class IncomingQueue < BaseQueue
+      TYPE = :incoming
+
+      protected def reenter
+        raise Ractor::Error, 'Can not reenter'
+      end
+    end
+
+    # * Wraps exception
+    # * Add `ack: ` to push (blocking)
+    class OutgoingQueue < BaseQueue
+      TYPE = :outgoing
+
+      WrappedException = ::Struct.new(:exception, :ractor)
+
+      def initialize
+        @ack_queue = ::Queue.new
+        super
+      end
+
+      def pop(timeout: nil, ack: true)
+        r = super(timeout: timeout)
+        @ack_queue << :done if ack
+        raise r.exception if WrappedException === r
+
+        r
+      end
+
+      def close(how = :hard)
+        super()
+        return if how == :soft
+
+        clear
+        @ack_queue.close
+      end
+
+      def push(obj, ack:)
+        super(obj)
+        if ack
+          r = @ack_queue.pop # block until popped
+          raise ClosedError, "The #{self.class::TYPE}-port is already closed" unless r == :done
+        end
+        self
+      end
+    end
+    private_constant :BaseQueue, :OutgoingQueue, :IncomingQueue
+  end
+end