Module: FriendlyNumbers

Defined in:
lib/friendly_numbers.rb,
lib/friendly_numbers/version.rb,
lib/friendly_numbers/seconds_to_time.rb,
lib/friendly_numbers/number_to_currency.rb,
lib/friendly_numbers/number_to_human_size.rb,
lib/friendly_numbers/number_to_percentage.rb

Defined Under Namespace

Modules: NumberToCurrency, NumberToHumanSize, NumberToPercentage, SecondsToTime

Constant Summary collapse

VERSION = 
"0.6.0"

Class Method Summary collapse

Class Method Details

.number_to_currency(value, options = {}) ⇒ Object

Convert a Number to a currency-formatted String

Options:

precision

number of decimal places

unit

symbol to prefix value

separator

symbol to separate thousands



16
17
18
 
# File 'lib/friendly_numbers.rb', line 16

def number_to_currency(value, options = {})
  NumberToCurrency.convert(value, options)
end

.number_to_human_size(bytes, options = {}) ⇒ Object

Convert a Number to a human-readable size of data

Options:

precision

number of decimal places

scales

Array of abbreviations in order



25
26
27
 
# File 'lib/friendly_numbers.rb', line 25

def number_to_human_size(bytes, options = {})
  NumberToHumanSize.convert(bytes, options)
end

.number_to_percentage(value, options = {}) ⇒ Object

Convert a Number to a percentage

Options:

precision

number of decimal places



33
34
35
 
# File 'lib/friendly_numbers.rb', line 33

def number_to_percentage(value, options = {})
  NumberToPercentage.convert(value, options)
end

.seconds_to_time(seconds, options = {}) ⇒ Object

Convert Seconds to an elapsed time

Options:

format

a callable object that receives hours, minutes, seconds as arguments



42
43
44
 
# File 'lib/friendly_numbers.rb', line 42

def seconds_to_time(seconds, options = {})
  SecondsToTime.convert(seconds, options)
end