activesupport 6.0.6.1 → 7.1.3.2

data/lib/active_support/number_helper.rb

@@ -1,7 +1,5 @@
 # frozen_string_literal: true
 
-require "active_support/dependencies/autoload"
-
 module ActiveSupport
   module NumberHelper
     extend ActiveSupport::Autoload
@@ -20,361 +18,438 @@ module ActiveSupport
 
     extend self
 
-    # Formats a +number+ into a phone number (US by default e.g., (555)
-    # 123-9876). You can customize the format in the +options+ hash.
+    # Formats +number+ into a phone number.
     #
-    # ==== Options
+    #   number_to_phone(5551234)    # => "555-1234"
+    #   number_to_phone("5551234")  # => "555-1234"
+    #   number_to_phone(1235551234) # => "123-555-1234"
+    #   number_to_phone("12x34")    # => "12x34"
     #
-    # * <tt>:area_code</tt> - Adds parentheses around the area code.
-    # * <tt>:delimiter</tt> - Specifies the delimiter to use
-    #   (defaults to "-").
-    # * <tt>:extension</tt> - Specifies an extension to add to the
-    #   end of the generated number.
-    # * <tt>:country_code</tt> - Sets the country code for the phone
-    #   number.
-    # * <tt>:pattern</tt> - Specifies how the number is divided into three
-    #   groups with the custom regexp to override the default format.
-    # ==== Examples
-    #
-    #   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: '.')
+    #   number_to_phone(1235551234, delimiter: ".", country_code: 1, extension: 1343)
     #   # => "+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"
+    # ==== Options
+    #
+    # [+:area_code+]
+    #   Whether to use parentheses for the area code. Defaults to false.
+    #
+    #     number_to_phone(1235551234, area_code: true)
+    #     # => "(123) 555-1234"
+    #
+    # [+:delimiter+]
+    #   The digit group delimiter to use. Defaults to <tt>"-"</tt>.
+    #
+    #     number_to_phone(1235551234, delimiter: " ")
+    #     # => "123 555 1234"
+    #
+    # [+:country_code+]
+    #   A country code to prepend.
+    #
+    #     number_to_phone(1235551234, country_code: 1)
+    #     # => "+1-123-555-1234"
+    #
+    # [+:extension+]
+    #   An extension to append.
+    #
+    #     number_to_phone(1235551234, extension: 555)
+    #     # => "123-555-1234 x 555"
+    #
+    # [+:pattern+]
+    #   A regexp that specifies how the digits should be grouped. The first
+    #   three captures from the regexp are treated as digit groups.
+    #
+    #     number_to_phone(13312345678, pattern: /(\d{3})(\d{4})(\d{4})$/)
+    #     # => "133-1234-5678"
+    #     number_to_phone(75561234567, pattern: /(\d{1,4})(\d{4})(\d{4})$/, area_code: true)
+    #     # => "(755) 6123-4567"
+    #
     def number_to_phone(number, options = {})
       NumberToPhoneConverter.convert(number, options)
     end
 
-    # Formats a +number+ into a currency string (e.g., $13.65). You
-    # can customize the format in the +options+ hash.
+    # Formats a +number+ into a currency string.
+    #
+    #   number_to_currency(1234567890.50)  # => "$1,234,567,890.50"
+    #   number_to_currency(1234567890.506) # => "$1,234,567,890.51"
+    #   number_to_currency("12x34")        # => "$12x34"
+    #
+    #   number_to_currency(1234567890.50, unit: "&pound;", separator: ",", delimiter: "")
+    #   # => "&pound;1234567890,50"
     #
     # The currency unit and number formatting of the current locale will be used
-    # unless otherwise specified in the provided options. No currency conversion
-    # is performed. If the user is given a way to change their locale, they will
+    # unless otherwise specified via options. No currency conversion is
+    # performed. If the user is given a way to change their locale, they will
     # also be able to change the relative value of the currency displayed with
     # this helper. If your application will ever support multiple locales, you
