cash 0.0.2 → 0.1.0

data/.travis.yml

@@ -0,0 +1,15 @@
+language: ruby
+rvm:
+  - 1.9.3
+  - 1.9.2
+  - jruby-18mode
+  - jruby-19mode
+  - rbx-18mode
+  - rbx-19mode
+  - ruby-head
+  - jruby-head
+  - 1.8.7
+  - ree
+matrix:
+  allow_failures:
+    - rvm: jruby-head

data/Guardfile

@@ -1,5 +1,5 @@
 guard 'rspec', :version => 2, :cli => '--color' do
   watch(%r{^spec/.+_spec\.rb$})
-  watch(%r{^lib/(.+)\.rb$})     { |m| "spec/#{m[1]}_spec.rb" }
+  watch(%r{^lib/(.+)\.rb$})     { |m| "spec/lib/#{m[1]}_spec.rb" }
   watch('spec/spec_helper.rb')  { "spec" }
 end

data/README.md

@@ -2,6 +2,7 @@
 
 Money object for your application. Based on BigDecimal and ISO-4217 currencies.
 
+
 ## Features
 
 Encapsulates an amount with its currency.
@@ -10,6 +11,14 @@ Backed by BigDecimal, so it can store arbitrary-precision values without roundin
 
 Safe and strict. Fail fast approach let's you sleep like a baby.
 
+
+## Compatibility
+
+Tested on Ruby 1.9, 1.8, JRuby, and RBX: 
+
+https://travis-ci.org/#!/pithyless/cash
+
+
 ## Credits
 
 Huge thanks go out to:

data/cash.gemspec

@@ -4,7 +4,7 @@ $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
 
 Gem::Specification.new do |gem|
   gem.name          = "cash"
-  gem.version       = '0.0.2'
+  gem.version       = '0.1.0'
   gem.authors       = ["Norbert Wojtowicz"]
   gem.email         = ["wojtowicz.norbert@gmail.com"]
   gem.description   = "Money model backed by BigDecimal"

data/lib/cash.rb

@@ -1,5 +1,94 @@
+# encoding: UTF-8
+
+require 'bigdecimal'
+
 require "cash/currency"
 require "cash/currency/iso4217"
 
 class Cash
+  include Comparable
+  include Equalable
+
+  def initialize(amount, currency)
+    @amount, @currency = StrictDecimal(amount), Currency.find!(currency)
+  end
+
+  attr_reader :amount, :currency
+
+  def StrictDecimal(arg)
+    case arg
+    when BigDecimal
+      arg
+    when Float
+      fail ArgumentError, "innacurate float for StrictDecimal(): #{arg.inspect}"
+    when Integer
+      BigDecimal(arg.to_s)
+    when String
+      Float(arg)
+      BigDecimal(arg)
+    else
+      fail TypeError
+    end
+  rescue TypeError
+    fail ArgumentError, "invalid value for StrictDecimal(): #{arg.inspect}"
+  end
+
+  def to_s
+    Format.display(self)
+  end
+
+  def inspect
+    "<Cash #{amount_string} #{currency.code}>"
+  end
+
+  def amount_string
+   "%.#{currency.offset}f" % amount.round(currency.offset)
+  end
+
+  def <=>(o)
+    check_type(o, :compare)
+    amount <=> o.amount
+  end
+
+  def +(o)
+    check_type(o, :add)
+    Cash.new(amount + o.amount, currency)
+  end
+
+  def -(o)
+    check_type(o, :subtract)
+    Cash.new(amount - o.amount, currency)
+  end
+
+  protected
+
+  def equality_state
+    [amount, currency]
+  end
+
+  def check_type(o, method)
+    unless o.instance_of?(self.class) && o.currency == currency
+      raise TypeError, "cannot #{method} #{self.inspect} to #{o.inspect}"
+    end
+  end
+
+
+  module Format
+    CURRENCIES = {
+      'EUR' => '€',
+      'USD' => '$'
+    }.freeze
+
+    def self.display(cash)
+      amount = cash.amount_string
+      currency_code = cash.currency.code
+
+      if sym = CURRENCIES[currency_code]
+        "#{sym}#{amount}"
+      else
+        "#{amount} #{currency_code}"
+      end
+    end
+  end
+
 end

