si_senior 0.0.2 → 0.0.3

checksums.yaml

@@ -1,15 +1,15 @@
 ---
 !binary "U0hBMQ==":
   metadata.gz: !binary |-
-    MTQ1ZWQ2OWI1NDE3NjhiN2RlMDFlNThlZmUyY2IwMWY0N2VjM2YyOQ==
+    OThhNWEwYjRkYTVlMDY2NzNmZGUwMmFmNDQyOWExZjA3MDZjOWFkOQ==
   data.tar.gz: !binary |-
-    MjVmZGY3OTY1Y2JlM2Q0ODgyY2EwMzM4NzMzZmNlZjkwZjc3OTg4Mw==
+    MDFhMGEzZmYxZmZhOTkxYjM0ZWFhN2I1MjNiNTU3YWY3YTZkOTM0Ng==
 !binary "U0hBNTEy":
   metadata.gz: !binary |-
-    NmY3YWFmNzQ0MDY1ODM5YTc0ZDU1YzFkZWZlYTMyYjVjYzY5YjgyNzg2MzE3
-    MzAxNWJkYWNlZDYzZjUwNmY3Mjg2YTIwZjVjNTNmNWVkZTBjOGQzYTE2NTMx
-    YjRlNjM0Y2ZjZTI5MjY0MmUyYjBmNGFkYmJiY2FmZTU1YTVlY2M=
+    NGU5MzExMTJhZTUyYWZlOGZkMWI5MDAxMGM4N2ZiZjhmYjlhYzk2OTI4Njg4
+    YTJhNjQyOTExOGJmMTAwMDQ0OTlmZTEwNGY0ZWNlYTgwNzViYjc1YTg2Y2U2
+    ZWVlMDJiNzhhN2Y4N2NmMzJjYjA2MjJhNzBjZmIwYTkxYmZjNjk=
   data.tar.gz: !binary |-
-    MjUyNDczMDc4MmY5NDliMzk5MzVlOGUwYzBmN2FkOTA3YTk5ZDA5NTljYTBi
-    ODZmYzMyYjg2ZGNkNDZlN2E5Y2NlMGU5YjExOGRiOTVjMDk2MmViZjViYzg2
-    YmI1NmUxNDIzOWI4N2I5OTc1NjYyYTM2YjY3MWRhNzYxZDZkNWI=
+    ZTg3NDQzNWM1MGQwYzY4NDdiOTIxNWM0YmYwOTgyY2RmYjIwNDkzNmEyZjQ4
+    Y2Y5ZGNmMWQ1NWM1NmM5YTBjZDY0MGI1MzI1ODg0Njk2MWE0MTFkMjUyMGUz
+    N2RkZjA2YTFiYTIyMGUwZmE5YWQ3YjdkOGE4YWEzZDYxOTkxNjY=

data/README.md

@@ -4,6 +4,10 @@ SI señor
 SI señor is a simple SI prefix converter.<br>
 Assume that you always have basic SI unit for conversion (seconds for time, meters for length and so on).
 
