activesupport 4.2.0 → 5.0.0.1

data/lib/active_support/core_ext/module/concerning.rb

@@ -63,10 +63,10 @@ class Module
   #
   # == Mix-in noise exiled to its own file:
   #
-  # Once our chunk of behavior starts pushing the scroll-to-understand it's
+  # Once our chunk of behavior starts pushing the scroll-to-understand-it
   # boundary, we give in and move it to a separate file. At this size, the
-  # overhead feels in good proportion to the size of our extraction, despite
-  # diluting our at-a-glance sense of how things really work.
+  # increased overhead can be a reasonable tradeoff even if it reduces our
+  # at-a-glance perception of how things work.
   #
   #   class Todo
   #     # Other todo implementation
@@ -99,7 +99,7 @@ class Module
   #   end
   #
   #   Todo.ancestors
-  #   # => Todo, Todo::EventTracking, Object
+  #   # => [Todo, Todo::EventTracking, Object]
   #
   # This small step has some wonderful ripple effects. We can
   # * grok the behavior of our class in one glance,

data/lib/active_support/core_ext/module/delegation.rb

@@ -5,10 +5,11 @@ class Module
   # option is not used.
   class DelegationError < NoMethodError; end
 
-  RUBY_RESERVED_WORDS = Set.new(
-    %w(alias and BEGIN begin break case class def defined? do else elsif END
-       end ensure false for if in module next nil not or redo rescue retry
-       return self super then true undef unless until when while yield)
+  DELEGATION_RESERVED_METHOD_NAMES = Set.new(
+    %w(_ arg args alias and BEGIN begin block break case class def defined? do
+       else elsif END end ensure false for if in module next nil not or redo
+       rescue retry return self super then true undef unless until when while
+       yield)
   ).freeze
 
   # Provides a +delegate+ class method to easily expose contained objects'
@@ -17,7 +18,7 @@ class Module
   # ==== Options
   # * <tt>:to</tt> - Specifies the target object
   # * <tt>:prefix</tt> - Prefixes the new method with the target name or a custom prefix
-  # * <tt>:allow_nil</tt> - if set to true, prevents a +NoMethodError+ to be raised
+  # * <tt>:allow_nil</tt> - if set to true, prevents a +NoMethodError+ from being raised
   #
   # The macro receives one or more method names (specified as symbols or
   # strings) and the name of the target object via the <tt>:to</tt> option
@@ -148,14 +149,11 @@ class Module
   #
   # The target method must be public, otherwise it will raise +NoMethodError+.
   #
-  def delegate(*methods)
-    options = methods.pop
-    unless options.is_a?(Hash) && to = options[:to]
+  def delegate(*methods, to: nil, prefix: nil, allow_nil: nil)
+    unless to
       raise ArgumentError, 'Delegation needs a target. Supply an options hash with a :to key as the last argument (e.g. delegate :hello, to: :greeter).'
     end
 
-    prefix, allow_nil = options.values_at(:prefix, :allow_nil)
-
     if prefix == true && to =~ /^[^a-z_]/
       raise ArgumentError, 'Can only automatically set the delegation prefix when delegating to a method.'
     end
@@ -167,11 +165,11 @@ class Module
         ''
       end
 
-    file, line = caller.first.split(':', 2)
-    line = line.to_i
+    location = caller_locations(1, 1).first
+    file, line = location.path, location.lineno
 
     to = to.to_s
-    to = "self.#{to}" if RUBY_RESERVED_WORDS.include?(to)
+    to = "self.#{to}" if DELEGATION_RESERVED_METHOD_NAMES.include?(to)
 
     methods.each do |method|
       # Attribute writer methods only accept one argument. Makes sure []=
@@ -185,19 +183,31 @@ class Module
       # On the other hand it could be that the target has side-effects,
       # whereas conceptually, from the user point of view, the delegator should
       # be doing one call.
-
-      exception = %(raise DelegationError, "#{self}##{method_prefix}#{method} delegated to #{to}.#{method}, but #{to} is nil: \#{self.inspect}")
-
-      method_def = [
-        "def #{method_prefix}#{method}(#{definition})",
-        "  _ = #{to}",
-        "  if !_.nil? || nil.respond_to?(:#{method})",
-        "    _.#{method}(#{definition})",
-        "  else",
-        "    #{exception unless allow_nil}",
-        "  end",
+      if allow_nil
+        method_def = [
+          "def #{method_prefix}#{method}(#{definition})",
+          "_ = #{to}",
+          "if !_.nil? || nil.respond_to?(:#{method})",
+          "  _.#{method}(#{definition})",
+          "end",
         "end"
-      ].join ';'
+        ].join ';'
+      else
+        exception = %(raise DelegationError, "#{self}##{method_prefix}#{method} delegated to #{to}.#{method}, but #{to} is nil: \#{self.inspect}")
+
+        method_def = [
+          "def #{method_prefix}#{method}(#{definition})",
+          " _ = #{to}",
+          "  _.#{method}(#{definition})",
+          "rescue NoMethodError => e",
+          "  if _.nil? && e.name == :#{method}",
+          "    #{exception}",
+          "  else",
+          "    raise",
+          "  end",
+          "end"
+        ].join ';'
+      end
 
       module_eval(method_def, file, line)
     end

data/lib/active_support/core_ext/module/deprecation.rb

@@ -13,8 +13,8 @@ class Module
   #
   #   class MyLib::Deprecator
   #     def deprecation_warning(deprecated_method_name, message, caller_backtrace = nil)
-  #        message = "#{deprecated_method_name} is deprecated and will be removed from MyLibrary | #{message}"
-  #        Kernel.warn message
+  #       message = "#{deprecated_method_name} is deprecated and will be removed from MyLibrary | #{message}"
+  #       Kernel.warn message
   #     end
   #   end
   def deprecate(*method_names)

data/lib/active_support/core_ext/module/introspection.rb

@@ -57,6 +57,10 @@ class Module
   end
 
   def local_constants #:nodoc:
+    ActiveSupport::Deprecation.warn(<<-MSG.squish)
+      Module#local_constants is deprecated and will be removed in Rails 5.1.
+      Use Module#constants(false) instead.
+    MSG
     constants(false)
   end
 end

data/lib/active_support/core_ext/module/method_transplanting.rb

@@ -1,11 +1,3 @@
-class Module
-  ###
-  # TODO: remove this after 1.9 support is dropped
-  def methods_transplantable? # :nodoc:
-    x = Module.new { def foo; end }
-    Module.new { define_method :bar, x.instance_method(:foo) }
-    true
-  rescue TypeError
-    false
-  end
-end
+require 'active_support/deprecation'
+
+ActiveSupport::Deprecation.warn("This file is deprecated and will be removed in Rails 5.1 with no replacement.")

data/lib/active_support/core_ext/module/qualified_const.rb

@@ -3,13 +3,16 @@ require 'active_support/core_ext/string/inflections'
 #--
 # Allows code reuse in the methods below without polluting Module.
 #++
-module QualifiedConstUtils
-  def self.raise_if_absolute(path)
-    raise NameError.new("wrong constant name #$&") if path =~ /\A::[^:]+/
-  end
 
-  def self.names(path)
-    path.split('::')
+module ActiveSupport
+  module QualifiedConstUtils
+    def self.raise_if_absolute(path)
+      raise NameError.new("wrong constant name #$&") if path =~ /\A::[^:]+/
+    end
+
+    def self.names(path)
+      path.split('::')
+    end
   end
 end
 
@@ -24,9 +27,14 @@ end
 #++
 class Module
   def qualified_const_defined?(path, search_parents=true)
-    QualifiedConstUtils.raise_if_absolute(path)
+    ActiveSupport::Deprecation.warn(<<-MESSAGE.squish)
+      Module#qualified_const_defined? is deprecated in favour of the builtin
+      Module#const_defined? and will be removed in Rails 5.1.
+    MESSAGE
 
-    QualifiedConstUtils.names(path).inject(self) do |mod, name|
+    ActiveSupport::QualifiedConstUtils.raise_if_absolute(path)
+
+    ActiveSupport::QualifiedConstUtils.names(path).inject(self) do |mod, name|
       return unless mod.const_defined?(name, search_parents)
       mod.const_get(name)
     end
@@ -34,19 +42,29 @@ class Module
   end
 
   def qualified_const_get(path)
-    QualifiedConstUtils.raise_if_absolute(path)
+    ActiveSupport::Deprecation.warn(<<-MESSAGE.squish)
+      Module#qualified_const_get is deprecated in favour of the builtin
+      Module#const_get and will be removed in Rails 5.1.
+    MESSAGE
+
+    ActiveSupport::QualifiedConstUtils.raise_if_absolute(path)
 
-    QualifiedConstUtils.names(path).inject(self) do |mod, name|
+    ActiveSupport::QualifiedConstUtils.names(path).inject(self) do |mod, name|
       mod.const_get(name)
     end
   end
 
   def qualified_const_set(path, value)
-    QualifiedConstUtils.raise_if_absolute(path)
+    ActiveSupport::Deprecation.warn(<<-MESSAGE.squish)
+      Module#qualified_const_set is deprecated in favour of the builtin
+      Module#const_set and will be removed in Rails 5.1.
+    MESSAGE
+
+    ActiveSupport::QualifiedConstUtils.raise_if_absolute(path)
 
     const_name = path.demodulize
     mod_name = path.deconstantize
-    mod = mod_name.empty? ? self : qualified_const_get(mod_name)
+    mod = mod_name.empty? ? self : const_get(mod_name)
     mod.const_set(const_name, value)
   end
 end

data/lib/active_support/core_ext/module/remove_method.rb

@@ -1,12 +1,35 @@
 class Module
+  # Removes the named method, if it exists.
   def remove_possible_method(method)
     if method_defined?(method) || private_method_defined?(method)
       undef_method(method)
     end
   end
 
+  # Removes the named singleton method, if it exists.
+  def remove_possible_singleton_method(method)
+    singleton_class.instance_eval do
+      remove_possible_method(method)
+    end
+  end
+
+  # Replaces the existing method definition, if there is one, with the passed
+  # block as its body.
   def redefine_method(method, &block)
+    visibility = method_visibility(method)
     remove_possible_method(method)
     define_method(method, &block)
+    send(visibility, method)
+  end
+
+  def method_visibility(method) # :nodoc:
+    case
+    when private_method_defined?(method)
+      :private
+    when protected_method_defined?(method)
+      :protected
+    else
+      :public
+    end
   end
 end

data/lib/active_support/core_ext/module.rb

@@ -3,6 +3,7 @@ require 'active_support/core_ext/module/introspection'
 require 'active_support/core_ext/module/anonymous'
 require 'active_support/core_ext/module/reachable'
 require 'active_support/core_ext/module/attribute_accessors'
+require 'active_support/core_ext/module/attribute_accessors_per_thread'
 require 'active_support/core_ext/module/attr_internal'
 require 'active_support/core_ext/module/concerning'
 require 'active_support/core_ext/module/delegation'

data/lib/active_support/core_ext/name_error.rb

@@ -1,5 +1,12 @@
 class NameError
   # Extract the name of the missing constant from the exception message.
+  #
+  #   begin
+  #     HelloWorld
+  #   rescue NameError => e
+  #     e.missing_name
+  #   end
+  #   # => "HelloWorld"
   def missing_name
     if /undefined local variable or method/ !~ message
       $1 if /((::)?([A-Z]\w*)(::[A-Z]\w*)*)$/ =~ message
@@ -7,10 +14,16 @@ class NameError
   end
 
   # Was this exception raised because the given name was missing?
+  #
+  #   begin
+  #     HelloWorld
+  #   rescue NameError => e
+  #     e.missing_name?("HelloWorld")
+  #   end
+  #   # => true
   def missing_name?(name)
     if name.is_a? Symbol
-      last_name = (missing_name || '').split('::').last
-      last_name == name.to_s
+      self.name == name
     else
       missing_name == name.to_s
     end

data/lib/active_support/core_ext/numeric/bytes.rb

@@ -7,36 +7,56 @@ class Numeric
   EXABYTE  = PETABYTE * 1024
 
   # Enables the use of byte calculations and declarations, like 45.bytes + 2.6.megabytes
+  #
+  #   2.bytes # => 2
   def bytes
     self
   end
   alias :byte :bytes
 
+  # Returns the number of bytes equivalent to the kilobytes provided.
+  #
+  #   2.kilobytes # => 2048
   def kilobytes
     self * KILOBYTE
   end
   alias :kilobyte :kilobytes
 
+  # Returns the number of bytes equivalent to the megabytes provided.
+  #
+  #   2.megabytes # => 2_097_152
   def megabytes
     self * MEGABYTE
   end
   alias :megabyte :megabytes
 
+  # Returns the number of bytes equivalent to the gigabytes provided.
+  #
+  #   2.gigabytes # => 2_147_483_648
   def gigabytes
     self * GIGABYTE
   end
   alias :gigabyte :gigabytes
 
+  # Returns the number of bytes equivalent to the terabytes provided.
+  #
+  #   2.terabytes # => 2_199_023_255_552
   def terabytes
     self * TERABYTE
   end
   alias :terabyte :terabytes
 
+  # Returns the number of bytes equivalent to the petabytes provided.
+  #
+  #   2.petabytes # => 2_251_799_813_685_248
   def petabytes
     self * PETABYTE
   end
   alias :petabyte :petabytes
 
+  # Returns the number of bytes equivalent to the exabytes provided.
+  #
+  #   2.exabytes # => 2_305_843_009_213_693_952
   def exabytes
     self * EXABYTE
   end

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

@@ -1,7 +1,8 @@
 require 'active_support/core_ext/big_decimal/conversions'
 require 'active_support/number_helper'
+require 'active_support/core_ext/module/deprecation'
 
-class Numeric
+module ActiveSupport::NumericWithFormat
 
   # Provides options for converting numbers into formatted strings.
   # Options are provided for phone numbers, currency, percentage,
@@ -14,71 +15,73 @@ class Numeric
   # ==== Examples
   #
   #  Phone Numbers:
-  #  5551234.to_s(:phone)                                     # => 555-1234
-  #  1235551234.to_s(:phone)                                  # => 123-555-1234
-  #  1235551234.to_s(:phone, area_code: true)                 # => (123) 555-1234
-  #  1235551234.to_s(:phone, delimiter: ' ')                  # => 123 555 1234
-  #  1235551234.to_s(:phone, area_code: true, extension: 555) # => (123) 555-1234 x 555
-  #  1235551234.to_s(:phone, country_code: 1)                 # => +1-123-555-1234
+  #  5551234.to_s(:phone)                                     # => "555-1234"
+  #  1235551234.to_s(:phone)                                  # => "123-555-1234"
+  #  1235551234.to_s(:phone, area_code: true)                 # => "(123) 555-1234"
+  #  1235551234.to_s(:phone, delimiter: ' ')                  # => "123 555 1234"
+  #  1235551234.to_s(:phone, area_code: true, extension: 555) # => "(123) 555-1234 x 555"
+  #  1235551234.to_s(:phone, country_code: 1)                 # => "+1-123-555-1234"
   #  1235551234.to_s(:phone, country_code: 1, extension: 1343, delimiter: '.')
-  #  # => +1.123.555.1234 x 1343
+  #  # => "+1.123.555.1234 x 1343"
   #
   #  Currency:
-  #  1234567890.50.to_s(:currency)                 # => $1,234,567,890.50
-  #  1234567890.506.to_s(:currency)                # => $1,234,567,890.51
-  #  1234567890.506.to_s(:currency, precision: 3)  # => $1,234,567,890.506
-  #  1234567890.506.to_s(:currency, locale: :fr)   # => 1 234 567 890,51 €
+  #  1234567890.50.to_s(:currency)                 # => "$1,234,567,890.50"
+  #  1234567890.506.to_s(:currency)                # => "$1,234,567,890.51"
+  #  1234567890.506.to_s(:currency, precision: 3)  # => "$1,234,567,890.506"
+  #  1234567890.506.to_s(:currency, locale: :fr)   # => "1 234 567 890,51 €"
   #  -1234567890.50.to_s(:currency, negative_format: '(%u%n)')
-  #  # => ($1,234,567,890.50)
+  #  # => "($1,234,567,890.50)"
   #  1234567890.50.to_s(:currency, unit: '£', separator: ',', delimiter: '')
-  #  # => £1234567890,50
+  #  # => "£1234567890,50"
   #  1234567890.50.to_s(:currency, unit: '£', separator: ',', delimiter: '', format: '%n %u')
-  #  # => 1234567890,50 £
+  #  # => "1234567890,50 £"
   #
   #  Percentage:
-  #  100.to_s(:percentage)                                  # => 100.000%
-  #  100.to_s(:percentage, precision: 0)                    # => 100%
-  #  1000.to_s(:percentage, delimiter: '.', separator: ',') # => 1.000,000%
-  #  302.24398923423.to_s(:percentage, precision: 5)        # => 302.24399%
-  #  1000.to_s(:percentage, locale: :fr)                    # => 1 000,000%
-  #  100.to_s(:percentage, format: '%n  %')                 # => 100  %
+  #  100.to_s(:percentage)                                  # => "100.000%"
+  #  100.to_s(:percentage, precision: 0)                    # => "100%"
+  #  1000.to_s(:percentage, delimiter: '.', separator: ',') # => "1.000,000%"
+  #  302.24398923423.to_s(:percentage, precision: 5)        # => "302.24399%"
+  #  1000.to_s(:percentage, locale: :fr)                    # => "1 000,000%"
+  #  100.to_s(:percentage, format: '%n  %')                 # => "100.000  %"
   #
   #  Delimited:
-  #  12345678.to_s(:delimited)                     # => 12,345,678
-  #  12345678.05.to_s(:delimited)                  # => 12,345,678.05
-  #  12345678.to_s(:delimited, delimiter: '.')     # => 12.345.678
-  #  12345678.to_s(:delimited, delimiter: ',')     # => 12,345,678
-  #  12345678.05.to_s(:delimited, separator: ' ')  # => 12,345,678 05
-  #  12345678.05.to_s(:delimited, locale: :fr)     # => 12 345 678,05
+  #  12345678.to_s(:delimited)                     # => "12,345,678"
+  #  12345678.05.to_s(:delimited)                  # => "12,345,678.05"
+  #  12345678.to_s(:delimited, delimiter: '.')     # => "12.345.678"
+  #  12345678.to_s(:delimited, delimiter: ',')     # => "12,345,678"
+  #  12345678.05.to_s(:delimited, separator: ' ')  # => "12,345,678 05"
+  #  12345678.05.to_s(:delimited, locale: :fr)     # => "12 345 678,05"
   #  98765432.98.to_s(:delimited, delimiter: ' ', separator: ',')
-  #  # => 98 765 432,98
+  #  # => "98 765 432,98"
   #
   #  Rounded:
-  #  111.2345.to_s(:rounded)                                      # => 111.235
-  #  111.2345.to_s(:rounded, precision: 2)                        # => 111.23
-  #  13.to_s(:rounded, precision: 5)                              # => 13.00000
-  #  389.32314.to_s(:rounded, precision: 0)                       # => 389
-  #  111.2345.to_s(:rounded, significant: true)                   # => 111
-  #  111.2345.to_s(:rounded, precision: 1, significant: true)     # => 100
-  #  13.to_s(:rounded, precision: 5, significant: true)           # => 13.000
-  #  111.234.to_s(:rounded, locale: :fr)                          # => 111,234
+  #  111.2345.to_s(:rounded)                                      # => "111.235"
+  #  111.2345.to_s(:rounded, precision: 2)                        # => "111.23"
+  #  13.to_s(:rounded, precision: 5)                              # => "13.00000"
+  #  389.32314.to_s(:rounded, precision: 0)                       # => "389"
+  #  111.2345.to_s(:rounded, significant: true)                   # => "111"
+  #  111.2345.to_s(:rounded, precision: 1, significant: true)     # => "100"
+  #  13.to_s(:rounded, precision: 5, significant: true)           # => "13.000"
+  #  111.234.to_s(:rounded, locale: :fr)                          # => "111,234"
   #  13.to_s(:rounded, precision: 5, significant: true, strip_insignificant_zeros: true)
-  #  # => 13
-  #  389.32314.to_s(:rounded, precision: 4, significant: true)    # => 389.3
+  #  # => "13"
+  #  389.32314.to_s(:rounded, precision: 4, significant: true)    # => "389.3"
   #  1111.2345.to_s(:rounded, precision: 2, separator: ',', delimiter: '.')
-  #  # => 1.111,23
+  #  # => "1.111,23"
   #
   #  Human-friendly size in Bytes:
-  #  123.to_s(:human_size)                                   # => 123 Bytes
-  #  1234.to_s(:human_size)                                  # => 1.21 KB
-  #  12345.to_s(:human_size)                                 # => 12.1 KB
-  #  1234567.to_s(:human_size)                               # => 1.18 MB
-  #  1234567890.to_s(:human_size)                            # => 1.15 GB
-  #  1234567890123.to_s(:human_size)                         # => 1.12 TB
-  #  1234567.to_s(:human_size, precision: 2)                 # => 1.2 MB
-  #  483989.to_s(:human_size, precision: 2)                  # => 470 KB
-  #  1234567.to_s(:human_size, precision: 2, separator: ',') # => 1,2 MB
-  #  1234567890123.to_s(:human_size, precision: 5)           # => "1.1229 TB"
+  #  123.to_s(:human_size)                                   # => "123 Bytes"
+  #  1234.to_s(:human_size)                                  # => "1.21 KB"
+  #  12345.to_s(:human_size)                                 # => "12.1 KB"
+  #  1234567.to_s(:human_size)                               # => "1.18 MB"
+  #  1234567890.to_s(:human_size)                            # => "1.15 GB"
+  #  1234567890123.to_s(:human_size)                         # => "1.12 TB"
+  #  1234567890123456.to_s(:human_size)                      # => "1.1 PB"
+  #  1234567890123456789.to_s(:human_size)                   # => "1.07 EB"
+  #  1234567.to_s(:human_size, precision: 2)                 # => "1.2 MB"
+  #  483989.to_s(:human_size, precision: 2)                  # => "470 KB"
+  #  1234567.to_s(:human_size, precision: 2, separator: ',') # => "1,2 MB"
+  #  1234567890123.to_s(:human_size, precision: 5)           # => "1.1228 TB"
   #  524288000.to_s(:human_size, precision: 5)               # => "500 MB"
   #
   #  Human-friendly format:
@@ -97,7 +100,10 @@ class Numeric
   #  1234567.to_s(:human, precision: 1,
   #                   separator: ',',
   #                   significant: false)                   # => "1,2 Million"
-  def to_formatted_s(format = :default, options = {})
+  def to_s(*args)
+    format, options = args
+    options ||= {}
+
     case format
     when :phone
       return ActiveSupport::NumberHelper.number_to_phone(self, options)
@@ -114,22 +120,26 @@ class Numeric
     when :human_size
       return ActiveSupport::NumberHelper.number_to_human_size(self, options)
     else
-      self.to_default_s
-    end
-  end
-
-  [Float, Fixnum, Bignum, BigDecimal].each do |klass|
-    klass.send(:alias_method, :to_default_s, :to_s)
-
-    klass.send(:define_method, :to_s) do |*args|
-      if args[0].is_a?(Symbol)
-        format = args[0]
-        options = args[1] || {}
-
-        self.to_formatted_s(format, options)
+      if is_a?(Float) || format.is_a?(Symbol)
+        super()
       else
-        to_default_s(*args)
+        super
       end
     end
   end
+
+  def to_formatted_s(*args)
+    to_s(*args)
+  end
+  deprecate to_formatted_s: :to_s
+end
+
+# Ruby 2.4+ unifies Fixnum & Bignum into Integer.
+if Integer == Fixnum
+  Integer.prepend ActiveSupport::NumericWithFormat
+else
+  Fixnum.prepend ActiveSupport::NumericWithFormat
+  Bignum.prepend ActiveSupport::NumericWithFormat
 end
+Float.prepend ActiveSupport::NumericWithFormat
+BigDecimal.prepend ActiveSupport::NumericWithFormat

data/lib/active_support/core_ext/numeric/inquiry.rb

@@ -0,0 +1,26 @@
+unless 1.respond_to?(:positive?) # TODO: Remove this file when we drop support to ruby < 2.3
+class Numeric
+  # Returns true if the number is positive.
+  #
+  #   1.positive?  # => true
+  #   0.positive?  # => false
+  #   -1.positive? # => false
+  def positive?
+    self > 0
+  end
+
+  # Returns true if the number is negative.
+  #
+  #   -1.negative? # => true
+  #   0.negative?  # => false
+  #   1.negative?  # => false
+  def negative?
+    self < 0
+  end
+end
+
+class Complex
+  undef :positive?
+  undef :negative?
+end
+end