Spec-Zone.ru › Ruby on Rails 7.1

module ActionView::Helpers::NumberHelper

Справочник по обработке чисел Action View

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

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

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

number_to_currency(number, options = {}) Показать исходный код
# File actionview/lib/action_view/helpers/number_helper.rb, line 128
def number_to_currency(number, options = {})
  delegate_number_helper_method(:number_to_currency, number, options)
end

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

Будут использованы единицы валюты и форматирование чисел текущего языка, если не указано иное в предоставленных параметрах. Преобразование валюты не выполняется. Если пользователю предоставляется возможность изменить свой язык, он также сможет изменить относительное значение отображаемой валюты с помощью этого помощника. Если ваше приложение будет поддерживать несколько языков, вы можете указать постоянный :locale параметр или рассмотреть использование библиотеки, способной выполнять преобразование валют.

Параметры

  • :locale - Устанавливает язык, используемый для форматирования (по умолчанию — текущий язык).

  • :precision - Устанавливает точность (по умолчанию — 2).

  • :unit - Устанавливает обозначение валюты (по умолчанию — “$”).

  • :separator - Устанавливает разделитель между единицами (по умолчанию — “.”).

  • :delimiter - Устанавливает разделитель тысяч (по умолчанию — “,”).

  • :format - Устанавливает формат для неотрицательных чисел (по умолчанию — “%u%n”). Поля %u для валюты и %n для числа.

  • :negative_format - Устанавливает формат для отрицательных чисел (по умолчанию — добавление тире перед отформатированным числом, заданным :format). Принимает те же поля, что и :format, за исключением того, что %n здесь представляет собой абсолютное значение числа.

  • :raise - Если истинно, вызывает InvalidNumberError при некорректном аргументе.

  • :strip_insignificant_zeros - Если true удаляет несущественные нули после десятичной запятой (по умолчанию — false).

Примеры

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(-0.456789, precision: 0)
# => "$0"
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$
number_to_currency(1234567890.50, strip_insignificant_zeros: true)
# => "$1,234,567,890.5"
number_to_human(number, options = {}) Показать исходный код
# File actionview/lib/action_view/helpers/number_helper.rb, line 405
def number_to_human(number, options = {})
  delegate_number_helper_method(:number_to_human, number, options)
end

Красиво выводит (форматирует и приближает) число так, чтобы его было легче читать (например: 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 - Hash с именами единиц-квантификаторов. Или строка, содержащая область 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"

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

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

number_to_human(12.00001)                                       # => "12"
number_to_human(12.00001, strip_insignificant_zeros: false)     # => "12.0"

Настраиваемые единицы-квантификаторы

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

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"
number_to_human_size(number, options = {}) Показать исходный код
# File actionview/lib/action_view/helpers/number_helper.rb, line 298
def number_to_human_size(number, options = {})
  delegate_number_helper_method(:number_to_human_size, number, options)
end

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

См. number_to_human, если нужно красиво вывести общее число.

Параметры

  • :locale - Устанавливает язык, используемый для форматирования (по умолчанию — текущий язык).

  • :precision - Устанавливает точность числа (по умолчанию — 3).

  • :significant - Если true, точность будет представлять количество значащих цифр. Если false, количество дробных цифр (по умолчанию true).

  • :separator - Устанавливает разделитель между дробной и целой частями (по умолчанию — “.”).

  • :delimiter - Устанавливает разделитель тысяч (по умолчанию — “”).

  • :strip_insignificant_zeros - Если true удаляет несущественные нули после десятичной запятой (по умолчанию — true).

  • :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(1234567890123456)                             # => 1.1 PB
number_to_human_size(1234567890123456789)                          # => 1.07 EB
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.1228 TB"
number_to_human_size(524288000, precision: 5)                      # => "500 MB"
number_to_percentage(number, options = {}) Показать исходный код
# File actionview/lib/action_view/helpers/number_helper.rb, line 168
def number_to_percentage(number, options = {})
  delegate_number_helper_method(:number_to_percentage, number, options)
end

Форматирует 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.000  %

number_to_percentage("98a", raise: true)                         # => InvalidNumberError
number_to_phone(number, options = {}) Показать исходный код
# File actionview/lib/action_view/helpers/number_helper.rb, line 63
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 в телефонный номер (по умолчанию США, например, (555) 123-9876). Вы можете настроить формат в options хэше.

Параметры

  • :area_code - Добавляет скобки вокруг кода города.

  • :delimiter - Указывает разделитель (по умолчанию — “-”).

  • :extension - Указывает добавление расширения в конец сгенерированного номера.

  • :country_code - Указывает код страны для телефонного номера.

  • :pattern - Указывает, как число делится на три группы с помощью настраиваемого регулярного выражения для переопределения формата по умолчанию.

  • :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

number_to_phone(75561234567, pattern: /(\d{1,4})(\d{4})(\d{4})$/, area_code: true)
# => "(755) 6123-4567"
number_to_phone(13312345678, pattern: /(\d{3})(\d{4})(\d{4})$/)
# => "133-1234-5678"
END_OF_DOCUMENT_MARKER
number_with_delimiter(number, options = {}) Показать исходный код
# File actionview/lib/action_view/helpers/number_helper.rb, line 207
def number_with_delimiter(number, options = {})
  delegate_number_helper_method(:number_to_delimited, number, options)
end

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

Параметры

  • :locale — Устанавливает используемый язык для форматирования (по умолчанию текущий язык).

  • :delimiter — Устанавливает разделитель тысяч (по умолчанию «,»).

  • :separator — Устанавливает разделитель между дробной и целой частью числа (по умолчанию «.»).

  • :delimiter_pattern — Устанавливает пользовательское регулярное выражение, используемое для определения расположения разделителей. Полезно при использовании форматов валют, таких как INR.

  • :raise — Если значение true, возникает 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("123456.78",
  delimiter_pattern: /(\d+?)(?=(\d\d)+(\d)(?!\d))/)    # => "1,23,456.78"

number_with_delimiter("112a", raise: true)              # => raise InvalidNumberError
number_with_precision(number, options = {}) Показать исходный код
# File actionview/lib/action_view/helpers/number_helper.rb, line 252
def number_with_precision(number, options = {})
  delegate_number_helper_method(:number_to_rounded, number, options)
end

Форматирует number с заданной точностью :precision (например, 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

© 2004–2021 David Heinemeier Hansson
Licensed under the MIT License.

Spec-Zone.ru

Настройки Оффлайн Что нового Помощь О нас
Spec-Zone .ru
спецификации, руководства, описания, API