bitcoin-money 0.5.1 → 0.6.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 08edeaf50fc52e5e28e8527f576ad423068c0984
-  data.tar.gz: ce6c85461f45a2d973f55c889f413009c327d346
+  metadata.gz: c0d20b83dd14d7d669af9743fd274b681d78926b
+  data.tar.gz: aa2ef366382416fd818386bc799f26c51cc15629
 SHA512:
-  metadata.gz: 1d934297abb3aeb256c0edf9b2ca328576166c0822022382ba9d934097bce6169b05723a5c7079e16f2ca7461030f79cc72a22c96fbe95ed67aab2b87236ffcd
-  data.tar.gz: fcdcdacc578c5732d99ffa1101911a4642ce9fc9a38688e35235c7c8b64643ecd62cc5f13bc1126d627f066e2a218e910a6e8b5127cc5768550f8ae2ea811d8a
+  metadata.gz: 6289ad3afa3f266bc4e5e971acedae165b752dbc23d2132a01f60b9ff1f9888e40af23a6b4fa550cc975d7deec9056a926c67b2d9795dce3ff7b5e61c9e2fdae
+  data.tar.gz: f03cf0cc62259bcac9c14ea09a9377510585069b6505c34a2b93f4ea9570f30acbda0e83bc71391e99b71aff4afa81bdec2ea0bee6cadd9f546397c11d30e420

data/bitcoin-money.gemspec

@@ -4,11 +4,11 @@ $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
 
 Gem::Specification.new do |spec|
   spec.name          = "bitcoin-money"
-  spec.version       = "0.5.1"
+  spec.version       = "0.6.0"
   spec.authors       = ["James Larisch"]
   spec.email         = ["root@jameslarisch.com"]
-  spec.summary       = "Represent BTC like Money, with nice precision."
-  spec.description   = "Represent BTC like Money, with nice precision."
+  spec.summary       = "Intelligently manipulate Bitcoin with a Ruby object."
+  spec.description   = "Supports conversions and arithmetic."
   spec.homepage      = "https://github.com/zenchilabs/bitcoin-money"
   spec.license       = "MIT"
 

data/lib/btc.rb

@@ -1,65 +1,65 @@
 require 'bigdecimal'
 
-class Btc
+class BTC
   BTC = BigDecimal.new('1.0')
   MBTC = BigDecimal.new('0.001')
-  UBTC = BigDecimal.new('0.000001')
+  BIT = BigDecimal.new('0.000001')
   SATOSHI = BigDecimal.new('0.00000001')
 
   MIN_BTC = SATOSHI.to_f
   MIN_MBTC = 0.00001
-  MIN_UBTC = 0.01
+  MIN_BIT = 0.01
   MIN_SATOSHI = 1
 
   def initialize(amt)
-    raise ArgumentError, "BTC amount must not be less than #{MIN_BTC}" unless Btc.valid_btc(amt)
+    raise ArgumentError, "BTC amount must not be less than #{MIN_BTC}" unless self.class.valid_btc?(amt)
     @amt = BigDecimal.new(amt.to_f.to_s)
   end
 
   def self.from_mbtc(amt)
-    raise ArgumentError, "mBTC amount must not be less than #{MIN_MBTC}" unless Btc.valid_mbtc(amt)
-    Btc.new(BigDecimal.new(amt.to_f.to_s) * MBTC)
+    raise ArgumentError, "mBTC amount must not be less than #{MIN_MBTC}" unless self.valid_mbtc?(amt)
+    self.new(BigDecimal.new(amt.to_f.to_s) * MBTC)
   end
 
-  def self.from_ubtc(amt)
-    raise ArgumentError, "uBTC amount must not be less than #{MIN_UBTC}" unless Btc.valid_ubtc(amt)
-    Btc.new(BigDecimal.new(amt.to_f.to_s) * UBTC)
+  def self.from_bits(amt)
+    raise ArgumentError, "bits amount must not be less than #{MIN_BIT}" unless self.valid_bits?(amt)
+    self.new(BigDecimal.new(amt.to_f.to_s) * BIT)
   end
 
   def self.from_satoshis(amt)
-    raise ArgumentError, 'Satoshi amount must be > 1 or 0' unless Btc.valid_satoshis(amt)
-    Btc.new(BigDecimal.new(amt.to_i.to_f.to_s) * SATOSHI)
+    raise ArgumentError, 'Satoshi amount must be > 1 or 0' unless self.valid_satoshis?(amt)
+    self.new(BigDecimal.new(amt.to_i.to_f.to_s) * SATOSHI)
   end
 
