refinance 0.0.1 → 1.0.0

data/LICENSE.txt

@@ -1,4 +1,4 @@
-Copyright (c) 2012 reInteractive
+Copyright (c) 2012-2013 reInteractive Pty Ltd
 
 MIT License
 

data/README.md

@@ -5,15 +5,17 @@ Currently, it contains algorithms for calculating the properties of ordinary
 annuities: principal, interest rate, number of payment periods, and payment
 amount.
 
-The algorithms are simple rather than fast. At present, they deal only with
-_annuities immediate_ (in which the interest is accumulated _before_ the
-payment), not _annuities due_ (in which the interest is accumulated _after_ the
-payment). There are many opportunities for extension and improvement.
+The algorithms are simple rather than fast and numerically robust. Thanks to
+duck typing, they work with both BigDecimals and Floats. At present, they deal
+only with _annuities immediate_ (in which the interest is accumulated _before_
+the payment), not _annuities due_ (in which the interest is accumulated _after_
+the payment). There are many opportunities for extension and improvement.
 
 ## Requirements
 
-This library requires Ruby 1.9.3 or newer. (However, it will work with Ruby
-1.9.2 if you only use Float, not BigDecimal, for floating-point values.)
+This library is tested with versions 1.9.3 and 2.0.0 of MRI (Matz's Ruby
+Interpreter). It also works with version 1.9.2 if you only use Float, not
+BigDecimal, for floating-point values.
 
 ## Installation
 

data/lib/refinance/version.rb

@@ -1,3 +1,3 @@
 module Refinance
-  VERSION = "0.0.1"
+  VERSION = "1.0.0"
 end

data/refinance.gemspec

@@ -19,6 +19,6 @@ Gem::Specification.new do |gem|
   gem.test_files = gem.files.grep(%r{^(test|spec|features)/})
   gem.require_paths = ["lib"]
 
-  gem.add_development_dependency 'rake', '0.9.2.2'
-  gem.add_development_dependency 'minitest', '3.5.0'
+  gem.add_development_dependency 'rake', '10.0.4'
+  gem.add_development_dependency 'minitest', '4.7.4'
 end

data/test/bigdecimal_annuities_test.rb

@@ -1,109 +1,62 @@
-require 'minitest/autorun'
+require 'test_helper'
 require 'bigdecimal'
-require 'refinance'
 
-class BigDecimalAnnuitiesTest < MiniTest::Unit::TestCase
+class BigDecimalAnnuitiesTest < AnnuitiesTest
 
   def test_improve_interest_rate
     # Based on Example 6 in http://oakroadsystems.com/math/loan.htm .
-    payment = BigDecimal.new('291')
-    periods = BigDecimal.new('48')
-    principal = BigDecimal.new('11200')
-    guess = BigDecimal.new('0.01')
-
-    expected = BigDecimal.new('0.0094295242')
-    actual = Refinance::Annuities.improve_interest_rate(payment, periods,
-      principal, guess)
-
-    assert_in_delta expected, actual, BigDecimal.new('0.00000001')
+    assert_improve_interest_rate payment: BigDecimal.new('291'),
+      periods: BigDecimal.new('48'), principal: BigDecimal.new('11200'),
+      guess: BigDecimal.new('0.01'), expected: BigDecimal.new('0.0094295242'),
+      delta: BigDecimal.new('0.00000001')
   end
 
   def test_interest_rate_stops_if_improvement_is_small
     # Based on Example 6 in http://oakroadsystems.com/math/loan.htm .
-    payment = BigDecimal.new('291')
-    periods = BigDecimal.new('48')
-    principal = BigDecimal.new('11200')
-    guess = BigDecimal.new('0.01')
-    imprecision = BigDecimal.new('0.5')
-
-    expected = BigDecimal.new('0.0094295242')
-    actual = Refinance::Annuities.interest_rate(payment, periods, principal,
-      guess, imprecision)
-
-    assert_in_delta expected, actual, BigDecimal.new('0.00000001')
-  end
-
-  def test_interest_rate_stops_if_max_iterations_reached
-    extreme_precision = BigDecimal.new('0')
-    guess = BigDecimal.new('0.01')
-
-    expected = guess
-    actual = Refinance::Annuities.interest_rate(0, 0, 0, guess,
-      extreme_precision, 1, 0)
-
-    assert_equal expected, actual
+    assert_interest_rate_stops_if_improvement_is_small \
+      payment: BigDecimal.new('291'), periods: BigDecimal.new('48'),
+      principal: BigDecimal.new('11200'), guess: BigDecimal.new('0.01'),
+      precision: BigDecimal.new('0.5'),
+      expected: BigDecimal.new('0.0094295242'),
+      delta: BigDecimal.new('0.00000001')
   end
 
   def test_interest_rate_does_multiple_iterations
     # Based on Example 6 in http://oakroadsystems.com/math/loan.htm .
