activesupport 4.2.0 → 5.2.0

data/lib/active_support/number_helper.rb

@@ -1,9 +1,12 @@
+# frozen_string_literal: true
+
 module ActiveSupport
   module NumberHelper
     extend ActiveSupport::Autoload
 
     eager_autoload do
       autoload :NumberConverter
+      autoload :RoundingHelper
       autoload :NumberToRoundedConverter
       autoload :NumberToDelimitedConverter
       autoload :NumberToHumanConverter
@@ -15,7 +18,7 @@ module ActiveSupport
 
     extend self
 
-    # Formats a +number+ into a US phone number (e.g., (555)
+    # Formats a +number+ into a phone number (US by default e.g., (555)
     # 123-9876). You can customize the format in the +options+ hash.
     #
     # ==== Options
@@ -27,19 +30,26 @@ module ActiveSupport
     #   end of the generated number.
     # * <tt>:country_code</tt> - Sets the country code for the phone
     #   number.
+    # * <tt>:pattern</tt> - Specifies how the number is divided into three
+    #   groups with the custom regexp to override the default format.
     # ==== Examples
     #
-    #   number_to_phone(5551234)                                     # => 555-1234
-    #   number_to_phone('5551234')                                   # => 555-1234
-    #   number_to_phone(1235551234)                                  # => 123-555-1234
-    #   number_to_phone(1235551234, area_code: true)                 # => (123) 555-1234
-    #   number_to_phone(1235551234, delimiter: ' ')                  # => 123 555 1234
-    #   number_to_phone(1235551234, area_code: true, extension: 555) # => (123) 555-1234 x 555
-    #   number_to_phone(1235551234, country_code: 1)                 # => +1-123-555-1234
-    #   number_to_phone('123a456')                                   # => 123a456
+    #   number_to_phone(5551234)                                     # => "555-1234"
+    #   number_to_phone('5551234')                                   # => "555-1234"
+    #   number_to_phone(1235551234)                                  # => "123-555-1234"
+    #   number_to_phone(1235551234, area_code: true)                 # => "(123) 555-1234"
+    #   number_to_phone(1235551234, delimiter: ' ')                  # => "123 555 1234"
+    #   number_to_phone(1235551234, area_code: true, extension: 555) # => "(123) 555-1234 x 555"
+    #   number_to_phone(1235551234, country_code: 1)                 # => "+1-123-555-1234"
+    #   number_to_phone('123a456')                                   # => "123a456"
     #
     #   number_to_phone(1235551234, country_code: 1, extension: 1343, delimiter: '.')
-    #   # => +1.123.555.1234 x 1343
+    #   # => "+1.123.555.1234 x 1343"
+    #
+    #   number_to_phone(75561234567, pattern: /(\d{1,4})(\d{4})(\d{4})$/, area_code: true)
+    #   # => "(755) 6123-4567"
+    #   number_to_phone(13312345678, pattern: /(\d{3})(\d{4})(\d{4})$/)
+    #   # => "133-1234-5678"
     def number_to_phone(number, options = {})
       NumberToPhoneConverter.convert(number, options)
     end
@@ -47,6 +57,14 @@ module ActiveSupport
     # Formats a +number+ into a currency string (e.g., $13.65). You
     # can customize the format in the +options+ hash.
     #
+    # The currency unit and number formatting of the current locale will be used
+    # unless otherwise specified in the provided options. No currency conversion
+    # is performed. If the user is given a way to change their locale, they will
+    # also be able to change the relative value of the currency displayed with
+    # this helper. If your application will ever support multiple locales, you
+    # may want to specify a constant <tt>:locale</tt> option or consider
+    # using a library capable of currency conversion.
+    #
     # ==== Options
     #
     # * <tt>:locale</tt> - Sets the locale to be used for formatting
@@ -63,25 +81,25 @@ module ActiveSupport
     #   (defaults to "%u%n").  Fields are <tt>%u</tt> for the
     #   currency, and <tt>%n</tt> for the number.
     # * <tt>:negative_format</tt> - Sets the format for negative