-  def self.valid_btc(amt)
+  def self.valid_btc?(amt)
     amt.to_f >= SATOSHI.to_f || amt.to_f == 0.0
   end
 
-  def self.valid_mbtc(amt)
+  def self.valid_mbtc?(amt)
     amt.to_f >= MIN_MBTC || amt.to_f == 0.0
   end
 
-  def self.valid_ubtc(amt)
-    amt.to_f >= MIN_UBTC || amt.to_f == 0.0
+  def self.valid_bits?(amt)
+    amt.to_f >= MIN_BIT || amt.to_f == 0.0
   end
 
-  def self.valid_satoshis(amt)
+  def self.valid_satoshis?(amt)
     amt.to_i >= 0
   end
 
-  def btc
+  def to_btc
     @amt
   end
 
-  def mbtc
+  def to_mbtc
     @amt / MBTC
   end
 
-  def ubtc
-    @amt / UBTC
+  def to_bits
+    @amt / BIT
   end
 
-  def satoshis
+  def to_satoshis
     @amt / SATOSHI
   end
 
@@ -72,30 +72,30 @@ class Btc
   end
 
   def +(other)
-    Btc.new(@amt + other.btc)
+    self.class.new(@amt + other.to_btc)
   end
 
   def /(other)
-    Btc.new(@amt / other.btc)
+    self.class.new(@amt / other.to_btc)
   end
 
   def -(other)
-    Btc.new(@amt - other.btc)
+    self.class.new(@amt - other.to_btc)
   end
 
   def *(other)
-    Btc.new(@amt * other.btc)
+    self.class.new(@amt * other.to_btc)
   end
 
   def **(exp)
-    Btc.new(@amt ** exp)
+    self.class.new(@amt ** exp)
   end
 
   def ==(other)
-    @amt == other.btc
+    @amt == other.to_btc
   end
 
   def inspect
-    "#<Btc BTC:#{btc.to_f} mBTC:#{mbtc.to_f} uBTC:#{ubtc.to_f} Satoshis:#{satoshis.to_f}>"
+    "#<BTC:#{to_btc.to_f} mBTC:#{to_mbtc.to_f} bits:#{to_bits.to_f} Satoshis:#{to_satoshis.to_f}>"
   end
 end

data/spec/btc_spec.rb

@@ -1,83 +1,83 @@
 require 'btc'
 
-describe Btc do
+describe BTC do
 
   describe '#new' do
     it 'should initialize okay' do
-      b = Btc.new(12345)
-      expect(b.btc).to eq(BigDecimal.new('12345.0'))
+      b = BTC.new(12345)
+      expect(b.to_btc).to eq(BigDecimal.new('12345.0'))
     end
 
     it 'should throw error if invalid btc amount' do
-      expect{ Btc.new(0.00000000000001) }.to raise_error(ArgumentError)
+      expect{ BTC.new(0.00000000000001) }.to raise_error(ArgumentError)
     end
   end
 
   describe '.from_mbtc' do
     it 'should throw error if invalid mbtc amount' do
-      expect{ Btc.from_mbtc(Btc::SATOSHI) }.to raise_error(ArgumentError)
+      expect{ BTC.from_mbtc(BTC::SATOSHI) }.to raise_error(ArgumentError)
     end
   end
 
-  describe '.from_ubtc' do
-    it 'should throw error if invalid ubtc amount' do
-      expect{ Btc.from_ubtc(Btc::MIN_UBTC - 10) }.to raise_error(ArgumentError)
+  describe '.from_bits' do
+    it 'should throw error if invalid bit amount' do
+      expect{ BTC.from_bits(BTC::MIN_BIT - 10) }.to raise_error(ArgumentError)
     end
   end
 
   describe '.from_satoshis' do
     it 'should throw error if invalid satoshi amount' do
-      expect{ Btc.from_satoshis(-1) }.to raise_error(ArgumentError)
+      expect{ BTC.from_satoshis(-1) }.to raise_error(ArgumentError)
     end
   end
 
   it 'should convert btc to mbtc and back' do
-    expect(Btc.new(Btc::MBTC.to_f).mbtc).to eq(BigDecimal.new('1'))
-    expect(Btc.from_mbtc(1).btc).to eq(BigDecimal.new(Btc::MBTC))
+    expect(BTC.new(BTC::MBTC.to_f).to_mbtc).to eq(BigDecimal.new('1'))
+    expect(BTC.from_mbtc(1).to_btc).to eq(BigDecimal.new(BTC::MBTC))
   end
 
   it 'should convert btc to satoshis and back' do
