module ActiveSupport::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 to_formatted_s.

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: '£', separator: ',', delimiter: '')
# => "£1234567890,50"
1234567890.50.to_fs(:currency, unit: '£', separator: ',', delimiter: '', format: '%n %u')
# => "1234567890,50 £"

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"