-    #   numbers (defaults to prepending an hyphen to the formatted
+    #   numbers (defaults to prepending a hyphen to the formatted
     #   number given by <tt>:format</tt>).  Accepts the same fields
     #   than <tt>:format</tt>, except <tt>%n</tt> is here the
     #   absolute value of the number.
     #
     # ==== Examples
     #
-    #   number_to_currency(1234567890.50)                # => $1,234,567,890.50
-    #   number_to_currency(1234567890.506)               # => $1,234,567,890.51
-    #   number_to_currency(1234567890.506, precision: 3) # => $1,234,567,890.506
-    #   number_to_currency(1234567890.506, locale: :fr)  # => 1 234 567 890,51 €
-    #   number_to_currency('123a456')                    # => $123a456
+    #   number_to_currency(1234567890.50)                # => "$1,234,567,890.50"
+    #   number_to_currency(1234567890.506)               # => "$1,234,567,890.51"
+    #   number_to_currency(1234567890.506, precision: 3) # => "$1,234,567,890.506"
+    #   number_to_currency(1234567890.506, locale: :fr)  # => "1 234 567 890,51 €"
+    #   number_to_currency('123a456')                    # => "$123a456"
     #
     #   number_to_currency(-1234567890.50, negative_format: '(%u%n)')
-    #   # => ($1,234,567,890.50)
+    #   # => "($1,234,567,890.50)"
     #   number_to_currency(1234567890.50, unit: '&pound;', separator: ',', delimiter: '')
-    #   # => &pound;1234567890,50
+    #   # => "&pound;1234567890,50"
     #   number_to_currency(1234567890.50, unit: '&pound;', separator: ',', delimiter: '', format: '%n %u')
-    #   # => 1234567890,50 &pound;
+    #   # => "1234567890,50 &pound;"
     def number_to_currency(number, options = {})
       NumberToCurrencyConverter.convert(number, options)
     end
@@ -94,9 +112,9 @@ module ActiveSupport
     # * <tt>:locale</tt> - Sets the locale to be used for formatting
     #   (defaults to current locale).
     # * <tt>:precision</tt> - Sets the precision of the number
-    #   (defaults to 3).
-    # * <tt>:significant</tt> - If +true+, precision will be the #
-    #   of significant_digits. If +false+, the # of fractional
+    #   (defaults to 3). Keeps the number's precision if +nil+.
+    # * <tt>:significant</tt> - If +true+, precision will be the number
+    #   of significant_digits. If +false+, the number of fractional
     #   digits (defaults to +false+).
     # * <tt>:separator</tt> - Sets the separator between the
     #   fractional and integer digits (defaults to ".").
@@ -110,14 +128,15 @@ module ActiveSupport
     #
     # ==== Examples
     #
-    #   number_to_percentage(100)                                  # => 100.000%
-    #   number_to_percentage('98')                                 # => 98.000%
-    #   number_to_percentage(100, precision: 0)                    # => 100%
-    #   number_to_percentage(1000, delimiter: '.', separator: ',') # => 1.000,000%
-    #   number_to_percentage(302.24398923423, precision: 5)        # => 302.24399%
-    #   number_to_percentage(1000, locale: :fr)                    # => 1 000,000%
-    #   number_to_percentage('98a')                                # => 98a%
-    #   number_to_percentage(100, format: '%n  %')                 # => 100  %
+    #   number_to_percentage(100)                                  # => "100.000%"
+    #   number_to_percentage('98')                                 # => "98.000%"
+    #   number_to_percentage(100, precision: 0)                    # => "100%"
+    #   number_to_percentage(1000, delimiter: '.', separator: ',') # => "1.000,000%"
+    #   number_to_percentage(302.24398923423, precision: 5)        # => "302.24399%"
+    #   number_to_percentage(1000, locale: :fr)                    # => "1000,000%"
+    #   number_to_percentage(1000, precision: nil)                 # => "1000%"
+    #   number_to_percentage('98a')                                # => "98a%"
+    #   number_to_percentage(100, format: '%n  %')                 # => "100.000  %"
     def number_to_percentage(number, options = {})
       NumberToPercentageConverter.convert(number, options)
     end