-    # may want to specify a constant <tt>:locale</tt> option or consider
-    # using a library capable of currency conversion.
+    # may want to specify a constant +:locale+ option or consider using a
+    # library capable of currency conversion.
     #
     # ==== Options
     #
-    # * <tt>:locale</tt> - Sets the locale to be used for formatting
-    #   (defaults to current locale).
-    # * <tt>:precision</tt> - Sets the level of precision (defaults
-    #   to 2).
-    # * <tt>:unit</tt> - Sets the denomination of the currency
-    #   (defaults to "$").
-    # * <tt>:separator</tt> - Sets the separator between the units
-    #   (defaults to ".").
-    # * <tt>:delimiter</tt> - Sets the thousands delimiter (defaults
-    #   to ",").
-    # * <tt>:format</tt> - Sets the format for non-negative numbers
-    #   (defaults to "%u%n").  Fields are <tt>%u</tt> for the
-    #   currency, and <tt>%n</tt> for the number.
-    # * <tt>:negative_format</tt> - Sets the format for negative
-    #   numbers (defaults to prepending a hyphen to the formatted
-    #   number given by <tt>:format</tt>).  Accepts the same fields
-    #   than <tt>:format</tt>, except <tt>%n</tt> is here the
-    #   absolute value of the number.
-    # * <tt>:strip_insignificant_zeros</tt> - If +true+ removes
-    #   insignificant zeros after the decimal separator (defaults to
-    #   +false+).
-    #
-    # ==== 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.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: '&pound;', separator: ',', delimiter: '')
-    #   # => "&pound;1234567890,50"
-    #   number_to_currency(1234567890.50, unit: '&pound;', separator: ',', delimiter: '', format: '%n %u')
-    #   # => "1234567890,50 &pound;"
-    #   number_to_currency(1234567890.50, strip_insignificant_zeros: true)
-    #   # => "$1,234,567,890.5"
+    # [+:locale+]
+    #   The locale to use for formatting. Defaults to the current locale.
+    #
+    #     number_to_currency(1234567890.506, locale: :fr)
+    #     # => "1 234 567 890,51 €"
+    #
+    # [+:precision+]
+    #   The level of precision. Defaults to 2.
+    #
+    #     number_to_currency(1234567890.123, precision: 3) # => "$1,234,567,890.123"
+    #     number_to_currency(0.456789, precision: 0)       # => "$0"
+    #
+    # [+:round_mode+]
+    #   Specifies how rounding is performed. See +BigDecimal.mode+. Defaults to
+    #   +:default+.
+    #
+    #     number_to_currency(1234567890.01, precision: 0, round_mode: :up)
+    #     # => "$1,234,567,891"
+    #
+    # [+:unit+]
+    #   The denomination of the currency. Defaults to <tt>"$"</tt>.
+    #
+    # [+:separator+]
+    #   The decimal separator. Defaults to <tt>"."</tt>.
+    #
+    # [+:delimiter+]
+    #   The thousands delimiter. Defaults to <tt>","</tt>.
+    #
+    # [+:format+]
+    #   The format for non-negative numbers. <tt>%u</tt> represents the currency,
+    #   and <tt>%n</tt> represents the number. Defaults to <tt>"%u%n"</tt>.
+    #
+    #     number_to_currency(1234567890.50, format: "%n %u")
+    #     # => "1,234,567,890.50 $"
+    #
+    # [+:negative_format+]
+    #   The format for negative numbers. <tt>%u</tt> and <tt>%n</tt> behave the
+    #   same as in +:format+, but <tt>%n</tt> represents the absolute value of
+    #   the number. Defaults to the value of +:format+ prepended with <tt>-</tt>.
+    #
+    #     number_to_currency(-1234567890.50, negative_format: "(%u%n)")
+    #     # => "($1,234,567,890.50)"
+    #
+    # [+:strip_insignificant_zeros+]
+    #   Whether to remove insignificant zeros after the decimal separator.
+    #   Defaults to false.
+    #
+    #     number_to_currency(1234567890.50, strip_insignificant_zeros: true)
+    #     # => "$1,234,567,890.5"
+    #
     def number_to_currency(number, options = {})
       NumberToCurrencyConverter.convert(number, options)
     end
 
