backports 3.15.0 → 3.24.1

data/lib/backports/ractor/sharing.rb

@@ -0,0 +1,97 @@
+# shareable_constant_value: literal
+
+module Backports
+  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
+end

data/lib/backports/rails/array.rb

@@ -1,3 +1,7 @@
+require 'backports/tools/deprecation'
+
+Backports.deprecate :rails, 'Rails backports are deprecated.'
+
 class Array
   # See official documentation[http://api.rubyonrails.org/classes/ActiveSupport/CoreExtensions/Array/ExtractOptions.html]
   def extract_options!

data/lib/backports/rails/enumerable.rb

@@ -1,3 +1,7 @@
+require 'backports/tools/deprecation'
+
+Backports.deprecate :rails, 'Rails backports are deprecated.'
+
 module Enumerable
   # Standard in rails... See official documentation[http://api.rubyonrails.org/classes/Enumerable.html]
   # Modified from rails 2.3 to not rely on size

data/lib/backports/rails/hash.rb

@@ -1,3 +1,7 @@
+require 'backports/tools/deprecation'
+
+Backports.deprecate :rails, 'Rails backports are deprecated.'
+
 class Hash
   # Standard in rails. See official documentation[http://api.rubyonrails.org/classes/ActiveSupport/CoreExtensions/Hash/Keys.html]
   def reverse_merge(other_hash)

data/lib/backports/rails/kernel.rb

@@ -1,5 +1,9 @@
 # frozen_string_literal: true
 
+require 'backports/tools/deprecation'
+
+Backports.deprecate :rails, 'Rails backports are deprecated.'
+
 # From ActiveSupport
 unless Object.method_defined? :try
   class Object

data/lib/backports/rails/module.rb

@@ -1,3 +1,7 @@
+require 'backports/tools/deprecation'
+
+Backports.deprecate :rails, 'Rails backports are deprecated.'
+
 class Module
   # Standard in rails... See official documentation[http://api.rubyonrails.org/classes/ActiveSupport/CoreExtensions/Module.html]
   def alias_method_chain(target, feature, &block)

data/lib/backports/rails/string.rb

@@ -1,3 +1,7 @@
+require 'backports/tools/deprecation'
+
+Backports.deprecate :rails, 'Rails backports are deprecated.'
+
 class String
   # Standard in rails. See official documentation[http://api.rubyonrails.org/classes/ActiveSupport/CoreExtensions/String/Inflections.html]
   def camelize(first_letter = :upper)

data/lib/backports/std_lib.rb

@@ -2,6 +2,9 @@
 # and load additionally the updated libraries.
 require 'backports/tools/std_lib'
 require 'backports/tools/alias_method_chain'
+require 'backports/tools/deprecation'
+
+Backports.deprecate :require_std_lib, 'Requiring backports/std_lib is deprecated. Use gems instead'
 
 module Kernel
   def require_with_backports(lib)

data/lib/backports/tools/deprecation.rb

@@ -0,0 +1,19 @@
+module Backports
+  class << self
+    attr_accessor :warned # private
+    Backports.warned = {}
+
+    def frown_upon kind, msg
+      warn kind, msg if $VERBOSE
+    end
+
+    def warn kind, msg
+      return if warned[kind]
+      super msg
+      warned[kind] = msg
+    end
+
+    alias_method :deprecate, :warn
+
+  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.15.0" unless const_defined? :VERSION # the guard is against a redefinition warning that happens on Travis
+  VERSION = "3.24.1" unless Backports.constants.include? :VERSION # the guard is against a redefinition warning that happens on Travis
 end

data/lib/backports.rb

@@ -1,3 +1,9 @@
 require "backports/version"
+
+require "backports/tools/deprecation"
+Backports.deprecate :require_version,
+                    "Doing `require 'backports'` is deprecated and will not load any backport in the next major release.\n" \
+                    "Require just the needed backports instead, or 'backports/latest'."
 require "backports/2.4"
+Backports.warned[:rails] = true
 require "backports/rails"