mroch-BigMoney 0.1.0

data/History.txt

@@ -0,0 +1,4 @@
+=== 0.1.0 / 2008-06-21
+
+* Initial beta release
+

data/LICENSE.txt

@@ -0,0 +1,20 @@
+Copyright (c) 2008 Marshall Roch
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/Manifest.txt

@@ -0,0 +1,10 @@
+History.txt
+LICENSE.txt
+Manifest.txt
+README.txt
+Rakefile
+bigmoney.gemspec
+lib/big_money.rb
+lib/big_money/big_money.rb
+lib/big_money/core_extensions.rb
+test/test_big_money.rb

data/README.txt

@@ -0,0 +1,70 @@
+= BigMoney
+
+== DESCRIPTION:
+
+Represents an amount of money in a particular currency. Backed by BigDecimal, 
+so is safe from float rounding errors.
+
+== FEATURES:
+
+* Encapsulates an amount with its currency into a single object.
+
+* Backed by BigDecimal, so it can store arbitrary-precision values without 
+  rounding errors. Useful if you're dealing with fractional cents.
+
+== PROBLEMS:
+
+* Does not implement all of Numeric, so doesn't quite act like a real number
+
+* Doesn't allow currency conversion (patches welcome)
+
+* Has a slightly different API than the Money package 
+  (http://dist.leetsoft.com/api/money/)
+
+== SYNOPSIS:
+
+  bm = BigMoney.new('3.99')
+  bm.amount                       #=> BigDecimal.new('3.99')
+  bm.currency                     #=> :USD
+  bm.to_s                         #=> '3.99'
+  bm.to_formatted_s('$%.2f')      #=> '$3.99'
+  bm.to_formatted_s('$%.2f %s')   #=> '$3.99 USD'
+  
+  bm2 = BigMoney.new(1)
+  bm + bm2                        #=> BigMoney.new(4.99)
+  bm + 1                          #=> BigMoney.new(4.99)
+
+== INSTALL:
+
+* Via git:
+
+    git clone git://github.com/mroch/bigmoney.git
+
+* From RubyForge: TBA
+
+* Via gem: TBA
+
+== LICENSE:
+
+(The MIT License)
+
+Copyright (c) 2008 Marshall Roch
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+'Software'), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED 'AS IS', WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
+IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY
+CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
+TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE
+SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/Rakefile

@@ -0,0 +1,11 @@
+# -*- ruby -*-
+
+require 'rubygems'
+require 'hoe'
+require './lib/big_money.rb'
+
+Hoe.new('BigMoney', BigMoney::VERSION) do |p|
+  p.developer('Marshall Roch', 'mroch@cmu.edu')
+end
+
+# vim: syntax=Ruby

data/bigmoney.gemspec

@@ -0,0 +1,27 @@
+Gem::Specification.new do |s|
+  s.name = "BigMoney"
+  s.version = "0.1.0"
+  s.date = "2008-06-21"
+  s.summary = "Represents an amount of money in a particular currency."
+  s.email = "mroch@cmu.edu"
+  s.homepage = "http://github.com/mroch/bigmoney"
+  s.description = "Represents an amount of money in a particular currency. Backed by BigDecimal, so is safe from float rounding errors."
+  s.has_rdoc = false
+  s.authors = ["Marshall Roch"]
+  s.files = [
+    "bigmoney.gemspec",
+    "History.txt",
+    "Manifest.txt",
+    "LICENSE.txt",
+    "Rakefile",
+    "README.txt",
+    "lib/big_money.rb",
+    "lib/big_money/big_money.rb",
+    "lib/big_money/core_extensions.rb",
+    "test/test_big_money.rb"
+  ]
+  s.test_files = ["test/test_big_money.rb"]
+  # s.rdoc_options = ["--main", "README.txt"]
+  # s.extra_rdoc_files = ["History.txt", "Manifest.txt", "README.txt"]
+  # s.add_dependency("mime-types", ["> 0.0.0"])
+end

data/lib/big_money/big_money.rb