-    payment = BigDecimal.new('291')
-    periods = BigDecimal.new('48')
-    principal = BigDecimal.new('11200')
-    guess = BigDecimal.new('0.01')
-    extreme_precision = BigDecimal.new('0')
-    max_iterations = 4
-
-    expected = BigDecimal.new('0.0094007411')
-    actual = Refinance::Annuities.interest_rate(payment, periods, principal,
-      guess, extreme_precision, 10, 4)
-
-    assert_in_delta expected, actual, BigDecimal.new('0.0000000001')
+    assert_interest_rate_does_multiple_iterations \
+      payment: BigDecimal.new('291'), periods: BigDecimal.new('48'),
+      principal: BigDecimal.new('11200'), guess: BigDecimal.new('0.01'),
+      precision: BigDecimal.new('0'), max_decimals: 10, max_iterations: 4,
+      expected: BigDecimal.new('0.0094007411'),
+      delta: BigDecimal.new('0.0000000001')
   end
 
   def test_payment
     # Based on Example 2 in http://oakroadsystems.com/math/loan.htm .
-    interest_rate = BigDecimal.new('0.0065')
-    periods = BigDecimal.new('360')
-    principal = BigDecimal.new('225000')
-
-    expected = BigDecimal.new('1619.708627')
-    actual = Refinance::Annuities.payment(interest_rate, periods, principal)
-
-    assert_in_delta expected, actual, BigDecimal.new('0.000001')
+    assert_payment interest_rate: BigDecimal.new('0.0065'),
+      periods: BigDecimal.new('360'), principal: BigDecimal.new('225000'),
+      expected: BigDecimal.new('1619.708627'),
+      delta: BigDecimal.new('0.000001')
   end
 
   def test_periods
     # Based on Example 3 in http://oakroadsystems.com/math/loan.htm .
-    interest_rate = BigDecimal.new('0.005')
-    payment = BigDecimal.new('100')
-    principal = BigDecimal.new('3500')
-
-    expected = BigDecimal.new('38.57')
-    actual = Refinance::Annuities.periods(interest_rate, payment, principal)
-
-    assert_in_delta expected, actual, BigDecimal.new('0.01')
+    assert_periods interest_rate: BigDecimal.new('0.005'),
+      payment: BigDecimal.new('100.0'), principal: BigDecimal.new('3500.0'),
+      expected: BigDecimal.new('38.57'), delta: BigDecimal.new('0.01')
   end
 
   def test_principal
     # Based on Example 5 in http://oakroadsystems.com/math/loan.htm .
-    interest_rate = BigDecimal.new('0.014083')
-    payment = BigDecimal.new('60')
-    periods = BigDecimal.new('36')
-
-    expected = BigDecimal.new('1685.26') # Example fudges to 1685.25.
-    actual = Refinance::Annuities.principal(interest_rate, payment, periods)
-
-    assert_in_delta expected, actual, BigDecimal.new('0.01')
+    assert_principal interest_rate: BigDecimal.new('0.014083'),
+      payment: BigDecimal.new('60'), periods: BigDecimal.new('36'),
+      expected: BigDecimal.new('1685.26'), delta: BigDecimal.new('0.01')
   end
 
   def test_effective_interest_rate
-    nominal_annual_interest_rate = BigDecimal.new('0.1')
-    compounding_periods_per_year = BigDecimal.new('12')
-
-    expected = BigDecimal.new('0.10471')
-    actual = Refinance::Annuities.effective_interest_rate(
-      nominal_annual_interest_rate, compounding_periods_per_year)
-
-    assert_in_delta expected, actual, BigDecimal.new('0.00001')
+    assert_effective_interest_rate \
+      nominal_annual_interest_rate: BigDecimal.new('0.1'),
+      compounding_periods_per_year: BigDecimal.new('12'),
+      expected: BigDecimal.new('0.10471'), delta: BigDecimal.new('0.00001')
   end
 end

data/test/float_annuities_test.rb

@@ -1,108 +1,48 @@
-require 'minitest/autorun'
-require 'refinance'
+require 'test_helper'
 
-class FloatAnnuitiesTest < MiniTest::Unit::TestCase
+class FloatAnnuitiesTest < AnnuitiesTest
 
   def test_improve_interest_rate
     # Based on Example 6 in http://oakroadsystems.com/math/loan.htm .
