backports 3.17.2 → 3.20.0

data/lib/backports/ractor/sharing.rb

@@ -0,0 +1,93 @@
+class Ractor
+  class << self
+    # @api private
+    def ractor_isolate(val, move = false)
+      return val if move
+
+      Cloner.deep_clone(val)
+    end
+
+    private def ractor_check_shareability?(obj, freeze_all)
+      ractor_shareable_self?(obj, freeze_all) do
+        visited = {}
+
+        return false unless ractor_shareable_parts?(obj, freeze_all, visited)
+
+        ractor_mark_set_shareable(visited)
+
+        true
+      end
+    end
+
+    # yield if shareability can't be determined without looking at its parts
+    def ractor_shareable_self?(obj, freeze_all)
+      return true if @ractor_shareable.key?(obj)
+      return true if ractor_shareable_by_nature?(obj, freeze_all)
+      if obj.frozen? || (freeze_all && obj.freeze)
+        yield
+      else
+        false
+      end
+    end
+
+    private def ractor_shareable_parts?(obj, freeze_all, visited)
+      return true if visited.key?(obj)
+      visited[obj] = true
+
+      ractor_traverse(obj) do |part|
+        return false unless ractor_shareable_self?(part, freeze_all) do
+          ractor_shareable_parts?(part, freeze_all, visited)
+        end
+      end
+
+      true
+    end
+
+    def ractor_mark_set_shareable(visited)
+      visited.each do |key|
+        @ractor_shareable[key] = Ractor
+      end
+    end
+
+    private def ractor_traverse(obj, &block)
+      case obj
+      when ::Hash
+        Hash obj.default
+        yield obj.default_proc
+        obj.each do |key, value|
+          yield key
+          yield value
+        end
+      when ::Range
+        yield obj.begin
+        yield obj.end
+      when ::Array, ::Struct
+        obj.each(&block)
+      when ::Complex
+        yield obj.real
+        yield obj.imaginary
+      when ::Rational
+        yield obj.numerator
+        yield obj.denominator
+      end
+      obj.instance_variables.each do |var|
+        yield obj.instance_variable_get(var)
+      end
+    end
+
+    private def ractor_shareable_by_nature?(obj, freeze_all)
+      case obj
+      when ::Module, ::Ractor
+        true
+      when ::Regexp, ::Range, ::Numeric
+        !freeze_all # Assume that these are literals that would have been frozen in 3.0
+                    # unless we're making them shareable, in which case we might as well
+                    # freeze them for real.
+      when ::Symbol, false, true, nil # Were only frozen in Ruby 2.3+
+        true
+      else
+        false
+      end
+    end
+  end
+end

data/lib/backports/tools/filtered_queue.rb

@@ -0,0 +1,202 @@
+module Backports
+  class FilteredQueue
+    require 'backports/2.3.0/queue/close'
+    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
+
+    # Like ::Queue, but with
+    # - filtering
+    # - timeout
+    # - raises on closed queues
+
+    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
+        @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
+        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/tools/require_relative_dir.rb

@@ -7,7 +7,12 @@ module Backports
         compact.
         sort.
         each do |f|
-          require short_path + f
+          path = '../../' + short_path + f
+          if Kernel.private_method_defined?(:require_relative)
+            require_relative path
+          else
+            require File.expand_path(path)
+          end
         end
   end
 end

data/lib/backports/version.rb

@@ -1,3 +1,3 @@
 module Backports
-  VERSION = "3.17.2" unless Backports.constants.include? :VERSION # the guard is against a redefinition warning that happens on Travis
+  VERSION = "3.20.0" unless Backports.constants.include? :VERSION # the guard is against a redefinition warning that happens on Travis
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: backports
 version: !ruby/object:Gem::Version
-  version: 3.17.2
+  version: 3.20.0
 platform: ruby
 authors:
 - Marc-André Lafortune
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2020-05-20 00:00:00.000000000 Z
+date: 2020-12-30 00:00:00.000000000 Z
 dependencies: []
 description: Essential backports that enable many of the nice features of Ruby for
   earlier versions.
@@ -425,12 +425,16 @@ files:
 - lib/backports/2.3.0/numeric.rb
 - lib/backports/2.3.0/numeric/negative.rb
 - lib/backports/2.3.0/numeric/positive.rb
+- lib/backports/2.3.0/queue/close.rb
+- lib/backports/2.3.0/string.rb
 - lib/backports/2.3.0/string/uminus.rb
 - lib/backports/2.3.0/string/uplus.rb
 - lib/backports/2.3.0/struct.rb
 - lib/backports/2.3.0/struct/dig.rb
 - lib/backports/2.3.rb
 - lib/backports/2.4.0.rb
+- lib/backports/2.4.0/bignum.rb
+- lib/backports/2.4.0/bignum/dup.rb
 - lib/backports/2.4.0/comparable.rb
 - lib/backports/2.4.0/comparable/clamp.rb
 - lib/backports/2.4.0/enumerable.rb
@@ -528,6 +532,16 @@ files:
 - lib/backports/2.7.0/time/ceil.rb
 - lib/backports/2.7.0/time/floor.rb
 - lib/backports/2.7.rb
+- lib/backports/3.0.0.rb
+- lib/backports/3.0.0/env.rb
+- lib/backports/3.0.0/env/except.rb
+- lib/backports/3.0.0/hash.rb
+- lib/backports/3.0.0/hash/except.rb
+- lib/backports/3.0.0/hash/transform_keys.rb
+- lib/backports/3.0.0/ractor.rb
+- lib/backports/3.0.0/symbol.rb
+- lib/backports/3.0.0/symbol/name.rb
+- lib/backports/3.0.rb
 - lib/backports/basic_object.rb
 - lib/backports/force/array_map.rb
 - lib/backports/force/enumerable_map.rb
@@ -535,6 +549,11 @@ files:
 - lib/backports/force/string_length.rb
 - lib/backports/force/string_size.rb
 - lib/backports/latest.rb
+- lib/backports/ractor/cloner.rb
+- lib/backports/ractor/errors.rb
+- lib/backports/ractor/queues.rb
+- lib/backports/ractor/ractor.rb
+- lib/backports/ractor/sharing.rb
 - lib/backports/rails.rb
 - lib/backports/rails/array.rb
 - lib/backports/rails/enumerable.rb
@@ -553,6 +572,7 @@ files:
 - lib/backports/tools/arguments.rb
 - lib/backports/tools/deprecation.rb
 - lib/backports/tools/extreme_object.rb
+- lib/backports/tools/filtered_queue.rb
 - lib/backports/tools/float_integer_conversion.rb
 - lib/backports/tools/io.rb
 - lib/backports/tools/make_block_optional.rb
@@ -566,10 +586,10 @@ homepage: http://github.com/marcandre/backports
 licenses:
 - MIT
 metadata:
-  changelog_uri: https://github.com/marcandre/backports/blob/master/CHANGELOG.rdoc
+  changelog_uri: https://github.com/marcandre/backports/blob/master/CHANGELOG.md
   source_code_uri: https://github.com/marcandre/backports
   bug_tracker_uri: https://github.com/marcandre/backports/issues
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -584,8 +604,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.1.2
-signing_key: 
+rubygems_version: 3.1.4
+signing_key:
 specification_version: 4
 summary: Backports of Ruby features for older Ruby.
 test_files: []