-    # Formats a +number+ as a percentage string (e.g., 65%). You can
-    # customize the format in the +options+ hash.
+    # Formats +number+ as a percentage string.
+    #
+    #   number_to_percentage(100)   # => "100.000%"
+    #   number_to_percentage("99")  # => "99.000%"
+    #   number_to_percentage("99x") # => "99x%"
+    #
+    #   number_to_percentage(12345.6789, delimiter: ".", separator: ",", precision: 2)
+    #   # => "12.345,68%"
     #
     # ==== Options
     #
-    # * <tt>:locale</tt> - Sets the locale to be used for formatting
-    #   (defaults to current locale).
-    # * <tt>:precision</tt> - Sets the precision of the number
-    #   (defaults to 3). Keeps the number's precision if +nil+.
-    # * <tt>:significant</tt> - If +true+, precision will be the number
-    #   of significant_digits. If +false+, the number of fractional
-    #   digits (defaults to +false+).
-    # * <tt>:separator</tt> - Sets the separator between the
-    #   fractional and integer digits (defaults to ".").
-    # * <tt>:delimiter</tt> - Sets the thousands delimiter (defaults
-    #   to "").
-    # * <tt>:strip_insignificant_zeros</tt> - If +true+ removes
-    #   insignificant zeros after the decimal separator (defaults to
-    #   +false+).
-    # * <tt>:format</tt> - Specifies the format of the percentage
-    #   string The number field is <tt>%n</tt> (defaults to "%n%").
-    #
-    # ==== Examples
-    #
-    #   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  %"
+    # [+:locale+]
+    #   The locale to use for formatting. Defaults to the current locale.
+    #
+    #     number_to_percentage(1000, locale: :fr)
+    #     # => "1000,000%"
+    #
+    # [+:precision+]
+    #   The level of precision, or +nil+ to preserve +number+'s precision.
+    #   Defaults to 2.
+    #
+    #     number_to_percentage(12.3456789, precision: 4) # => "12.3457%"
+    #     number_to_percentage(99.999, precision: 0)     # => "100%"
+    #     number_to_percentage(99.999, precision: nil)   # => "99.999%"
+    #
+    # [+:round_mode+]
+    #   Specifies how rounding is performed. See +BigDecimal.mode+. Defaults to
+    #   +:default+.
+    #
+    #     number_to_percentage(12.3456789, precision: 4, round_mode: :down)
+    #     # => "12.3456%"
+    #
+    # [+:significant+]
+    #   Whether +:precision+ should be applied to significant digits instead of
+    #   fractional digits. Defaults to false.
+    #
+    #     number_to_percentage(12345.6789)                                  # => "12345.679%"
+    #     number_to_percentage(12345.6789, significant: true)               # => "12300%"
+    #     number_to_percentage(12345.6789, precision: 2)                    # => "12345.68%"
+    #     number_to_percentage(12345.6789, precision: 2, significant: true) # => "12000%"
+    #
+    # [+:separator+]
+    #   The decimal separator. Defaults to <tt>"."</tt>.
+    #
+    # [+:delimiter+]
+    #   The thousands delimiter. Defaults to <tt>","</tt>.
+    #
+    # [+:strip_insignificant_zeros+]
+    #   Whether to remove insignificant zeros after the decimal separator.
+    #   Defaults to false.
+    #
+    # [+:format+]
+    #   The format of the output. <tt>%n</tt> represents the number. Defaults to
+    #   <tt>"%n%"</tt>.
+    #
+    #     number_to_percentage(100, format: "%n  %")
+    #     # => "100.000  %"
+    #
     def number_to_percentage(number, options = {})
       NumberToPercentageConverter.convert(number, options)
     end
 
