number_helper.rb 27.3 KB
Newer Older
1 2
# encoding: utf-8

3
require 'active_support/core_ext/big_decimal/conversions'
4
require 'active_support/core_ext/object/blank'
S
Santiago Pastorino 已提交
5
require 'active_support/core_ext/string/output_safety'
J
Jeremy Kemper 已提交
6

7
module ActionView
R
Rizwan Reza 已提交
8
  # = Action View Number Helpers
9
  module Helpers #:nodoc:
10

11
    # Provides methods for converting numbers into formatted strings.
12
    # Methods are provided for phone numbers, currency, percentage,
13 14 15 16
    # precision, positional notation, file size and pretty printing.
    #
    # Most methods expect a +number+ argument, and will return it
    # unchanged if can't be converted into a valid number.
17
    module NumberHelper
18

19
      DEFAULT_CURRENCY_VALUES = { :format => "%u%n", :negative_format => "-%u%n", :unit => "$", :separator => ".", :delimiter => ",",
20 21
                                  :precision => 2, :significant => false, :strip_insignificant_zeros => false }

22 23 24 25 26 27 28 29 30
      # Raised when argument +number+ param given to the helpers is invalid and
      # the option :raise is set to  +true+.
      class InvalidNumberError < StandardError
        attr_accessor :number
        def initialize(number)
          @number = number
        end
      end

31 32
      # Formats a +number+ into a US phone number (e.g., (555)
      # 123-9876). You can customize the format in the +options+ hash.
33 34
      #
      # ==== Options
35
      #
36 37 38 39 40 41 42 43 44
      # * <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>:raise</tt> - If true, raises +InvalidNumberError+ when
      #   the argument is invalid.
45
      #
46
      # ==== Examples
47
      #
48
      #  number_to_phone(5551234)                                           # => 555-1234
49
      #  number_to_phone("5551234")                                         # => 555-1234
50 51 52 53 54
      #  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
55 56
      #  number_to_phone("123a456")                                         # => 123a456
      #
V
Vijay Dev 已提交
57
      #  number_to_phone("1234a567", :raise => true)                        # => InvalidNumberError
58
      #
59
      #  number_to_phone(1235551234, :country_code => 1, :extension => 1343, :delimiter => ".")
60
      #  # => +1.123.555.1234 x 1343
61
      def number_to_phone(number, options = {})
A
Aaron Patterson 已提交
62
        return unless number
63
        options = options.symbolize_keys
64

65
        parse_float(number, true) if options[:raise]
66

67
        number       = number.to_s.strip
68
        area_code    = options[:area_code]
69
        delimiter    = options[:delimiter] || "-"
70
        extension    = options[:extension]
71
        country_code = options[:country_code]
72

S
Santiago Pastorino 已提交
73
        if area_code
74
          number.gsub!(/(\d{1,3})(\d{3})(\d{4}$)/,"(\\1) \\2#{delimiter}\\3")
75
        else
76
          number.gsub!(/(\d{0,3})(\d{3})(\d{4})$/,"\\1#{delimiter}\\2#{delimiter}\\3")
77
          number.slice!(0, 1) if number.start_with?(delimiter) && !delimiter.blank?
78
        end
S
Santiago Pastorino 已提交
79

80
        str = ''
S
Santiago Pastorino 已提交
81 82
        str << "+#{country_code}#{delimiter}" unless country_code.blank?
        str << number
83
        str << " x #{extension}" unless extension.blank?
84
        ERB::Util.html_escape(str)
85 86
      end

87 88
      # Formats a +number+ into a currency string (e.g., $13.65). You
      # can customize the format in the +options+ hash.
89
      #
90
      # ==== Options
91
      #
92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111
      # * <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 an 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>:raise</tt> - If true, raises +InvalidNumberError+ when
      #   the argument is invalid.
112 113
      #
      # ==== Examples
114
      #
115 116 117
      #  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
