Provides methods for converting numbers into formatted strings. Methods are provided for phone numbers, currency, percentage, precision, positional notation, and file size.
Methods
- number_to_currency
- number_to_human_size
- number_to_percentage
- number_to_phone
- number_with_delimiter
- number_with_precision
Constants
| STORAGE_UNITS | = | [:byte, :kb, :mb, :gb, :tb].freeze |
Public Instance methods
Formats a number into a currency string (e.g., $13.65). You can customize the format in the options hash.
Options
- :precision - Sets the level of precision (defaults to 2).
- :unit - Sets the denomination of the currency (defaults to "$").
- :separator - Sets the separator between the units (defaults to ".").
- :delimiter - Sets the thousands delimiter (defaults to ",").
- :format - Sets the format of the output string (defaults to
"%u%n"). The field types are:
%u The currency unit %n The number
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.50, :unit => "£", :separator => ",", :delimiter => "") # => £1234567890,50 number_to_currency(1234567890.50, :unit => "£", :separator => ",", :delimiter => "", :format => "%n %u") # => 1234567890,50 £
[ show source ]
# File actionpack/lib/action_view/helpers/number_helper.rb, line 73
73: def number_to_currency(number, options = {})
74: options.symbolize_keys!
75:
76: defaults = I18n.translate('number.format''number.format', :locale => options[:locale], :raise => true) rescue {}
77: currency = I18n.translate('number.currency.format''number.currency.format', :locale => options[:locale], :raise => true) rescue {}
78: defaults = defaults.merge(currency)
79:
80: precision = options[:precision] || defaults[:precision]
81: unit = options[:unit] || defaults[:unit]
82: separator = options[:separator] || defaults[:separator]
83: delimiter = options[:delimiter] || defaults[:delimiter]
84: format = options[:format] || defaults[:format]
85: separator = '' if precision == 0
86:
87: begin
88: format.gsub(/%n/, number_with_precision(number,
89: :precision => precision,
90: :delimiter => delimiter,
91: :separator => separator)
92: ).gsub(/%u/, unit).html_safe
93: rescue
94: number
95: end
96: end
Formats the bytes in size into a more understandable representation (e.g., giving it 1500 yields 1.5 KB). This method is useful for reporting file sizes to users. This method returns nil if size cannot be converted into a number. You can customize the format in the options hash.
Options
- :precision - Sets the level of precision (defaults to 1).
- :separator - Sets the separator between the units (defaults to ".").
- :delimiter - Sets the thousands delimiter (defaults to "").
Examples
number_to_human_size(123) # => 123 Bytes number_to_human_size(1234) # => 1.2 KB number_to_human_size(12345) # => 12.1 KB number_to_human_size(1234567) # => 1.2 MB number_to_human_size(1234567890) # => 1.1 GB number_to_human_size(1234567890123) # => 1.1 TB number_to_human_size(1234567, :precision => 2) # => 1.18 MB number_to_human_size(483989, :precision => 0) # => 473 KB number_to_human_size(1234567, :precision => 2, :separator => ',') # => 1,18 MB
Zeros after the decimal point are always stripped out, regardless of the specified precision:
helper.number_to_human_size(1234567890123, :precision => 5) # => "1.12283 TB" helper.number_to_human_size(524288000, :precision=>5) # => "500 MB"
You can still use number_to_human_size with the old API that accepts the precision as its optional second parameter:
number_to_human_size(1234567, 2) # => 1.18 MB number_to_human_size(483989, 0) # => 473 KB
[ show source ]
# File actionpack/lib/action_view/helpers/number_helper.rb, line 258
258: def number_to_human_size(number, *args)
259: return nil if number.nil?
260:
261: options = args.extract_options!
262: options.symbolize_keys!
263:
264: defaults = I18n.translate('number.format''number.format', :locale => options[:locale], :raise => true) rescue {}
265: human = I18n.translate('number.human.format''number.human.format', :locale => options[:locale], :raise => true) rescue {}
266: defaults = defaults.merge(human)
267:
268: unless args.empty?
269: ActiveSupport::Deprecation.warn('number_to_human_size takes an option hash ' +
270: 'instead of a separate precision argument.', caller)
271: precision = args[0] || defaults[:precision]
272: end
273:
274: precision ||= (options[:precision] || defaults[:precision])
275: separator ||= (options[:separator] || defaults[:separator])
276: delimiter ||= (options[:delimiter] || defaults[:delimiter])
277:
278: storage_units_format = I18n.translate('number.human.storage_units.format''number.human.storage_units.format', :locale => options[:locale], :raise => true)
279:
280: if number.to_i < 1024
281: unit = I18n.translate('number.human.storage_units.units.byte''number.human.storage_units.units.byte', :locale => options[:locale], :count => number.to_i, :raise => true)
282: storage_units_format.gsub(/%n/, number.to_i.to_s).gsub(/%u/, unit)
283: else
284: max_exp = STORAGE_UNITS.size - 1
285: number = Float(number)
286: exponent = (Math.log(number) / Math.log(1024)).to_i # Convert to base 1024
287: exponent = max_exp if exponent > max_exp # we need this to avoid overflow for the highest unit
288: number /= 1024 ** exponent
289:
290: unit_key = STORAGE_UNITS[exponent]
291: unit = I18n.translate("number.human.storage_units.units.#{unit_key}""number.human.storage_units.units.#{unit_key}", :locale => options[:locale], :count => number, :raise => true)
292:
293: begin
294: escaped_separator = Regexp.escape(separator)
295: formatted_number = number_with_precision(number,
296: :precision => precision,
297: :separator => separator,
298: :delimiter => delimiter
299: ).sub(/(#{escaped_separator})(\d*[1-9])?0+\z/, '\1\2').sub(/#{escaped_separator}\z/, '')
300: storage_units_format.gsub(/%n/, formatted_number).gsub(/%u/, unit)
301: rescue
302: number
303: end
304: end
305: end
Formats a number as a percentage string (e.g., 65%). You can customize the format in the options hash.
Options
- :precision - Sets the level of precision (defaults to 3).
- :separator - Sets the separator between the units (defaults to ".").
- :delimiter - Sets the thousands delimiter (defaults to "").
Examples
number_to_percentage(100) # => 100.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%
[ show source ]
# File actionpack/lib/action_view/helpers/number_helper.rb, line 111
111: def number_to_percentage(number, options = {})
112: options.symbolize_keys!
113:
114: defaults = I18n.translate('number.format''number.format', :locale => options[:locale], :raise => true) rescue {}
115: percentage = I18n.translate('number.percentage.format''number.percentage.format', :locale => options[:locale], :raise => true) rescue {}
116: defaults = defaults.merge(percentage)
117:
118: precision = options[:precision] || defaults[:precision]
119: separator = options[:separator] || defaults[:separator]
120: delimiter = options[:delimiter] || defaults[:delimiter]
121:
122: begin
123: number_with_precision(number,
124: :precision => precision,
125: :separator => separator,
126: :delimiter => delimiter) + "%"
127: rescue
128: number
129: end
130: end
Formats a number into a US phone number (e.g., (555) 123-9876). You can customize the format in the options hash.
Options
- :area_code - Adds parentheses around the area code.
- :delimiter - Specifies the delimiter to use (defaults to "-").
- :extension - Specifies an extension to add to the end of the generated number.
- :country_code - Sets the country code for the phone number.
Examples
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(1235551234, :country_code => 1, :extension => 1343, :delimiter => ".") => +1.123.555.1234 x 1343
[ show source ]
# File actionpack/lib/action_view/helpers/number_helper.rb, line 27
27: def number_to_phone(number, options = {})
28: number = number.to_s.strip unless number.nil?
29: options = options.symbolize_keys
30: area_code = options[:area_code] || nil
31: delimiter = options[:delimiter] || "-"
32: extension = options[:extension].to_s.strip || nil
33: country_code = options[:country_code] || nil
34:
35: begin
36: str = ""
37: str << "+#{country_code}#{delimiter}" unless country_code.blank?
38: str << if area_code
39: number.gsub!(/([0-9]{1,3})([0-9]{3})([0-9]{4}$)/,"(\\1) \\2#{delimiter}\\3")
40: else
41: number.gsub!(/([0-9]{0,3})([0-9]{3})([0-9]{4})$/,"\\1#{delimiter}\\2#{delimiter}\\3")
42: number.starts_with?('-') ? number.slice!(1..-1) : number
43: end
44: str << " x #{extension}" unless extension.blank?
45: str
46: rescue
47: number
48: end
49: end
Formats a number with grouped thousands using delimiter (e.g., 12,324). You can customize the format in the options hash.
Options
- :delimiter - Sets the thousands delimiter (defaults to ",").
- :separator - Sets the separator between the units (defaults to ".").
Examples
number_with_delimiter(12345678) # => 12,345,678 number_with_delimiter(12345678.05) # => 12,345,678.05 number_with_delimiter(12345678, :delimiter => ".") # => 12.345.678 number_with_delimiter(12345678, :separator => ",") # => 12,345,678 number_with_delimiter(98765432.98, :delimiter => " ", :separator => ",") # => 98 765 432,98
You can still use number_with_delimiter with the old API that accepts the delimiter as its optional second and the separator as its optional third parameter:
number_with_delimiter(12345678, " ") # => 12 345.678 number_with_delimiter(12345678.05, ".", ",") # => 12.345.678,05
[ show source ]
# File actionpack/lib/action_view/helpers/number_helper.rb, line 152
152: def number_with_delimiter(number, *args)
153: options = args.extract_options!
154: options.symbolize_keys!
155:
156: defaults = I18n.translate('number.format''number.format', :locale => options[:locale], :raise => true) rescue {}
157:
158: unless args.empty?
159: ActiveSupport::Deprecation.warn('number_with_delimiter takes an option hash ' +
160: 'instead of separate delimiter and precision arguments.', caller)
161: delimiter = args[0] || defaults[:delimiter]
162: separator = args[1] || defaults[:separator]
163: end
164:
165: delimiter ||= (options[:delimiter] || defaults[:delimiter])
166: separator ||= (options[:separator] || defaults[:separator])
167:
168: begin
169: parts = number.to_s.split('.')
170: parts[0].gsub!(/(\d)(?=(\d\d\d)+(?!\d))/, "\\1#{delimiter}")
171: parts.join(separator)
172: rescue
173: number
174: end
175: end
Formats a number with the specified level of :precision (e.g., 112.32 has a precision of 2). You can customize the format in the options hash.
Options
- :precision - Sets the level of precision (defaults to 3).
- :separator - Sets the separator between the units (defaults to ".").
- :delimiter - Sets the thousands delimiter (defaults to "").
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(1111.2345, :precision => 2, :separator => ',', :delimiter => '.') # => 1.111,23
You can still use number_with_precision with the old API that accepts the precision as its optional second parameter:
number_with_precision(number_with_precision(111.2345, 2) # => 111.23
[ show source ]
# File actionpack/lib/action_view/helpers/number_helper.rb, line 196
196: def number_with_precision(number, *args)
197: options = args.extract_options!
198: options.symbolize_keys!
199:
200: defaults = I18n.translate('number.format''number.format', :locale => options[:locale], :raise => true) rescue {}
201: precision_defaults = I18n.translate('number.precision.format''number.precision.format', :locale => options[:locale],
202: :raise => true) rescue {}
203: defaults = defaults.merge(precision_defaults)
204:
205: unless args.empty?
206: ActiveSupport::Deprecation.warn('number_with_precision takes an option hash ' +
207: 'instead of a separate precision argument.', caller)
208: precision = args[0] || defaults[:precision]
209: end
210:
211: precision ||= (options[:precision] || defaults[:precision])
212: separator ||= (options[:separator] || defaults[:separator])
213: delimiter ||= (options[:delimiter] || defaults[:delimiter])
214:
215: begin
216: rounded_number = (Float(number) * (10 ** precision)).round.to_f / 10 ** precision
217: number_with_delimiter("%01.#{precision}f" % rounded_number,
218: :separator => separator,
219: :delimiter => delimiter)
220: rescue
221: number
222: end
223: end