Provides methods for converting numbers into formatted strings. Methods are provided for phone numbers, currency, percentage, precision, positional notation, and file size.

Methods
N
Constants
STORAGE_UNITS = [:byte, :kb, :mb, :gb, :tb].freeze
 
Instance Public methods
number_to_currency(number, options = {})

Formats a numberinto a currency string (e.g., $13.65). You can customize the format in the optionshash.

Options

  • :precision- Sets the level of precision (defaults to 2).

  • :unit- Sets the denomination of the currency (defaults to “$”).

  • :separator- Sets the separator between the units (defaults to “.”).

  • :delimiter- Sets the thousands delimiter (defaults to “,”).

  • :format- Sets the format of the output string (defaults to “%u%n”). The field types are:

    %u  The currency unit
    %n  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.50, :unit => "£", :separator => ",", :delimiter => "")
# => £1234567890,50
number_to_currency(1234567890.50, :unit => "£", :separator => ",", :delimiter => "", :format => "%n %u")
# => 1234567890,50 £
# File actionpack/lib/action_view/helpers/number_helper.rb, line 73
def number_to_currency(number, options = {})
  options.symbolize_keys!
  defaults  = I18n.translate(:'number.format', :locale => options[:locale], :raise => true) rescue {}
  currency  = I18n.translate(:'number.currency.format', :locale => options[:locale], :raise => true) rescue {}
  defaults  = defaults.merge(currency)
  precision = options[:precision] || defaults[:precision]
  unit      = options[:unit]      || defaults[:unit]
  separator = options[:separator] || defaults[:separator]
  delimiter = options[:delimiter] || defaults[:delimiter]
  format    = options[:format]    || defaults[:format]
  separator = '' if precision == 0
  begin
    format.gsub(/%n/, number_with_precision(number,
      :precision => precision,
      :delimiter => delimiter,
      :separator => separator)
    ).gsub(/%u/, unit).html_safe
  rescue
    number
  end
end
number_to_human_size(number, *args)

Formats the bytes in sizeinto a more understandable representation (e.g., giving it 1500 yields 1.5 KB). This method is useful for reporting file sizes to users. This method returns nil if sizecannot be converted into a number. You can customize the format in the optionshash.

Options

  • :precision- Sets the level of precision (defaults to 1).

  • :separator- Sets the separator between the units (defaults to “.”).

  • :delimiter- Sets the thousands delimiter (defaults to “”).

Examples

number_to_human_size(123)                                          # => 123 Bytes
number_to_human_size(1234)                                         # => 1.2 KB
number_to_human_size(12345)                                        # => 12.1 KB
number_to_human_size(1234567)                                      # => 1.2 MB
number_to_human_size(1234567890)                                   # => 1.1 GB
number_to_human_size(1234567890123)                                # => 1.1 TB
number_to_human_size(1234567, :precision => 2)                     # => 1.18 MB
number_to_human_size(483989, :precision => 0)                      # => 473 KB
number_to_human_size(1234567, :precision => 2, :separator => ',')  # => 1,18 MB

Zeros after the decimal point are always stripped out, regardless of the specified precision:

helper.number_to_human_size(1234567890123, :precision => 5)        # => "1.12283 TB"
helper.number_to_human_size(524288000, :precision=>5)              # => "500 MB"

You can still use number_to_human_sizewith the old API that accepts the precisionas its optional second parameter:

number_to_human_size(1234567, 2)    # => 1.18 MB
number_to_human_size(483989, 0)     # => 473 KB
# File actionpack/lib/action_view/helpers/number_helper.rb, line 258
def number_to_human_size(number, *args)
  return nil if number.nil?
  options = args.extract_options!
  options.symbolize_keys!
  defaults = I18n.translate(:'number.format', :locale => options[:locale], :raise => true) rescue {}
  human    = I18n.translate(:'number.human.format', :locale => options[:locale], :raise => true) rescue {}
  defaults = defaults.merge(human)
  unless args.empty?
    ActiveSupport::Deprecation.warn('number_to_human_size takes an option hash ' +
      'instead of a separate precision argument.', caller)
    precision = args[0] || defaults[:precision]
  end
  precision ||= (options[:precision] || defaults[:precision])
  separator ||= (options[:separator] || defaults[:separator])
  delimiter ||= (options[:delimiter] || defaults[:delimiter])
  storage_units_format = I18n.translate(:'number.human.storage_units.format', :locale => options[:locale], :raise => true)
  if number.to_i < 1024
    unit = I18n.translate(:'number.human.storage_units.units.byte', :locale => options[:locale], :count => number.to_i, :raise => true)
    storage_units_format.gsub(/%n/, number.to_i.to_s).gsub(/%u/, unit)
  else
    max_exp  = STORAGE_UNITS.size - 1
    number   = Float(number)
    exponent = (Math.log(number) / Math.log(1024)).to_i # Convert to base 1024
    exponent = max_exp if exponent > max_exp # we need this to avoid overflow for the highest unit
    number  /= 1024 ** exponent
    unit_key = STORAGE_UNITS[exponent]
    unit = I18n.translate(:"number.human.storage_units.units.#{unit_key}", :locale => options[:locale], :count => number, :raise => true)
    begin
      escaped_separator = Regexp.escape(separator)
      formatted_number = number_with_precision(number,
        :precision => precision,
        :separator => separator,
        :delimiter => delimiter
      ).sub(/(#{escaped_separator})(\d*[1-9])?0+\z/, '\1\2').sub(/#{escaped_separator}\z/, '')
      storage_units_format.gsub(/%n/, formatted_number).gsub(/%u/, unit)
    rescue
      number
    end
  end
end
number_to_percentage(number, options = {})

Formats a numberas a percentage string (e.g., 65%). You can customize the format in the optionshash.

Options

  • :precision- Sets the level of precision (defaults to 3).

  • :separator- Sets the separator between the units (defaults to “.”).

  • :delimiter- Sets the thousands delimiter (defaults to “”).

Examples

number_to_percentage(100)                                        # => 100.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%
# File actionpack/lib/action_view/helpers/number_helper.rb, line 111
def number_to_percentage(number, options = {})
  options.symbolize_keys!
  defaults   = I18n.translate(:'number.format', :locale => options[:locale], :raise => true) rescue {}
  percentage = I18n.translate(:'number.percentage.format', :locale => options[:locale], :raise => true) rescue {}
  defaults  = defaults.merge(percentage)
  precision = options[:precision] || defaults[:precision]
  separator = options[:separator] || defaults[:separator]
  delimiter = options[:delimiter] || defaults[:delimiter]
  begin
    number_with_precision(number,
      :precision => precision,
      :separator => separator,
      :delimiter => delimiter) + "%"
  rescue
    number
  end
end
number_to_phone(number, options = {})

Formats a numberinto a US phone number (e.g., (555) 123-9876). You can customize the format in the optionshash.

Options

  • :area_code- Adds parentheses around the area code.

  • :delimiter- Specifies the delimiter to use (defaults to “-”).

  • :extension- Specifies an extension to add to the end of the generated number.

  • :country_code- Sets the country code for the phone number.

Examples

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(1235551234, :country_code => 1, :extension => 1343, :delimiter => ".")
=> +1.123.555.1234 x 1343
# File actionpack/lib/action_view/helpers/number_helper.rb, line 27
def number_to_phone(number, options = {})
  number       = number.to_s.strip unless number.nil?
  options      = options.symbolize_keys
  area_code    = options[:area_code] || nil
  delimiter    = options[:delimiter] || "-"
  extension    = options[:extension].to_s.strip || nil
  country_code = options[:country_code] || nil
  begin
    str = ""
    str << "+#{country_code}#{delimiter}" unless country_code.blank?
    str << if area_code
      number.gsub!(/([0-9]{1,3})([0-9]{3})([0-9]{4}$)/,"(\\1) \\2#{delimiter}\\3")
    else
      number.gsub!(/([0-9]{0,3})([0-9]{3})([0-9]{4})$/,"\\1#{delimiter}\\2#{delimiter}\\3")
      number.starts_with?('-') ? number.slice!(1..-1) : number
    end
    str << " x #{extension}" unless extension.blank?
    str
  rescue
    number
  end
end
number_with_delimiter(number, *args)

Formats a numberwith grouped thousands using delimiter(e.g., 12,324). You can customize the format in the optionshash.

Options

  • :delimiter- Sets the thousands delimiter (defaults to “,”).

  • :separator- Sets the separator between the units (defaults to “.”).

Examples

number_with_delimiter(12345678)                        # => 12,345,678
number_with_delimiter(12345678.05)                     # => 12,345,678.05
number_with_delimiter(12345678, :delimiter => ".")     # => 12.345.678
number_with_delimiter(12345678, :separator => ",")     # => 12,345,678
number_with_delimiter(98765432.98, :delimiter => " ", :separator => ",")
# => 98 765 432,98

You can still use number_with_delimiterwith the old API that accepts the delimiteras its optional second and the separatoras its optional third parameter:

number_with_delimiter(12345678, " ")                     # => 12 345.678
number_with_delimiter(12345678.05, ".", ",")             # => 12.345.678,05
# File actionpack/lib/action_view/helpers/number_helper.rb, line 152
def number_with_delimiter(number, *args)
  options = args.extract_options!
  options.symbolize_keys!
  defaults = I18n.translate(:'number.format', :locale => options[:locale], :raise => true) rescue {}
  unless args.empty?
    ActiveSupport::Deprecation.warn('number_with_delimiter takes an option hash ' +
      'instead of separate delimiter and precision arguments.', caller)
    delimiter = args[0] || defaults[:delimiter]
    separator = args[1] || defaults[:separator]
  end
  delimiter ||= (options[:delimiter] || defaults[:delimiter])
  separator ||= (options[:separator] || defaults[:separator])
  begin
    parts = number.to_s.split('.')
    parts[0].gsub!(/(\d)(?=(\d\d\d)+(?!\d))/, "\\1#{delimiter}")
    parts.join(separator)
  rescue
    number
  end
end
number_with_precision(number, *args)

Formats a numberwith the specified level of :precision(e.g., 112.32 has a precision of 2). You can customize the format in the optionshash.

Options

  • :precision- Sets the level of precision (defaults to 3).

  • :separator- Sets the separator between the units (defaults to “.”).

  • :delimiter- Sets the thousands delimiter (defaults to “”).

Examples

number_with_precision(111.2345)                    # => 111.235
number_with_precision(111.2345, :precision => 2)   # => 111.23
number_with_precision(13, :precision => 5)         # => 13.00000
number_with_precision(389.32314, :precision => 0)  # => 389
number_with_precision(1111.2345, :precision => 2, :separator => ',', :delimiter => '.')
# => 1.111,23

You can still use number_with_precisionwith the old API that accepts the precisionas its optional second parameter:

number_with_precision(number_with_precision(111.2345, 2)   # => 111.23
# File actionpack/lib/action_view/helpers/number_helper.rb, line 196
def number_with_precision(number, *args)
  options = args.extract_options!
  options.symbolize_keys!
  defaults           = I18n.translate(:'number.format', :locale => options[:locale], :raise => true) rescue {}
  precision_defaults = I18n.translate(:'number.precision.format', :locale => options[:locale],
                                                                  :raise => true) rescue {}
  defaults           = defaults.merge(precision_defaults)
  unless args.empty?
    ActiveSupport::Deprecation.warn('number_with_precision takes an option hash ' +
      'instead of a separate precision argument.', caller)
    precision = args[0] || defaults[:precision]
  end
  precision ||= (options[:precision] || defaults[:precision])
  separator ||= (options[:separator] || defaults[:separator])
  delimiter ||= (options[:delimiter] || defaults[:delimiter])
  begin
    rounded_number = (Float(number) * (10 ** precision)).round.to_f / 10 ** precision
    number_with_delimiter("%01.#{precision}f" % rounded_number,
      :separator => separator,
      :delimiter => delimiter)
  rescue
    number
  end
end