data/lib/cash/currency.rb

@@ -19,10 +19,15 @@ class Cash
     class << self
 
       def find(currency)
+        return currency if currency.kind_of?(self)
         currency = currency.to_s.upcase
         all.find{ |c| c.code == currency }
       end
 
+      def find!(currency)
+        find(currency) or fail ArgumentError, "unknown currency: #{currency}"
+      end
+
       def all
         @all ||= Set.new
       end

data/spec/lib/cash/currency_spec.rb

@@ -29,12 +29,28 @@ describe Cash::Currency do
       end
     end
 
+    it 'returns self for currency' do
+      currency = Cash::Currency::USD
+      Cash::Currency.find(currency).should equal(currency)
+    end
+
     it 'returns nil for missing currency' do
       Cash::Currency.find('zzz').should be_nil
     end
   end
 
 
+  describe '::find!' do
+    it 'returns currency' do
+      Cash::Currency.find!('usd').should == Cash::Currency::USD
+    end
+
+    it 'fails for missing currency' do
+      expect{ Cash::Currency.find!('zzz') }.to raise_error(ArgumentError)
+    end
+  end
+
+
   context 'equality' do
     let(:usd) { Cash::Currency::USD }
     let(:usd2) { Cash::Currency.new('usd', 2, 'US dollar') }

data/spec/lib/cash_spec.rb