@@ -134,19 +153,25 @@ module ActiveSupport
     #   to ",").
     # * <tt>:separator</tt> - Sets the separator between the
     #   fractional and integer digits (defaults to ".").
+    # * <tt>:delimiter_pattern</tt> - Sets a custom regular expression used for
+    #   deriving the placement of delimiter. Helpful when using currency formats
+    #   like INR.
     #
     # ==== Examples
     #
-    #   number_to_delimited(12345678)                    # => 12,345,678
-    #   number_to_delimited('123456')                    # => 123,456
-    #   number_to_delimited(12345678.05)                 # => 12,345,678.05
-    #   number_to_delimited(12345678, delimiter: '.')    # => 12.345.678
-    #   number_to_delimited(12345678, delimiter: ',')    # => 12,345,678
-    #   number_to_delimited(12345678.05, separator: ' ') # => 12,345,678 05
-    #   number_to_delimited(12345678.05, locale: :fr)    # => 12 345 678,05
-    #   number_to_delimited('112a')                      # => 112a
+    #   number_to_delimited(12345678)                    # => "12,345,678"
+    #   number_to_delimited('123456')                    # => "123,456"
+    #   number_to_delimited(12345678.05)                 # => "12,345,678.05"
+    #   number_to_delimited(12345678, delimiter: '.')    # => "12.345.678"
+    #   number_to_delimited(12345678, delimiter: ',')    # => "12,345,678"
+    #   number_to_delimited(12345678.05, separator: ' ') # => "12,345,678 05"
+    #   number_to_delimited(12345678.05, locale: :fr)    # => "12 345 678,05"
+    #   number_to_delimited('112a')                      # => "112a"
     #   number_to_delimited(98765432.98, delimiter: ' ', separator: ',')
-    #   # => 98 765 432,98
+    #                                                    # => "98 765 432,98"
+    #   number_to_delimited("123456.78",
+    #     delimiter_pattern: /(\d+?)(?=(\d\d)+(\d)(?!\d))/)
+    #                                                    # => "1,23,456.78"
     def number_to_delimited(number, options = {})
       NumberToDelimitedConverter.convert(number, options)
     end
@@ -161,9 +186,9 @@ module ActiveSupport
     # * <tt>:locale</tt> - Sets the locale to be used for formatting
     #   (defaults to current locale).
     # * <tt>:precision</tt> - Sets the precision of the number
-    #   (defaults to 3).
-    # * <tt>:significant</tt> - If +true+, precision will be the #
-    #   of significant_digits. If +false+, the # of fractional
+    #   (defaults to 3). Keeps the number's precision if +nil+.
+    # * <tt>:significant</tt> - If +true+, precision will be the number
+    #   of significant_digits. If +false+, the number of fractional
     #   digits (defaults to +false+).
     # * <tt>:separator</tt> - Sets the separator between the
     #   fractional and integer digits (defaults to ".").
@@ -175,21 +200,22 @@ module ActiveSupport
     #
     # ==== Examples
     #
