activesupport 1.2.4 → 8.1.2

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

@@ -0,0 +1,145 @@
+# frozen_string_literal: true
+
+require "active_support/core_ext/big_decimal/conversions"
+require "active_support/number_helper"
+
+module ActiveSupport
+  module NumericWithFormat
+    # \Numeric With Format
+    #
+    # Provides options for converting numbers into formatted strings.
+    # Options are provided for phone numbers, currency, percentage,
+    # precision, positional notation, file size, and pretty printing.
+    #
+    # This method is aliased to <tt>to_formatted_s</tt>.
+    #
+    # ==== Options
+    #
+    # For details on which formats use which options, see ActiveSupport::NumberHelper
+    #
+    # ==== Examples
+    #
+    #  Phone Numbers:
+    #  5551234.to_fs(:phone)                                     # => "555-1234"
+    #  1235551234.to_fs(:phone)                                  # => "123-555-1234"
+    #  1235551234.to_fs(:phone, area_code: true)                 # => "(123) 555-1234"
+    #  1235551234.to_fs(:phone, delimiter: ' ')                  # => "123 555 1234"
+    #  1235551234.to_fs(:phone, area_code: true, extension: 555) # => "(123) 555-1234 x 555"
+    #  1235551234.to_fs(:phone, country_code: 1)                 # => "+1-123-555-1234"
+    #  1235551234.to_fs(:phone, country_code: 1, extension: 1343, delimiter: '.')
+    #  # => "+1.123.555.1234 x 1343"
+    #
+    #  Currency:
+    #  1234567890.50.to_fs(:currency)                     # => "$1,234,567,890.50"
+    #  1234567890.506.to_fs(:currency)                    # => "$1,234,567,890.51"
+    #  1234567890.506.to_fs(:currency, precision: 3)      # => "$1,234,567,890.506"
+    #  1234567890.506.to_fs(:currency, round_mode: :down) # => "$1,234,567,890.50"
+    #  1234567890.506.to_fs(:currency, locale: :fr)       # => "1 234 567 890,51 €"
+    #  -1234567890.50.to_fs(:currency, negative_format: '(%u%n)')
+    #  # => "($1,234,567,890.50)"
+    #  1234567890.50.to_fs(:currency, unit: '&pound;', separator: ',', delimiter: '')
+    #  # => "&pound;1234567890,50"
+    #  1234567890.50.to_fs(:currency, unit: '&pound;', separator: ',', delimiter: '', format: '%n %u')
+    #  # => "1234567890,50 &pound;"
+    #
+    #  Percentage:
+    #  100.to_fs(:percentage)                                  # => "100.000%"
+    #  100.to_fs(:percentage, precision: 0)                    # => "100%"
+    #  1000.to_fs(:percentage, delimiter: '.', separator: ',') # => "1.000,000%"
+    #  302.24398923423.to_fs(:percentage, precision: 5)        # => "302.24399%"
+    #  302.24398923423.to_fs(:percentage, round_mode: :down)   # => "302.243%"
+    #  1000.to_fs(:percentage, locale: :fr)                    # => "1 000,000%"
+    #  100.to_fs(:percentage, format: '%n  %')                 # => "100.000  %"
+    #
+    #  Delimited:
+    #  12345678.to_fs(:delimited)                     # => "12,345,678"
+    #  12345678.05.to_fs(:delimited)                  # => "12,345,678.05"
+    #  12345678.to_fs(:delimited, delimiter: '.')     # => "12.345.678"
+    #  12345678.to_fs(:delimited, delimiter: ',')     # => "12,345,678"
+    #  12345678.05.to_fs(:delimited, separator: ' ')  # => "12,345,678 05"
+    #  12345678.05.to_fs(:delimited, locale: :fr)     # => "12 345 678,05"
+    #  98765432.98.to_fs(:delimited, delimiter: ' ', separator: ',')
+    #  # => "98 765 432,98"
+    #
+    #  Rounded:
+    #  111.2345.to_fs(:rounded)                                      # => "111.235"
+    #  111.2345.to_fs(:rounded, precision: 2)                        # => "111.23"
+    #  111.2345.to_fs(:rounded, precision: 2, round_mode: :up)       # => "111.24"
+    #  13.to_fs(:rounded, precision: 5)                              # => "13.00000"
+    #  389.32314.to_fs(:rounded, precision: 0)                       # => "389"
+    #  111.2345.to_fs(:rounded, significant: true)                   # => "111"
+    #  111.2345.to_fs(:rounded, precision: 1, significant: true)     # => "100"
+    #  13.to_fs(:rounded, precision: 5, significant: true)           # => "13.000"
+    #  111.234.to_fs(:rounded, locale: :fr)                          # => "111,234"
+    #  13.to_fs(:rounded, precision: 5, significant: true, strip_insignificant_zeros: true)
+    #  # => "13"
+    #  389.32314.to_fs(:rounded, precision: 4, significant: true)    # => "389.3"
+    #  1111.2345.to_fs(:rounded, precision: 2, separator: ',', delimiter: '.')
+    #  # => "1.111,23"
+    #
+    #  Human-friendly size in Bytes:
+    #  123.to_fs(:human_size)                                    # => "123 Bytes"
+    #  1234.to_fs(:human_size)                                   # => "1.21 KB"
+    #  12345.to_fs(:human_size)                                  # => "12.1 KB"
+    #  1234567.to_fs(:human_size)                                # => "1.18 MB"
+    #  1234567890.to_fs(:human_size)                             # => "1.15 GB"
+    #  1234567890123.to_fs(:human_size)                          # => "1.12 TB"
+    #  1234567890123456.to_fs(:human_size)                       # => "1.1 PB"
+    #  1234567890123456789.to_fs(:human_size)                    # => "1.07 EB"
+    #  1234567.to_fs(:human_size, precision: 2)                  # => "1.2 MB"
+    #  1234567.to_fs(:human_size, precision: 2, round_mode: :up) # => "1.3 MB"
+    #  483989.to_fs(:human_size, precision: 2)                   # => "470 KB"
+    #  1234567.to_fs(:human_size, precision: 2, separator: ',')  # => "1,2 MB"
+    #  1234567890123.to_fs(:human_size, precision: 5)            # => "1.1228 TB"
+    #  524288000.to_fs(:human_size, precision: 5)                # => "500 MB"
+    #
+    #  Human-friendly format:
+    #  123.to_fs(:human)                                       # => "123"
+    #  1234.to_fs(:human)                                      # => "1.23 Thousand"
+    #  12345.to_fs(:human)                                     # => "12.3 Thousand"
+    #  1234567.to_fs(:human)                                   # => "1.23 Million"
+    #  1234567890.to_fs(:human)                                # => "1.23 Billion"
+    #  1234567890123.to_fs(:human)                             # => "1.23 Trillion"
+    #  1234567890123456.to_fs(:human)                          # => "1.23 Quadrillion"
+    #  1234567890123456789.to_fs(:human)                       # => "1230 Quadrillion"
+    #  489939.to_fs(:human, precision: 2)                      # => "490 Thousand"
+    #  489939.to_fs(:human, precision: 2, round_mode: :down)   # => "480 Thousand"
+    #  489939.to_fs(:human, precision: 4)                      # => "489.9 Thousand"
+    #  1234567.to_fs(:human, precision: 4,
+    #                   significant: false)                             # => "1.2346 Million"
+    #  1234567.to_fs(:human, precision: 1,
+    #                   separator: ',',
+    #                   significant: false)                             # => "1,2 Million"
+    def to_fs(format = nil, options = nil)
+      return to_s if format.nil?
+
+      case format
+      when Integer, String
+        to_s(format)
+      when :phone
+        ActiveSupport::NumberHelper.number_to_phone(self, options || {})
+      when :currency
+        ActiveSupport::NumberHelper.number_to_currency(self, options || {})
+      when :percentage
+        ActiveSupport::NumberHelper.number_to_percentage(self, options || {})
+      when :delimited
+        ActiveSupport::NumberHelper.number_to_delimited(self, options || {})
+      when :rounded
+        ActiveSupport::NumberHelper.number_to_rounded(self, options || {})
+      when :human
+        ActiveSupport::NumberHelper.number_to_human(self, options || {})
+      when :human_size
+        ActiveSupport::NumberHelper.number_to_human_size(self, options || {})
+      when Symbol
+        to_s
+      else
+        to_s(format)
+      end
+    end
+    alias_method :to_formatted_s, :to_fs
+  end
+end
+
+Integer.include ActiveSupport::NumericWithFormat
+Float.include ActiveSupport::NumericWithFormat
+BigDecimal.include ActiveSupport::NumericWithFormat

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

