vendor/rails/actionpack/lib/action_view/helpers/number_helper.rb

   1 module ActionView
   2   module Helpers #:nodoc:
   3     # Provides methods for converting numbers into formatted strings.
   4     # Methods are provided for phone numbers, currency, percentage,
   5     # precision, positional notation, and file size.
   6     module NumberHelper
   7       # Formats a +number+ into a US phone number (e.g., (555) 123-9876). You can customize the format
   8       # in the +options+ hash.
   9       #
  10       # ==== Options
  11       # * <tt>:area_code</tt>  - Adds parentheses around the area code.
  12       # * <tt>:delimiter</tt>  - Specifies the delimiter to use (defaults to "-").
  13       # * <tt>:extension</tt>  - Specifies an extension to add to the end of the
  14       #   generated number.
  15       # * <tt>:country_code</tt>  - Sets the country code for the phone number.
  16       #
  17       # ==== Examples
  18       #  number_to_phone(1235551234)                                        # => 123-555-1234
  19       #  number_to_phone(1235551234, :area_code => true)                    # => (123) 555-1234
  20       #  number_to_phone(1235551234, :delimiter => " ")                     # => 123 555 1234
  21       #  number_to_phone(1235551234, :area_code => true, :extension => 555) # => (123) 555-1234 x 555
  22       #  number_to_phone(1235551234, :country_code => 1)                    # => +1-123-555-1234
  23       #
  24       #  number_to_phone(1235551234, :country_code => 1, :extension => 1343, :delimiter => ".")
  25       #  => +1.123.555.1234 x 1343
  26       def number_to_phone(number, options = {})
  27         number       = number.to_s.strip unless number.nil?
  28         options      = options.symbolize_keys
  29         area_code    = options[:area_code] || nil
  30         delimiter    = options[:delimiter] || "-"
  31         extension    = options[:extension].to_s.strip || nil
  32         country_code = options[:country_code] || nil
  33
  34         begin
  35           str = ""
  36           str << "+#{country_code}#{delimiter}" unless country_code.blank?
  37           str << if area_code
  38             number.gsub!(/([0-9]{1,3})([0-9]{3})([0-9]{4}$)/,"(\\1) \\2#{delimiter}\\3")
  39           else
  40             number.gsub!(/([0-9]{1,3})([0-9]{3})([0-9]{4})$/,"\\1#{delimiter}\\2#{delimiter}\\3")
  41           end
  42           str << " x #{extension}" unless extension.blank?
  43           str
  44         rescue
  45           number
  46         end
  47       end
  48
  49       # Formats a +number+ into a currency string (e.g., $13.65). You can customize the format
  50       # in the +options+ hash.
  51       #
  52       # ==== Options
  53       # * <tt>:precision</tt>  -  Sets the level of precision (defaults to 2).
  54       # * <tt>:unit</tt>       - Sets the denomination of the currency (defaults to "$").
  55       # * <tt>:separator</tt>  - Sets the separator between the units (defaults to ".").
  56       # * <tt>:delimiter</tt>  - Sets the thousands delimiter (defaults to ",").
  57       # * <tt>:format</tt>     - Sets the format of the output string (defaults to "%u%n"). The field types are:
  58       #
  59       #     %u  The currency unit
  60       #     %n  The number
  61       #
  62       # ==== Examples
  63       #  number_to_currency(1234567890.50)                    # => $1,234,567,890.50
  64       #  number_to_currency(1234567890.506)                   # => $1,234,567,890.51
  65       #  number_to_currency(1234567890.506, :precision => 3)  # => $1,234,567,890.506
  66       #
  67       #  number_to_currency(1234567890.50, :unit => "&pound;", :separator => ",", :delimiter => "")
  68       #  # => &pound;1234567890,50
  69       #  number_to_currency(1234567890.50, :unit => "&pound;", :separator => ",", :delimiter => "", :format => "%n %u")
  70       #  # => 1234567890,50 &pound;
  71       def number_to_currency(number, options = {})
  72         options.symbolize_keys!
  73
  74         defaults  = I18n.translate(:'number.format', :locale => options[:locale], :raise => true) rescue {}
  75         currency  = I18n.translate(:'number.currency.format', :locale => options[:locale], :raise => true) rescue {}
  76         defaults  = defaults.merge(currency)
  77
  78         precision = options[:precision] || defaults[:precision]
  79         unit      = options[:unit]      || defaults[:unit]
  80         separator = options[:separator] || defaults[:separator]
  81         delimiter = options[:delimiter] || defaults[:delimiter]
  82         format    = options[:format]    || defaults[:format]
  83         separator = '' if precision == 0
  84
  85         begin
  86           format.gsub(/%n/, number_with_precision(number,
  87             :precision => precision,
  88             :delimiter => delimiter,
  89             :separator => separator)
  90           ).gsub(/%u/, unit)
  91         rescue
  92           number
  93         end
  94       end
  95
  96       # Formats a +number+ as a percentage string (e.g., 65%). You can customize the
  97       # format in the +options+ hash.
  98       #
  99       # ==== Options
 100       # * <tt>:precision</tt>  - Sets the level of precision (defaults to 3).
 101       # * <tt>:separator</tt>  - Sets the separator between the units (defaults to ".").
 102       # * <tt>:delimiter</tt>  - Sets the thousands delimiter (defaults to "").
 103       #
 104       # ==== Examples
 105       #  number_to_percentage(100)                                        # => 100.000%
 106       #  number_to_percentage(100, :precision => 0)                       # => 100%
 107       #  number_to_percentage(1000, :delimiter => '.', :separator => ',') # => 1.000,000%
 108       #  number_to_percentage(302.24398923423, :precision => 5)           # => 302.24399%
 109       def number_to_percentage(number, options = {})
 110         options.symbolize_keys!
 111
 112         defaults   = I18n.translate(:'number.format', :locale => options[:locale], :raise => true) rescue {}
 113         percentage = I18n.translate(:'number.percentage.format', :locale => options[:locale], :raise => true) rescue {}
 114         defaults  = defaults.merge(percentage)
 115
 116         precision = options[:precision] || defaults[:precision]
 117         separator = options[:separator] || defaults[:separator]
 118         delimiter = options[:delimiter] || defaults[:delimiter]
 119
 120         begin
 121           number_with_precision(number,
 122             :precision => precision,
 123             :separator => separator,
 124             :delimiter => delimiter) + "%"
 125         rescue
 126           number
 127         end
 128       end
 129
 130       # Formats a +number+ with grouped thousands using +delimiter+ (e.g., 12,324). You can
 131       # customize the format in the +options+ hash.
 132       #
 133       # ==== Options
 134       # * <tt>:delimiter</tt>  - Sets the thousands delimiter (defaults to ",").
 135       # * <tt>:separator</tt>  - Sets the separator between the units (defaults to ".").
 136       #
 137       # ==== Examples
 138       #  number_with_delimiter(12345678)                        # => 12,345,678
 139       #  number_with_delimiter(12345678.05)                     # => 12,345,678.05
 140       #  number_with_delimiter(12345678, :delimiter => ".")     # => 12.345.678
 141       #  number_with_delimiter(12345678, :seperator => ",")     # => 12,345,678
 142       #  number_with_delimiter(98765432.98, :delimiter => " ", :separator => ",")
 143       #  # => 98 765 432,98
 144       #
 145       # You can still use <tt>number_with_delimiter</tt> with the old API that accepts the
 146       # +delimiter+ as its optional second and the +separator+ as its
 147       # optional third parameter:
 148       #  number_with_delimiter(12345678, " ")                     # => 12 345.678
 149       #  number_with_delimiter(12345678.05, ".", ",")             # => 12.345.678,05
 150       def number_with_delimiter(number, *args)
 151         options = args.extract_options!
 152         options.symbolize_keys!
 153
 154         defaults = I18n.translate(:'number.format', :locale => options[:locale], :raise => true) rescue {}
 155
 156         unless args.empty?
 157           ActiveSupport::Deprecation.warn('number_with_delimiter takes an option hash ' +
 158             'instead of separate delimiter and precision arguments.', caller)
 159           delimiter = args[0] || defaults[:delimiter]
 160           separator = args[1] || defaults[:separator]
 161         end
 162
 163         delimiter ||= (options[:delimiter] || defaults[:delimiter])
 164         separator ||= (options[:separator] || defaults[:separator])
 165
 166         begin
 167           parts = number.to_s.split('.')
 168           parts[0].gsub!(/(\d)(?=(\d\d\d)+(?!\d))/, "\\1#{delimiter}")
 169           parts.join(separator)
 170         rescue
 171           number
 172         end
 173       end
 174
 175       # Formats a +number+ with the specified level of <tt>:precision</tt> (e.g., 112.32 has a precision of 2).
 176       # You can customize the format in the +options+ hash.
 177       #
 178       # ==== Options
 179       # * <tt>:precision</tt>  - Sets the level of precision (defaults to 3).
 180       # * <tt>:separator</tt>  - Sets the separator between the units (defaults to ".").
 181       # * <tt>:delimiter</tt>  - Sets the thousands delimiter (defaults to "").
 182       #
 183       # ==== Examples
 184       #  number_with_precision(111.2345)                    # => 111.235
 185       #  number_with_precision(111.2345, :precision => 2)   # => 111.23
 186       #  number_with_precision(13, :precision => 5)         # => 13.00000
 187       #  number_with_precision(389.32314, :precision => 0)  # => 389
 188       #  number_with_precision(1111.2345, :precision => 2, :separator => ',', :delimiter => '.')
 189       #  # => 1.111,23
 190       #
 191       # You can still use <tt>number_with_precision</tt> with the old API that accepts the
 192       # +precision+ as its optional second parameter:
 193       #   number_with_precision(number_with_precision(111.2345, 2)   # => 111.23
 194       def number_with_precision(number, *args)
 195         options = args.extract_options!
 196         options.symbolize_keys!
 197
 198         defaults           = I18n.translate(:'number.format', :locale => options[:locale], :raise => true) rescue {}
 199         precision_defaults = I18n.translate(:'number.precision.format', :locale => options[:locale],
 200                                                                         :raise => true) rescue {}
 201         defaults           = defaults.merge(precision_defaults)
 202
 203         unless args.empty?
 204           ActiveSupport::Deprecation.warn('number_with_precision takes an option hash ' +
 205             'instead of a separate precision argument.', caller)
 206           precision = args[0] || defaults[:precision]
 207         end
 208
 209         precision ||= (options[:precision] || defaults[:precision])
 210         separator ||= (options[:separator] || defaults[:separator])
 211         delimiter ||= (options[:delimiter] || defaults[:delimiter])
 212
 213         begin
 214           rounded_number = (Float(number) * (10 ** precision)).round.to_f / 10 ** precision
 215           number_with_delimiter("%01.#{precision}f" % rounded_number,
 216             :separator => separator,
 217             :delimiter => delimiter)
 218         rescue
 219           number
 220         end
 221       end
 222
 223       STORAGE_UNITS = %w( Bytes KB MB GB TB ).freeze
 224
 225       # Formats the bytes in +size+ into a more understandable representation
 226       # (e.g., giving it 1500 yields 1.5 KB). This method is useful for
 227       # reporting file sizes to users. This method returns nil if
 228       # +size+ cannot be converted into a number. You can customize the
 229       # format in the +options+ hash.
 230       #
 231       # ==== Options
 232       # * <tt>:precision</tt>  - Sets the level of precision (defaults to 1).
 233       # * <tt>:separator</tt>  - Sets the separator between the units (defaults to ".").
 234       # * <tt>:delimiter</tt>  - Sets the thousands delimiter (defaults to "").
 235       #
 236       # ==== Examples
 237       #  number_to_human_size(123)                                          # => 123 Bytes
 238       #  number_to_human_size(1234)                                         # => 1.2 KB
 239       #  number_to_human_size(12345)                                        # => 12.1 KB
 240       #  number_to_human_size(1234567)                                      # => 1.2 MB
 241       #  number_to_human_size(1234567890)                                   # => 1.1 GB
 242       #  number_to_human_size(1234567890123)                                # => 1.1 TB
 243       #  number_to_human_size(1234567, :precision => 2)                     # => 1.18 MB
 244       #  number_to_human_size(483989, :precision => 0)                      # => 473 KB
 245       #  number_to_human_size(1234567, :precision => 2, :separator => ',')  # => 1,18 MB
 246       #
 247       # You can still use <tt>number_to_human_size</tt> with the old API that accepts the
 248       # +precision+ as its optional second parameter:
 249       #  number_to_human_size(1234567, 2)    # => 1.18 MB
 250       #  number_to_human_size(483989, 0)     # => 473 KB
 251       def number_to_human_size(number, *args)
 252         return number.nil? ? nil : pluralize(number.to_i, "Byte") if number.to_i < 1024
 253
 254         options = args.extract_options!
 255         options.symbolize_keys!
 256
 257         defaults = I18n.translate(:'number.format', :locale => options[:locale], :raise => true) rescue {}
 258         human    = I18n.translate(:'number.human.format', :locale => options[:locale], :raise => true) rescue {}
 259         defaults = defaults.merge(human)
 260
 261         unless args.empty?
 262           ActiveSupport::Deprecation.warn('number_to_human_size takes an option hash ' +
 263             'instead of a separate precision argument.', caller)
 264           precision = args[0] || defaults[:precision]
 265         end
 266
 267         precision ||= (options[:precision] || defaults[:precision])
 268         separator ||= (options[:separator] || defaults[:separator])
 269         delimiter ||= (options[:delimiter] || defaults[:delimiter])
 270
 271         max_exp  = STORAGE_UNITS.size - 1
 272         number   = Float(number)
 273         exponent = (Math.log(number) / Math.log(1024)).to_i # Convert to base 1024
 274         exponent = max_exp if exponent > max_exp # we need this to avoid overflow for the highest unit
 275         number  /= 1024 ** exponent
 276         unit     = STORAGE_UNITS[exponent]
 277
 278         begin
 279           escaped_separator = Regexp.escape(separator)
 280           number_with_precision(number,
 281             :precision => precision,
 282             :separator => separator,
 283             :delimiter => delimiter
 284           ).sub(/(\d)(#{escaped_separator}[1-9]*)?0+\z/, '\1\2').sub(/#{escaped_separator}\z/, '') + " #{unit}"
 285         rescue
 286           number
 287         end
 288       end
 289     end
 290   end
 291 end