118
      #  number_to_currency(1234567890.506, :locale => :fr)   # => 1 234 567 890,51 €
119 120
      #  number_to_currency("123a456")                        # => $123a456
      #
V
Vijay Dev 已提交
121
      #  number_to_currency("123a456", :raise => true)        # => InvalidNumberError
122
      #
123
      #  number_to_currency(-1234567890.50, :negative_format => "(%u%n)")
124
      #  # => ($1,234,567,890.50)
125
      #  number_to_currency(1234567890.50, :unit => "&pound;", :separator => ",", :delimiter => "")
126
      #  # => &pound;1234567890,50
127 128
      #  number_to_currency(1234567890.50, :unit => "&pound;", :separator => ",", :delimiter => "", :format => "%n %u")
      #  # => 1234567890,50 &pound;
129
      def number_to_currency(number, options = {})
130
        return unless number
131
        options = options.symbolize_keys
132

133
        currency = translations_for('currency', options[:locale])
134
        currency[:negative_format] ||= "-" + currency[:format] if currency[:format]
135

136
        defaults  = DEFAULT_CURRENCY_VALUES.merge(defaults_translations(options[:locale])).merge!(currency)
137
        defaults[:negative_format] = "-" + options[:format] if options[:format]
138
        options   = defaults.merge!(options)
139

140 141 142
        unit      = options.delete(:unit)
        format    = options.delete(:format)

143 144 145 146 147
        if number.to_f < 0
          format = options.delete(:negative_format)
          number = number.respond_to?("abs") ? number.abs : number.sub(/^-/, '')
        end

148 149
        begin
          value = number_with_precision(number, options.merge(:raise => true))
150
          format.gsub('%n', value).gsub('%u', unit).html_safe
151 152 153 154
        rescue InvalidNumberError => e
          if options[:raise]
            raise
          else
155
            formatted_number = format.gsub('%n', e.number).gsub('%u', unit)
156 157
            e.number.to_s.html_safe? ? formatted_number.html_safe : formatted_number
          end
158 159 160
        end
      end

161 162
      # Formats a +number+ as a percentage string (e.g., 65%). You can
      # customize the format in the +options+ hash.
163
      #
164
      # ==== Options
165
      #
166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183
      # * <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 #
      #   of significant_digits. If +false+, the # 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%").
      # * <tt>:raise</tt> - If true, raises +InvalidNumberError+ when
      #   the argument is invalid.
184 185
      #
      # ==== Examples
186
      #
187
      #  number_to_percentage(100)                                        # => 100.000%
188
      #  number_to_percentage("98")                                       # => 98.000%
189 190 191
      #  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%
192
      #  number_to_percentage(1000, :locale => :fr)                       # => 1 000,000%
193
      #  number_to_percentage("98a")                                      # => 98a%
R
Rodrigo Flores 已提交
194
      #  number_to_percentage(100, :format => "%n  %")                    # => 100  %
195
      #
V
Vijay Dev 已提交
196
      #  number_to_percentage("98a", :raise => true)                      # => InvalidNumberError
197
      def number_to_percentage(number, options = {})
198
        return unless number
199
        options = options.symbolize_keys
200

201 202
        defaults = format_translations('percentage', options[:locale])
        options  = defaults.merge!(options)
203

R
Rodrigo Flores 已提交
204 205
        format = options[:format] || "%n%"

206
        begin
R
Rodrigo Flores 已提交
207 208
          value = number_with_precision(number, options.merge(:raise => true))
          format.gsub(/%n/, value).html_safe
209 210 211 212
        rescue InvalidNumberError => e
          if options[:raise]
            raise
          else
213 214
            formatted_number = format.gsub(/%n/, e.number)
            e.number.to_s.html_safe? ? formatted_number.html_safe : formatted_number
215 216
          end
        end
217 218
      end

219 220 221
      # Formats a +number+ with grouped thousands using +delimiter+
      # (e.g., 12,324). You can customize the format in the +options+
      # hash.
222
      #
223
      # ==== Options
224
      #
225 226 227 228 229 230 231 232
      # * <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>:raise</tt> - If true, raises +InvalidNumberError+ when
      #   the argument is invalid.
233 234
      #
      # ==== Examples
235
      #
236
      #  number_with_delimiter(12345678)                        # => 12,345,678
237
      #  number_with_delimiter("123456")                        # => 123,456
238 239
      #  number_with_delimiter(12345678.05)                     # => 12,345,678.05
      #  number_with_delimiter(12345678, :delimiter => ".")     # => 12.345.678
V
Vijay Dev 已提交
240
      #  number_with_delimiter(12345678, :delimiter => ",")     # => 12,345,678
241
      #  number_with_delimiter(12345678.05, :separator => " ")  # => 12,345,678 05
242
      #  number_with_delimiter(12345678.05, :locale => :fr)     # => 12 345 678,05
243
      #  number_with_delimiter("112a")                          # => 112a
244
      #  number_with_delimiter(98765432.98, :delimiter => " ", :separator => ",")
245
      #  # => 98 765 432,98
246 247
      #
      #  number_with_delimiter("112a", :raise => true)          # => raise InvalidNumberError
248
      def number_with_delimiter(number, options = {})
249
        options = options.symbolize_keys
250

251
        parse_float(number, options[:raise]) or return number
252

253
        options = defaults_translations(options[:locale]).merge(options)
254

255
        parts = number.to_s.to_str.split('.')
256
        parts[0].gsub!(/(\d)(?=(\d\d\d)+(?!\d))/, "\\1#{options[:delimiter]}")
257
        safe_join(parts, options[:separator])
258
      end
259

260 261 262
      # 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+).
263 264 265
      # You can customize the format in the +options+ hash.
      #
      # ==== Options
266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282
      #
      # * <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 #
      #   of significant_digits. If +false+, the # 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>:raise</tt> - If true, raises +InvalidNumberError+ when
      #   the argument is invalid.
283
      #
284
      # ==== Examples
285
      #
286 287 288 289 290 291 292
      #  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
293
      #  number_with_precision(111.234, :locale => :fr)                             # => 111,234
294
      #
295
      #  number_with_precision(13, :precision => 5, :significant => true, :strip_insignificant_zeros => true)
296
      #  # => 13
297
      #
298
      #  number_with_precision(389.32314, :precision => 4, :significant => true)    # => 389.3
299 300
      #  number_with_precision(1111.2345, :precision => 2, :separator => ',', :delimiter => '.')
      #  # => 1.111,23
301
      def number_with_precision(number, options = {})
302
        options = options.symbolize_keys
303

304
        number = (parse_float(number, options[:raise]) or return number)
305

306 307
        defaults = format_translations('precision', options[:locale])
        options  = defaults.merge!(options)
308

309 310
        precision = options.delete :precision
        significant = options.delete :significant
311
        strip_insignificant_zeros = options.delete :strip_insignificant_zeros
312

313
        if significant and precision > 0
314 315 316
          if number == 0
            digits, rounded_number = 1, 0
          else
317
            digits = (Math.log10(number.abs) + 1).floor
318 319
            rounded_number = (BigDecimal.new(number.to_s) / BigDecimal.new((10 ** (digits - precision)).to_f.to_s)).round.to_f * 10 ** (digits - precision)
            digits = (Math.log10(rounded_number.abs) + 1).floor # After rounding, the number of digits may have changed
320
          end
321
          precision -= digits
322 323
          precision = precision > 0 ? precision : 0  #don't let it be negative
        else
324
          rounded_number = BigDecimal.new(number.to_s).round(precision).to_f
325
          rounded_number = rounded_number.zero? ? rounded_number.abs : rounded_number #prevent showing negative zeros
326
        end
327
        formatted_number = number_with_delimiter("%01.#{precision}f" % rounded_number, options)
328
        if strip_insignificant_zeros