-    payment = 291.0
-    periods = 48.0
-    principal = 11200.0
-    guess = 0.01
-
-    expected = 0.0094295242
-    actual = Refinance::Annuities.improve_interest_rate(payment, periods,
-      principal, guess)
-
-    assert_in_delta expected, actual, 0.00000001
+    assert_improve_interest_rate payment: 291.0, periods: 48.0,
+      principal: 11200.0, guess: 0.01, expected: 0.0094295242,
+      delta: 0.00000001
   end
 
   def test_interest_rate_stops_if_improvement_is_small
     # Based on Example 6 in http://oakroadsystems.com/math/loan.htm .
-    payment = 291.0
-    periods = 48.0
-    principal = 11200.0
-    guess = 0.01
-    imprecision = 0.5
-
-    expected = 0.0094295242
-    actual = Refinance::Annuities.interest_rate(payment, periods, principal,
-      guess, imprecision)
-
-    assert_in_delta expected, actual, 0.00000001
-  end
-
-  def test_interest_rate_stops_if_max_iterations_reached
-    extreme_precision = 0.0
-    guess = 0.01
-
-    expected = guess
-    actual = Refinance::Annuities.interest_rate(0, 0, 0, guess,
-      extreme_precision, 1, 0)
-
-    assert_equal expected, actual
+    assert_interest_rate_stops_if_improvement_is_small payment: 291.0,
+      periods: 48.0, principal: 11200.0, guess: 0.01, precision: 0.5,
+      expected: 0.0094295242, delta: 0.00000001
   end
 
   def test_interest_rate_does_multiple_iterations
     # Based on Example 6 in http://oakroadsystems.com/math/loan.htm .
-    payment = 291.0
-    periods = 48.0
-    principal = 11200.0
-    guess = 0.01
-    extreme_precision = 0.0
-    max_iterations = 4
-
-    expected = 0.0094007411
-    actual = Refinance::Annuities.interest_rate(payment, periods, principal,
-      guess, extreme_precision, 10, 4)
-
-    assert_in_delta expected, actual, 0.0000000001
+    assert_interest_rate_does_multiple_iterations payment: 291.0,
+      periods: 48.0, principal: 11200.0, guess: 0.01, precision: 0.0,
+      max_decimals: 10, max_iterations: 4, expected: 0.0094007411,
+      delta: 0.0000000001
   end
 
   def test_payment
-    # Based on Example 2 in http://oakroadsystems.com/math/loan.htm .
-    interest_rate = 0.0065
-    periods = 360.0
-    principal = 225000.0
-
-    expected = 1619.708627
-    actual = Refinance::Annuities.payment(interest_rate, periods, principal)
-
-    assert_in_delta expected, actual, 0.000001
+    assert_payment interest_rate: 0.0065, periods: 360.0, principal: 225000.0,
+      expected: 1619.708627, delta: 0.000001
   end
 
   def test_periods
     # Based on Example 3 in http://oakroadsystems.com/math/loan.htm .
-    interest_rate = 0.005
-    payment = 100.0
-    principal = 3500.0
-
-    expected = 38.57
-    actual = Refinance::Annuities.periods(interest_rate, payment, principal)
-
-    assert_in_delta expected, actual, 0.01
+    assert_periods interest_rate: 0.005, payment: 100.0, principal: 3500.0,
+      expected: 38.57, delta: 0.01
   end
 
   def test_principal
     # Based on Example 5 in http://oakroadsystems.com/math/loan.htm .
-    interest_rate = 0.014083
-    payment = 60.0
-    periods = 36.0
-
-    expected = 1685.26 # Example fudges to 1685.25.
-    actual = Refinance::Annuities.principal(interest_rate, payment, periods)
-
-    assert_in_delta expected, actual, 0.01
+    assert_principal interest_rate: 0.014083, payment: 60.0, periods: 36.0,
+      expected: 1685.26, delta: 0.01
   end
 
   def test_effective_interest_rate
-    nominal_annual_interest_rate = 0.1
-    compounding_periods_per_year = 12.0
-
-    expected = 0.10471
-    actual = Refinance::Annuities.effective_interest_rate(
-      nominal_annual_interest_rate, compounding_periods_per_year)
-
-    assert_in_delta expected, actual, 0.00001
+    assert_effective_interest_rate nominal_annual_interest_rate: 0.1,
+      compounding_periods_per_year: 12.0, expected: 0.10471, delta: 0.00001
   end
 end

data/test/refinance_test.rb

@@ -1,7 +1,6 @@
-require 'minitest/autorun'
-require 'refinance'
+require 'test_helper'
 