-    # Formats a +number+ with grouped thousands using +delimiter+
-    # (e.g., 12,324). You can customize the format in the +options+
-    # hash.
+    # Formats +number+ by grouping thousands with a delimiter.
+    #
+    #   number_to_delimited(12345678)      # => "12,345,678"
+    #   number_to_delimited("123456")      # => "123,456"
+    #   number_to_delimited(12345678.9876) # => "12,345,678.9876"
+    #   number_to_delimited("12x34")       # => "12x34"
+    #
+    #   number_to_delimited(12345678.9876, delimiter: ".", separator: ",")
+    #   # => "12.345.678,9876"
     #
     # ==== Options
     #
-    # * <tt>:locale</tt> - Sets the locale to be used for formatting
-    #   (defaults to current locale).
-    # * <tt>:delimiter</tt> - Sets the thousands delimiter (defaults
-    #   to ",").
-    # * <tt>:separator</tt> - Sets the separator between the
-    #   fractional and integer digits (defaults to ".").
-    # * <tt>:delimiter_pattern</tt> - Sets a custom regular expression used for
-    #   deriving the placement of delimiter. Helpful when using currency formats
-    #   like INR.
-    #
-    # ==== Examples
-    #
-    #   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"
+    # [+:locale+]
+    #   The locale to use for formatting. Defaults to the current locale.
+    #
+    #     number_to_delimited(12345678.05, locale: :fr)
+    #     # => "12 345 678,05"
+    #
+    # [+:delimiter+]
+    #   The thousands delimiter. Defaults to <tt>","</tt>.
+    #
+    #     number_to_delimited(12345678, delimiter: ".")
+    #     # => "12.345.678"
+    #
+    # [+:separator+]
+    #   The decimal separator. Defaults to <tt>"."</tt>.
+    #
+    #     number_to_delimited(12345678.05, separator: " ")
+    #     # => "12,345,678 05"
+    #
+    # [+:delimiter_pattern+]
+    #   A regexp to determine the placement of delimiters. Helpful when using
+    #   currency formats like INR.
+    #
+    #     number_to_delimited("123456.78", delimiter_pattern: /(\d+?)(?=(\d\d)+(\d)(?!\d))/)
+    #     # => "1,23,456.78"
+    #
     def number_to_delimited(number, options = {})
       NumberToDelimitedConverter.convert(number, options)
     end
 
-    # Formats a +number+ with the specified level of
-    # <tt>:precision</tt> (e.g., 112.32 has a precision of 2 if
-    # +:significant+ is +false+, and 5 if +:significant+ is +true+).
-    # You can customize the format in the +options+ hash.
+    # Formats +number+ to a specific level of precision.
+    #
+    #   number_to_rounded(12345.6789)                # => "12345.679"
+    #   number_to_rounded(12345.6789, precision: 2)  # => "12345.68"
+    #   number_to_rounded(12345.6789, precision: 0)  # => "12345"
+    #   number_to_rounded(12345, precision: 5)       # => "12345.00000"
     #
     # ==== Options
     #