+##### Important
+All operations are done on BigDecimal (numbers are automatically converted) - you have to use 
+[`BigDecimal#to_s(s)`](http://www.ruby-doc.org/stdlib-2.0/libdoc/bigdecimal/rdoc/BigDecimal.html#method-i-to_s) after prefixing or converting to get pretty formatting.
+
 #### Sample usage
 `1.milli`<br>
 `1.kilo.to_mega`<br>

data/lib/si_senior/core_ext.rb

@@ -5,165 +5,202 @@ module SiSenior
     require 'bigdecimal'
     include SiSenior::Constant
 
-    # Prefixes
+    # Returns BigDecimal result of prefixing with yotta (multiplies value by 1.0e+24)
     def yotta
       big_self * YOTTA
     end
 
+    # Returns BigDecimal result of prefixing with zetta (multiplies value by 1.0e+21)
     def zetta
       big_self * ZETTA
     end
 
+    # Returns BigDecimal result of prefixing with exa (multiplies value by 1.0e+18)
     def exa
       big_self * EXA
     end
 
+    # Returns BigDecimal result of prefixing with peta (multiplies value by 1.0e+15)
     def peta
       big_self * PETA
     end
 
+    # Returns BigDecimal result of prefixing with tera (multiplies value by 1.0e+12)
     def tera
       big_self * TERA
     end
 
+    # Returns BigDecimal result of prefixing with giga (multiplies value by 1.0e+9)
     def giga
       big_self * GIGA
     end
 
+    # Returns BigDecimal result of prefixing with mega (multiplies value by 1.0e+6)
     def mega
       big_self * MEGA
     end
 
+    # Returns BigDecimal result of prefixing with kilo (multiplies value by 1.0e+3)
     def kilo
       big_self * KILO
     end
 
+    # Returns BigDecimal result of prefixing with hecto (multiplies value by 1.0e+2)
     def hecto
       big_self * HECTO
     end
 
+    # Returns BigDecimal result of prefixing with deca (multiplies value by 1.0e+1)
     def deca
       big_self * DECA
     end
 
+    # Returns BigDecimal result of prefixing with deci (multiples value by 1.0e-1)
     def deci
       big_self * DECI
     end
 
+    # Returns BigDecimal result of prefixing with centi (multiples value by 1.0e-2)
     def centi
       big_self * CENTI
     end
 
+    # Returns BigDecimal result of prefixing with milli (multiples value by 1.0e-3)
     def milli
       big_self * MILLI
     end
 
+    # Returns BigDecimal result of prefixing with micro (multiples value by 1.0e-6)
     def micro
       big_self * MICRO
     end
 
+    # Returns BigDecimal result of prefixing with nano (multiples value by 1.0e-9)
     def nano
       big_self * NANO
     end
 
+    # Returns BigDecimal result of prefixing with pico (multiples value by 1.0e-12)
     def pico
       big_self * PICO
     end
 
+    # Returns BigDecimal result of prefixing with femto (multiples value by 1.0e-15)
     def femto
       big_self * FEMTO
     end
 
+    # Returns BigDecimal result of prefixing with atto (multiples value by 1.0e-18)
     def atto
       big_self * ATTO
     end
 
+    # Returns BigDecimal result of prefixing with zepto (multiples value by 1.0e-21)
     def zepto
       big_self * ZEPTO
     end
 
+    # Returns BigDecimal result of prefixing with yocto (multiples value by 1.0e-24)
     def yocto
       big_self * YOCTO
     end
 
-    # Converters
-
+    # Returns BigDecimal result of conversion to yotta (divides by 1.0e+24)
     def to_yotta
       big_self / YOTTA
     end
 
+    # Returns BigDecimal result of conversion to zetta (divides by 1.0e+21)
     def to_zetta
       big_self / ZETTA
     end
 
+    # Returns BigDecimal result of conversion to exa (divides by 1.0e+18)
     def to_exa
       big_self / EXA
     end
 
+    # Returns BigDecimal result of conversion to peta (divides by 1.0e+15)
     def to_peta
      big_self / PETA
     end
 
+    # Returns BigDecimal result of conversion to tera (divides by 1.0e+12)
     def to_tera
       big_self / TERA
     end
 
+    # Returns BigDecimal result of conversion to giga (divides by 1.0e+9)
     def to_giga
       big_self / GIGA
     end
 
+    # Returns BigDecimal result of conversion to mega (divides by 1.0e+6)
     def to_mega
       big_self / MEGA
     end
 
+    # Returns BigDecimal result of conversion to kilo (divides by 1.0e+3)
     def to_kilo
       big_self / KILO
     end
 
+    # Returns BigDecimal result of conversion to hecto (divides by 1.0e+2)
     def to_hecto
       big_self / HECTO
     end
 
+    # Returns BigDecimal result of conversion to deca (divides by 1.0e+1)
     def to_deca
       big_self / DECA
     end
 
+    # Returns BigDecimal result of conversion to deci (divides by 1.0e-1)
     def to_deci
       big_self / DECI
     end
 
+    # Returns BigDecimal result of conversion to centi (divides by 1.0e-2)
     def to_centi
       big_self / CENTI
     end
 
+    # Returns BigDecimal result of conversion to milli (divides by 1.0e-3)
     def to_milli
       big_self / MILLI
     end
 
+    # Returns BigDecimal result of conversion to micro (divides by 1.0e-6)
     def to_micro
       big_self / MICRO
     end
 
+    # Returns BigDecimal result of conversion to nano (divides by 1.0e-9)
     def to_nano
       big_self / NANO
     end
 
+    # Returns BigDecimal result of conversion to pico (divides by 1.0e-12)
     def to_pico
       big_self / PICO
     end
 
+    # Returns BigDecimal result of conversion to femto (divides by 1.0e-15)
     def to_femto
       big_self / FEMTO
     end
 
+    # Returns BigDecimal result of conversion to atto (divides by 1.0e-18)
     def to_atto
       big_self / ATTO
     end
 
+    # Returns BigDecimal result of conversion to zepto (divides by 1.0e-21)
     def to_zepto
       big_self / ZEPTO
     end
 
+    # Returns BigDecimal result of conversion to yocto (divides by 1.0e-24)
     def to_yocto
       big_self / YOCTO
     end

data/lib/si_senior/version.rb

@@ -1,3 +1,3 @@
 module SiSenior
-  VERSION = "0.0.2"
+  VERSION = "0.0.3"
 end

data/si_senior.gemspec

@@ -8,7 +8,7 @@ Gem::Specification.new do |spec|
   spec.version       = SiSenior::VERSION
   spec.authors       = ["Tomasz Wójcik"]
   spec.email         = ["wojcik.tomek@gmail.com"]
-  spec.description   = "SI unit converter. Supports prefixes (1.kilo, 5.mega etc) and conversions (1.to_mega, 5.mili.to_centi etc)"
+  spec.description   = "SI unit converter. Supports prefixes (1.kilo, 5.mega etc) and conversions (1.to_mega, 5.milli.to_centi etc)"
   spec.summary       = "SI unit converter."
   spec.homepage      = "https://github.com/tomaszwojcik/si_senior"
   spec.license       = "MIT"

data/spec/lib/si_senior_spec.rb

@@ -75,7 +75,7 @@ describe SiSenior do
   end
 
   # Investigate BigDecimal requirement here
-  # Probably this is  the float issue with big floats like 1.0e-21 and 1.0e-24
+  # Probably this is the float issue with big floats like 1.0e-21 and 1.0e-24
 
   it 'returns 1.0e-21 for 1.zepto' do
     expect(1.zepto).to eq BigDecimal.new('1.0e-21')
@@ -93,7 +93,7 @@ describe SiSenior do
     expect(1.yocto.to_yotta).to eq 1.0e-48
   end
 
-  it 'converting from and to thesame prefix returns 1' do
+  it 'converting from and to the same prefix returns 1' do
     expect(1.yotta.to_yotta).to eq 1
     expect(1.yocto.to_yocto).to eq 1
   end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: si_senior
 version: !ruby/object:Gem::Version
-  version: 0.0.2
+  version: 0.0.3
 platform: ruby
 authors:
 - Tomasz Wójcik
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-09-17 00:00:00.000000000 Z
+date: 2013-09-18 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -53,7 +53,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 description: SI unit converter. Supports prefixes (1.kilo, 5.mega etc) and conversions
-  (1.to_mega, 5.mili.to_centi etc)
+  (1.to_mega, 5.milli.to_centi etc)
 email:
 - wojcik.tomek@gmail.com
 executables: []