-    #   number_to_rounded(111.2345)                                  # => 111.235
-    #   number_to_rounded(111.2345, precision: 2)                    # => 111.23
-    #   number_to_rounded(13, precision: 5)                          # => 13.00000
-    #   number_to_rounded(389.32314, precision: 0)                   # => 389
-    #   number_to_rounded(111.2345, significant: true)               # => 111
-    #   number_to_rounded(111.2345, precision: 1, significant: true) # => 100
-    #   number_to_rounded(13, precision: 5, significant: true)       # => 13.000
-    #   number_to_rounded(111.234, locale: :fr)                      # => 111,234
+    #   number_to_rounded(111.2345)                                  # => "111.235"
+    #   number_to_rounded(111.2345, precision: 2)                    # => "111.23"
+    #   number_to_rounded(13, precision: 5)                          # => "13.00000"
+    #   number_to_rounded(389.32314, precision: 0)                   # => "389"
+    #   number_to_rounded(111.2345, significant: true)               # => "111"
+    #   number_to_rounded(111.2345, precision: 1, significant: true) # => "100"
+    #   number_to_rounded(13, precision: 5, significant: true)       # => "13.000"
+    #   number_to_rounded(13, precision: nil)                        # => "13"
+    #   number_to_rounded(111.234, locale: :fr)                      # => "111,234"
     #
     #   number_to_rounded(13, precision: 5, significant: true, strip_insignificant_zeros: true)
-    #   # => 13
+    #   # => "13"
     #
-    #   number_to_rounded(389.32314, precision: 4, significant: true) # => 389.3
+    #   number_to_rounded(389.32314, precision: 4, significant: true) # => "389.3"
     #   number_to_rounded(1111.2345, precision: 2, separator: ',', delimiter: '.')
-    #   # => 1.111,23
+    #   # => "1.111,23"
     def number_to_rounded(number, options = {})
       NumberToRoundedConverter.convert(number, options)
     end
@@ -208,8 +234,8 @@ module ActiveSupport
     #   (defaults to current locale).
     # * <tt>:precision</tt> - Sets the precision of the number
     #   (defaults to 3).
-    # * <tt>:significant</tt> - If +true+, precision will be the #
-    #   of significant_digits. If +false+, the # of fractional
+    # * <tt>:significant</tt> - If +true+, precision will be the number
+    #   of significant_digits. If +false+, the number of fractional
     #   digits (defaults to +true+)
     # * <tt>:separator</tt> - Sets the separator between the
     #   fractional and integer digits (defaults to ".").
@@ -218,20 +244,20 @@ module ActiveSupport
     # * <tt>:strip_insignificant_zeros</tt> - If +true+ removes
     #   insignificant zeros after the decimal separator (defaults to
     #   +true+)
-    # * <tt>:prefix</tt> - If +:si+ formats the number using the SI
-    #   prefix (defaults to :binary)
     #
     # ==== Examples
     #
-    #   number_to_human_size(123)                                    # => 123 Bytes
-    #   number_to_human_size(1234)                                   # => 1.21 KB
-    #   number_to_human_size(12345)                                  # => 12.1 KB
-    #   number_to_human_size(1234567)                                # => 1.18 MB
-    #   number_to_human_size(1234567890)                             # => 1.15 GB
-    #   number_to_human_size(1234567890123)                          # => 1.12 TB
-    #   number_to_human_size(1234567, precision: 2)                  # => 1.2 MB
-    #   number_to_human_size(483989, precision: 2)                   # => 470 KB
-    #   number_to_human_size(1234567, precision: 2, separator: ',')  # => 1,2 MB
+    #   number_to_human_size(123)                                    # => "123 Bytes"
+    #   number_to_human_size(1234)                                   # => "1.21 KB"
+    #   number_to_human_size(12345)                                  # => "12.1 KB"
+    #   number_to_human_size(1234567)                                # => "1.18 MB"
+    #   number_to_human_size(1234567890)                             # => "1.15 GB"
+    #   number_to_human_size(1234567890123)                          # => "1.12 TB"
+    #   number_to_human_size(1234567890123456)                       # => "1.1 PB"
+    #   number_to_human_size(1234567890123456789)                    # => "1.07 EB"
+    #   number_to_human_size(1234567, precision: 2)                  # => "1.2 MB"
+    #   number_to_human_size(483989, precision: 2)                   # => "470 KB"
+    #   number_to_human_size(1234567, precision: 2, separator: ',')  # => "1,2 MB"
     #   number_to_human_size(1234567890123, precision: 5)            # => "1.1228 TB"
     #   number_to_human_size(524288000, precision: 5)                # => "500 MB"
     def number_to_human_size(number, options = {})