329
          escaped_separator = Regexp.escape(options[:separator])
330
          formatted_number.sub(/(#{escaped_separator})(\d*[1-9])?0+\z/, '\1\2').sub(/#{escaped_separator}\z/, '').html_safe
331
        else
332
          formatted_number
333
        end
334
      end
335

336 337
      STORAGE_UNITS = [:byte, :kb, :mb, :gb, :tb].freeze

338 339 340 341
      # 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.
342
      #
343 344
      # See <tt>number_to_human</tt> if you want to pretty-print a
      # generic number.
345
      #
346
      # ==== Options
347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366
      #
      # * <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 #
      #   of significant_digits. If +false+, the # 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>:prefix</tt> - If +:si+ formats the number using the SI
      #   prefix (defaults to :binary)
      # * <tt>:raise</tt> - If true, raises +InvalidNumberError+ when
      #   the argument is invalid.
      #
367
      # ==== Examples
368
      #
369
      #  number_to_human_size(123)                                          # => 123 Bytes
370
      #  number_to_human_size(1234)                                         # => 1.21 KB
371
      #  number_to_human_size(12345)                                        # => 12.1 KB
372 373 374 375 376 377
      #  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
378
      #
379 380 381 382
      # Non-significant zeros after the fractional separator are
      # stripped out by default (set
      # <tt>:strip_insignificant_zeros</tt> to +false+ to change
      # that):
383
      #  number_to_human_size(1234567890123, :precision => 5)        # => "1.1229 TB"
M
Matt Duncan 已提交
384
      #  number_to_human_size(524288000, :precision => 5)            # => "500 MB"
385
      def number_to_human_size(number, options = {})
386
        options = options.symbolize_keys
387

388
        number = (parse_float(number, options[:raise]) or return number)
389

390 391
        defaults = format_translations('human', options[:locale])
        options  = defaults.merge!(options)
392

393 394
        #for backwards compatibility with those that didn't add strip_insignificant_zeros to their locale files
        options[:strip_insignificant_zeros] = true if not options.key?(:strip_insignificant_zeros)
395

396
        storage_units_format = I18n.translate(:'number.human.storage_units.format', :locale => options[:locale], :raise => true)
G
Guillermo Iguaran 已提交
397

398
        base = options[:prefix] == :si ? 1000 : 1024
399

400
        if number.to_i < base
401
          unit = I18n.translate(:'number.human.storage_units.units.byte', :locale => options[:locale], :count => number.to_i, :raise => true)
402
          storage_units_format.gsub(/%n/, number.to_i.to_s).gsub(/%u/, unit).html_safe
403 404
        else
          max_exp  = STORAGE_UNITS.size - 1
405
          exponent = (Math.log(number) / Math.log(base)).to_i # Convert to base
406
          exponent = max_exp if exponent > max_exp # we need this to avoid overflow for the highest unit
407
          number  /= base ** exponent
408 409 410 411

          unit_key = STORAGE_UNITS[exponent]
          unit = I18n.translate(:"number.human.storage_units.units.#{unit_key}", :locale => options[:locale], :count => number, :raise => true)

412
          formatted_number = number_with_precision(number, options)
413
          storage_units_format.gsub(/%n/, formatted_number).gsub(/%u/, unit).html_safe
414
        end
415
      end
416 417 418 419

      DECIMAL_UNITS = {0 => :unit, 1 => :ten, 2 => :hundred, 3 => :thousand, 6 => :million, 9 => :billion, 12 => :trillion, 15 => :quadrillion,
        -1 => :deci, -2 => :centi, -3 => :mili, -6 => :micro, -9 => :nano, -12 => :pico, -15 => :femto}.freeze

420 421 422 423
      # 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).
424
      #
425 426
      # See <tt>number_to_human_size</tt> if you want to print a file
      # size.
427
      #
428 429 430 431 432
      # You can also define you 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).
433 434
      #
      # ==== Options
V
Vijay Dev 已提交
435
      #
436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465
      # * <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 #
      #   of significant_digits. If +false+, the # 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
      # * <tt>:raise</tt> - If true, raises +InvalidNumberError+ when
      #   the argument is invalid.
466 467
      #
      # ==== Examples
468
      #
469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484
      #  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"
      #
485 486 487
      # Non-significant zeros after the decimal separator are stripped
      # out by default (set <tt>:strip_insignificant_zeros</tt> to
      # +false+ to change that):
488
      #  number_to_human(12345012345, :significant_digits => 6)       # => "12.345 Billion"
M
Matt Duncan 已提交
489
      #  number_to_human(500000000, :precision => 5)                  # => "500 Million"
490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506
      #
      # ==== 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"
R
R.T. Lechow 已提交
507
      #     billion: "gazillion-distance"
508 509 510 511 512
      #
      # Then you could do:
      #
      #  number_to_human(543934, :units => :distance)                              # => "544 kilometers"
      #  number_to_human(54393498, :units => :distance)                            # => "54400 kilometers"
R
R.T. Lechow 已提交
513
      #  number_to_human(54393498000, :units => :distance)                         # => "54.4 gazillion-distance"
514 515 516 517 518
      #  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"
      #
      def number_to_human(number, options = {})
519
        options = options.symbolize_keys
520

521
        number = (parse_float(number, options[:raise]) or return number)
522

523 524
        defaults = format_translations('human', options[:locale])
        options  = defaults.merge!(options)
525

526 527
        #for backwards compatibility with those that didn't add strip_insignificant_zeros to their locale files
        options[:strip_insignificant_zeros] = true if not options.key?(:strip_insignificant_zeros)
528

529 530
        inverted_du = DECIMAL_UNITS.invert

531 532 533 534 535 536 537 538 539 540
        units = options.delete :units
        unit_exponents = case units
        when Hash
          units
        when String, Symbol
          I18n.translate(:"#{units}", :locale => options[:locale], :raise => true)
        when nil
          I18n.translate(:"number.human.decimal_units.units", :locale => options[:locale], :raise => true)
        else
          raise ArgumentError, ":units must be a Hash or String translation scope."
541
        end.keys.map{|e_name| inverted_du[e_name] }.sort_by{|e| -e}
542

543
        number_exponent = number != 0 ? Math.log10(number.abs).floor : 0
544
        display_exponent = unit_exponents.find{ |e| number_exponent >= e } || 0
545 546 547 548 549 550 551 552 553 554 555 556 557
        number  /= 10 ** display_exponent

        unit = case units
        when Hash
          units[DECIMAL_UNITS[display_exponent]]
        when String, Symbol
          I18n.translate(:"#{units}.#{DECIMAL_UNITS[display_exponent]}", :locale => options[:locale], :count => number.to_i)
        else
          I18n.translate(:"number.human.decimal_units.units.#{DECIMAL_UNITS[display_exponent]}", :locale => options[:locale], :count => number.to_i)
        end

        decimal_format = options[:format] || I18n.translate(:'number.human.decimal_units.format', :locale => options[:locale], :default => "%n %u")
        formatted_number = number_with_precision(number, options)
558
        decimal_format.gsub(/%n/, formatted_number).gsub(/%u/, unit).strip.html_safe
559 560
      end

561 562
      private

563 564 565 566
      def format_translations(namespace, locale)
        defaults_translations(locale).merge(translations_for(namespace, locale))
      end

567 568 569 570 571 572 573 574
      def defaults_translations(locale)
        I18n.translate(:'number.format', :locale => locale, :default => {})
      end

      def translations_for(namespace, locale)
        I18n.translate(:"number.#{namespace}.format", :locale => locale, :default => {})
      end

575
      def parse_float(number, raise_error)
576 577
        Float(number)
      rescue ArgumentError, TypeError
578
        raise InvalidNumberError, number if raise_error
579
      end
580 581
    end
  end
582
end