@@ -1,59 +1,66 @@
-module ActiveSupport #:nodoc:
-  module CoreExtensions #:nodoc:
-    module Numeric #:nodoc:
-      # Enables the use of time calculations and declarations, like 45.minutes + 2.hours + 4.years
-      module Time
-        def minutes
-          self * 60
-        end
-        alias :minute :minutes  
-        
-        def hours
-          self * 60.minutes
-        end
-        alias :hour :hours
-        
-        def days
-          self * 24.hours
-        end
-        alias :day :days
-
-        def weeks
-          self * 7.days
-        end
-        alias :week :weeks
-        
-        def fortnights
-          self * 2.weeks
-        end
-        alias :fortnight :fortnights
-        
-        def months
-          self * 30.days
-        end
-        alias :month :months
-
-        def years
-          (self * 365.25.days).to_i
-        end
-        alias :year :years
-
-        # Reads best without arguments:  10.minutes.ago
-        def ago(time = ::Time.now)
-          time - self
-        end
-
-        # Reads best with argument:  10.minutes.until(time)
-        alias :until :ago
-
-        # Reads best with argument:  10.minutes.since(time)
-        def since(time = ::Time.now)
-          time + self
-        end
-
-        # Reads best without arguments:  10.minutes.from_now
-        alias :from_now :since
-      end
-    end
+# frozen_string_literal: true
+
+require "active_support/duration"
+require "active_support/core_ext/time/calculations"
+require "active_support/core_ext/time/acts_like"
+require "active_support/core_ext/date/calculations"
+require "active_support/core_ext/date/acts_like"
+
+class Numeric
+  # Returns a Duration instance matching the number of seconds provided.
+  #
+  #   2.seconds # => 2 seconds
+  def seconds
+    ActiveSupport::Duration.seconds(self)
+  end
+  alias :second :seconds
+
+  # Returns a Duration instance matching the number of minutes provided.
+  #
+  #   2.minutes # => 2 minutes
+  def minutes
+    ActiveSupport::Duration.minutes(self)
+  end
+  alias :minute :minutes
+
+  # Returns a Duration instance matching the number of hours provided.
+  #
+  #   2.hours # => 2 hours
+  def hours
+    ActiveSupport::Duration.hours(self)
+  end
+  alias :hour :hours
+
+  # Returns a Duration instance matching the number of days provided.
+  #
+  #   2.days # => 2 days
+  def days
+    ActiveSupport::Duration.days(self)
+  end
+  alias :day :days
+
+  # Returns a Duration instance matching the number of weeks provided.
+  #
+  #   2.weeks # => 2 weeks
+  def weeks
+    ActiveSupport::Duration.weeks(self)
+  end
+  alias :week :weeks
+
+  # Returns a Duration instance matching the number of fortnights provided.
+  #
+  #   2.fortnights # => 4 weeks
+  def fortnights
+    ActiveSupport::Duration.weeks(self * 2)
+  end
+  alias :fortnight :fortnights
+
+  # Returns the number of milliseconds equivalent to the seconds provided.
+  # Used with the standard time durations.
+  #
+  #   2.in_milliseconds # => 2000
+  #   1.hour.in_milliseconds # => 3600000
+  def in_milliseconds
+    self * 1000
   end
 end