@@ -258,8 +284,8 @@ module ActiveSupport
     #   (defaults to current locale).
     # * <tt>:precision</tt> - Sets the precision of the number
     #   (defaults to 3).
-    # * <tt>:significant</tt> - If +true+, precision will be the #
-    #   of significant_digits. If +false+, the # of fractional
+    # * <tt>:significant</tt> - If +true+, precision will be the number
+    #   of significant_digits. If +false+, the number of fractional
     #   digits (defaults to +true+)
     # * <tt>:separator</tt> - Sets the separator between the
     #   fractional and integer digits (defaults to ".").

data/lib/active_support/number_helper/number_converter.rb

@@ -1,8 +1,10 @@
-require 'active_support/core_ext/big_decimal/conversions'
-require 'active_support/core_ext/object/blank'
-require 'active_support/core_ext/hash/keys'
-require 'active_support/i18n'
-require 'active_support/core_ext/class/attribute'
+# frozen_string_literal: true
+
+require "active_support/core_ext/big_decimal/conversions"
+require "active_support/core_ext/object/blank"
+require "active_support/core_ext/hash/keys"
+require "active_support/i18n"
+require "active_support/core_ext/class/attribute"
 
 module ActiveSupport
   module NumberHelper
@@ -139,17 +141,17 @@ module ActiveSupport
           @options ||= format_options.merge(opts)
         end
 
-        def format_options #:nodoc:
+        def format_options
           default_format_options.merge!(i18n_format_options)
         end
 
-        def default_format_options #:nodoc:
+        def default_format_options
           options = DEFAULTS[:format].dup
           options.merge!(DEFAULTS[namespace][:format]) if namespace
           options
         end
 
-        def i18n_format_options #:nodoc:
+        def i18n_format_options
           locale = opts[:locale]
           options = I18n.translate(:'number.format', locale: locale, default: {}).dup
 
@@ -160,7 +162,7 @@ module ActiveSupport
           options
         end
 
-        def translate_number_value_with_default(key, i18n_options = {}) #:nodoc:
+        def translate_number_value_with_default(key, i18n_options = {})
           I18n.translate(key, { default: default_value(key), scope: :number }.merge!(i18n_options))
         end
 
@@ -169,10 +171,10 @@ module ActiveSupport
         end
 
         def default_value(key)
-          key.split('.').reduce(DEFAULTS) { |defaults, k| defaults[k.to_sym] }
+          key.split(".").reduce(DEFAULTS) { |defaults, k| defaults[k.to_sym] }
         end
 
-        def valid_float? #:nodoc:
+        def valid_float?
           Float(number)
         rescue ArgumentError, TypeError
           false

data/lib/active_support/number_helper/number_to_currency_converter.rb

@@ -1,3 +1,7 @@
+# frozen_string_literal: true
+
+require "active_support/core_ext/numeric/inquiry"
+
 module ActiveSupport
   module NumberHelper
     class NumberToCurrencyConverter < NumberConverter # :nodoc:
@@ -7,36 +11,32 @@ module ActiveSupport
         number = self.number.to_s.strip
         format = options[:format]
 
-        if is_negative?(number)
+        if number.to_f.negative?
           format = options[:negative_format]
           number = absolute_value(number)
         end
 
         rounded_number = NumberToRoundedConverter.convert(number, options)
-        format.gsub(/%n/, rounded_number).gsub(/%u/, options[:unit])
+        format.gsub("%n".freeze, rounded_number).gsub("%u".freeze, options[:unit])
       end
 
       private
 
-        def is_negative?(number)
-          number.to_f.phase != 0
-        end
-
         def absolute_value(number)
-          number.respond_to?("abs") ? number.abs : number.sub(/\A-/, '')
+          number.respond_to?(:abs) ? number.abs : number.sub(/\A-/, "")
         end
 
         def options
           @options ||= begin
             defaults = default_format_options.merge(i18n_opts)