-    # * <tt>:locale</tt> - Sets the locale to be used for formatting
-    #   (defaults to current locale).
-    # * <tt>:precision</tt> - Sets the precision of the number
-    #   (defaults to 3). Keeps the number's precision if +nil+.
-    # * <tt>:significant</tt> - If +true+, precision will be the number
-    #   of significant_digits. If +false+, the number of fractional
-    #   digits (defaults to +false+).
-    # * <tt>:separator</tt> - Sets the separator between the
-    #   fractional and integer digits (defaults to ".").
-    # * <tt>:delimiter</tt> - Sets the thousands delimiter (defaults
-    #   to "").
-    # * <tt>:strip_insignificant_zeros</tt> - If +true+ removes
-    #   insignificant zeros after the decimal separator (defaults to
-    #   +false+).
-    #
-    # ==== Examples
-    #
-    #   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(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"
+    # [+:locale+]
+    #   The locale to use for formatting. Defaults to the current locale.
+    #
+    #     number_to_rounded(111.234, locale: :fr)
+    #     # => "111,234"
+    #
+    # [+:precision+]
+    #   The level of precision, or +nil+ to preserve +number+'s precision.
+    #   Defaults to 3.
+    #
+    #     number_to_rounded(12345.6789, precision: nil)
+    #     # => "12345.6789"
+    #
+    # [+:round_mode+]
+    #   Specifies how rounding is performed. See +BigDecimal.mode+. Defaults to
+    #   +:default+.
+    #
+    #     number_to_rounded(12.34, precision: 0, round_mode: :up)
+    #     # => "13"
+    #
+    # [+:significant+]
+    #   Whether +:precision+ should be applied to significant digits instead of
+    #   fractional digits. Defaults to false.
+    #
+    #     number_to_rounded(12345.6789)                                  # => "12345.679"
+    #     number_to_rounded(12345.6789, significant: true)               # => "12300"
+    #     number_to_rounded(12345.6789, precision: 2)                    # => "12345.68"
+    #     number_to_rounded(12345.6789, precision: 2, significant: true) # => "12000"
+    #
+    # [+:separator+]
+    #   The decimal separator. Defaults to <tt>"."</tt>.
+    #
+    # [+:delimiter+]
+    #   The thousands delimiter. Defaults to <tt>","</tt>.
+    #
+    # [+:strip_insignificant_zeros+]
+    #   Whether to remove insignificant zeros after the decimal separator.
+    #   Defaults to false.
+    #
+    #     number_to_rounded(12.34, strip_insignificant_zeros: false)  # => "12.340"
+    #     number_to_rounded(12.34, strip_insignificant_zeros: true)   # => "12.34"
+    #     number_to_rounded(12.3456, strip_insignificant_zeros: true) # => "12.346"
+    #
     def number_to_rounded(number, options = {})
       NumberToRoundedConverter.convert(number, options)
     end
 
-    # Formats the bytes in +number+ into a more understandable
-    # representation (e.g., giving it 1500 yields 1.5 KB). This
-    # method is useful for reporting file sizes to users. You can
-    # customize the format in the +options+ hash.
+    # Formats +number+ as bytes into a more human-friendly representation.
+    # Useful for reporting file sizes to users.
+    #
+    #   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"
     #
-    # See <tt>number_to_human</tt> if you want to pretty-print a
-    # generic number.
+    # See #number_to_human if you want to pretty-print a generic number.
     #
     # ==== Options
     #
-    # * <tt>:locale</tt> - Sets the locale to be used for formatting
-    #   (defaults to current locale).
-    # * <tt>:precision</tt> - Sets the precision of the number
-    #   (defaults to 3).
-    # * <tt>:significant</tt> - If +true+, precision will be the number
-    #   of significant_digits. If +false+, the number of fractional
-    #   digits (defaults to +true+)
-    # * <tt>:separator</tt> - Sets the separator between the
-    #   fractional and integer digits (defaults to ".").
-    # * <tt>:delimiter</tt> - Sets the thousands delimiter (defaults
-    #   to "").
-    # * <tt>:strip_insignificant_zeros</tt> - If +true+ removes
-    #   insignificant zeros after the decimal separator (defaults to
-    #   +true+)
-    #
-    # ==== Examples
-    #
-    #   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"
+    # [+:locale+]
+    #   The locale to use for formatting. Defaults to the current locale.
+    #
+    # [+:precision+]
+    #   The level of precision. Defaults to 3.
+    #
+    #     number_to_human_size(123456, precision: 2)  # => "120 KB"
+    #     number_to_human_size(1234567, precision: 2) # => "1.2 MB"
+    #
+    # [+:round_mode+]
+    #   Specifies how rounding is performed. See +BigDecimal.mode+. Defaults to
+    #   +:default+.
+    #
+    #     number_to_human_size(123456, precision: 2, round_mode: :up)
+    #     # => "130 KB"
+    #
+    # [+:significant+]
+    #   Whether +:precision+ should be applied to significant digits instead of
+    #   fractional digits. Defaults to true.
+    #
+    # [+:separator+]
+    #   The decimal separator. Defaults to <tt>"."</tt>.
+    #
+    #     number_to_human_size(1234567, separator: ",")
+    #     # => "1,18 MB"
+    #
+    # [+:delimiter+]
+    #   The thousands delimiter. Defaults to <tt>","</tt>.
+    #
+    # [+:strip_insignificant_zeros+]
+    #   Whether to remove insignificant zeros after the decimal separator.
+    #   Defaults to true.
+    #
     def number_to_human_size(number, options = {})
       NumberToHumanSizeConverter.convert(number, options)
     end
 