@@ -0,0 +1,159 @@
+#encoding: UTF-8
+
+require 'spec_helper'
+
+describe Cash do
+
+  describe '#initialize' do
+
+    let(:currency) { Cash::Currency::USD }
+    let(:big_one) { BigDecimal('1.0') }
+    let(:one) { '1.0' }
+
+    context 'amount' do
+      it 'initializes with big decimal' do
+        Cash.new(big_one, currency).amount.should eq(big_one)
+      end
+
+      it 'initializes with string' do
+        Cash.new(one, currency).amount.should eq(big_one)
+      end
+
+      it 'initializes with integer' do
+        Cash.new(1, currency).amount.should eq(big_one)
+      end
+
+      it 'fails with float' do
+        expect{ Cash.new(Float(one), currency) }.to raise_error(ArgumentError)
+      end
+
+      it 'fails with nil object' do
+        expect{ Cash.new(nil, currency) }.to raise_error(ArgumentError)
+      end
+
+      it 'fails with other object' do
+        expect{ Cash.new(Object.new, currency) }.to raise_error(ArgumentError)
+      end
+
+      it 'fails with invalid string' do
+        expect{ Cash.new('silly', currency) }.to raise_error(ArgumentError)
+      end
+    end
+
+    context 'currency' do
+      it 'initializes with string' do
+        Cash.new(1, 'usd').currency.should == Cash::Currency::USD
+      end
+
+      it 'initializes with symbol' do
+        Cash.new(1, :USD).currency.should == Cash::Currency::USD
+      end
+
+      it 'initializes with currency' do
+        currency = Cash::Currency.find('usd')
+        Cash.new(1, currency).currency.should == Cash::Currency::USD
+      end
+
+      it 'fails with missing currency' do
+        expect{ Cash.new(1, 'zzz') }.to raise_error(ArgumentError)
+      end
+
+      it 'fails with nil object' do
+        expect{ Cash.new(1, nil) }.to raise_error(ArgumentError)
+      end
+
+      it 'fails with other object' do
+        expect{ Cash.new(1, Object.new) }.to raise_error(ArgumentError)
+      end
+    end
+
+  end
+
+  describe '#to_s' do
+    it 'displays Euro' do
+      Cash.new('100.3', :eur).to_s.should == '€100.30'
+    end
+
+    it 'displays Dollar' do
+      Cash.new('9999', :usd).to_s.should == '$9999.00'
+    end
+
+    it 'displays other currencies' do
+      Cash.new('.123', :pln).to_s.should == '0.12 PLN'
+    end
+
+    it 'displays correct offset' do
+      Cash.new('123.4567', :jpy).to_s.should == '123 JPY'
+      Cash.new('123.4567', :twd).to_s.should == '123.5 TWD'
+      Cash.new('123.4567', :pln).to_s.should == '123.46 PLN'
+      Cash.new('123.4567', :bhd).to_s.should == '123.457 BHD'
+    end
+  end
+
+  describe '#inspect' do
+    it 'displays value and currency' do
+       Cash.new('100.3', :eur).inspect.should == '<Cash 100.30 EUR>'
+    end
+  end
+
+  context 'comparable' do
+    describe '#==' do
+      it { Cash.new(1, :usd).should == Cash.new(1, :usd) }
+      it { Cash.new(2, :usd).should_not == Cash.new(1, :usd) }
+      it { Cash.new(1, :pln).should_not == Cash.new(1, :usd) }
+    end
+
+    describe '#<=>' do
+      it { (Cash.new(1, :usd) <=> Cash.new(2, :usd)).should == -1 }
+      it { (Cash.new(2, :usd) <=> Cash.new(2, :usd)).should == 0 }
+      it { (Cash.new(3, :usd) <=> Cash.new(2, :usd)).should == 1 }
+
+      it 'fails for different currencies' do
+        expect{ Cash.new(1, :pln) <=> Cash.new(1, :usd) }.to raise_error(TypeError)
+      end
+
+      it 'fails for non-cash' do
+        expect{ Cash.new(1, :pln) <=> 1 }.to raise_error(TypeError)
+      end
+    end
+
+    it { (Cash.new(1, :usd) < Cash.new(2, :usd)).should be_true }
+    it { (Cash.new(3, :usd) >= Cash.new(3, :usd)).should be_true }
+    it { (Cash.new(3, :usd) == Cash.new(3, :usd)).should be_true }
+    it { (Cash.new(3, :pln) != Cash.new(3, :usd)).should be_true }
+    it { (Cash.new('1.234', :usd) != Cash.new('1.23', :usd)).should be_true }
+
+    it 'fails for different currencies' do
+      expect{ Cash.new(1, :usd) < Cash.new(1, :pln) }.to raise_error(TypeError)
+    end
+  end
+
+  context 'arithmetic' do
+    let(:one_usd) { Cash.new(1, :usd) }
+    let(:two_usd) { Cash.new(2, :usd) }
+    let(:three_usd) { Cash.new(3, :usd) }
+    let(:two_pln) { Cash.new(2, :pln) }
+
+
+    describe 'addition' do
+      it 'adds amounts' do
+        (one_usd + two_usd).should == three_usd
+      end
+
+      it 'fails for different currencies' do
+        expect{ one_usd + two_pln }.to raise_error(TypeError)
+      end
+    end
+
+    describe 'subtraction' do
+      it 'subtracts amounts' do
+        (three_usd - one_usd).should == two_usd
+      end
+
+      it 'fails for different currencies' do
+        expect{ three_usd - two_pln }.to raise_error(TypeError)
+      end
+    end
+  end
+
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: cash
 version: !ruby/object:Gem::Version
-  version: 0.0.2
+  version: 0.1.0
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-10-02 00:00:00.000000000 Z
+date: 2012-10-08 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rake
@@ -51,6 +51,7 @@ extensions: []
 extra_rdoc_files: []
 files:
 - .gitignore
+- .travis.yml
 - Gemfile
 - Guardfile
 - LICENSE.txt
@@ -62,6 +63,7 @@ files:
 - lib/cash/currency/iso4217.rb
 - lib/cash/equalable.rb
 - spec/lib/cash/currency_spec.rb
+- spec/lib/cash_spec.rb
 - spec/spec_helper.rb
 homepage: https://github.com/pithyless/cash
 licenses: []
@@ -77,7 +79,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: 2019834350230060789
+      hash: 2451445660094864039
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements:
@@ -86,7 +88,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: 2019834350230060789
+      hash: 2451445660094864039
 requirements: []
 rubyforge_project: 
 rubygems_version: 1.8.23
@@ -95,4 +97,5 @@ specification_version: 3
 summary: Money model backed by BigDecimal
 test_files:
 - spec/lib/cash/currency_spec.rb
+- spec/lib/cash_spec.rb
 - spec/spec_helper.rb