-class RefinanceTest < MiniTest::Unit::TestCase
+class RefinanceTest < Minitest::Unit::TestCase
   def test_refinance_is_a_module
     assert_kind_of Module, ::Refinance
   end
@@ -9,4 +8,11 @@ class RefinanceTest < MiniTest::Unit::TestCase
   def test_version_is_a_string
     assert_kind_of String, ::Refinance::VERSION
   end
+
+  def test_interest_rate_stops_if_max_iterations_reached
+    expected = 0.42
+    actual = Refinance::Annuities.interest_rate(0, 0, 0, expected, 0, 1, 0)
+
+    assert_equal expected, actual
+  end
 end

data/test/test_helper.rb

@@ -0,0 +1,60 @@
+require 'minitest/autorun'
+require 'refinance'
+
+class AnnuitiesTest < Minitest::Unit::TestCase
+  def assert_improve_interest_rate options
+    actual = Refinance::Annuities.improve_interest_rate(
+      options.fetch(:payment),
+      options.fetch(:periods),
+      options.fetch(:principal),
+      options.fetch(:guess))
+
+    assert_in_delta options.fetch(:expected), actual, options.fetch(:delta)
+  end
+
+  def assert_interest_rate_stops_if_improvement_is_small options
+    actual = Refinance::Annuities.interest_rate(options.fetch(:payment),
+      options.fetch(:periods), options.fetch(:principal),
+      options.fetch(:guess), options.fetch(:precision))
+
+    assert_in_delta options.fetch(:expected), actual, options.fetch(:delta)
+  end
+
+  def assert_interest_rate_does_multiple_iterations options
+    actual = Refinance::Annuities.interest_rate(options.fetch(:payment),
+      options.fetch(:periods), options.fetch(:principal),
+      options.fetch(:guess), options.fetch(:precision),
+      options.fetch(:max_decimals), options.fetch(:max_iterations))
+
+    assert_in_delta options.fetch(:expected), actual, options.fetch(:delta)
+  end
+
+  def assert_payment options
+    actual = Refinance::Annuities.payment(options.fetch(:interest_rate),
+      options.fetch(:periods), options.fetch(:principal))
+
+    assert_in_delta options.fetch(:expected), actual, options.fetch(:delta)
+  end
+
+  def assert_periods options
+    actual = Refinance::Annuities.periods(options.fetch(:interest_rate),
+      options.fetch(:payment), options.fetch(:principal))
+
+    assert_in_delta options.fetch(:expected), actual, options.fetch(:delta)
+  end
+
+  def assert_principal options
+    actual = Refinance::Annuities.principal(options.fetch(:interest_rate),
+      options.fetch(:payment), options.fetch(:periods))
+
+    assert_in_delta options.fetch(:expected), actual, options.fetch(:delta)
+  end
+
+  def assert_effective_interest_rate options
+    actual = Refinance::Annuities.effective_interest_rate(
+      options.fetch(:nominal_annual_interest_rate),
+      options.fetch(:compounding_periods_per_year))
+
+    assert_in_delta options.fetch(:expected), actual, options.fetch(:delta)
+  end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: refinance
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 1.0.0
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-09-27 00:00:00.000000000 Z
+date: 2013-05-03 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rake
@@ -18,7 +18,7 @@ dependencies:
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 0.9.2.2
+        version: 10.0.4
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
@@ -26,7 +26,7 @@ dependencies:
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 0.9.2.2
+        version: 10.0.4
 - !ruby/object:Gem::Dependency
   name: minitest
   requirement: !ruby/object:Gem::Requirement
@@ -34,7 +34,7 @@ dependencies:
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 3.5.0
+        version: 4.7.4
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
@@ -42,7 +42,7 @@ dependencies:
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 3.5.0
+        version: 4.7.4
 description: A collection of finance algorithms related to annuities.
 email:
 - enquiries@reinteractive.net
@@ -62,6 +62,7 @@ files:
 - test/bigdecimal_annuities_test.rb
 - test/float_annuities_test.rb
 - test/refinance_test.rb
+- test/test_helper.rb
 homepage: https://github.com/reinteractive-open/refinance
 licenses:
 - MIT
@@ -83,10 +84,10 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: 803431032426501235
+      hash: 1916847891747794597
 requirements: []
 rubyforge_project: 
-rubygems_version: 1.8.24
+rubygems_version: 1.8.25
 signing_key: 
 specification_version: 3
 summary: Simple annuity algorithms
@@ -94,3 +95,4 @@ test_files:
 - test/bigdecimal_annuities_test.rb
 - test/float_annuities_test.rb
 - test/refinance_test.rb
+- test/test_helper.rb