модуль ActionView::Helpers::NumberHelper

Предоставляет методы для преобразования чисел в отформатированные строки. Представлены методы для телефонных номеров, валюты, процентов, точности, позиционной записи, размера файла и красивого отображения.

Большинство методов ожидают аргумент number, и вернут его без изменений, если не смогут преобразовать его в действительное число.

Методы экземпляра общедоступного класса

number_to_currency(number, options = {}) Показать исходный код

Форматирует number в строку валюты (например, $13.65). Вы можете настроить формат в options хэше.

Параметры

:locale - Устанавливает используемый локаль для форматирования (по умолчанию — текущий локаль).
:precision - Устанавливает уровень точности (по умолчанию 2).
:unit - Устанавливает обозначение валюты (по умолчанию «$»).
:separator - Устанавливает разделитель между единицами (по умолчанию «.»).
:delimiter - Устанавливает разделитель тысяч (по умолчанию «,»).
:format - Устанавливает формат для неотрицательных чисел (по умолчанию «%u%n»). Поля — %u для валюты и %n для числа.
:negative_format - Устанавливает формат для отрицательных чисел (по умолчанию — добавление тире перед отформатированным числом, заданным :format). Принимает те же поля, что и :format, за исключением того, что %n здесь — абсолютное значение числа.
:raise - Если истинно, то при некорректном аргументе InvalidNumberError.

Примеры

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("123a456", raise: true)           # => InvalidNumberError

number_to_currency(-1234567890.50, negative_format: "(%u%n)")
# => ($1,234,567,890.50)
number_to_currency(1234567890.50, unit: "R$", separator: ",", delimiter: "")
# => R$1234567890,50
number_to_currency(1234567890.50, unit: "R$", separator: ",", delimiter: "", format: "%n %u")
# => 1234567890,50 R$

# File actionview/lib/action_view/helpers/number_helper.rb, line 106
def number_to_currency(number, options = {})
  delegate_number_helper_method(:number_to_currency, number, options)
end

number_to_human(number, options = {}) Показать исходный код

Красиво отображает (форматирует и приближает) число таким образом, чтобы его было легче читать (например: 1200000000 становится «1,2 миллиарда»). Это полезно для очень больших чисел (слишком трудно читать).

См. number_to_human_size для вывода размера файла.

Вы также можете определить свои собственные имена единиц измерения, если хотите использовать другие десятичные единицы (например, 1500 становится «1,5 километра», 0,150 становится «150 миллилитров» и т. д.). Вы можете определить широкий диапазон единиц измерения, даже дробные (санти, деци, мили и т. д.).

Параметры

:locale - Устанавливает используемый локаль для форматирования (по умолчанию — текущий локаль).
:precision - Устанавливает точность числа (по умолчанию 3).
:significant - Если true, точность будет количеством значащих цифр. Если false, то количеством дробных цифр (по умолчанию true)
:separator - Устанавливает разделитель между дробной и целой частью (по умолчанию «.»).
:delimiter - Устанавливает разделитель тысяч (по умолчанию «»).
:strip_insignificant_zeros - Если true, удаляет несущественные нули после десятичной точки (по умолчанию true)
:units - Хэш с именами единиц измерения. Или строка, содержащая i18n область, где найти этот хэш. Он может иметь следующие ключи:
- целые: :unit, :ten, *:hundred, :thousand, :million, *:billion, :trillion, *:quadrillion
- дробные: :deci, :centi, *:mili, :micro, :nano, *:pico, :femto
:format - Устанавливает формат выводимой строки (по умолчанию «%n %u»). Типы полей:
- %u - Квантификатор (например, 'тысяча')
- %n - Число
:raise - Если истинно, то при некорректном аргументе InvalidNumberError.

Примеры

number_to_human(123)                                          # => "123"
number_to_human(1234)                                         # => "1.23 Thousand"
number_to_human(12345)                                        # => "12.3 Thousand"
number_to_human(1234567)                                      # => "1.23 Million"
number_to_human(1234567890)                                   # => "1.23 Billion"
number_to_human(1234567890123)                                # => "1.23 Trillion"
number_to_human(1234567890123456)                             # => "1.23 Quadrillion"
number_to_human(1234567890123456789)                          # => "1230 Quadrillion"
number_to_human(489939, precision: 2)                         # => "490 Thousand"
number_to_human(489939, precision: 4)                         # => "489.9 Thousand"
number_to_human(1234567, precision: 4,
                        significant: false)                   # => "1.2346 Million"