data/lib/active_support/core_ext/numeric.rb

@@ -1,7 +1,5 @@
-require File.dirname(__FILE__) + '/numeric/time'
-require File.dirname(__FILE__) + '/numeric/bytes'
+# frozen_string_literal: true
 
-class Numeric #:nodoc:
-  include ActiveSupport::CoreExtensions::Numeric::Time 
-  include ActiveSupport::CoreExtensions::Numeric::Bytes 
-end
+require_relative "numeric/bytes"
+require_relative "numeric/time"
+require_relative "numeric/conversions"

data/lib/active_support/core_ext/object/acts_like.rb

@@ -0,0 +1,45 @@
+# frozen_string_literal: true
+
+class Object
+  # Provides a way to check whether some class acts like some other class based on the existence of
+  # an appropriately-named marker method.
+  #
+  # A class that provides the same interface as <tt>SomeClass</tt> may define a marker method named
+  # <tt>acts_like_some_class?</tt> to signal its compatibility to callers of
+  # <tt>acts_like?(:some_class)</tt>.
+  #
+  # For example, Active Support extends <tt>Date</tt> to define an <tt>acts_like_date?</tt> method,
+  # and extends <tt>Time</tt> to define <tt>acts_like_time?</tt>. As a result, developers can call
+  # <tt>x.acts_like?(:time)</tt> and <tt>x.acts_like?(:date)</tt> to test duck-type compatibility,
+  # and classes that are able to act like <tt>Time</tt> can also define an <tt>acts_like_time?</tt>
+  # method to interoperate.
+  #
+  # Note that the marker method is only expected to exist. It isn't called, so its body or return
+  # value are irrelevant.
+  #
+  # ==== Example: A class that provides the same interface as <tt>String</tt>
+  #
+  # This class may define:
+  #
+  #   class Stringish
+  #     def acts_like_string?
+  #     end
+  #   end
+  #
+  # Then client code can query for duck-type-safeness this way:
+  #
+  #   Stringish.new.acts_like?(:string) # => true
+  #
+  def acts_like?(duck)
+    case duck
+    when :time
+      respond_to? :acts_like_time?
+    when :date
+      respond_to? :acts_like_date?
+    when :string
+      respond_to? :acts_like_string?
+    else
+      respond_to? :"acts_like_#{duck}?"
+    end
+  end
+end

