activesupport 5.0.0 → 6.1.0

data/lib/active_support/core_ext/enumerable.rb

@@ -1,4 +1,21 @@
+# frozen_string_literal: true
+
 module Enumerable
+  INDEX_WITH_DEFAULT = Object.new
+  private_constant :INDEX_WITH_DEFAULT
+
+  # Enumerable#sum was added in Ruby 2.4, but it only works with Numeric elements
+  # when we omit an identity.
+
+  # :stopdoc:
+
+  # We can't use Refinements here because Refinements with Module which will be prepended
+  # doesn't work well https://bugs.ruby-lang.org/issues/13446
+  alias :_original_sum_with_required_identity :sum
+  private :_original_sum_with_required_identity
+
+  # :startdoc:
+
   # Calculates a sum from the elements.
   #
   #  payments.sum { |p| p.price * p.tax_rate }
@@ -12,34 +29,66 @@ module Enumerable
   #
   #  [5, 15, 10].sum # => 30
   #  ['foo', 'bar'].sum # => "foobar"
-  #  [[1, 2], [3, 1, 5]].sum => [1, 2, 3, 1, 5]
+  #  [[1, 2], [3, 1, 5]].sum # => [1, 2, 3, 1, 5]
   #
   # The default sum of an empty list is zero. You can override this default:
   #
   #  [].sum(Payment.new(0)) { |i| i.amount } # => Payment.new(0)
   def sum(identity = nil, &block)
-    if block_given?
+    if identity
+      _original_sum_with_required_identity(identity, &block)
+    elsif block_given?
       map(&block).sum(identity)
     else
-      sum = identity ? inject(identity, :+) : inject(:+)
-      sum || identity || 0
+      inject(:+) || 0
     end
   end
 
-  # Convert an enumerable to a hash.
+  # Convert an enumerable to a hash, using the block result as the key and the
+  # element as the value.
   #
   #   people.index_by(&:login)
-  #     => { "nextangle" => <Person ...>, "chade-" => <Person ...>, ...}
+  #   # => { "nextangle" => <Person ...>, "chade-" => <Person ...>, ...}
+  #
   #   people.index_by { |person| "#{person.first_name} #{person.last_name}" }
-  #     => { "Chade- Fowlersburg-e" => <Person ...>, "David Heinemeier Hansson" => <Person ...>, ...}
+  #   # => { "Chade- Fowlersburg-e" => <Person ...>, "David Heinemeier Hansson" => <Person ...>, ...}
   def index_by
     if block_given?
-      Hash[map { |elem| [yield(elem), elem] }]
+      result = {}
+      each { |elem| result[yield(elem)] = elem }
+      result
     else
       to_enum(:index_by) { size if respond_to?(:size) }
     end
   end
 
+  # Convert an enumerable to a hash, using the element as the key and the block
+  # result as the value.
+  #
+  #   post = Post.new(title: "hey there", body: "what's up?")
+  #
+  #   %i( title body ).index_with { |attr_name| post.public_send(attr_name) }
+  #   # => { title: "hey there", body: "what's up?" }
+  #
+  # If an argument is passed instead of a block, it will be used as the value
+  # for all elements:
+  #
+  #   %i( created_at updated_at ).index_with(Time.now)
+  #   # => { created_at: 2020-03-09 22:31:47, updated_at: 2020-03-09 22:31:47 }
+  def index_with(default = INDEX_WITH_DEFAULT)
+    if block_given?
+      result = {}
+      each { |elem| result[elem] = yield(elem) }
+      result
+    elsif default != INDEX_WITH_DEFAULT
+      result = {}
+      each { |elem| result[elem] = default }
+      result
+    else
+      to_enum(:index_with) { size if respond_to?(:size) }
+    end
+  end
+
   # Returns +true+ if the enumerable has more than 1 element. Functionally
   # equivalent to <tt>enum.to_a.size > 1</tt>. Can be called with a block too,
   # much like any?, so <tt>people.many? { |p| p.age > 26 }</tt> returns +true+
@@ -56,37 +105,110 @@ module Enumerable
     end
   end
 