-    # Pretty prints (formats and approximates) a number in a way it
-    # is more readable by humans (eg.: 1200000000 becomes "1.2
-    # Billion"). This is useful for numbers that can get very large
-    # (and too hard to read).
+    # Formats +number+ into a more human-friendly representation. Useful for
+    # numbers that can become very large and too hard to read.
     #
-    # See <tt>number_to_human_size</tt> if you want to print a file
-    # size.
+    #   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"
     #
-    # You can also define your own unit-quantifier names if you want
-    # to use other decimal units (eg.: 1500 becomes "1.5
-    # kilometers", 0.150 becomes "150 milliliters", etc). You may
-    # define a wide range of unit quantifiers, even fractional ones
-    # (centi, deci, mili, etc).
+    # See #number_to_human_size if you want to pretty-print a file size.
     #
     # ==== Options
     #
-    # * <tt>:locale</tt> - Sets the locale to be used for formatting
-    #   (defaults to current locale).
-    # * <tt>:precision</tt> - Sets the precision of the number
-    #   (defaults to 3).
-    # * <tt>:significant</tt> - If +true+, precision will be the number
-    #   of significant_digits. If +false+, the number of fractional
-    #   digits (defaults to +true+)
-    # * <tt>:separator</tt> - Sets the separator between the
-    #   fractional and integer digits (defaults to ".").
-    # * <tt>:delimiter</tt> - Sets the thousands delimiter (defaults
-    #   to "").
-    # * <tt>:strip_insignificant_zeros</tt> - If +true+ removes
-    #   insignificant zeros after the decimal separator (defaults to
-    #   +true+)
-    # * <tt>:units</tt> - A Hash of unit quantifier names. Or a
-    #   string containing an i18n scope where to find this hash. It
-    #   might have the following keys:
-    #   * *integers*: <tt>:unit</tt>, <tt>:ten</tt>,
-    #     <tt>:hundred</tt>, <tt>:thousand</tt>, <tt>:million</tt>,
-    #     <tt>:billion</tt>, <tt>:trillion</tt>,
-    #     <tt>:quadrillion</tt>
-    #   * *fractionals*: <tt>:deci</tt>, <tt>:centi</tt>,
-    #     <tt>:mili</tt>, <tt>:micro</tt>, <tt>:nano</tt>,
-    #     <tt>:pico</tt>, <tt>:femto</tt>
-    # * <tt>:format</tt> - Sets the format of the output string
-    #   (defaults to "%n %u"). The field types are:
-    #   * %u - The quantifier (ex.: 'thousand')
-    #   * %n - The number
-    #
-    # ==== Examples
-    #
-    #   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"
-    #
-    # Non-significant zeros after the decimal separator are stripped
-    # out by default (set <tt>:strip_insignificant_zeros</tt> to
-    # +false+ to change that):
-    #
-    # number_to_human(12.00001)                                       # => "12"
-    # number_to_human(12.00001, strip_insignificant_zeros: false)     # => "12.0"
-    #
-    # ==== Custom Unit Quantifiers
-    #
-    # You can also use your own custom unit quantifiers:
-    #  number_to_human(500000, units: { unit: 'ml', thousand: 'lt' })  # => "500 lt"
-    #
-    # If in your I18n locale you have:
-    #
-    #   distance:
-    #     centi:
-    #       one: "centimeter"
-    #       other: "centimeters"
-    #     unit:
-    #       one: "meter"
-    #       other: "meters"
-    #     thousand:
-    #       one: "kilometer"
-    #       other: "kilometers"
-    #     billion: "gazillion-distance"
-    #
-    # Then you could do:
-    #
-    #   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"
+    # [+:locale+]
+    #   The locale to use for formatting. Defaults to the current locale.
+    #
+    # [+:precision+]
+    #   The level of precision. Defaults to 3.
+    #
+    #     number_to_human(123456, precision: 2) # => "120 Thousand"
+    #     number_to_human(123456, precision: 4) # => "123.5 Thousand"
+    #
+    # [+:round_mode+]
+    #   Specifies how rounding is performed. See +BigDecimal.mode+. Defaults to
+    #   +:default+.
+    #
+    #     number_to_human(123456, precision: 2, round_mode: :up)
+    #     # => "130 Thousand"
+    #
+    # [+:significant+]
+    #   Whether +:precision+ should be applied to significant digits instead of
+    #   fractional digits. Defaults to true.
+    #
+    # [+:separator+]
+    #   The decimal separator. Defaults to <tt>"."</tt>.
+    #
+    #     number_to_human(123456, precision: 4, separator: ",")
+    #     # => "123,5 Thousand"
+    #
+    # [+:delimiter+]
+    #   The thousands delimiter. Defaults to <tt>","</tt>.
+    #
+    # [+:strip_insignificant_zeros+]
+    #   Whether to remove insignificant zeros after the decimal separator.
+    #   Defaults to true.
+    #
+    #     number_to_human(1000000)                                   # => "1 Million"
+    #     number_to_human(1000000, strip_insignificant_zeros: false) # => "1.00 Million"
+    #     number_to_human(10.01)                                     # => "10"
+    #     number_to_human(10.01, strip_insignificant_zeros: false)   # => "10.0"
+    #
+    # [+:format+]
+    #   The format of the output. <tt>%n</tt> represents the number, and
+    #   <tt>%u</tt> represents the quantifier (e.g., "Thousand"). Defaults to
+    #   <tt>"%n %u"</tt>.
+    #
+    # [+:units+]
+    #   A Hash of custom unit quantifier names.
+    #
+    #     number_to_human(1, units: { unit: "m", thousand: "km" })        # => "1 m"
+    #     number_to_human(100, units: { unit: "m", thousand: "km" })      # => "100 m"
+    #     number_to_human(1000, units: { unit: "m", thousand: "km" })     # => "1 km"
+    #     number_to_human(100000, units: { unit: "m", thousand: "km" })   # => "100 km"
+    #     number_to_human(10000000, units: { unit: "m", thousand: "km" }) # => "10000 km"
+    #
+    #   The following keys are supported for integer units: +:unit+, +:ten+,
+    #   +:hundred+, +:thousand+, +:million+, +:billion+, +:trillion+,
+    #   +:quadrillion+. Additionally, the following keys are supported for
+    #   fractional units: +:deci+, +:centi+, +:mili+, +:micro+, +:nano+,
+    #   +:pico+, +:femto+.
+    #
+    #   The Hash can also be defined as a scope in an I18n locale. For example:
+    #
+    #     en:
+    #       distance:
+    #         centi:
+    #           one: "centimeter"
+    #           other: "centimeters"
+    #         unit:
+    #           one: "meter"
+    #           other: "meters"
+    #         thousand:
+    #           one: "kilometer"
+    #           other: "kilometers"
+    #
+    #   Then it can be specified by name:
+    #
+    #     number_to_human(1, units: :distance)        # => "1 meter"
+    #     number_to_human(100, units: :distance)      # => "100 meters"
+    #     number_to_human(1000, units: :distance)     # => "1 kilometer"
+    #     number_to_human(100000, units: :distance)   # => "100 kilometers"
+    #     number_to_human(10000000, units: :distance) # => "10000 kilometers"
+    #     number_to_human(0.1, units: :distance)      # => "10 centimeters"
+    #     number_to_human(0.01, units: :distance)     # => "1 centimeter"
+    #
     def number_to_human(number, options = {})
       NumberToHumanConverter.convert(number, options)
     end