@@ -0,0 +1,83 @@
+require 'bigdecimal'
+
+class BigMoney
+  VERSION = '0.1.0'
+  
+  class MoneyError < StandardError ; end
+  class UncomparableCurrency < MoneyError ; end
+  
+  @@default_currency = :USD
+  def self.default_currency ; @@default_currency ; end
+  def self.default_currency=(c) ; @@default_currency = c ; end
+  def default_currency ; self.class.default_currency ; end
+  def default_currency=(c) ; self.class.default_currency = c ; end
+  
+  attr_reader :amount, :currency
+  
+  def initialize(amount, currency = nil)
+    @amount = amount.class == BigDecimal ? amount : BigDecimal.new(amount.to_s)
+    @currency = currency || self.default_currency
+  end
+  
+  def eql?(other_money)
+    currency == other_money.currency && amount == other_money.amount
+  end
+  
+  def ==(other_money)
+    eql?(other_money)
+  end
+  
+  def <=>(other_money)
+    raise UncomparableCurrency, "Cannot compare #{currency} to #{other_money.currency}" \
+      unless currency == other_money.currency
+    
+    amount <=> other_money.amount
+  end
+  
+  def -@
+    BigMoney.new(-amount, currency)
+  end
+  
+  def +(val)
+    op(:+, val)
+  end
+  
+  def -(val)
+    op(:-, val)
+  end
+  
+  def *(val)
+    op(:*, val)
+  end
+
+  def /(val)
+    op(:/, val)
+  end
+  
+  def to_s
+    to_formatted_s('%.2f')
+  end
+  
+  def to_formatted_s(format)
+    format.sub(/%s/, currency.to_s.upcase) % amount
+  end
+  
+  def to_i
+    amount.to_i
+  end
+  
+  def to_f
+    amount.to_f
+  end
+
+private
+  def op(s, val)
+    if val.class == BigMoney
+      raise UncomparableCurrency, "Cannot compare #{currency} to #{val.currency}" \
+        unless currency == val.currency
+      BigMoney.new(amount.send(s, val.amount), currency)
+    else
+      BigMoney.new(amount.send(s, val), currency)
+    end
+  end
+end

data/lib/big_money/core_extensions.rb

@@ -0,0 +1,11 @@
+class String
+  def to_big_money(currency = nil)
+    BigMoney.new(self, currency)
+  end
+end
+
+class Numeric
+  def to_big_money(currency = nil)
+    BigMoney.new(self, currency)
+  end
+end

data/lib/big_money.rb

@@ -0,0 +1,5 @@
+dir = File.dirname(__FILE__)
+$LOAD_PATH << dir unless $LOAD_PATH.include?(dir)
+
+require 'big_money/big_money'
+require 'big_money/core_extensions'

data/test/test_big_money.rb