number_to_human(1234567, precision: 1,
                        separator: ',',
                        significant: false)                   # => "1,2 Million"

Незначительные нули после десятичной точки удаляются по умолчанию (установите :strip_insignificant_zeros в false для изменения этого):

number_to_human(12345012345, significant_digits: 6)       # => "12.345 Billion"
number_to_human(500000000, precision: 5)                  # => "500 Million"

Пользовательские единицы измерения

Вы также можете использовать свои собственные пользовательские единицы измерения:

number_to_human(500000, units: {unit: "ml", thousand: "lt"})  # => "500 lt"

Если в вашем локали I18n есть:

distance:
  centi:
    one: "centimeter"
    other: "centimeters"
  unit:
    one: "meter"
    other: "meters"
  thousand:
    one: "kilometer"
    other: "kilometers"
  billion: "gazillion-distance"

Тогда вы можете сделать так:

number_to_human(543934, units: :distance)              # => "544 kilometers"
number_to_human(54393498, units: :distance)            # => "54400 kilometers"
number_to_human(54393498000, units: :distance)         # => "54.4 gazillion-distance"
number_to_human(343, units: :distance, precision: 1)   # => "300 meters"
number_to_human(1, units: :distance)                   # => "1 meter"
number_to_human(0.34, units: :distance)                # => "34 centimeters"

# File actionview/lib/action_view/helpers/number_helper.rb, line 378
def number_to_human(number, options = {})
  delegate_number_helper_method(:number_to_human, number, options)
end

number_to_human_size(number, options = {}) Показать исходный код

Форматирует байты в number в более понятное представление (например, 1500 — 1,5 КБ). Этот метод полезен для отображения размера файлов пользователям. Вы можете настроить формат в хэше options.

См. number_to_human для красивого отображения произвольного числа.

Параметры

:locale - Устанавливает используемый локаль для форматирования (по умолчанию — текущий локаль).
:precision - Устанавливает точность числа (по умолчанию 3).
:significant - Если true, точность будет количеством значащих цифр. Если false, то количеством дробных цифр (по умолчанию true)
:separator - Устанавливает разделитель между дробной и целой частью (по умолчанию «.»).
:delimiter - Устанавливает разделитель тысяч (по умолчанию «»).
:strip_insignificant_zeros - Если true удаляет несущественные нули после десятичной точки (по умолчанию true)
:prefix - Если :si форматирует число с использованием префиксов СИ (по умолчанию :binary)
:raise - Если истинно, то при некорректном аргументе InvalidNumberError.

Примеры

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(1234567890123, precision: 5)        # => "1.1229 TB"
number_to_human_size(524288000, precision: 5)            # => "500 MB"

# File actionview/lib/action_view/helpers/number_helper.rb, line 276
def number_to_human_size(number, options = {})
  delegate_number_helper_method(:number_to_human_size, number, options)
end

number_to_percentage(number, options = {}) Показать исходный код

Форматирует number как строку процентов (например, 65%). Вы можете настроить формат в options хэше.

Параметры

:locale - Устанавливает используемый локаль для форматирования (по умолчанию — текущий локаль).
:precision - Устанавливает точность числа (по умолчанию 3).
:significant - Если true, точность будет количеством значащих цифр. Если false, то количеством дробных цифр (по умолчанию false).
:separator - Устанавливает разделитель между дробной и целой частью (по умолчанию «.»).
:delimiter - Устанавливает разделитель тысяч (по умолчанию «»).
:strip_insignificant_zeros - Если true удаляет несущественные нули после десятичной точки (по умолчанию false).
:format - Указывает формат строки процентов. Поле числа %n (по умолчанию «%n%»).
:raise - Если истинно, то при некорректном аргументе InvalidNumberError.

Примеры

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("98a", raise: true)                         # => InvalidNumberError

# File actionview/lib/action_view/helpers/number_helper.rb, line 146
def number_to_percentage(number, options = {})
  delegate_number_helper_method(:number_to_percentage, number, options)