-    expect(Btc.new(Btc::SATOSHI).satoshis).to eq(BigDecimal.new('1'))
-    expect(Btc.from_satoshis(1).btc).to eq(BigDecimal.new(Btc::SATOSHI))
+    expect(BTC.new(BTC::SATOSHI).to_satoshis).to eq(BigDecimal.new('1'))
+    expect(BTC.from_satoshis(1).to_btc).to eq(BigDecimal.new(BTC::SATOSHI))
   end
 
   it 'should convert mbtc to satoshis and back' do
-    expect(Btc.from_mbtc(1).satoshis).to eq(BigDecimal.new('100000'))
-    expect(Btc.from_satoshis(10000).mbtc).to eq(BigDecimal.new('0.1'))
+    expect(BTC.from_mbtc(1).to_satoshis).to eq(BigDecimal.new('100000'))
+    expect(BTC.from_satoshis(10000).to_mbtc).to eq(BigDecimal.new('0.1'))
   end
 
-  it 'should convert btc to ubtc and back' do
-    expect(Btc.new(1).ubtc).to eq(BigDecimal.new('1000000'))
-    expect(Btc.from_ubtc(12).btc).to eq(BigDecimal('.000012'))
+  it 'should convert btc to bit and back' do
+    expect(BTC.new(1).to_bits).to eq(BigDecimal.new('1000000'))
+    expect(BTC.from_bits(12).to_btc).to eq(BigDecimal('.000012'))
   end
 
   it 'should use equality correctly' do
-    expect(Btc.new(0.123)).to eq(Btc.from_mbtc(123))
-    expect(Btc.new(0.123)).to eq(Btc.from_satoshis(12300000))
-    expect(Btc.from_mbtc(12)).to eq(Btc.from_satoshis(1200000))
+    expect(BTC.new(0.123)).to eq(BTC.from_mbtc(123))
+    expect(BTC.new(0.123)).to eq(BTC.from_satoshis(12300000))
+    expect(BTC.from_mbtc(12)).to eq(BTC.from_satoshis(1200000))
   end
 
   it 'should use multiplication correctly' do
-    expect(Btc.new(0.1234) * Btc.new(0.1234)).to eq(Btc.new(BigDecimal.new('0.1234') * BigDecimal.new('0.1234')))
+    expect(BTC.new(0.1234) * BTC.new(0.1234)).to eq(BTC.new(BigDecimal.new('0.1234') * BigDecimal.new('0.1234')))
   end
 
   it 'should use division correctly' do
-    expect(Btc.new(0.1234) / Btc.new(0.1234)).to eq(Btc.new(BigDecimal.new('0.1234') / BigDecimal.new('0.1234')))
+    expect(BTC.new(0.1234) / BTC.new(0.1234)).to eq(BTC.new(BigDecimal.new('0.1234') / BigDecimal.new('0.1234')))
   end
 
   it 'should use addition correctly' do
-    expect(Btc.new(0.1234) + Btc.new(0.1234)).to eq(Btc.new(BigDecimal.new('0.1234') + BigDecimal.new('0.1234')))
+    expect(BTC.new(0.1234) + BTC.new(0.1234)).to eq(BTC.new(BigDecimal.new('0.1234') + BigDecimal.new('0.1234')))
   end
 
   it 'should use subtraction correctly' do
-    expect(Btc.new(0.1234) - Btc.new(0.1234)).to eq(Btc.new(BigDecimal.new('0.1234') - BigDecimal.new('0.1234')))
+    expect(BTC.new(0.1234) - BTC.new(0.1234)).to eq(BTC.new(BigDecimal.new('0.1234') - BigDecimal.new('0.1234')))
   end
 
   it 'should use to_f correctly' do
-    expect(Btc.new(1.5).to_f).to eq(1.5)
+    expect(BTC.new(1.5).to_f).to eq(1.5)
   end
 
   it 'should use to_i correctly' do
-    expect(Btc.new(1.4).to_i).to eq(1)
+    expect(BTC.new(1.4).to_i).to eq(1)
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: bitcoin-money
 version: !ruby/object:Gem::Version
-  version: 0.5.1
+  version: 0.6.0
 platform: ruby
 authors:
 - James Larisch
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-06-20 00:00:00.000000000 Z
+date: 2014-12-14 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rake
@@ -38,7 +38,7 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: 3.0.0
-description: Represent BTC like Money, with nice precision.
+description: Supports conversions and arithmetic.
 email:
 - root@jameslarisch.com
 executables: []
@@ -76,6 +76,7 @@ rubyforge_project:
 rubygems_version: 2.2.2
 signing_key: 
 specification_version: 4
-summary: Represent BTC like Money, with nice precision.
+summary: Intelligently manipulate Bitcoin with a Ruby object.
 test_files:
 - spec/btc_spec.rb
+has_rdoc: