Module: Fossil::NumberHelper
- Included in:
- Sequel::Model
- Defined in:
- lib/support/number_helper.rb
Overview
Provides methods for converting numbers into formatted strings. Methods are provided for phone numbers, currency, percentage, precision, positional notation, and file size.
Instance Method Summary collapse
-
#number_to_currency(number, options = {}) ⇒ Object
Formats a
number
into a currency string (e.g., $13.65). -
#number_to_percentage(number, options = {}) ⇒ Object
Formats a
number
as a percentage string (e.g., 65%). -
#number_to_phone(number, options = {}) ⇒ Object
Formats a
number
into a US phone number (e.g., (555) 123-9876). -
#number_with_delimiter(number, *args) ⇒ Object
Formats a
number
with grouped thousands usingdelimiter
(e.g., 12,324). -
#number_with_precision(number, *args) ⇒ Object
Formats a
number
with the specified level of:precision
(e.g., 112.32 has a precision of 2).
Instance Method Details
#number_to_currency(number, options = {}) ⇒ Object
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 £
74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 |
# File 'lib/support/number_helper.rb', line 74 def number_to_currency(number, = {}) .symbolize_keys! defaults = I18n.translate(:'number.format', :locale => [:locale], :raise => true) rescue {} currency = I18n.translate(:'number.currency.format', :locale => [:locale], :raise => true) rescue {} defaults = defaults.merge(currency) precision = [:precision] || defaults[:precision] unit = [:unit] || defaults[:unit] separator = [:separator] || defaults[:separator] delimiter = [:delimiter] || defaults[:delimiter] format = [:format] || defaults[:format] separator = '' if precision == 0 begin format.gsub(/%n/, number_with_precision(number, :precision => precision, :delimiter => delimiter, :separator => separator) ).gsub(/%u/, unit) rescue number end end |
#number_to_percentage(number, options = {}) ⇒ Object
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%
113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 |
# File 'lib/support/number_helper.rb', line 113 def number_to_percentage(number, = {}) .symbolize_keys! defaults = I18n.translate(:'number.format', :locale => [:locale], :raise => true) rescue {} percentage = I18n.translate(:'number.percentage.format', :locale => [:locale], :raise => true) rescue {} defaults = defaults.merge(percentage) precision = [:precision] || defaults[:precision] separator = [:separator] || defaults[:separator] delimiter = [:delimiter] || defaults[:delimiter] begin number_with_precision(number, :precision => precision, :separator => separator, :delimiter => delimiter) + "%" rescue number end end |
#number_to_phone(number, options = {}) ⇒ Object
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
26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 |
# File 'lib/support/number_helper.rb', line 26 def number_to_phone(number, = {}) number = number.to_s.strip unless number.nil? = .symbolize_keys area_code = [:area_code] || nil delimiter = [:delimiter] || "-" extension = [:extension].to_s.strip || nil country_code = [:country_code] || nil begin str = "" str << "+#{country_code}#{delimiter}" unless country_code.blank? str << if area_code number.gsub!(/([0-9]{1,3})([0-9]{3})([0-9]{4}$)/, "(\\1) \\2#{delimiter}\\3") else number.gsub!(/([0-9]{0,3})([0-9]{3})([0-9]{4})$/, "\\1#{delimiter}\\2#{delimiter}\\3") number.starts_with?('-') ? number.slice!(1..-1) : number end str << " x #{extension}" unless extension.blank? str rescue number end end |
#number_with_delimiter(number, *args) ⇒ Object
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
155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 |
# File 'lib/support/number_helper.rb', line 155 def number_with_delimiter(number, *args) = args. .symbolize_keys! defaults = I18n.translate(:'number.format', :locale => [:locale], :raise => true) rescue {} unless args.empty? ActiveSupport::Deprecation.warn('number_with_delimiter takes an option hash ' + 'instead of separate delimiter and precision arguments.', caller) delimiter = args[0] || defaults[:delimiter] separator = args[1] || defaults[:separator] end delimiter ||= ([:delimiter] || defaults[:delimiter]) separator ||= ([:separator] || defaults[:separator]) begin parts = number.to_s.split('.') parts[0].gsub!(/(\d)(?=(\d\d\d)+(?!\d))/, "\\1#{delimiter}") parts.join(separator) rescue number end end |
#number_with_precision(number, *args) ⇒ Object
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
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 |
# File 'lib/support/number_helper.rb', line 200 def number_with_precision(number, *args) = args. .symbolize_keys! defaults = I18n.translate(:'number.format', :locale => [:locale], :raise => true) rescue {} precision_defaults = I18n.translate(:'number.precision.format', :locale => [:locale], :raise => true) rescue {} defaults = defaults.merge(precision_defaults) unless args.empty? ActiveSupport::Deprecation.warn('number_with_precision takes an option hash ' + 'instead of a separate precision argument.', caller) precision = args[0] || defaults[:precision] end precision ||= ([:precision] || defaults[:precision]) separator ||= ([:separator] || defaults[:separator]) delimiter ||= ([:delimiter] || defaults[:delimiter]) begin rounded_number = (Float(number) * (10 ** precision)).round.to_f / 10 ** precision number_with_delimiter("%01.#{precision}f" % rounded_number, :separator => separator, :delimiter => delimiter) rescue number end end |