end

number_to_phone(number, options = {}) Показать исходный код

Форматирует number в номер телефона США (например, (555) 123-9876). Вы можете настроить формат в options хэше.

Параметры

:area_code - Добавляет скобки вокруг кода области.
:delimiter - Указывает разделитель (по умолчанию «-»).
:extension - Указывает добавление расширения в конец сгенерированного номера.
:country_code - Устанавливает код страны для номера телефона.
:raise - Если истинно, то при некорректном аргументе InvalidNumberError.

Примеры

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("1234a567", raise: true)                           # => InvalidNumberError

number_to_phone(1235551234, country_code: 1, extension: 1343, delimiter: ".")
# => +1.123.555.1234 x 1343

# File actionview/lib/action_view/helpers/number_helper.rb, line 56
def number_to_phone(number, options = {})
  return unless number
  options = options.symbolize_keys

  parse_float(number, true) if options.delete(:raise)
  ERB::Util.html_escape(ActiveSupport::NumberHelper.number_to_phone(number, options))
end

number_with_delimiter(number, options = {}) Показать исходный код

Форматирует number с группировкой тысяч, используя delimiter (например, 12 324). Вы можете настроить формат в options хэше.

Параметры

:locale - Устанавливает используемый локаль для форматирования (по умолчанию — текущий локаль).
:delimiter - Устанавливает разделитель тысяч (по умолчанию «,»).
:separator - Устанавливает разделитель между дробной и целой частью (по умолчанию «.»).
:raise - Если истинно, то при некорректном аргументе InvalidNumberError.

Примеры

 number_with_delimiter(12345678)                        # => 12,345,678
 number_with_delimiter("123456")                        # => 123,456
 number_with_delimiter(12345678.05)                     # => 12,345,678.05
 number_with_delimiter(12345678, delimiter: ".")        # => 12.345.678
 number_with_delimiter(12345678, delimiter: ",")        # => 12,345,678
 number_with_delimiter(12345678.05, separator: " ")     # => 12,345,678 05
 number_with_delimiter(12345678.05, locale: :fr)        # => 12 345 678,05
 number_with_delimiter("112a")                          # => 112a
 number_with_delimiter(98765432.98, delimiter: " ", separator: ",")
 # => 98 765 432,98

number_with_delimiter("112a", raise: true)              # => raise InvalidNumberError

# File actionview/lib/action_view/helpers/number_helper.rb, line 179
def number_with_delimiter(number, options = {})
  delegate_number_helper_method(:number_to_delimited, number, options)
end

number_with_precision(number, options = {}) Показать исходный код

Форматирует number с заданной точностью (например, 112.32 имеет точность 2, если :significant является false, и 5, если :significant является true). Вы можете настроить формат в хэше options.

Параметры

:locale - Устанавливает используемый локаль для форматирования (по умолчанию — текущий локаль).
:precision - Устанавливает точность числа (по умолчанию 3).
:significant - Если true, точность будет количеством значащих цифр. Если false, то количеством знаков после запятой (по умолчанию false).
:separator - Устанавливает разделитель между дробной и целой частью (по умолчанию «.»).
:delimiter - Устанавливает разделитель разрядов (по умолчанию «»).
:strip_insignificant_zeros - Если true, удаляются незначительные нули после десятичной точки (по умолчанию false).
:raise - Если true, генерируется исключение InvalidNumberError при некорректном аргументе.

Примеры

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(111.2345, significant: true)                      # => 111
number_with_precision(111.2345, precision: 1, significant: true)        # => 100
number_with_precision(13, precision: 5, significant: true)              # => 13.000
number_with_precision(111.234, locale: :fr)                             # => 111,234

number_with_precision(13, precision: 5, significant: true, strip_insignificant_zeros: true)
# => 13

number_with_precision(389.32314, precision: 4, significant: true)       # => 389.3
number_with_precision(1111.2345, precision: 2, separator: ',', delimiter: '.')
# => 1.111,23

# File actionview/lib/action_view/helpers/number_helper.rb, line 224
def number_with_precision(number, options = {})
  delegate_number_helper_method(:number_to_rounded, number, options)
end