si 0.1.1 → 0.1.2

data/README.md

@@ -20,6 +20,8 @@ Or install it yourself as:
 
 ### `si`
 
+Express a numeric value with SI prefix.
+
 ```ruby
 0.9.si            # '900m'
 9.si              # '9'
@@ -50,19 +52,32 @@ Or install it yourself as:
 9876543210000.si(:length => 5)  # '9.8765T'
 
 # For convenience, a single Fixnum is recognized as :length value
-9876543210000.si(5)  # '9.8765T'
+9876543210000.si(5)             # '9.8765T'
 ```
 
 ### `si_byte`
 
-`si_byte` is simply a shorcut for 
+`si_byte` is simply a shorcut for `number.si(:length => length, :base => 1024, :min_exp => 0) + 'B'`.
 
 ```ruby
-number.si(:length => length, :base => 1024, :min_exp => 0) + 'B'
+13255342817.si_byte(3)  # '12.3GB'
 ```
 
+## SI module methods: convert / revert
+
 ```ruby
-13255342817.si_byte(3)  # '12.3GB'
+SI.convert(9876543210000, :length => 5)  # '9.8765T'
+SI.revert('100k', :base => 1024)         # 102400.0
+```
+
+## Avoiding monkey-patching
+
+Require 'si/minimal' instead to avoid monkey-patching numeric classes.
+
+```ruby
+require 'si/minimal'
+
+SI.convert(987654321, 3)  # 988M
 ```
 
 ## Contributing

data/lib/si.rb

@@ -1,55 +1,5 @@
 # encoding: utf-8
 
-require "si/version"
-
-module SI
-  PREFIXES = Hash[ -8.upto(8).zip(%[yzafpnμm kMGTPEZY].chars.map(&:strip)) ]
-  DEFAULT = {
-    :length  =>    3,
-    :base    => 1000,
-    :min_exp =>   -8,
-    :max_exp =>    8,
-  }
-
-  def si options = {}
-    options = { :length => options } if options.is_a?(Fixnum) && options >= 3
-    options = DEFAULT.merge(options)
-    length,
-    min_exp,
-    max_exp = options.values_at(:length, :min_exp, :max_exp)
-    base    = options[:base].to_f
-    minus   = self < 0 ? '-' : ''
-    selfp   = self.abs
-
-    PREFIXES.keys.sort.reverse.select { |exp| (min_exp..max_exp).include? exp }.each do |exp|
-      denom = base ** exp
-      if selfp >= denom || exp == min_exp
-        val = selfp / denom
-        val = val.round [length - val.to_i.to_s.length, 0].max
-        val = val.to_i if exp == 0 && self.is_a?(Fixnum)
-        val = val.to_s.ljust(length + 1, '0') if val.is_a?(Float)
-
-        return "#{minus}#{val}#{PREFIXES[exp]}"
-      end
-    end
-
-    nil
-  end
-
-  def si_byte length = 3
-    self.si(:length => length, :base => 1024, :min_exp => 0) + 'B'
-  end
-end
-
-class Float
-  include SI
-end
-
-class Fixnum
-  include SI
-end
-
-class Bignum
-  include SI
-end
+require 'si/minimal'
+require 'si/patch'
 

data/lib/si/constants.rb

@@ -0,0 +1,13 @@
+# encoding: utf-8
+
+module SI
+  PREFIXES = Hash[ -8.upto(8).zip(%[yzafpnμm kMGTPEZY].chars.map(&:strip)) ]
+
+  DEFAULT = {
+    :length  =>    3,
+    :base    => 1000,
+    :min_exp =>   -8,
+    :max_exp =>    8,
+  }
+end
+

data/lib/si/minimal.rb

@@ -0,0 +1,4 @@
+require 'si/version'
+require 'si/constants'
+require 'si/module'
+

data/lib/si/module.rb

@@ -0,0 +1,49 @@
+module SI
+  class << self
+    def convert num, options = {}
+      options = { :length => options } if options.is_a?(Fixnum) && options >= 3
+      options = DEFAULT.merge(options)
+      length,
+      min_exp,
+      max_exp = options.values_at(:length, :min_exp, :max_exp)
+      base    = options[:base].to_f
+      minus   = num < 0 ? '-' : ''
+      nump    = num.abs
+
+      PREFIXES.keys.sort.reverse.select { |exp| (min_exp..max_exp).include? exp }.each do |exp|
+        denom = base ** exp
+        if nump >= denom || exp == min_exp
+          val = nump / denom
+          val = val.round [length - val.to_i.to_s.length, 0].max
+          val = val.to_i if exp == 0 && num.is_a?(Fixnum)
+          val = val.to_s.ljust(length + 1, '0') if val.is_a?(Float)
+
+          return "#{minus}#{val}#{PREFIXES[exp]}"
+        end
+      end
+
+      nil
+    end
+
+    def revert str, options = {}
+      options = DEFAULT.select { |k, v| k == :base }.merge(options)
+      base    = options[:base]
+      pair    = PREFIXES.to_a.find { |k, v| v == str[-1] }
+
+      if pair
+        str[0...-1].to_f * (options[:base] ** pair.first)
+      else
+        str.to_f
+      end
+    end
+  end
+
+  def si options = {}
+    SI.convert(self, options)
+  end
+
+  def si_byte length = 3
+    SI.convert(self, :length => length, :base => 1024, :min_exp => 0) + 'B'
+  end
+end
+

data/lib/si/patch.rb

@@ -0,0 +1,15 @@
+class Float
+  include SI
+end
+
+class Fixnum
+  include SI
+end
+
+class Bignum
+  include SI
+end
+
+class Rational
+  include SI
+end

data/lib/si/version.rb

@@ -1,3 +1,3 @@
 module SI
-  VERSION = "0.1.1"
+  VERSION = "0.1.2"
 end

data/test/test_si.rb

@@ -180,5 +180,21 @@ class TestSI < Test::Unit::TestCase
   def test_shortcut
     assert_equal '123.5M', 123450000.si(4)
   end
+
+  def test_module_methods
+    assert_equal '9.8765T',          SI.convert(9876543210000, :length => 5)
+    assert_equal 9876500000000,      SI.revert('9.8765T')
+    assert_equal 9876500000,         SI.revert('9.8765G')
+    assert_equal 9876500,            SI.revert('9.8765M')
+    assert_equal 9.8765 * 1024 ** 2, SI.revert('9.8765M', :base => 1024)
+    assert_equal 0.0098765,          SI.revert('9.8765m')
+    assert_equal 0.0098765,          SI.revert('9.8765m')
+    assert_equal 9.8765,             SI.revert('9.8765')
+    assert_equal 0.0,                SI.revert('hello') # FIXME
+  end
+
+  def test_rational
+    assert_equal '12.345n', (12345 * (10 ** -12)).si(5)
+  end
 end
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: si
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.1.2
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-09-11 00:00:00.000000000 Z
+date: 2012-09-13 00:00:00.000000000 Z
 dependencies: []
 description: Formats a number with SI prefix
 email:
@@ -24,6 +24,10 @@ files:
 - README.md
 - Rakefile
 - lib/si.rb
+- lib/si/constants.rb
+- lib/si/minimal.rb
+- lib/si/module.rb
+- lib/si/patch.rb
 - lib/si/version.rb
 - si.gemspec
 - test/test_si.rb