Module | ActionView::Helpers::NumberHelper |
In: |
vendor/rails/actionpack/lib/action_view/helpers/number_helper.rb
|
Provides methods for converting numbers into formatted strings. Methods are provided for phone numbers, currency, percentage, precision, positional notation, and file size.
Formats a number into a currency string (e.g., $13.65). You can customize the format in the options hash.
%u The currency unit %n The number
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 £
# File vendor/rails/actionpack/lib/action_view/helpers/number_helper.rb, line 71 71: def number_to_currency(number, options = {}) 72: options = options.stringify_keys 73: precision = options["precision"] || 2 74: unit = options["unit"] || "$" 75: separator = precision > 0 ? options["separator"] || "." : "" 76: delimiter = options["delimiter"] || "," 77: format = options["format"] || "%u%n" 78: 79: begin 80: parts = number_with_precision(number, precision).split('.') 81: format.gsub(/%n/, number_with_delimiter(parts[0], delimiter) + separator + parts[1].to_s).gsub(/%u/, unit) 82: rescue 83: number 84: end 85: 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 change the default precision of 1 using the precision parameter precision.
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, 2) # => 1.18 MB number_to_human_size(483989, 0) # => 4 MB
# File vendor/rails/actionpack/lib/action_view/helpers/number_helper.rb, line 171 171: def number_to_human_size(size, precision=1) 172: size = Kernel.Float(size) 173: case 174: when size.to_i == 1; "1 Byte" 175: when size < 1.kilobyte; "%d Bytes" % size 176: when size < 1.megabyte; "%.#{precision}f KB" % (size / 1.0.kilobyte) 177: when size < 1.gigabyte; "%.#{precision}f MB" % (size / 1.0.megabyte) 178: when size < 1.terabyte; "%.#{precision}f GB" % (size / 1.0.gigabyte) 179: else "%.#{precision}f TB" % (size / 1.0.terabyte) 180: end.sub(/([0-9]\.\d*?)0+ /, '\1 ' ).sub(/\. /,' ') 181: rescue 182: nil 183: end
Formats a number as a percentage string (e.g., 65%). You can customize the format in the options hash.
number_to_percentage(100) # => 100.000% number_to_percentage(100, :precision => 0) # => 100% number_to_percentage(302.24398923423, :precision => 5) # => 302.24399%
# File vendor/rails/actionpack/lib/action_view/helpers/number_helper.rb, line 100 100: def number_to_percentage(number, options = {}) 101: options = options.stringify_keys 102: precision = options["precision"] || 3 103: separator = options["separator"] || "." 104: 105: begin 106: number = number_with_precision(number, precision) 107: parts = number.split('.') 108: if parts.at(1).nil? 109: parts[0] + "%" 110: else 111: parts[0] + separator + parts[1].to_s + "%" 112: end 113: rescue 114: number 115: end 116: end
Formats a number into a US phone number (e.g., (555) 123-9876). You can customize the format in the options hash.
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
# File vendor/rails/actionpack/lib/action_view/helpers/number_helper.rb, line 26 26: def number_to_phone(number, options = {}) 27: number = number.to_s.strip unless number.nil? 28: options = options.stringify_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
Formats a number with grouped thousands using delimiter (e.g., 12,324). You can customize the format using optional delimiter and separator parameters.
number_with_delimiter(12345678) # => 12,345,678 number_with_delimiter(12345678.05) # => 12,345,678.05 number_with_delimiter(12345678, ".") # => 12.345.678 number_with_delimiter(98765432.98, " ", ",") # => 98 765 432,98
# File vendor/rails/actionpack/lib/action_view/helpers/number_helper.rb, line 132 132: def number_with_delimiter(number, delimiter=",", separator=".") 133: begin 134: parts = number.to_s.split('.') 135: parts[0].gsub!(/(\d)(?=(\d\d\d)+(?!\d))/, "\\1#{delimiter}") 136: parts.join separator 137: rescue 138: number 139: end 140: end
Formats a number with the specified level of precision (e.g., 112.32 has a precision of 2). The default level of precision is 3.
number_with_precision(111.2345) # => 111.235 number_with_precision(111.2345, 2) # => 111.23 number_with_precision(13, 5) # => 13.00000 number_with_precision(389.32314, 0) # => 389
# File vendor/rails/actionpack/lib/action_view/helpers/number_helper.rb, line 150 150: def number_with_precision(number, precision=3) 151: "%01.#{precision}f" % ((Float(number) * (10 ** precision)).round.to_f / 10 ** precision) 152: rescue 153: number 154: end