finance 1.1.2 → 2.0.0

data/HISTORY

@@ -1,3 +1,11 @@
+= Version 2.0.0
+23 Jul 2013
+
+* Removed Integer#months, Integer#years, and replaced Numeric#to_d by Numeric#to_s in the interest of Rails compatibility.
+* Converted unit tests from the shoulda framework to minitest.
+* Removed octal numbers in test_cashflow.rb
+* Thanks to @thadd, @bramswenson, and @xpe for their contributions to this release!
+
 = Version 1.1.2
 16 Jun 2012
 

data/{README → README.md}

@@ -1,104 +1,115 @@
-= FINANCE
+# FINANCE
 
 a library for financial modelling in Ruby.
 
-== INSTALL
+## INSTALL
 
-  $ sudo gem install finance
+    $ sudo gem install finance
 
-== OVERVIEW
+## IMPORTANT CHANGES
 
-=== GETTING STARTED
+Contributions by [@thadd](https://github.com/thadd) and
+[@bramswenson](https://github.com/bramswenson) have made the `finance`
+library fully compatible with rails, at the cost of the `#years` and
+`#months` convenience methods on `Integer`, as well as the `#to_d` method for
+converting `Numerics` into `DecNums`.  These methods have been removed, due to
+conflicts with existing rails methods.
 
-  >> require 'finance'
+Correspondingly, `finance` has been bumped up to version 2.0.
+
+## OVERVIEW
+
+### GETTING STARTED
+
+    >> require 'finance'
 
 *Note:* As of version 1.0.0, the entire library is contained under the
 Finance namespace.  Existing code will not work unless you add:
 
-  >> include Finance
+    >> include Finance
 
 for all of the examples below, we'll assume that you have done this.
 
-=== AMORTIZATION
+### AMORTIZATION
 
 You are interested in borrowing $250,000 under a 30 year, fixed-rate
 loan with a 4.25% APR.
 
-  >> rate = Rate.new(0.0425, :apr, :duration => 30.years)
-  >> amortization = 250000.amortize(rate)
+    >> rate = Rate.new(0.0425, :apr, :duration => (30 * 12))
+    >> amortization = Amortization.new(250000, rate)
 
 Find the standard monthly payment:
 
-  >> amortization.payment
-  => DecNum('-1229.91')
+    >> amortization.payment
+    => DecNum('-1229.91')
 
 Find the total cost of the loan:
 
-  >> amortization.payments.sum
-  => DecNum('-442766.55')
+    >> amortization.payments.sum
+    => DecNum('-442766.55')
 
 How much will you pay in interest?
 
-  >> amortization.interest.sum
-  => DecNum('192766.55')
+    >> amortization.interest.sum
+    => DecNum('192766.55')
 
 How much interest in the first six months?
 
-  >> amortization.interest[0,6].sum
-  => DecNum('5294.62')
+    >> amortization.interest[0,6].sum
+    => DecNum('5294.62')
 
 If your loan has an adjustable rate, no problem.  You can pass an
 arbitrary number of rates, and they will be used in the amortization.
 For example, we can look at an amortization of $250000, where the APR
 starts at 4.25%, and increases by 1% every five years.
 
-  >> values = %w{ 0.0425 0.0525 0.0625 0.0725 0.0825 0.0925 }
-  >> rates = values.collect { |value| Rate.new( value, :apr, :duration = 5.years ) }
-  >> arm = Amortization.new(250000, *rates)
+    >> values = %w{ 0.0425 0.0525 0.0625 0.0725 0.0825 0.0925 }
+    >> rates = values.collect { |value| Rate.new( value, :apr, :duration => (5  * 12) }
+    >> arm = Amortization.new(250000, *rates)
 
 Since we are looking at an ARM, there is no longer a single "payment" value.
 
-  >> arm.payment
-  => nil
+    >> arm.payment
+    => nil
 
 But we can look at the different payments over time.
 
-  >> arm.payments.uniq
-  => [DecNum('-1229.85'), DecNum('-1360.41'), DecNum('-1475.65'), DecNum('-1571.07'), ... snipped ... ]
+    >> arm.payments.uniq
+    => [DecNum('-1229.85'), DecNum('-1360.41'), DecNum('-1475.65'), DecNum('-1571.07'), ... snipped ... ]
 
 The other methods previously discussed can be accessed in the same way:
 
-  >> arm.interest.sum
-  => DecNum('287515.45')
-  >> arm.payments.sum
-  => DecNum('-537515.45')
+    >> arm.interest.sum
+    => DecNum('287515.45')
+    >> arm.payments.sum
+    => DecNum('-537515.45')
 
 Last, but not least, you may pass a block when creating an Amortization
 which returns a modified monthly payment.  For example, to increase your
 payment by $150, do:
 
-  >> rate = Rate.new(0.0425, :apr, :duration => 30.years)
-  >> extra_payments = 250000.amortize(rate){ |period| period.payment - 150 }
+    >> rate = Rate.new(0.0425, :apr, :duration => (30 * 12))
+    >> extra_payments = 250000.amortize(rate){ |period| period.payment - 150 }
 
 Disregarding the block, we have used the same parameters as the first
 example.  Notice the difference in the results:
 
-  >> amortization.payments.sum
-  => DecNum('-442745.98')
-  >> extra_payments.payments.sum
-  => DecNum('-400566.24')
-  >> amortization.interest.sum
-  => DecNum('192745.98')
-  >> extra_payments.interest.sum
-  => DecNum('150566.24')
+    >> amortization.payments.sum
+    => DecNum('-442745.98')
+    >> extra_payments.payments.sum
+    => DecNum('-400566.24')
+    >> amortization.interest.sum
+    => DecNum('192745.98')
+    >> extra_payments.interest.sum
+    => DecNum('150566.24')
 
 You can also increase your payment to a specific amount:
 
-  >> extra_payments_2 = 250000.amortize(rate){ -1500 }
+    >> extra_payments_2 = 250000.amortize(rate){ -1500 }
 
-== ABOUT
+## ABOUT
 
-I started developing _finance_ while analyzing mortgages as a personal
+I started developing `finance` while analyzing mortgages as a personal
 project.  Spreadsheets have convenient formulas for doing this type of
 work, until you want to do something semi-complex (like ARMs or extra
 payments), at which point you need to create your own amortization
@@ -110,31 +121,31 @@ have as a gem.
 More broadly, I believe there are many calculations that are necessary
 for the effective management of personal finances, but are difficult
 (or impossible) to do with spreadsheets or other existing open source
-tools.  My hope is that the _finance_ library will grow to provide a set
+tools.  My hope is that the `finance` library will grow to provide a set
 of open, tested tools to fill this gap.
 
-If you have used _finance_ and find it useful, I would enjoy hearing
+If you have used `finance` and find it useful, I would enjoy hearing
 about it!
 
-== FEATURES
+## FEATURES
 
 Currently implemented features include:
 
-* Uses the {http://flt.rubyforge.org/ flt} library to ensure precision decimal arithmetic in all calculations.
+* Uses the [flt](http://flt.rubyforge.org/) library to ensure precision decimal arithmetic in all calculations.
 * Fixed-rate mortgage amortization (30/360).
 * Interest rates
 * Various cash flow computations, such as NPV and IRR.
 * Adjustable rate mortgage amortization.
 * Payment modifications (i.e., how does paying an additional $75 per month affect the amortization?)
 
-== RESOURCES
+## RESOURCES
 
-[RubyGems Page] {https://rubygems.org/gems/finance}
-[Source Code] {http://github.com/wkranec/finance}
-[Bug Tracker] {https://github.com/wkranec/finance/issues}
-[Google Group] {http://groups.google.com/group/finance-gem/topics?pli=1}
+* [RubyGems Page](https://rubygems.org/gems/finance)
+* [Source Code](http://github.com/wkranec/finance)
+* [Bug Tracker](https://github.com/wkranec/finance/issues)
+* [Google Group](http://groups.google.com/group/finance-gem/topics?pli=1)
 
-== COPYRIGHT
+## COPYRIGHT
 
 This library is released under the terms of the LGPL license.
 

data/lib/finance.rb

@@ -1,5 +1,5 @@
+require 'finance/decimal'
 require 'finance/cashflows'
-require 'finance/interval'
 
 # The *Finance* module adheres to the following conventions for
 # financial calculations:

data/lib/finance/amortization.rb

@@ -8,14 +8,14 @@ module Finance
   #   example uses the amortize method for the Numeric class.  The second
   #   calls Amortization.new directly.
   # @example Borrow $250,000 under a 30 year, fixed-rate loan with a 4.25% APR
-  #   rate = Rate.new(0.0425, :apr, :duration => 30.years)
+  #   rate = Rate.new(0.0425, :apr, :duration => (30 * 12))
   #   amortization = 250000.amortize(rate)
   # @example Borrow $250,000 under a 30 year, adjustable rate loan, with an APR starting at 4.25%, and increasing by 1% every five years
   #   values = %w{ 0.0425 0.0525 0.0625 0.0725 0.0825 0.0925 }
-  #   rates = values.collect { |value| Rate.new( value, :apr, :duration = 5.years ) }
+  #   rates = values.collect { |value| Rate.new( value, :apr, :duration = (5 * 12) ) }
   #   arm = Amortization.new(250000, *rates)
   # @example Borrow $250,000 under a 30 year, fixed-rate loan with a 4.25% APR, but pay $150 extra each month
-  #   rate = Rate.new(0.0425, :apr, :duration => 30.years)
+  #   rate = Rate.new(0.0425, :apr, :duration => (5 * 12))
   #   extra_payments = 250000.amortize(rate){ |period| period.payment - 150 }
   # @api public
   class Amortization
@@ -42,7 +42,7 @@ module Finance
 
     # @return [Array] the amount of any additional payments in each period
     # @example
-    #   rate = Rate.new(0.0375, :apr, :duration => 30.years)
+    #   rate = Rate.new(0.0375, :apr, :duration => (30 * 12))
     #   amt = 300000.amortize(rate){ |payment| payment.amount-100}
     #   amt.additional_payments #=> [DecNum('-100.00'), DecNum('-100.00'), ... ]
     # @api public
@@ -63,8 +63,8 @@ module Finance
 
       pmt = Payment.new(amount, :period => @period)
       if @block then pmt.modify(&@block) end
-        
-      rate.duration.times do
+
+      rate.duration.to_i.times do
         # Do this first in case the balance is zero already.
         if @balance.zero? then break end
 
@@ -78,7 +78,7 @@ module Finance
         if pmt.amount.abs > @balance then pmt.amount = -@balance end
         @transactions << pmt.dup
         @balance += pmt.amount
-        
+
         @period += 1
       end
     end
@@ -111,11 +111,11 @@ module Finance
 
     # @return [Integer] the time required to pay off the loan, in months
     # @example In most cases, the duration is equal to the total duration of all rates
-    #   rate = Rate.new(0.0375, :apr, :duration => 30.years)
+    #   rate = Rate.new(0.0375, :apr, :duration => (30 * 12))
     #   amt = 300000.amortize(rate)
     #   amt.duration #=> 360
     # @example Extra payments may reduce the duration
-    #   rate = Rate.new(0.0375, :apr, :duration => 30.years)
+    #   rate = Rate.new(0.0375, :apr, :duration => (30 * 12))
     #   amt = 300000.amortize(rate){ |payment| payment.amount-100}
     #   amt.duration #=> 319
     # @api public
@@ -130,10 +130,10 @@ module Finance
     # @param [Proc] block
     # @api public
     def initialize(principal, *rates, &block)
-      @principal = principal.to_d
+      @principal = Flt::DecNum.new(principal.to_s)
       @rates     = rates
       @block     = block
-      
+
       # compute the total duration from all of the rates.
       @periods = (rates.collect { |r| r.duration }).sum
       @period  = 0
@@ -148,11 +148,11 @@ module Finance
 
     # @return [Array] the amount of interest charged in each period
     # @example find the total cost of interest for a loan
-    #   rate = Rate.new(0.0375, :apr, :duration => 30.years)
+    #   rate = Rate.new(0.0375, :apr, :duration => (30 * 12))
     #   amt = 300000.amortize(rate)
     #   amt.interest.sum #=> DecNum('200163.94')
     # @example find the total interest charges in the first six months
-    #   rate = Rate.new(0.0375, :apr, :duration => 30.years)
+    #   rate = Rate.new(0.0375, :apr, :duration => (30 * 12))
     #   amt = 300000.amortize(rate)
     #   amt.interest[0,6].sum #=> DecNum('5603.74')
     # @api public
@@ -166,7 +166,7 @@ module Finance
     # @param [Integer] periods the number of periods needed for repayment
     # @note in most cases, you will probably want to use rate.monthly when calling this function outside of an Amortization instance.
     # @example
-    #   rate = Rate.new(0.0375, :apr, :duration => 30.years)
+    #   rate = Rate.new(0.0375, :apr, :duration => (30 * 12))
     #   rate.duration #=> 360
     #   Amortization.payment(200000, rate.monthly, rate.duration) #=> DecNum('-926.23')
     # @see http://en.wikipedia.org/wiki/Amortization_calculator
@@ -177,7 +177,7 @@ module Finance
 
     # @return [Array] the amount of the payment in each period
     # @example find the total payments for a loan
-    #   rate = Rate.new(0.0375, :apr, :duration => 30.years)
+    #   rate = Rate.new(0.0375, :apr, :duration => (30 * 12))
     #   amt = 300000.amortize(rate)
     #   amt.payments.sum #=> DecNum('-500163.94')
     # @api public
@@ -191,6 +191,6 @@ class Numeric
   # @see Amortization#new
   # @api public
   def amortize(*rates, &block)
-    amortization = Finance::Amortization.new(self, *rates, &block)
+    Finance::Amortization.new(self, *rates, &block)
   end
 end

data/lib/finance/cashflows.rb

@@ -32,7 +32,7 @@ module Finance
       end
 
       def values(x)
-        value = @transactions.send(@function, x[0].to_d)
+        value = @transactions.send(@function, Flt::DecNum.new(x[0].to_s))
         [ BigDecimal.new(value.to_s) ]
       end
     end
@@ -52,7 +52,7 @@ module Finance
 
       func = Function.new(self, :npv)
       rate = [ func.one ]
-      n = nlsolve( func, rate )
+      nlsolve( func, rate )
       rate[0]
     end
 
@@ -69,9 +69,9 @@ module Finance
     # @see http://en.wikipedia.org/wiki/Net_present_value
     # @api public
     def npv(rate)
-      self.collect! { |entry| entry.to_d }
+      self.collect! { |entry| Flt::DecNum.new(entry.to_s) }
 
-      rate, total = rate.to_d, 0.to_d
+      rate, total = Flt::DecNum.new(rate.to_s), Flt::DecNum.new(0.to_s)
       self.each_with_index do |cashflow, index|
         total += cashflow / (1 + rate) ** index
       end
@@ -97,7 +97,7 @@ module Finance
 
       func = Function.new(self, :xnpv)
       rate = [ func.one ]
-      n = nlsolve( func, rate )
+      nlsolve( func, rate )
       Rate.new(rate[0], :apr, :compounds => :annually)
     end
 
@@ -111,11 +111,11 @@ module Finance
     #   @transactions.xnpv(0.6).round(2) #=> -937.41
     # @api public
     def xnpv(rate)
-      rate  = rate.to_d
+      rate  = Flt::DecNum.new(rate.to_s)
       start = self[0].date
 
       self.inject(0) do |sum, t|
-        n = t.amount / ( (1 + rate) ** ((t.date-start) / 31536000.to_d)) # 365 * 86400
+        n = t.amount / ( (1 + rate) ** ((t.date-start) / Flt::DecNum.new(31536000.to_s))) # 365 * 86400
         sum + n
       end
     end

data/lib/finance/rates.rb

@@ -11,7 +11,7 @@ module Finance
     TYPES = { :apr       => "effective",
               :apy       => "effective",
               :effective => "effective",
-              :nominal   => "nominal" 
+              :nominal   => "nominal"
             }
 
     # @return [Integer] the duration for which the rate is valid, in months
@@ -55,13 +55,13 @@ module Finance
     # @api private
     def compounds=(input)
       @periods = case input
-                 when :annually     then Flt::DecNum 1
+                 when :annually     then Flt::DecNum.new(1)
                  when :continuously then Flt::DecNum.infinity
-                 when :daily        then Flt::DecNum 365
-                 when :monthly      then Flt::DecNum 12
-                 when :quarterly    then Flt::DecNum 4
-                 when :semiannually then Flt::DecNum 2
-                 when Numeric       then Flt::DecNum input.to_s
+                 when :daily        then Flt::DecNum.new(365)
+                 when :monthly      then Flt::DecNum.new(12)
+                 when :quarterly    then Flt::DecNum.new(4)
+                 when :semiannually then Flt::DecNum.new(2)
+                 when Numeric       then Flt::DecNum.new(input.to_s)
                  else raise ArgumentError
                  end
     end
@@ -98,7 +98,7 @@ module Finance
 
       # Set the rate in the proper way, based on the value of type.
       begin
-        send("#{TYPES.fetch(type)}=", rate.to_d)
+        send("#{TYPES.fetch(type)}=", Flt::DecNum.new(rate.to_s))
       rescue KeyError
         raise ArgumentError, "type must be one of #{TYPES.keys.join(', ')}", caller
       end
@@ -135,7 +135,7 @@ module Finance
     #   Rate.to_effective(0.05, 4) #=> DecNum('0.05095')
     # @api public
     def Rate.to_effective(rate, periods)
-      rate, periods = rate.to_d, periods.to_d
+      rate, periods = Flt::DecNum.new(rate.to_s), Flt::DecNum.new(periods.to_s)
 
       if periods.infinite?
         rate.exp - 1
@@ -153,7 +153,7 @@ module Finance
     # @see http://www.miniwebtool.com/nominal-interest-rate-calculator/
     # @api public
     def Rate.to_nominal(rate, periods)
-      rate, periods = rate.to_d, periods.to_d
+      rate, periods = Flt::DecNum.new(rate.to_s), Flt::DecNum.new(periods.to_s)
 
       if periods.infinite?
         (rate + 1).log

data/lib/finance/transaction.rb

@@ -24,7 +24,7 @@ module Finance
     #   t.amount #=> 750
     # @api public
     def amount=(value)
-      @amount = value.to_d
+      @amount = Flt::DecNum.new(value.to_s)
     end
 
     # @return [DecNum] the difference between the original transaction
@@ -51,7 +51,7 @@ module Finance
     def initialize(amount, opts={})
       @amount = amount
       @original = amount
-      
+
       # Set optional attributes..
       opts.each do |key, value|
         send("#{key}=", value)
@@ -111,7 +111,7 @@ module Finance
       "Interest(#{@amount})"
     end
   end
-  
+
   # Represent a loan payment as a Transaction
   # @see Transaction
   class Payment < Transaction

data/test/test_amortization.rb

@@ -1,91 +1,84 @@
-require_relative '../lib/finance/amortization.rb'
-require_relative '../lib/finance/interval.rb'
-require_relative '../lib/finance/rates.rb'
-include Finance
-
-require 'flt/d'
-require 'minitest/unit'
-require 'shoulda'
+require_relative 'test_helper'
 
 # @see http://tinyurl.com/6zroqvd for detailed calculations for the
 #   examples in these unit tests.
-class TestAmortization < Test::Unit::TestCase
+describe "Amortization" do
   def ipmt(principal, rate, payment, period)
     -(-rate*principal*(1+rate)**(period-1) - payment*((1+rate)**(period-1)-1)).round(2)
   end
 
-  context "a fixed-rate amortization of 200000 at 3.75% over 30 years" do
-    setup do
-      @rate = Rate.new(0.0375, :apr, :duration => 30.years)
+  describe "a fixed-rate amortization of 200000 at 3.75% over 30 years" do
+    before(:all) do
+      @rate = Rate.new(0.0375, :apr, :duration => (30 * 12))
       @principal = D(200000)
       @std = Amortization.new(@principal, @rate)
     end
 
-    should "have a principal of $200,000" do
+    it "should have a principal of $200,000" do
       assert_equal @principal, @std.principal
     end
 
-    should "have a final balance of zero" do
+    it "should have a final balance of zero" do
       assert @std.balance.zero?
     end
 
-    should "have a duration of 360 months" do
+    it "should have a duration of 360 months" do
       assert_equal 360, @std.duration
     end
 
-    should "have a monthly payment of $926.23" do
+    it "should have a monthly payment of $926.23" do
       assert_equal D('-926.23'), @std.payment
     end
 
-    should "have a final payment of $926.96 (due to rounding)" do
+    it "should have a final payment of $926.96 (due to rounding)" do
       assert_equal D('-926.96'), @std.payments[-1]
     end
 
-    should "have total payments of $333,443.53" do
+    it "should have total payments of $333,443.53" do
       assert_equal D('-333443.53'), @std.payments.sum
     end
 
-    should "have interest charges which agree with the standard formula" do
+    it "should have interest charges which agree with the standard formula" do
       0.upto 359 do |period|
         assert_equal @std.interest[period], ipmt(@principal, @rate.monthly, @std.payment, period+1)
       end
     end
 
-    should "have total interest charges of $133,433.33" do
+    it "should have total interest charges of $133,433.33" do
       assert_equal D('133443.53'), @std.interest.sum
     end
   end
 
-  context "an adjustable rate amortization of 200000 starting at 3.75% and increasing by 1% every 3 years" do
-    setup do
+  describe "an adjustable rate amortization of 200000 starting at 3.75% and increasing by 1% every 3 years" do
+    before(:all) do
       @rates = []
       0.upto 9 do |adj|
-        @rates << Rate.new(0.0375 + (D('0.01') * adj), :apr, :duration => 3.years)
+        @rates << Rate.new(0.0375 + (D('0.01') * adj), :apr, :duration => (3 * 12))
       end
       @principal = D(200000)
       @arm = Amortization.new(@principal, *@rates)
     end
 
-    should "have a principal of $200,000" do
+    it "should have a principal of $200,000" do
       assert_equal @principal, @arm.principal
     end
 
-    should "have a final balance of zero" do
+    it "should have a final balance of zero" do
       assert @arm.balance.zero?
     end
 
-    should "have a duration of 360 months" do
+    it "should have a duration of 360 months" do
       assert_equal 360, @arm.duration
     end
 
-    should "not have a fixed monthly payment (since it changes)" do
+    it "should not have a fixed monthly payment (since it changes)" do
       assert_nil @arm.payment
     end
 
-    should "have payments which increase every three years" do
+    it "should have payments which increase every three years" do
       values = %w{926.23 1033.73 1137.32 1235.39 1326.30 1408.27 1479.28 1537.03 1578.84 1601.66 }
       values.collect!{ |v| -D(v) }
-      
+
       payments = []
       values[0,9].each do |v|
         36.times do
@@ -100,70 +93,70 @@ class TestAmortization < Test::Unit::TestCase
       end
     end
 
-    should "have a final payment of $1601.78 (due to rounding)" do
+    it "should have a final payment of $1601.78 (due to rounding)" do
       assert_equal D('-1601.78'), @arm.payments[-1]
     end
 
-    should "have total payments of $47,505.92" do
+    it "should have total payments of $47,505.92" do
       assert_equal D('-477505.92'), @arm.payments.sum
     end
 
-    should "have total interest charges of $277,505.92" do
+    it "should have total interest charges of $277,505.92" do
       assert_equal D('277505.92'), @arm.interest.sum
     end
   end
 
-  context "a fixed-rate amortization of 200000 at 3.75% over 30 years, where an additional 100 is paid each month" do
-    setup do
-      @rate = Rate.new(0.0375, :apr, :duration => 30.years)
+  describe "a fixed-rate amortization of 200000 at 3.75% over 30 years, where an additional 100 is paid each month" do
+    before(:all) do
+      @rate = Rate.new(0.0375, :apr, :duration => (30 * 12))
       @principal = D(200000)
       @exp = Amortization.new(@principal, @rate){ |period| period.payment - 100 }
     end
 
-    should "have a principal of $200,000" do
+    it "should have a principal of $200,000" do
       assert_equal @principal, @exp.principal
     end
 
-    should "have a final balance of zero" do
+    it "should have a final balance of zero" do
       assert @exp.balance.zero?
     end
 
-    should "have a duration of 301 months" do
+    it "should have a duration of 301 months" do
       assert_equal 301, @exp.duration
     end
 
-    should "have a monthly payment of $1026.23" do
+    it "should have a monthly payment of $1026.23" do
       assert_equal D('-1026.23'), @exp.payment
     end
 
-    should "have a final payment of $1011.09" do
+    it "should have a final payment of $1011.09" do
       assert_equal D('-1011.09'), @exp.payments[-1]
     end
 
-    should "have total payments of $308,880.09" do
+    it "should have total payments of $308,880.09" do
       assert_equal D('-308880.09'), @exp.payments.sum
     end
 
-    should "have total additional payments of $30,084.86" do
+    it "should have total additional payments of $30,084.86" do
       assert_equal D('-30084.86'), @exp.additional_payments.sum
     end
 
-    should "have total interest charges of $108880.09" do
+    it "should have total interest charges of $108880.09" do
       assert_equal D('108880.09'), @exp.interest.sum
     end
   end
 end
 
-class TestNumericMethod < Test::Unit::TestCase
-  def test_simple
-    rate = Rate.new(0.0375, :apr, :duration => 30.years)
+describe "Numeric Method" do
+  it 'works with simple invocation' do
+    rate = Rate.new(0.0375, :apr, :duration => (30 * 12))
     amt_method = 300000.amortize(rate)
     amt_class  = Amortization.new(300000, rate)
     assert_equal amt_method, amt_class
   end
 
-  def test_with_block
-    rate = Rate.new(0.0375, :apr, :duration => 30.years)
+  it 'works with block invocation' do
+    rate = Rate.new(0.0375, :apr, :duration => (30 * 12))
     amt_method = 300000.amortize(rate){ |period| period.payment-300 }
     amt_class  = Amortization.new(300000, rate){ |period| period.payment-300 }
     assert_equal amt_method, amt_class

data/test/test_cashflows.rb

@@ -1,37 +1,31 @@
-require_relative '../lib/finance/cashflows.rb'
-require_relative '../lib/finance/rates.rb'
-require_relative '../lib/finance/transaction.rb'
-include Finance
+require_relative 'test_helper'
 
-require 'flt/d'
-require 'minitest/unit'
-require 'shoulda'
-
-class TestCashflows < Test::Unit::TestCase
-  context "an array of numeric cashflows" do
-    should "have an Internal Rate of Return" do
+describe "Cashflows" do
+  describe "an array of numeric cashflows" do
+    it "should have an Internal Rate of Return" do
       assert_equal D("0.143"), [-4000,1200,1410,1875,1050].irr.round(3)
       assert_raises(ArgumentError) { [10,20,30].irr }
     end
 
-    should "have a Net Present Value" do
+    it "should have a Net Present Value" do
       assert_equal D("49.211"), [-100.0, 60, 60, 60].npv(0.1).round(3)
     end
   end
-  context "an array of Transactions" do
-    setup do
+
+  describe "an array of Transactions" do
+    before(:all) do
       @xactions=[]
-      @xactions << Transaction.new(-1000, :date => Time.new(1985,01,01))
-      @xactions << Transaction.new(  600, :date => Time.new(1990,01,01))
-      @xactions << Transaction.new(  600, :date => Time.new(1995,01,01))
+      @xactions << Transaction.new(-1000, :date => Time.new(1985, 1, 1))
+      @xactions << Transaction.new(  600, :date => Time.new(1990, 1, 1))
+      @xactions << Transaction.new(  600, :date => Time.new(1995, 1, 1))
     end
 
-    should "have an Internal Rate of Return" do
+    it "should have an Internal Rate of Return" do
       assert_equal D("0.024851"), @xactions.xirr.effective.round(6)
-      assert_raises(ArgumentError) { @xactions[1,2].xirr }
+      assert_raises(ArgumentError) { @xactions[1, 2].xirr }
     end
 
-    should "have a Net Present Value" do
+    it "should have a Net Present Value" do
       assert_equal D("-937.41"), @xactions.xnpv(0.6).round(2)
     end
   end

data/test/test_helper.rb

@@ -0,0 +1,13 @@
+require 'minitest/autorun'
+require 'minitest/spec'
+
+require 'active_support/all'
+
+require 'flt'
+require 'flt/d'
+
+require_relative '../lib/finance/amortization.rb'
+require_relative '../lib/finance/cashflows.rb'
+require_relative '../lib/finance/rates.rb'
+require_relative '../lib/finance/transaction.rb'
+include Finance

data/test/test_rates.rb

@@ -1,77 +1,71 @@
-require_relative '../lib/finance/rates.rb'
-include Finance
+require_relative 'test_helper'
 
-require 'flt'
-require 'flt/d'
-require 'minitest/unit'
-require 'shoulda'
-
-class TestRates < Test::Unit::TestCase
-  context "an interest rate" do
-    context "can compound with different periods" do
-      should "compound monthly by default" do
+describe "Rates" do
+  describe "an interest rate" do
+    describe "can compound with different periods" do
+      it "should compound monthly by default" do
         rate = Rate.new(0.15, :nominal)
         assert_equal D('0.16075'), rate.effective.round(5)
       end
 
-      should "compound annually" do
+      it "should compound annually" do
         rate = Rate.new(0.15, :nominal, :compounds => :annually)
         assert_equal D('0.15'), rate.effective
       end
 
-      should "compound continuously" do
+      it "should compound continuously" do
         rate = Rate.new(0.15, :nominal, :compounds => :continuously)
         assert_equal D('0.16183'), rate.effective.round(5)
       end
 
-      should "compound daily" do
+      it "should compound daily" do
         rate = Rate.new(0.15, :nominal, :compounds => :daily)
         assert_equal D('0.16180'), rate.effective.round(5)
       end
 
-      should "compound quarterly" do
+      it "should compound quarterly" do
         rate = Rate.new(0.15, :nominal, :compounds => :quarterly)
         assert_equal D('0.15865'), rate.effective.round(5)
       end
 
-      should "compound semiannually" do
+      it "should compound semiannually" do
         rate = Rate.new(0.15, :nominal, :compounds => :semiannually)
         assert_equal D('0.15563'), rate.effective.round(5)
       end
 
-      should "accept a numerical value as the compounding frequency per year" do
+      it "should accept a numerical value as the compounding frequency per year" do
         rate = Rate.new(0.15, :nominal, :compounds => 7)
         assert_equal D('0.15999'), rate.effective.round(5)
       end
 
-      should "raise an exception if an unknown string is given" do
+      it "should raise an exception if an unknown string is given" do
         assert_raises(ArgumentError){ Rate.new(0.15, :nominal, :compounds => :quickly) }
       end
     end
 
-    should "accept a duration if given" do
+    it "should accept a duration if given" do
       rate = Rate.new(0.0375, :effective, :duration => 360)
       assert_equal 360, rate.duration
     end
 
-    should "be comparable to other interest rates" do
+    it "should be comparable to other interest rates" do
       r1 = Rate.new(0.15, :nominal)
       r2 = Rate.new(0.16, :nominal)
       assert_equal( 1, r2 <=> r1)
       assert_equal(-1, r1 <=> r2)
     end
-    
-    should "convert to a monthly value" do
+
+    it "should convert to a monthly value" do
       rate = Rate.new(0.0375, :effective)
       assert_equal D('0.003125'), rate.monthly
     end
 
-    should "convert effective interest rates to nominal" do
+    it "should convert effective interest rates to nominal" do
       assert_equal D('0.03687'), Rate.to_nominal(D('0.0375'), 12).round(5)
       assert_equal D('0.03681'), Rate.to_nominal(D('0.0375'), Flt::DecNum.infinity).round(5)
     end
 
-    should "raise an exception if an unknown value is given for :type" do
+    it "should raise an exception if an unknown value is given for :type" do
       assert_raises(ArgumentError){ Rate.new(0.0375, :foo) }
     end
   end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: finance
 version: !ruby/object:Gem::Version
-  version: 1.1.2
+  version: 2.0.0
   prerelease: 
 platform: ruby
 authors:
@@ -9,11 +9,11 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-06-16 00:00:00.000000000 Z
+date: 2013-07-23 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: flt
-  requirement: &2152191000 !ruby/object:Gem::Requirement
+  requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -21,33 +21,69 @@ dependencies:
         version: 1.3.0
   type: :runtime
   prerelease: false
-  version_requirements: *2152191000
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 1.3.0
+- !ruby/object:Gem::Dependency
+  name: minitest
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 4.7.5
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 4.7.5
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 4.0.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 4.0.0
 description: The finance library provides a Ruby interface for working with interest
   rates, mortgage amortization, and cashflows (NPV, IRR, etc.).
 email: wkranec@gmail.com
 executables: []
 extensions: []
 extra_rdoc_files:
-- README
+- README.md
 - COPYING
 - COPYING.LESSER
 - HISTORY
 files:
-- README
+- README.md
 - COPYING
 - COPYING.LESSER
 - HISTORY
+- lib/finance.rb
+- lib/finance/transaction.rb
 - lib/finance/amortization.rb
-- lib/finance/cashflows.rb
-- lib/finance/decimal.rb
-- lib/finance/interval.rb
 - lib/finance/rates.rb
-- lib/finance/transaction.rb
-- lib/finance.rb
+- lib/finance/decimal.rb
+- lib/finance/cashflows.rb
 - test/test_amortization.rb
 - test/test_cashflows.rb
-- test/test_interval.rb
 - test/test_rates.rb
+- test/test_helper.rb
 homepage: https://rubygems.org/gems/finance
 licenses: []
 post_install_message: 
@@ -68,7 +104,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 1.8.15
+rubygems_version: 1.8.24
 signing_key: 
 specification_version: 3
 summary: a library for financial modelling in Ruby.

data/lib/finance/interval.rb

@@ -1,13 +0,0 @@
-class Integer
-  # convert an integer value representing months (or years) into months
-  # @return [Integer] the number of months
-  # @example
-  #   360.months #=> 360
-  #   30.years #=> 360
-  # @api public
-  def method_missing(name, *args, &block)
-    return self      if name.to_s == "months"
-    return self * 12 if name.to_s == "years"
-    super
-  end
-end

data/test/test_interval.rb

@@ -1,18 +0,0 @@
-require_relative '../lib/finance/interval.rb'
-
-require 'minitest/unit'
-require 'shoulda'
-
-class TestInterval < Test::Unit::TestCase
-  context "a time interval" do
-    context "can be created from an integer" do
-      should "convert an integer into months" do
-        assert_equal 360, 360.months
-      end
-
-      should "convert an integer into years" do
-        assert_equal 360, 30.years
-      end
-    end
-  end
-end