@@ -0,0 +1,128 @@
+require 'test/unit'
+require 'big_money'
+require 'bigdecimal'
+
+class TestBigMoney < Test::Unit::TestCase
+  
+  def test_initialize_with_bigdecimal
+    val = BigDecimal.new("1.005")
+    assert_same val, BigMoney.new(val).amount, 'Should not create a clone of the input'
+  end
+  
+  def test_initialize_with_string
+    assert_equal BigDecimal.new("1.005"), BigMoney.new("1.005").amount
+    assert_equal BigDecimal.new("10"), BigMoney.new("10").amount
+    assert_equal BigDecimal.new("0"), BigMoney.new("0").amount
+    assert_equal BigDecimal.new("0"), BigMoney.new("foo").amount
+  end
+  
+  def test_initialize_with_integer
+    assert_equal BigDecimal.new("100"), BigMoney.new(100).amount
+    assert_equal BigDecimal.new("0"), BigMoney.new(0).amount
+  end
+  
+  def test_initialize_with_float
+    assert_equal BigDecimal.new("1.005"), BigMoney.new(1.005).amount
+    assert_equal BigDecimal.new("0"), BigMoney.new(0.0).amount
+  end
+  
+  def test_eql?
+    assert BigMoney.new("1.00", :usd).eql?(BigMoney.new("1.00", :usd))
+    assert !BigMoney.new("1.00", :usd).eql?(BigMoney.new("1.01", :usd))
+    assert !BigMoney.new("1.00", :usd).eql?(BigMoney.new("1.00", :cad))
+  end
+  
+  def test_compare
+    m1, m2 = BigMoney.new("1.00", :usd), BigMoney.new("1.50", :usd)
+    assert_equal(-1, (m1 <=> m2))
+    assert_equal(0, (m1 <=> m1))
+    assert_equal(1, (m2 <=> m1))
+    
+    m3 = BigMoney.new("1.00", :cad)
+    assert_raises BigMoney::UncomparableCurrency do
+      m1 <=> m3
+    end
+  end
+  
+  def test_add
+    m1, m2, m3 = BigMoney.new(1.00, :usd), BigMoney.new(1.50, :usd), BigMoney.new(0, :usd)
+    assert_equal BigDecimal.new("2.50"), (m1 + m2).amount
+    assert_equal BigDecimal.new("2.50"), (m2 + m1).amount
+    assert_equal BigDecimal.new("1.00"), (m1 + m3).amount
+    assert_equal BigDecimal.new("1.00"), (m3 + m1).amount
+    assert_not_same m1, m1 + m3
+    assert_not_same m1, m3 + m1
+    assert_equal BigDecimal.new("5.50"), (m2 + 4).amount
+    assert_equal BigDecimal.new("5.50"), (m2 + 4.00).amount
+  end
+  
+  def test_subtract
+    m1, m2, m3 = BigMoney.new(1.00, :usd), BigMoney.new(1.50, :usd), BigMoney.new(0, :usd)
+    assert_equal BigDecimal.new("-0.50"), (m1 - m2).amount
+    assert_equal BigDecimal.new("0.50"), (m2 - m1).amount
+    assert_equal BigDecimal.new("1.00"), (m1 - m3).amount
+    assert_equal BigDecimal.new("-1.00"), (m3 - m1).amount
+    assert_equal BigDecimal.new("-2.50"), (m2 - 4).amount
+    assert_equal BigDecimal.new("-2.50"), (m2 - 4.00).amount
+  end
+  
+  def test_multiply
+    m1, m2, m3 = BigMoney.new(2.00, :usd), BigMoney.new(1.50, :usd), BigMoney.new(0, :usd)
+    assert_equal BigDecimal.new("4.00"), (m1 * m1).amount
+    assert_equal BigDecimal.new("3.00"), (m1 * m2).amount
+    assert_equal BigDecimal.new("3.00"), (m2 * m1).amount
+    assert_equal BigDecimal.new("0"), (m1 * m3).amount
+    assert_equal BigDecimal.new("0"), (m3 * m1).amount
+    assert_equal BigDecimal.new("0"), (m3 * m3).amount
+    assert_equal BigDecimal.new("3.00"), (m2 * 2).amount
+    assert_equal BigDecimal.new("3.00"), (m2 * 2.00).amount
+  end
+  
+  def test_divide
+    m1, m2, m3 = BigMoney.new(2.00, :usd), BigMoney.new(1.50, :usd), BigMoney.new(0, :usd)
+    assert_equal BigDecimal.new("1.00"), (m1 / m1).amount
+    assert_equal BigDecimal.new("1.3333333333333334"), (m1 / m2).amount
+    assert_equal BigDecimal.new("0.75"), (m2 / m1).amount
+    assert_equal BigDecimal.new("0"), (m3 / m1).amount
+    assert((m1 / m3).amount.infinite?)
+    assert((m3 / m3).amount.nan?)
+    assert((m1 / 0).amount.infinite?)
+    assert((m3 / 0).amount.nan?)
+    assert_equal BigDecimal.new("0.75"), (m2 / 2).amount
+    assert_equal BigDecimal.new("0.75"), (m2 / 2.00).amount
+  end
+  
+  def test_to_s
+    assert_equal '1.00', BigMoney.new(1).to_s
+    assert_equal '1.50', BigMoney.new(1.5).to_s
+    assert_equal '-11.50', BigMoney.new(-11.5).to_s
+  end
+  
+  def test_to_formatted_s
+    assert_equal '1.00', BigMoney.new(1).to_formatted_s("%.2f")
+    assert_equal '$1.00', BigMoney.new(1).to_formatted_s("$%.2f")
+    assert_equal 'USD $1.00', BigMoney.new(1).to_formatted_s("%s $%.2f")
+    assert_equal '$1.00 USD', BigMoney.new(1).to_formatted_s("$%.2f %s")
+    assert_equal '$1 USD', BigMoney.new(1).to_formatted_s("$%.0f %s")
+    assert_equal '$1.00 <span class="currency">USD</span>', BigMoney.new(1).to_formatted_s('$%.2f <span class="currency">%s</span>')
+  end
+  
+  def test_to_i
+    assert_equal(1, BigMoney.new(1).to_i)
+    assert_equal(1, BigMoney.new(1.5).to_i)
+    assert_equal(-11, BigMoney.new(-11.5).to_i)
+  end
+  
+  def test_to_f
+    assert_in_delta(1.0, BigMoney.new(1).to_f, 0.000001)
+    assert_in_delta(1.5, BigMoney.new(1.5).to_f, 0.000001)
+    assert_in_delta(-11.5, BigMoney.new(-11.5).to_f, 0.000001)
+  end
+  
+  def test_neg
+    assert_equal BigMoney.new(-1), -BigMoney.new(1)
+    assert_equal BigMoney.new(1),  -BigMoney.new(-1)
+    assert_equal BigMoney.new(1),  -BigMoney.new(-1)
+  end
+
+end

metadata

@@ -0,0 +1,62 @@
+--- !ruby/object:Gem::Specification 
+name: mroch-BigMoney
+version: !ruby/object:Gem::Version 
+  version: 0.1.0
+platform: ruby
+authors: 
+- Marshall Roch
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2008-06-21 00:00:00 -07:00
+default_executable: 
+dependencies: []
+
+description: Represents an amount of money in a particular currency. Backed by BigDecimal, so is safe from float rounding errors.
+email: mroch@cmu.edu
+executables: []
+
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- bigmoney.gemspec
+- History.txt
+- Manifest.txt
+- LICENSE.txt
+- Rakefile
+- README.txt
+- lib/big_money.rb
+- lib/big_money/big_money.rb
+- lib/big_money/core_extensions.rb
+- test/test_big_money.rb
+has_rdoc: false
+homepage: http://github.com/mroch/bigmoney
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.0.1
+signing_key: 
+specification_version: 2
+summary: Represents an amount of money in a particular currency.
+test_files: 
+- test/test_big_money.rb