+  # Returns a new array that includes the passed elements.
+  #
+  #   [ 1, 2, 3 ].including(4, 5)
+  #   # => [ 1, 2, 3, 4, 5 ]
+  #
+  #   ["David", "Rafael"].including %w[ Aaron Todd ]
+  #   # => ["David", "Rafael", "Aaron", "Todd"]
+  def including(*elements)
+    to_a.including(*elements)
+  end
+
   # The negative of the <tt>Enumerable#include?</tt>. Returns +true+ if the
   # collection does not include the object.
   def exclude?(object)
     !include?(object)
   end
 
-  # Returns a copy of the enumerable without the specified elements.
+  # Returns a copy of the enumerable excluding the specified elements.
   #
-  #   ["David", "Rafael", "Aaron", "Todd"].without "Aaron", "Todd"
-  #     => ["David", "Rafael"]
+  #   ["David", "Rafael", "Aaron", "Todd"].excluding "Aaron", "Todd"
+  #   # => ["David", "Rafael"]
   #
-  #   {foo: 1, bar: 2, baz: 3}.without :bar
-  #     => {foo: 1, baz: 3}
-  def without(*elements)
+  #   ["David", "Rafael", "Aaron", "Todd"].excluding %w[ Aaron Todd ]
+  #   # => ["David", "Rafael"]
+  #
+  #   {foo: 1, bar: 2, baz: 3}.excluding :bar
+  #   # => {foo: 1, baz: 3}
+  def excluding(*elements)
+    elements.flatten!(1)
     reject { |element| elements.include?(element) }
   end
 
-  # Convert an enumerable to an array based on the given key.
+  # Alias for #excluding.
+  def without(*elements)
+    excluding(*elements)
+  end
+
+  # Extract the given key from each element in the enumerable.
   #
   #   [{ name: "David" }, { name: "Rafael" }, { name: "Aaron" }].pluck(:name)
-  #     => ["David", "Rafael", "Aaron"]
+  #   # => ["David", "Rafael", "Aaron"]
   #
   #   [{ id: 1, name: "David" }, { id: 2, name: "Rafael" }].pluck(:id, :name)
-  #     => [[1, "David"], [2, "Rafael"]]
+  #   # => [[1, "David"], [2, "Rafael"]]
   def pluck(*keys)
     if keys.many?
       map { |element| keys.map { |key| element[key] } }
     else
-      map { |element| element[keys.first] }
+      key = keys.first
+      map { |element| element[key] }
     end
   end
+
+  # Extract the given key from the first element in the enumerable.
+  #
+  #   [{ name: "David" }, { name: "Rafael" }, { name: "Aaron" }].pick(:name)
+  #   # => "David"
+  #
+  #   [{ id: 1, name: "David" }, { id: 2, name: "Rafael" }].pick(:id, :name)
+  #   # => [1, "David"]
+  def pick(*keys)
+    return if none?
+
+    if keys.many?
+      keys.map { |key| first[key] }
+    else
+      first[keys.first]
+    end
+  end
+
+  # Returns a new +Array+ without the blank items.
+  # Uses Object#blank? for determining if an item is blank.
+  #
+  #    [1, "", nil, 2, " ", [], {}, false, true].compact_blank
+  #    # =>  [1, 2, true]
+  #
+  #    Set.new([nil, "", 1, 2])
+  #    # => [2, 1] (or [1, 2])
+  #
+  # When called on a +Hash+, returns a new +Hash+ without the blank values.
+  #
+  #    { a: "", b: 1, c: nil, d: [], e: false, f: true }.compact_blank
+  #    #=> { b: 1, f: true }
+  def compact_blank
+    reject(&:blank?)
+  end
+end
+
+class Hash
+  # Hash#reject has its own definition, so this needs one too.
+  def compact_blank #:nodoc:
+    reject { |_k, v| v.blank? }
+  end
+
+  # Removes all blank values from the +Hash+ in place and returns self.
+  # Uses Object#blank? for determining if a value is blank.
+  #
+  #    h = { a: "", b: 1, c: nil, d: [], e: false, f: true }
+  #    h.compact_blank!
+  #    # => { b: 1, f: true }
+  def compact_blank!
+    # use delete_if rather than reject! because it always returns self even if nothing changed
+    delete_if { |_k, v| v.blank? }
+  end
 end
 
 class Range #:nodoc:
@@ -107,18 +229,32 @@ class Range #:nodoc:
   end
 end
 
-# Array#sum was added in Ruby 2.4 but it only works with Numeric elements.
-#
-# We tried shimming it to attempt the fast native method, rescue TypeError,
-# and fall back to the compatible implementation, but that's much slower than
-# just calling the compat method in the first place.
-if Array.instance_methods(false).include?(:sum) && !(%w[a].sum rescue false)
-  class Array
-    remove_method :sum
-
-    def sum(*args) #:nodoc:
-      # Use Enumerable#sum instead.
+# Using Refinements here in order not to expose our internal method
+using Module.new {
+  refine Array do
+    alias :orig_sum :sum
+  end
+}
+
+class Array #:nodoc:
+  # Array#sum was added in Ruby 2.4 but it only works with Numeric elements.
+  def sum(init = nil, &block)
+    if init.is_a?(Numeric) || first.is_a?(Numeric)
+      init ||= 0
+      orig_sum(init, &block)
+    else
       super
     end
   end
+
+  # Removes all blank elements from the +Array+ in place and returns self.
+  # Uses Object#blank? for determining if an item is blank.
+  #
+  #    a = [1, "", nil, 2, " ", [], {}, false, true]
+  #    a.compact_blank!
+  #    # =>  [1, 2, true]
+  def compact_blank!
+    # use delete_if rather than reject! because it always returns self even if nothing changed
+    delete_if(&:blank?)
+  end
 end

data/lib/active_support/core_ext/file/atomic.rb

@@ -1,4 +1,6 @@
-require 'fileutils'
+# frozen_string_literal: true
+
+require "fileutils"
 
 class File
   # Write to a file atomically. Useful for situations where you don't
@@ -17,7 +19,7 @@ class File
   #     file.write('hello')
   #   end
   def self.atomic_write(file_name, temp_dir = dirname(file_name))
-    require 'tempfile' unless defined?(Tempfile)
+    require "tempfile" unless defined?(Tempfile)
 
     Tempfile.open(".#{basename(file_name)}", temp_dir) do |temp_file|
       temp_file.binmode
@@ -27,7 +29,7 @@ class File
       old_stat = if exist?(file_name)
         # Get original file permissions
         stat(file_name)
-      elsif temp_dir != dirname(file_name)
+      else
         # If not possible, probe which are the default permissions in the
         # destination directory.
         probe_stat_in(dirname(file_name))
@@ -53,11 +55,11 @@ class File
   # Private utility method.
   def self.probe_stat_in(dir) #:nodoc:
     basename = [
-      '.permissions_check',
+      ".permissions_check",
       Thread.current.object_id,
       Process.pid,
       rand(1000000)
-    ].join('.')
+    ].join(".")
 
     file_name = join(dir, basename)
     FileUtils.touch(file_name)

data/lib/active_support/core_ext/file.rb

@@ -1 +1,3 @@
-require 'active_support/core_ext/file/atomic'
+# frozen_string_literal: true
+
+require "active_support/core_ext/file/atomic"

data/lib/active_support/core_ext/hash/conversions.rb

@@ -1,11 +1,13 @@
-require 'active_support/xml_mini'
-require 'active_support/time'
-require 'active_support/core_ext/object/blank'
-require 'active_support/core_ext/object/to_param'
-require 'active_support/core_ext/object/to_query'
-require 'active_support/core_ext/array/wrap'
-require 'active_support/core_ext/hash/reverse_merge'
-require 'active_support/core_ext/string/inflections'
+# frozen_string_literal: true
+
+require "active_support/xml_mini"
+require "active_support/core_ext/object/blank"
+require "active_support/core_ext/object/to_param"
+require "active_support/core_ext/object/to_query"
+require "active_support/core_ext/object/try"
+require "active_support/core_ext/array/wrap"
+require "active_support/core_ext/hash/reverse_merge"
+require "active_support/core_ext/string/inflections"
 
 class Hash
   # Returns a string containing an XML representation of its receiver:
@@ -71,11 +73,11 @@ class Hash
   # configure your own builder with the <tt>:builder</tt> option. The method also accepts
   # options like <tt>:dasherize</tt> and friends, they are forwarded to the builder.
   def to_xml(options = {})
-    require 'active_support/builder' unless defined?(Builder)
+    require "active_support/builder" unless defined?(Builder::XmlMarkup)
 
     options = options.dup
     options[:indent]  ||= 2
-    options[:root]    ||= 'hash'
+    options[:root]    ||= "hash"
     options[:builder] ||= Builder::XmlMarkup.new(indent: options[:indent])
 
     builder = options[:builder]
@@ -159,36 +161,36 @@ module ActiveSupport
     private
       def normalize_keys(params)
         case params
-          when Hash
-            Hash[params.map { |k,v| [k.to_s.tr('-', '_'), normalize_keys(v)] } ]
-          when Array
-            params.map { |v| normalize_keys(v) }
-          else
-            params
+        when Hash
+          Hash[params.map { |k, v| [k.to_s.tr("-", "_"), normalize_keys(v)] } ]
+        when Array
+          params.map { |v| normalize_keys(v) }
+        else
+          params
         end
       end
 
       def deep_to_h(value)
         case value
-          when Hash
-            process_hash(value)
-          when Array
-            process_array(value)
-          when String
-            value
-          else
-            raise "can't typecast #{value.class.name} - #{value.inspect}"
+        when Hash
+          process_hash(value)
+        when Array
+          process_array(value)
+        when String
+          value
+        else
+          raise "can't typecast #{value.class.name} - #{value.inspect}"
         end
       end
 
       def process_hash(value)
-        if value.include?('type') && !value['type'].is_a?(Hash) && @disallowed_types.include?(value['type'])
-          raise DisallowedType, value['type']
+        if value.include?("type") && !value["type"].is_a?(Hash) && @disallowed_types.include?(value["type"])
+          raise DisallowedType, value["type"]
         end
 
         if become_array?(value)
-          _, entries = Array.wrap(value.detect { |k,v| not v.is_a?(String) })
-          if entries.nil? || value['__content__'].try(:empty?)
+          _, entries = Array.wrap(value.detect { |k, v| not v.is_a?(String) })
+          if entries.nil? || value["__content__"].try(:empty?)
             []
           else
             case entries
@@ -204,28 +206,28 @@ module ActiveSupport
           process_content(value)
 
         elsif become_empty_string?(value)
-          ''
+          ""
         elsif become_hash?(value)
-          xml_value = Hash[value.map { |k,v| [k, deep_to_h(v)] }]
+          xml_value = value.transform_values { |v| deep_to_h(v) }
 
           # Turn { files: { file: #<StringIO> } } into { files: #<StringIO> } so it is compatible with
           # how multipart uploaded files from HTML appear
-          xml_value['file'].is_a?(StringIO) ? xml_value['file'] : xml_value
+          xml_value["file"].is_a?(StringIO) ? xml_value["file"] : xml_value
         end
       end
 
       def become_content?(value)
-        value['type'] == 'file' || (value['__content__'] && (value.keys.size == 1 || value['__content__'].present?))
+        value["type"] == "file" || (value["__content__"] && (value.keys.size == 1 || value["__content__"].present?))
       end
 
       def become_array?(value)
-        value['type'] == 'array'
+        value["type"] == "array"
       end
 
       def become_empty_string?(value)
         # { "string" => true }
         # No tests fail when the second term is removed.
-        value['type'] == 'string' && value['nil'] != 'true'
+        value["type"] == "string" && value["nil"] != "true"
       end
 
       def become_hash?(value)
@@ -234,19 +236,19 @@ module ActiveSupport
 
       def nothing?(value)
         # blank or nil parsed values are represented by nil
