Module ActionView::Helpers::NumberHelper
In: vendor/rails/actionpack/lib/action_view/helpers/number_helper.rb

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

Methods

Public Instance methods

Formats a number into a currency string (e.g., $13.65). You can customize the format in the options hash.

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 ",").

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

[Source]

    # File vendor/rails/actionpack/lib/action_view/helpers/number_helper.rb, line 65
65:       def number_to_currency(number, options = {})
66:         options   = options.stringify_keys
67:         precision = options["precision"] || 2
68:         unit      = options["unit"] || "$"
69:         separator = precision > 0 ? options["separator"] || "." : ""
70:         delimiter = options["delimiter"] || ","
71: 
72:         begin
73:           parts = number_with_precision(number, precision).split('.')
74:           unit + number_with_delimiter(parts[0], delimiter) + separator + parts[1].to_s
75:         rescue
76:           number
77:         end
78:       end

Formats the bytes in size into 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 size cannot be converted into a number. You can change the default precision of 1 using the precision parameter precision.

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, 2)    # => 1.18 MB
 number_to_human_size(483989, 0)     # => 4 MB

[Source]

     # File vendor/rails/actionpack/lib/action_view/helpers/number_helper.rb, line 164
164:       def number_to_human_size(size, precision=1)
165:         size = Kernel.Float(size)
166:         case
167:           when size.to_i == 1;    "1 Byte"
168:           when size < 1.kilobyte; "%d Bytes" % size
169:           when size < 1.megabyte; "%.#{precision}f KB"  % (size / 1.0.kilobyte)
170:           when size < 1.gigabyte; "%.#{precision}f MB"  % (size / 1.0.megabyte)
171:           when size < 1.terabyte; "%.#{precision}f GB"  % (size / 1.0.gigabyte)
172:           else                    "%.#{precision}f TB"  % (size / 1.0.terabyte)
173:         end.sub(/([0-9])\.?0+ /, '\1 ' )
174:       rescue
175:         nil
176:       end

Formats a number as a percentage string (e.g., 65%). You can customize the format in the options hash.

Options

  • :precision - Sets the level of precision (defaults to 3).
  • :separator - Sets the separator between the units (defaults to ".").

Examples

 number_to_percentage(100)                         # => 100.000%
 number_to_percentage(100, :precision => 0)        # => 100%

 number_to_percentage(302.24398923423, :precision => 5)
 # => 302.24399%

[Source]

     # File vendor/rails/actionpack/lib/action_view/helpers/number_helper.rb, line 93
 93:       def number_to_percentage(number, options = {})
 94:         options   = options.stringify_keys
 95:         precision = options["precision"] || 3
 96:         separator = options["separator"] || "."
 97: 
 98:         begin
 99:           number = number_with_precision(number, precision)
100:           parts = number.split('.')
101:           if parts.at(1).nil?
102:             parts[0] + "%"
103:           else
104:             parts[0] + separator + parts[1].to_s + "%"
105:           end
106:         rescue
107:           number
108:         end
109:       end

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

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(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

[Source]

    # File vendor/rails/actionpack/lib/action_view/helpers/number_helper.rb, line 26
26:       def number_to_phone(number, options = {})
27:         number       = number.to_s.strip unless number.nil?
28:         options      = options.stringify_keys
29:         area_code    = options["area_code"] || nil
30:         delimiter    = options["delimiter"] || "-"
31:         extension    = options["extension"].to_s.strip || nil
32:         country_code = options["country_code"] || nil
33: 
34:         begin
35:           str = ""
36:           str << "+#{country_code}#{delimiter}" unless country_code.blank?
37:           str << if area_code
38:             number.gsub!(/([0-9]{1,3})([0-9]{3})([0-9]{4}$)/,"(\\1) \\2#{delimiter}\\3")
39:           else
40:             number.gsub!(/([0-9]{1,3})([0-9]{3})([0-9]{4})$/,"\\1#{delimiter}\\2#{delimiter}\\3")
41:           end
42:           str << " x #{extension}" unless extension.blank?
43:           str
44:         rescue
45:           number
46:         end
47:       end

Formats a number with grouped thousands using delimiter (e.g., 12,324). You can customize the format using optional delimiter and separator parameters.

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, ".")  # => 12.345.678

 number_with_delimiter(98765432.98, " ", ",")
 # => 98 765 432,98

[Source]

     # File vendor/rails/actionpack/lib/action_view/helpers/number_helper.rb, line 125
125:       def number_with_delimiter(number, delimiter=",", separator=".")
126:         begin
127:           parts = number.to_s.split('.')
128:           parts[0].gsub!(/(\d)(?=(\d\d\d)+(?!\d))/, "\\1#{delimiter}")
129:           parts.join separator
130:         rescue
131:           number
132:         end
133:       end

Formats a number with the specified level of precision (e.g., 112.32 has a precision of 2). The default level of precision is 3.

Examples

 number_with_precision(111.2345)     # => 111.235
 number_with_precision(111.2345, 2)  # => 111.24
 number_with_precision(13, 5)        # => 13.00000
 number_with_precision(389.32314, 0) # => 389

[Source]

     # File vendor/rails/actionpack/lib/action_view/helpers/number_helper.rb, line 143
143:       def number_with_precision(number, precision=3)
144:         "%01.#{precision}f" % number
145:       rescue
146:         number
147:       end

[Validate]