units-money 0.0.1 → 0.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 3ae4e44e51a6022d26084d8619fc7d258d787ae2
-  data.tar.gz: fe0e4b14ba1ba6caeb14c811d8b900f15014cdd8
+  metadata.gz: 979637dbcc82fc6e61e8359774b02f6c90762182
+  data.tar.gz: acee5476580cd1e0a0f40d0c4a917e17e7d3e3bc
 SHA512:
-  metadata.gz: ff550678a16e1eeb49b248296f3781bb82671e8d505344976b69a7deabaa91427a25fd312a7c7bbe3efd575403db609536e6b7481c7892a02f231aef93637648
-  data.tar.gz: cb6bc224a0b01e1158e69ab9db410594ddc5c5f29bfd5fbc2c97be6bbbefb73c8ba12f8b97ac1c6244ab11e8df00c6702f1df4393effed9ac1fc2b2301d2f394
+  metadata.gz: b2469df496d5010b40cae677428aaf4808ed2afa0f4e9abaafa7f9a5467871d0040df17f7372ceab2833640fc60acee00c5b5c60c49a417d047fe05207805897
+  data.tar.gz: a09949f3d91e9e4fcad5924b19009919b6539dc56fc8c88abb80373226d5f802ad0febe70136b3c421af181d03da88ce24fa8b90ee23c56c391461543fa2f428

data/README.md

@@ -11,7 +11,94 @@ units-money library / gem - units of (crypto) money (in integer) incl. ether / e
 
 ## Usage
 
-To be done
+[Money](#money)
+
+The following methods are added on `Integer` (`Fixnum` and `Bignum`)
+and always return another `Integer` (`Fixnum` and `Bignum`)
+object (in the base money unit) for now:
+
+### Exponential
+
+``` ruby
+E2  = 10**2   #                       100
+E3  = 10**3   #                      1000
+E4  = 10**4   #                    10_000
+E5  = 10**5   #                   100_000
+E6  = 10**6   #                 1_000_000
+E7  = 10**7   #                10_000_000
+E8  = 10**8   #               100_000_000
+E9  = 10**9   #             1_000_000_000
+E10 = 10**10  #            10_000_000_000
+E11 = 10**11  #           100_000_000_000
+E12 = 10**12  #         1_000_000_000_000
+E13 = 10**13  #        10_000_000_000_000
+E14 = 10**14  #       100_000_000_000_000
+E15 = 10**15  #     1_000_000_000_000_000
+E16 = 10**16  #    10_000_000_000_000_000
+E17 = 10**17  #   100_000_000_000_000_000
+E18 = 10**18  # 1_000_000_000_000_000_000
+
+def e3()  self * E3; end
+def e4()  self * E4; end
+def e5()  self * E5; end
+def e6()  self * E6; end
+def e7()  self * E7; end
+def e8()  self * E8; end
+def e9()  self * E9; end
+def e10() self * E10; end
+def e11() self * E11; end
+def e12() self * E12; end
+def e13() self * E13; end
+def e14() self * E14; end
+def e15() self * E15; end
+def e16() self * E16; end
+def e17() self * E17; end
+def e18() self * E18; end
+```
+
+
+### Ether
+
+``` ruby
+def.wei()        self; end
+def kwei()       self * e3; end
+def mwei()       self * e6; end
+def gwei()       self * e9; end
+def microether() self * e12; end
+def milliether() self * e15; end
+def ether()      self * e18; end
+
+########################################################
+## aliases
+alias_method :babbage,   :kwei
+alias_method :lovelace,  :mwei
+alias_method :shannon,   :gwei
+alias_method :szabo,     :microether
+alias_method :finney,    :milliether
+
+alias_method :microeth,  :microether
+alias_method :micro,     :microether
+alias_method :millieth,  :milliether
+alias_method :milli,     :milliether
+alias_method :eth,       :ether
+```
+
+
+
+
+### Money
+
+Note: The `Money` class  is for now just an empty "wrapper" around an integer:
+
+``` ruby
+class Money
+  def self.zero() 0; end
+end
+
+## "global" converter function e.g. Money(0)
+def Money( arg ) arg; end
+```
+
 
 
 ## License

data/lib/units-money.rb

@@ -22,6 +22,7 @@ def Money( arg ) arg; end
 
 
 module ExponentialUnits
+
   E2  = 10**2   #                       100
   E3  = 10**3   #                      1000
   E4  = 10**4   #                    10_000
@@ -56,7 +57,7 @@ module ExponentialUnits
   def e16() self * E16; end
   def e17() self * E17; end
   def e18() self * E18; end
-end
+end # module  ExponentialUnits
 
 
 module EtherUnits
@@ -80,12 +81,12 @@ module EtherUnits
   #   finney         => Hal Finney (1956-2014)
 
   def wei()        self; end
-  def kwei()       self * E3; end
-  def mwei()       self * E6; end
-  def gwei()       self * E9; end
-  def microether() self * E12; end
-  def milliether() self * E15; end
-  def ether()      self * E18; end
+  def kwei()       self * e3; end
+  def mwei()       self * e6; end
+  def gwei()       self * e9; end
+  def microether() self * e12; end
+  def milliether() self * e15; end
+  def ether()      self * e18; end
 
   ########################################################
   ## aliases

data/lib/units-money/version.rb

@@ -3,8 +3,8 @@
 module UnitsMoney
 
   MAJOR = 0
-  MINOR = 0
-  PATCH = 1
+  MINOR = 1
+  PATCH = 0
   VERSION = [MAJOR,MINOR,PATCH].join('.')
 
   def self.version

data/test/test_units_money.rb

@@ -17,9 +17,19 @@ def test_exponential
   assert_equal 1_000_000_000,             1.e9
   assert_equal 1_000_000,                 1.e6
   assert_equal 1_000,                     1.e3
+
+  assert_equal 1_000_000_000_000_000_000, Integer::E18
+  assert_equal 1_000_000_000_000_000,     Integer::E15
+  assert_equal 1_000_000_000_000,         Integer::E12
+  assert_equal 1_000_000_000,             Integer::E9
+  assert_equal 1_000_000,                 Integer::E6
+  assert_equal 1_000,                     Integer::E3
 end
 
+
 def test_ether
+  pp Integer.ancestors.inspect
+
   value = rand( 1_000_000_000 )
 
   assert_equal 1_000_000_000_000_000_000,       1.ether

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: units-money
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.1.0
 platform: ruby
 authors:
 - Gerald Bauer