data/lib/active_support/core_ext/object/blank.rb

@@ -0,0 +1,199 @@
+# frozen_string_literal: true
+
+require "concurrent/map"
+
+class Object
+  # An object is blank if it's false, empty, or a whitespace string.
+  # For example, +nil+, '', '   ', [], {}, and +false+ are all blank.
+  #
+  # This simplifies
+  #
+  #   !address || address.empty?
+  #
+  # to
+  #
+  #   address.blank?
+  #
+  # @return [true, false]
+  def blank?
+    respond_to?(:empty?) ? !!empty? : false
+  end
+
+  # An object is present if it's not blank.
+  #
+  # @return [true, false]
+  def present?
+    !blank?
+  end
+
+  # Returns the receiver if it's present otherwise returns +nil+.
+  # <tt>object.presence</tt> is equivalent to
+  #
+  #    object.present? ? object : nil
+  #
+  # For example, something like
+  #
+  #   state   = params[:state]   if params[:state].present?
+  #   country = params[:country] if params[:country].present?
+  #   region  = state || country || 'US'
+  #
+  # becomes
+  #
+  #   region = params[:state].presence || params[:country].presence || 'US'
+  #
+  # @return [Object]
+  def presence
+    self if present?
+  end
+end
+
+class NilClass
+  # +nil+ is blank:
+  #
+  #   nil.blank? # => true
+  #
+  # @return [true]
+  def blank?
+    true
+  end
+
+  def present? # :nodoc:
+    false
+  end
+end
+
+class FalseClass
+  # +false+ is blank:
+  #
+  #   false.blank? # => true
+  #
+  # @return [true]
+  def blank?
+    true
+  end
+
+  def present? # :nodoc:
+    false
+  end
+end
+
+class TrueClass
+  # +true+ is not blank:
+  #
+  #   true.blank? # => false
+  #
+  # @return [false]
+  def blank?
+    false
+  end
+
+  def present? # :nodoc:
+    true
+  end
+end
+
+class Array
+  # An array is blank if it's empty:
+  #
+  #   [].blank?      # => true
+  #   [1,2,3].blank? # => false
+  #
+  # @return [true, false]
+  alias_method :blank?, :empty?
+
+  def present? # :nodoc:
+    !empty?
+  end
+end
+
+class Hash
+  # A hash is blank if it's empty:
+  #
+  #   {}.blank?                # => true
+  #   { key: 'value' }.blank?  # => false
+  #
+  # @return [true, false]
+  alias_method :blank?, :empty?
+
+  def present? # :nodoc:
+    !empty?
+  end
+end
+
+class Symbol
+  # A Symbol is blank if it's empty:
+  #
+  #   :''.blank?     # => true
+  #   :symbol.blank? # => false
+  alias_method :blank?, :empty?
+
+  def present? # :nodoc:
+    !empty?
+  end
+end
+
+class String
+  BLANK_RE = /\A[[:space:]]*\z/
+  ENCODED_BLANKS = Concurrent::Map.new do |h, enc|
+    h[enc] = Regexp.new(BLANK_RE.source.encode(enc), BLANK_RE.options | Regexp::FIXEDENCODING)
+  end
+
+  # A string is blank if it's empty or contains whitespaces only:
+  #
+  #   ''.blank?       # => true
+  #   '   '.blank?    # => true
+  #   "\t\n\r".blank? # => true
+  #   ' blah '.blank? # => false
+  #
+  # Unicode whitespace is supported:
+  #
+  #   "\u00a0".blank? # => true
+  #
+  # @return [true, false]
+  def blank?
+    # The regexp that matches blank strings is expensive. For the case of empty
+    # strings we can speed up this method (~3.5x) with an empty? call. The
+    # penalty for the rest of strings is marginal.
+    empty? ||
+      begin
+        BLANK_RE.match?(self)
+      rescue Encoding::CompatibilityError
+        ENCODED_BLANKS[self.encoding].match?(self)
+      end
+  end
+
+  def present? # :nodoc:
+    !blank?
+  end
+end
+
+class Numeric # :nodoc:
+  # No number is blank:
+  #
+  #   1.blank? # => false
+  #   0.blank? # => false
+  #
+  # @return [false]
+  def blank?
+    false
+  end
+
+  def present?
+    true
+  end
+end
+
+class Time # :nodoc:
+  # No Time is blank:
+  #
+  #   Time.now.blank? # => false
+  #
+  # @return [false]
+  def blank?
+    false
+  end
+
+  def present?
+    true
+  end
+end

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

@@ -0,0 +1,6 @@
+# frozen_string_literal: true
+
+require "active_support/core_ext/object/to_param"
+require "active_support/core_ext/object/to_query"
+require "active_support/core_ext/array/conversions"
+require "active_support/core_ext/hash/conversions"

data/lib/active_support/core_ext/object/deep_dup.rb

@@ -0,0 +1,71 @@
+# frozen_string_literal: true
+
+require "active_support/core_ext/object/duplicable"
+
+class Object
+  # Returns a deep copy of object if it's duplicable. If it's
+  # not duplicable, returns +self+.
+  #
+  #   object = Object.new
+  #   dup    = object.deep_dup
+  #   dup.instance_variable_set(:@a, 1)
+  #
+  #   object.instance_variable_defined?(:@a) # => false
+  #   dup.instance_variable_defined?(:@a)    # => true
+  def deep_dup
+    duplicable? ? dup : self
+  end
+end
+
+class Array
+  # Returns a deep copy of array.
+  #
+  #   array = [1, [2, 3]]
+  #   dup   = array.deep_dup
+  #   dup[1][2] = 4
+  #
+  #   array[1][2] # => nil
+  #   dup[1][2]   # => 4
+  def deep_dup
+    map(&:deep_dup)
+  end
+end
+
+class Hash
+  # Returns a deep copy of hash.
+  #
+  #   hash = { a: { b: 'b' } }
+  #   dup  = hash.deep_dup
+  #   dup[:a][:c] = 'c'
+  #
+  #   hash[:a][:c] # => nil
+  #   dup[:a][:c]  # => "c"
+  def deep_dup
+    hash = dup
+    each_pair do |key, value|
+      if ::String === key || ::Symbol === key
+        hash[key] = value.deep_dup
+      else
+        hash.delete(key)
+        hash[key.deep_dup] = value.deep_dup
+      end
+    end
+    hash
+  end
+end
+
+class Module
+  # Returns a copy of module or class if it's anonymous. If it's
+  # named, returns +self+.
+  #
+  #   Object.deep_dup == Object # => true
+  #   klass = Class.new
+  #   klass.deep_dup == klass # => false
+  def deep_dup
+    if name.nil?
+      super
+    else
+      self
+    end
+  end
+end

data/lib/active_support/core_ext/object/duplicable.rb

@@ -0,0 +1,69 @@
+# frozen_string_literal: true
+
+#--
+# Most objects are cloneable, but not all. For example you can't dup methods:
+#
+#   method(:puts).dup # => TypeError: allocator undefined for Method
+#
+# Classes may signal their instances are not duplicable removing +dup+/+clone+
+# or raising exceptions from them. So, to dup an arbitrary object you normally
+# use an optimistic approach and are ready to catch an exception, say:
+#
+#   arbitrary_object.dup rescue object
+#
+# Rails dups objects in a few critical spots where they are not that arbitrary.
+# That rescue is very expensive (like 40 times slower than a predicate), and it
+# is often triggered.
+#
+# That's why we hardcode the following cases and check duplicable? instead of
+# using that rescue idiom.
+#++
+class Object
+  # Can you safely dup this object?
+  #
+  # False for method objects;
+  # true otherwise.
+  def duplicable?
+    true
+  end
+end
+
+methods_are_duplicable = begin
+  Object.instance_method(:duplicable?).dup
+  true
+rescue TypeError
+  false
+end
+
+unless methods_are_duplicable
+  class Method
+    # Methods are not duplicable:
+    #
+    #   method(:puts).duplicable? # => false
+    #   method(:puts).dup         # => TypeError: allocator undefined for Method
+    def duplicable?
+      false
+    end
+  end
+
+  class UnboundMethod
+    # Unbound methods are not duplicable:
+    #
+    #   method(:puts).unbind.duplicable? # => false
+    #   method(:puts).unbind.dup         # => TypeError: allocator undefined for UnboundMethod
+    def duplicable?
+      false
+    end
+  end
+end
+
+require "singleton"
+
+module Singleton
+  # Singleton instances are not duplicable:
+  #
+  #   Class.new.include(Singleton).instance.dup # TypeError (can't dup instance of singleton
+  def duplicable?
+    false
+  end
+end