W3cubDocs

/Padrino

Module: Padrino::Helpers::NumberHelpers

Overview

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

Adapted from Rails Number Helpers.

Constant Summary

STORAGE_UNITS =

The units available for storage formatting.

[:byte, :kb, :mb, :gb, :tb].freeze

Instance Method Summary

Instance Method Details

#number_to_currency(number, options = {}) ⇒ String

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

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 £

Parameters:

  • number (Float) — Currency value to format.
  • options (Hash) (defaults to: {}) — Options for currency conversion.

Options Hash (options):

  • :precision (Fixnum) — default: 2 — Sets the level of precision.
  • :unit (String) — default: "$" — Sets the denomination of the currency.
  • :separator (String) — default: "." — Sets the separator between the units.
  • :delimiter (String) — default: "," — Sets the thousands delimiter.
  • :format (String) — default: "%u%n" — Sets the format of the output string. The field types are:
    %u  The currency unit
    %n  The number

Returns:

  • (String) — The formatted representation of the currency.

#number_to_human_size(number, options = {}) ⇒ String

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 customize the format in the options hash.

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

Parameters:

  • number (Fixnum) — Number value to format.
  • options (Hash) (defaults to: {}) — Options for formatter.

Options Hash (options):

  • :precision (Fixnum) — default: 1 — Sets the level of precision.
  • :separator (String) — default: "." — Sets the separator between the units.
  • :delimiter (String) — default: "" — Sets the thousands delimiter.

Returns:

  • (String) — The formatted representation of bytes

#number_to_percentage(number, options = {}) ⇒ String

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

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%

Parameters:

  • number (Fixnum, Float) — Percentage value to format.
  • options (Hash) (defaults to: {}) — Options for percentage conversion.

Options Hash (options):

  • :precision (Fixnum) — default: 3 — Sets the level of precision.
  • :separator (String) — default: "." — Sets the separator between the units.
  • :delimiter (String) — default: "" — Sets the thousands delimiter.

Returns:

  • (String) — The formatted representation of the percentage

#number_with_delimiter(number, options = {}) ⇒ String

Formats a number with grouped thousands using delimiter (e.g., 12,324). You can customize the format in the options hash.

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

Parameters:

  • number (Fixnum, Float) — Number value to format.
  • options (Hash) (defaults to: {}) — Options for formatter.

Options Hash (options):

  • :delimiter (String) — default: ", " — Sets the thousands delimiter.
  • :separator (String) — default: "." — Sets the separator between the units.

Returns:

  • (String) — The formatted representation of the number.

#number_with_precision(number, options = {}) ⇒ String

Formats a number with the specified level of :precision (e.g., 112.32 has a precision of 2). You can customize the format in the options hash.

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

Parameters:

  • number (Fixnum, Float) — Number value to format.
  • options (Hash) (defaults to: {}) — Options for formatter.

Options Hash (options):

  • :precision (Fixnum) — default: 3 — Sets the level of precision.
  • :separator (String) — default: "." — Sets the separator between the units.
  • :delimiter (String) — default: "" — Sets the thousands delimiter.

Returns:

  • (String) — The formatted representation of the number.