-        value.blank? || value['nil'] == 'true'
+        value.blank? || value["nil"] == "true"
       end
 
       def garbage?(value)
         # If the type is the only element which makes it then
         # this still makes the value nil, except if type is
         # an XML node(where type['value'] is a Hash)
-        value['type'] && !value['type'].is_a?(::Hash) && value.size == 1
+        value["type"] && !value["type"].is_a?(::Hash) && value.size == 1
       end
 
       def process_content(value)
-        content = value['__content__']
-        if parser = ActiveSupport::XmlMini::PARSING[value['type']]
+        content = value["__content__"]
+        if parser = ActiveSupport::XmlMini::PARSING[value["type"]]
           parser.arity == 1 ? parser.call(content) : parser.call(content, value)
         else
           content
@@ -257,6 +259,5 @@ module ActiveSupport
         value.map! { |i| deep_to_h(i) }
         value.length > 1 ? value : value.first
       end
-
   end
 end

data/lib/active_support/core_ext/hash/deep_merge.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 class Hash
   # Returns a new hash with +self+ and +other_hash+ merged recursively.
   #
@@ -19,20 +21,14 @@ class Hash
 
   # Same as +deep_merge+, but modifies +self+.
   def deep_merge!(other_hash, &block)
-    other_hash.each_pair do |current_key, other_value|
-      this_value = self[current_key]
-
-      self[current_key] = if this_value.is_a?(Hash) && other_value.is_a?(Hash)
-        this_value.deep_merge(other_value, &block)
+    merge!(other_hash) do |key, this_val, other_val|
+      if this_val.is_a?(Hash) && other_val.is_a?(Hash)
+        this_val.deep_merge(other_val, &block)
+      elsif block_given?
+        block.call(key, this_val, other_val)
       else
-        if block_given? && key?(current_key)
-          block.call(current_key, this_value, other_value)
-        else
-          other_value
-        end
+        other_val
       end
     end
-
-    self
   end
 end

data/lib/active_support/core_ext/hash/deep_transform_values.rb

@@ -0,0 +1,46 @@
+# frozen_string_literal: true
+
+class Hash
+  # Returns a new hash with all values converted by the block operation.
+  # This includes the values from the root hash and from all
+  # nested hashes and arrays.
+  #
+  #  hash = { person: { name: 'Rob', age: '28' } }
+  #
+  #  hash.deep_transform_values{ |value| value.to_s.upcase }
+  #  # => {person: {name: "ROB", age: "28"}}
+  def deep_transform_values(&block)
+    _deep_transform_values_in_object(self, &block)
+  end
+
+  # Destructively converts all values by using the block operation.
+  # This includes the values from the root hash and from all
+  # nested hashes and arrays.
+  def deep_transform_values!(&block)
+    _deep_transform_values_in_object!(self, &block)
+  end
+
+  private
+    # Support methods for deep transforming nested hashes and arrays.
+    def _deep_transform_values_in_object(object, &block)
+      case object
+      when Hash
+        object.transform_values { |value| _deep_transform_values_in_object(value, &block) }
+      when Array
+        object.map { |e| _deep_transform_values_in_object(e, &block) }
+      else
+        yield(object)
+      end
+    end
+
+    def _deep_transform_values_in_object!(object, &block)
+      case object
+      when Hash
+        object.transform_values! { |value| _deep_transform_values_in_object!(value, &block) }
+      when Array
+        object.map! { |e| _deep_transform_values_in_object!(e, &block) }
+      else
+        yield(object)
+      end
+    end
+end

data/lib/active_support/core_ext/hash/except.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 class Hash
   # Returns a hash that includes everything except given keys.
   #   hash = { a: true, b: false, c: nil }
@@ -8,8 +10,8 @@ class Hash
   # This is useful for limiting a set of parameters to everything but a few known toggles:
   #   @person.update(params[:person].except(:admin))
   def except(*keys)
-    dup.except!(*keys)
-  end
+    slice(*self.keys - keys)
+  end unless method_defined?(:except)
 
   # Removes the given keys from hash and returns it.
   #   hash = { a: true, b: false, c: nil }

