Spec-Zone.ru › Ruby on Rails 7.1

модуль ActiveSupport::NumberHelper

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

number_to_currency(число, options = {}) Показать исходный код 
# File activesupport/lib/active_support/number_helper.rb, line 114
def number_to_currency(number, options = {})
  NumberToCurrencyConverter.convert(number, options)
end

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

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

Параметры

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

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

  • :round_mode - Определяет, как выполняется округление (по умолчанию :default. См. BigDecimal::mode)

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

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

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

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

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

  • :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(-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: '£', separator: ',', delimiter: '')
# => "£1234567890,50"
number_to_currency(1234567890.50, unit: '£', separator: ',', delimiter: '', format: '%n %u')
# => "1234567890,50 £"
number_to_currency(1234567890.50, strip_insignificant_zeros: true)
# => "$1,234,567,890.5"
number_to_currency(1234567890.50, precision: 0, round_mode: :up)
# => "$1,234,567,891"
number_to_delimited(число, options = {}) Показать исходный код 
# File activesupport/lib/active_support/number_helper.rb, line 189
def number_to_delimited(number, options = {})
  NumberToDelimitedConverter.convert(number, options)
end

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

Параметры

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

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

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

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

Примеры

number_to_delimited(12345678)                    # => "12,345,678"
number_to_delimited('123456')                    # => "123,456"
number_to_delimited(12345678.05)                 # => "12,345,678.05"
number_to_delimited(12345678, delimiter: '.')    # => "12.345.678"
number_to_delimited(12345678, delimiter: ',')    # => "12,345,678"
number_to_delimited(12345678.05, separator: ' ') # => "12,345,678 05"
number_to_delimited(12345678.05, locale: :fr)    # => "12 345 678,05"
number_to_delimited('112a')                      # => "112a"
number_to_delimited(98765432.98, delimiter: ' ', separator: ',')
                                                 # => "98 765 432,98"
number_to_delimited("123456.78",
  delimiter_pattern: /(\d+?)(?=(\d\d)+(\d)(?!\d))/)
                                                 # => "1,23,456.78"
number_to_human(число, options = {}) Показать исходный код 
# File activesupport/lib/active_support/number_helper.rb, line 392
def number_to_human(number, options = {})
  NumberToHumanConverter.convert(number, options)
end

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

См. number_to_human_size, если нужно вывести размер файла.

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

Параметры

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

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

  • :round_mode - Определяет, как выполняется округление (по умолчанию :default. См. BigDecimal::mode)

  • :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 - Число

Примеры

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(489939, precision: 2
                      , round_mode: :down)   # => "480 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(число, options = {}) Показать исходный код 
# File activesupport/lib/active_support/number_helper.rb, line 283
def number_to_human_size(number, options = {})
  NumberToHumanSizeConverter.convert(number, options)
end

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

См. number_to_human, если хотите красиво отобразить обычное число.

Параметры

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

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

  • :round_mode - Определяет, как выполняется округление (по умолчанию :default. См. BigDecimal::mode)

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

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

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

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

Примеры

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(483989, precision: 2, round_mode: :up)  # => "480 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(число, options = {}) Показать исходный код 
# File activesupport/lib/active_support/number_helper.rb, line 154
def number_to_percentage(number, options = {})
  NumberToPercentageConverter.convert(number, options)
end

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

Параметры

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

  • :precision - Устанавливает точность числа (по умолчанию 3). Сохраняет точность числа, если nil.

  • :round_mode - Определяет, как выполняется округление (по умолчанию :default. См. BigDecimal::mode)

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

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

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

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

  • :format - Указывает формат строки процента. Поле с числом %n (по умолчанию “%n%”).

Примеры

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)                                # => "1000,000%"
number_to_percentage(1000, precision: nil)                             # => "1000%"
number_to_percentage('98a')                                            # => "98a%"
number_to_percentage(100, format: '%n  %')                             # => "100.000  %"
number_to_percentage(302.24398923423, precision: 5, round_mode: :down) # => "302.24398%"
number_to_phone(number, options = {}) Показать исходный код 
# File activesupport/lib/active_support/number_helper.rb, line 53
def number_to_phone(number, options = {})
  NumberToPhoneConverter.convert(number, options)
end

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

Параметры

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

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

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

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

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

Примеры

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(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"
number_to_rounded(number, options = {}) Показать исходный код 
# File activesupport/lib/active_support/number_helper.rb, line 236
def number_to_rounded(number, options = {})
  NumberToRoundedConverter.convert(number, options)
end

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

Параметры

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

  • :precision - Устанавливает точность числа (по умолчанию 3). Сохраняет точность числа, если nil.

  • :round_mode - Определяет способ округления (по умолчанию: :default. См. BigDecimal::mode)

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

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

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

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

Примеры

number_to_rounded(111.2345)                                  # => "111.235"
number_to_rounded(111.2345, precision: 2)                    # => "111.23"
number_to_rounded(13, precision: 5)                          # => "13.00000"
number_to_rounded(389.32314, precision: 0)                   # => "389"
number_to_rounded(111.2345, significant: true)               # => "111"
number_to_rounded(111.2345, precision: 1, significant: true) # => "100"
number_to_rounded(13, precision: 5, significant: true)       # => "13.000"
number_to_rounded(13, precision: nil)                        # => "13"
number_to_rounded(389.32314, precision: 0, round_mode: :up)  # => "390"
number_to_rounded(111.234, locale: :fr)                      # => "111,234"

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

number_to_rounded(389.32314, precision: 4, significant: true) # => "389.3"
number_to_rounded(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