Skip to content
This repository
tree: 0d6e8edc2a
Fetching contributors…

Cannot retrieve contributors at this time

file 441 lines (416 sloc) 21.303 kb
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441
# encoding: utf-8

require 'active_support/core_ext/hash/keys'
require 'active_support/core_ext/string/output_safety'
require 'active_support/number_helper'

module ActionView
  # = Action View Number Helpers
  module Helpers #:nodoc:

    # Provides methods for converting numbers into formatted strings.
    # Methods are provided for phone numbers, currency, percentage,
    # 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.
    module NumberHelper

      # 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

      # Formats a +number+ into a US phone number (e.g., (555)
      # 123-9876). You can customize the format in the +options+ hash.
      #
      # ==== Options
      #
      # * <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.
      #
      # ==== 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("1234a567", raise: true) # => InvalidNumberError
      #
      # number_to_phone(1235551234, country_code: 1, extension: 1343, delimiter: ".")
      # # => +1.123.555.1234 x 1343
      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

      # Formats a +number+ into a currency string (e.g., $13.65). You
      # can customize the format in the +options+ hash.
      #
      # ==== 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 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.
      #
      # ==== 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(-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;
      def number_to_currency(number, options = {})
        return unless number
        options = escape_unsafe_delimiters_and_separators(options.symbolize_keys)

        wrap_with_output_safety_handling(number, options.delete(:raise)) {
          ActiveSupport::NumberHelper.number_to_currency(number, options)
        }
      end

      # Formats a +number+ as a percentage string (e.g., 65%). You can
      # customize the format in the +options+ hash.
      #
      # ==== 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 #
      # 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.
      #
      # ==== 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) # => 1 000,000%
      # number_to_percentage("98a") # => 98a%
      # number_to_percentage(100, format: "%n %") # => 100 %
      #
      # number_to_percentage("98a", raise: true) # => InvalidNumberError
      def number_to_percentage(number, options = {})
        return unless number
        options = escape_unsafe_delimiters_and_separators(options.symbolize_keys)

        wrap_with_output_safety_handling(number, options.delete(:raise)) {
          ActiveSupport::NumberHelper.number_to_percentage(number, options)
        }
      end

      # Formats a +number+ with grouped thousands using +delimiter+
      # (e.g., 12,324). You can customize the format in the +options+
      # hash.
      #
      # ==== 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>:raise</tt> - If true, raises +InvalidNumberError+ when
      # the argument is invalid.
      #
      # ==== Examples
      #
      # number_with_delimiter(12345678) # => 12,345,678
      # number_with_delimiter("123456") # => 123,456
      # number_with_delimiter(12345678.05) # => 12,345,678.05
      # number_with_delimiter(12345678, delimiter: ".") # => 12.345.678
      # number_with_delimiter(12345678, delimiter: ",") # => 12,345,678
      # number_with_delimiter(12345678.05, separator: " ") # => 12,345,678 05
      # number_with_delimiter(12345678.05, locale: :fr) # => 12 345 678,05
      # number_with_delimiter("112a") # => 112a
      # number_with_delimiter(98765432.98, delimiter: " ", separator: ",")
      # # => 98 765 432,98
      #
      # number_with_delimiter("112a", raise: true) # => raise InvalidNumberError
      def number_with_delimiter(number, options = {})
        options = escape_unsafe_delimiters_and_separators(options.symbolize_keys)

        wrap_with_output_safety_handling(number, options.delete(:raise)) {
          ActiveSupport::NumberHelper.number_to_delimited(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.
      #
      # ==== 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 #
      # 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.
      #
      # ==== Examples
      #
      # 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
      def number_with_precision(number, options = {})
        options = escape_unsafe_delimiters_and_separators(options.symbolize_keys)

        wrap_with_output_safety_handling(number, options.delete(:raise)) {
          ActiveSupport::NumberHelper.number_to_rounded(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.
      #
      # See <tt>number_to_human</tt> 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 #
      # 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.
      #
      # ==== 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(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
      #
      # Non-significant zeros after the fractional separator are
      # stripped out by default (set
      # <tt>:strip_insignificant_zeros</tt> to +false+ to change
      # that):
      #
      # number_to_human_size(1234567890123, precision: 5) # => "1.1229 TB"
      # number_to_human_size(524288000, precision: 5) # => "500 MB"
      def number_to_human_size(number, options = {})
        options = escape_unsafe_delimiters_and_separators(options.symbolize_keys)

        wrap_with_output_safety_handling(number, options.delete(:raise)) {
          ActiveSupport::NumberHelper.number_to_human_size(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).
      #
      # See <tt>number_to_human_size</tt> if you want to print a file
      # size.
      #
      # 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).
      #
      # ==== 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 #
      # 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.
      #
      # ==== 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"
      #
      # 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(12345012345, significant_digits: 6) # => "12.345 Billion"
      # number_to_human(500000000, precision: 5) # => "500 Million"
      #
      # ==== 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"
      #
      def number_to_human(number, options = {})
        options = escape_unsafe_delimiters_and_separators(options.symbolize_keys)

        wrap_with_output_safety_handling(number, options.delete(:raise)) {
          ActiveSupport::NumberHelper.number_to_human(number, options)
        }
      end

      private

      def escape_unsafe_delimiters_and_separators(options)
        options[:separator] = ERB::Util.html_escape(options[:separator]) if options[:separator] && !options[:separator].html_safe?
        options[:delimiter] = ERB::Util.html_escape(options[:delimiter]) if options[:delimiter] && !options[:delimiter].html_safe?
        options
      end

      def wrap_with_output_safety_handling(number, raise_on_invalid, &block)
        valid_float = valid_float?(number)
        raise InvalidNumberError, number if raise_on_invalid && !valid_float

        formatted_number = yield

        if valid_float || number.html_safe?
          formatted_number.html_safe
        else
          formatted_number
        end
      end

      def valid_float?(number)
        !parse_float(number, false).nil?
      end

      def parse_float(number, raise_error)
        Float(number)
      rescue ArgumentError, TypeError
        raise InvalidNumberError, number if raise_error
      end
    end
  end
end
Something went wrong with that request. Please try again.