data/lib/active_support/core_ext/hash/indifferent_access.rb

@@ -1,7 +1,8 @@
-require 'active_support/hash_with_indifferent_access'
+# frozen_string_literal: true
 
-class Hash
+require "active_support/hash_with_indifferent_access"
 
+class Hash
   # Returns an <tt>ActiveSupport::HashWithIndifferentAccess</tt> out of its receiver:
   #
   #   { a: 1 }.with_indifferent_access['a'] # => 1

data/lib/active_support/core_ext/hash/keys.rb

@@ -1,33 +1,6 @@
-class Hash
-  # Returns a new hash with all keys converted using the +block+ operation.
-  #
-  #  hash = { name: 'Rob', age: '28' }
-  #
-  #  hash.transform_keys { |key| key.to_s.upcase } # => {"NAME"=>"Rob", "AGE"=>"28"}
-  #
-  # If you do not provide a +block+, it will return an Enumerator
-  # for chaining with other methods:
-  #
-  #  hash.transform_keys.with_index { |k, i| [k, i].join } # => {"name0"=>"Rob", "age1"=>"28"}
-  def transform_keys
-    return enum_for(:transform_keys) { size } unless block_given?
-    result = {}
-    each_key do |key|
-      result[yield(key)] = self[key]
-    end
-    result
-  end
-
-  # Destructively converts all keys using the +block+ operations.
-  # Same as +transform_keys+ but modifies +self+.
-  def transform_keys!
-    return enum_for(:transform_keys!) { size } unless block_given?
-    keys.each do |key|
-      self[yield(key)] = delete(key)
-    end
-    self
-  end
+# frozen_string_literal: true
 
+class Hash
   # Returns a new hash with all keys converted to strings.
   #
   #   hash = { name: 'Rob', age: '28' }
@@ -52,14 +25,14 @@ class Hash
   #   hash.symbolize_keys
   #   # => {:name=>"Rob", :age=>"28"}
   def symbolize_keys
-    transform_keys{ |key| key.to_sym rescue key }
+    transform_keys { |key| key.to_sym rescue key }
   end
   alias_method :to_options,  :symbolize_keys
 
   # Destructively converts all keys to symbols, as long as they respond
   # to +to_sym+. Same as +symbolize_keys+, but modifies +self+.
   def symbolize_keys!
-    transform_keys!{ |key| key.to_sym rescue key }
+    transform_keys! { |key| key.to_sym rescue key }
   end
   alias_method :to_options!, :symbolize_keys!
 
@@ -128,18 +101,18 @@ class Hash
   #   hash.deep_symbolize_keys
   #   # => {:person=>{:name=>"Rob", :age=>"28"}}
   def deep_symbolize_keys
-    deep_transform_keys{ |key| key.to_sym rescue key }
+    deep_transform_keys { |key| key.to_sym rescue key }
   end
 
   # Destructively converts all keys to symbols, as long as they respond
   # to +to_sym+. This includes the keys from the root hash and from all
   # nested hashes and arrays.
   def deep_symbolize_keys!
-    deep_transform_keys!{ |key| key.to_sym rescue key }
+    deep_transform_keys! { |key| key.to_sym rescue key }
   end
 
   private
-    # support methods for deep transforming nested hashes and arrays
+    # Support methods for deep transforming nested hashes and arrays.
     def _deep_transform_keys_in_object(object, &block)
       case object
       when Hash
@@ -147,7 +120,7 @@ class Hash
           result[yield(key)] = _deep_transform_keys_in_object(value, &block)
         end
       when Array
-        object.map {|e| _deep_transform_keys_in_object(e, &block) }
+        object.map { |e| _deep_transform_keys_in_object(e, &block) }
       else
         object
       end
@@ -162,7 +135,7 @@ class Hash
         end
         object
       when Array
-        object.map! {|e| _deep_transform_keys_in_object!(e, &block)}
+        object.map! { |e| _deep_transform_keys_in_object!(e, &block) }
       else
         object
       end