-            # Override negative format if format options is given
+            # Override negative format if format options are given
             defaults[:negative_format] = "-#{opts[:format]}" if opts[:format]
             defaults.merge!(opts)
           end
         end
 
         def i18n_opts
-          # Set International negative format if not exists
+          # Set International negative format if it does not exist
           i18n = i18n_format_options
           i18n[:negative_format] ||= "-#{i18n[:format]}" if i18n[:format]
           i18n

data/lib/active_support/number_helper/number_to_delimited_converter.rb

@@ -1,9 +1,11 @@
+# frozen_string_literal: true
+
 module ActiveSupport
   module NumberHelper
     class NumberToDelimitedConverter < NumberConverter #:nodoc:
       self.validate_float = true
 
-      DELIMITED_REGEX = /(\d)(?=(\d\d\d)+(?!\d))/
+      DEFAULT_DELIMITER_REGEX = /(\d)(?=(\d\d\d)+(?!\d))/
 
       def convert
         parts.join(options[:separator])
@@ -12,12 +14,16 @@ module ActiveSupport
       private
 
         def parts
-          left, right = number.to_s.split('.')
-          left.gsub!(DELIMITED_REGEX) do |digit_to_delimit|
+          left, right = number.to_s.split(".".freeze)
+          left.gsub!(delimiter_pattern) do |digit_to_delimit|
             "#{digit_to_delimit}#{options[:delimiter]}"
           end
           [left, right].compact
         end
+
+        def delimiter_pattern
+          options.fetch(:delimiter_pattern, DEFAULT_DELIMITER_REGEX)
+        end
     end
   end
 end

data/lib/active_support/number_helper/number_to_human_converter.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module ActiveSupport
   module NumberHelper
     class NumberToHumanConverter < NumberConverter # :nodoc:
@@ -9,6 +11,7 @@ module ActiveSupport
       self.validate_float = true
 
       def convert # :nodoc:
+        @number = RoundingHelper.new(options).round(number)
         @number = Float(number)
 
         # for backwards compatibility with those that didn't add strip_insignificant_zeros to their locale files
@@ -18,27 +21,26 @@ module ActiveSupport
 
         units = opts[:units]
         exponent = calculate_exponent(units)
-        @number = number / (10 ** exponent)
-
-        unit = determine_unit(units, exponent)
+        @number = number / (10**exponent)
 
         rounded_number = NumberToRoundedConverter.convert(number, options)
-        format.gsub(/%n/, rounded_number).gsub(/%u/, unit).strip
+        unit = determine_unit(units, exponent)
+        format.gsub("%n".freeze, rounded_number).gsub("%u".freeze, unit).strip
       end
 
       private
 
         def format
-          options[:format] || translate_in_locale('human.decimal_units.format')
+          options[:format] || translate_in_locale("human.decimal_units.format")
         end
 
         def determine_unit(units, exponent)
           exp = DECIMAL_UNITS[exponent]
           case units
           when Hash
-            units[exp] || ''
+            units[exp] || ""
           when String, Symbol
-            I18n.translate("#{units}.#{exp}", :locale => options[:locale], :count => number.to_i)
+            I18n.translate("#{units}.#{exp}", locale: options[:locale], count: number.to_i)
           else
             translate_in_locale("human.decimal_units.units.#{exp}", count: number.to_i)
           end
@@ -54,12 +56,12 @@ module ActiveSupport
           when Hash
             units
           when String, Symbol
-            I18n.translate(units.to_s, :locale => options[:locale], :raise => true)
+            I18n.translate(units.to_s, locale: options[:locale], raise: true)
           when nil
             translate_in_locale("human.decimal_units.units", raise: true)
           else
             raise ArgumentError, ":units must be a Hash or String translation scope."
-          end.keys.map { |e_name| INVERTED_DECIMAL_UNITS[e_name] }.sort_by { |e| -e }
+          end.keys.map { |e_name| INVERTED_DECIMAL_UNITS[e_name] }.sort_by(&:-@)
         end
     end
   end