friendly_numbers 0.1.0 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: d0ffa8e616e2a56a0eb4a48975b9cc33fd038ea9
-  data.tar.gz: 53f0f0beb3ed999a9b68b7609c549a53e4448b5c
+  metadata.gz: 083f9bc78bce7405ff3be9b4c98d54f513d51656
+  data.tar.gz: d8ae616f668ef23ca2cda1e03747a698c5e9acf0
 SHA512:
-  metadata.gz: eb9ff0ec92c89fcf2c9ce0db77108ede76abec1cb33ea2a971d9c200e2b982a216953bc2d74d767a3857e08a50055c89e3b54fa7389229ebb5bfda170c721f08
-  data.tar.gz: 5757ad5cfb357191bfa5e416f6a682d0e2f727940898930533bcca507404b095deff04f24e11d48a173d39579b83e7eb8679d9d429b506b3d060691c6984d525
+  metadata.gz: fce62b13582d6a10918e2678dbdc261ec1ebb084f6254b21a37ebc8c038475902b63729ae9ad01f8db323b16c441f80e89d17036a9d0bb768aa8a147a293d4f8
+  data.tar.gz: ff0a37dbcf10e3252d09259fb95db65f98f51ea18f0b34d9e6844ac76d78200ad61bc4617c995ac7feaf9cef09eec22afbc8e4d3f40e6c1e4140a7d759b7be92

data/lib/friendly_numbers.rb

@@ -1,17 +1,37 @@
 require "friendly_numbers/version"
 require "friendly_numbers/number_to_currency"
 require "friendly_numbers/number_to_human_size"
+require "friendly_numbers/number_to_percentage"
 
 module FriendlyNumbers
+  module_function
+
+  # Convert a Number to a currency-formatted String
+  #
+  # Options:
+  # precision:: number of decimal places
+  # unit:: symbol to prefix value
+  # separator:: symbol to separate thousands
   def number_to_currency(value, options = {})
     NumberToCurrency.convert(value, options)
   end
-  module_function :number_to_currency
 
+  # Convert a Number to a human-readable size of data
+  #
+  # Options:
+  # precision:: number of decimal places
+  # scales:: Array of abbreviations in order
   def number_to_human_size(bytes, options = {})
     NumberToHumanSize.convert(bytes, options)
   end
-  module_function :number_to_human_size
+
+  # Convert a Number to a percentage
+  #
+  # Options:
+  # precision:: number of decimal places
+  def number_to_percentage(value, options = {})
+    NumberToPercentage.convert(value, options)
+  end
 end
 
 Friendly = FriendlyNumbers

data/lib/friendly_numbers/number_to_currency.rb

@@ -1,14 +1,31 @@
 module FriendlyNumbers
   module NumberToCurrency
-    extend self
+    DEFAULTS = {
+      precision: 2,
+      unit: "$",
+      separator: ","
+    }
 
-    def convert(value, options)
-      options = {
-        precision: 2,
-        unit: "$"
-      }.merge(options)
+    module_function
 
-      format("%s%.#{options[:precision]}f", options[:unit], value)
+    def convert(value, options) # :nodoc:
+      options = DEFAULTS.merge(options)
+
+      whole, part = value.divmod(1)
+
+      parted = partition(whole, options[:separator])
+
+      options[:unit] +
+        parted +
+        format("%.#{options[:precision]}f", part)[1..-1] # Strip leading 0
+    end
+
+    def partition(whole, separator)
+      whole.to_s.chars.reverse
+        .each_slice(3)
+        .map(&:join)
+        .join(separator)
+        .reverse
     end
   end
 end

data/lib/friendly_numbers/number_to_human_size.rb

@@ -1,12 +1,14 @@
 module FriendlyNumbers
   module NumberToHumanSize
-    extend self
+    DEFAULTS = {
+      precision: 3,
+      scales: %w(Bytes KB MB GB TB PB EB ZB YB)
+    }
 
-    def convert(bytes, options)
-      options = {
-        precision: 3,
-        scales: %w(Bytes KB MB GB TB PB)
-      }.merge(options)
+    module_function
+
+    def convert(bytes, options) # :nodoc:
+      options = DEFAULTS.merge(options)
 
       value, scale = calculate_smallest_value_with_scale(bytes)
       precision = zero_precision_for_zero_remainder(value, options[:precision])
@@ -14,7 +16,7 @@ module FriendlyNumbers
       format("%.#{precision}f %s", value, options[:scales][scale])
     end
 
-    def calculate_smallest_value_with_scale(value)
+    def calculate_smallest_value_with_scale(value) # :nodoc:
       scale = 0
       while value >= 1024
         value /= 1024.0
@@ -23,7 +25,7 @@ module FriendlyNumbers
       [value, scale]
     end
 
-    def zero_precision_for_zero_remainder(value, default_precision = 0)
+    def zero_precision_for_zero_remainder(value, default_precision = 0) # :nodoc:
       if (value % 1).zero?
         0
       else

data/lib/friendly_numbers/number_to_percentage.rb

@@ -0,0 +1,15 @@
+module FriendlyNumbers
+  module NumberToPercentage
+    DEFAULTS = {
+      precision: 2
+    }
+
+    module_function
+
+    def convert(value, options) # :nodoc:
+      options = DEFAULTS.merge(options)
+
+      format("%.#{options[:precision]}f\%", value * 100)
+    end
+  end
+end

data/lib/friendly_numbers/version.rb

@@ -1,3 +1,3 @@
 module FriendlyNumbers
-  VERSION = "0.1.0"
+  VERSION = "0.2.0"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: friendly_numbers
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors:
 - Adam Daniels
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2017-02-03 00:00:00.000000000 Z
+date: 2017-03-11 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -75,6 +75,7 @@ files:
 - lib/friendly_numbers.rb
 - lib/friendly_numbers/number_to_currency.rb
 - lib/friendly_numbers/number_to_human_size.rb
+- lib/friendly_numbers/number_to_percentage.rb
 - lib/friendly_numbers/version.rb
 homepage: https://github.com/adam12/friendly_numbers
 licenses: