mortgage_calculations 0.1.10 → 0.2.1

data/README.rdoc

@@ -1,15 +1,19 @@
-= mortgage_calc
+= mortgage_calculations
 
 http://www.pathf.com/blogs/2010/02/mortcalc-gem/
 
-Calculates mortgage APR, monthly payments, and fees.
+Calculates mortgage APR and monthly payments.
 
 == INSTALL
-  $ sudo gem install gemcutter
-  $ gem tumble
-  $ sudo gem install mortgage_calc
+  $ sudo gem install mortgage_calculations
+
+or add following to your Gemfile
+
+  gem "mortgage_calculations", :require => "mortgage_calc"
+
 or add the following to your <b>environment.rb</b>
-  config.gem 'mortgage_calc'
+
+  config.gem 'mortgage_calculations', :lib => "mortgage_calc"
 
 ==Example:
     loan_amount = 350000
@@ -18,12 +22,11 @@ or add the following to your <b>environment.rb</b>
     lender_fee = 800
     points = 1.0
 
-    mort_calc = MortgageCalc::MortgageUtil.new(loan_amount, interest_rate, period, lender_fee, points)
+    mort_calc = MortgageCalc::MortgageUtil.new(loan_amount, interest_rate, total_fees, period)
     
     mort_calc.apr
     mort_calc.monthly_payment
     mort_calc.monthly_payment_with_fees
-    mort_calc.total_fees
 
 ==Formulas used
 ===Monthly payment with fees
@@ -46,4 +49,4 @@ or add the following to your <b>environment.rb</b>
 
 ===Total fees
 Total fees are calculated simply by adding Lender fees to the points paid by borrower.
-    T = E + P(C)
+    T = E + P(C)

data/VERSION

@@ -1 +1 @@
-0.1.10
+0.2.1

data/features/step_definitions/apr_steps.rb

@@ -1,5 +1,6 @@
 Given /^(.*), (.*), (.*), (.*), (.*)$/ do |loan_amount, fees, points, rate, period|
-  @mortgage_util = MortgageCalc::MortgageUtil.new(Integer(loan_amount), Float(rate), Integer(period), Float(fees), Float(points))
+  fee = Float(fees) + Float(loan_amount) * Float(points)/100
+  @mortgage_util = MortgageCalc::MortgageUtil.new(Integer(loan_amount), Float(rate), fee, Integer(period))
 end
 
 Then /^the resultant apr should be (.*)$/ do |apr_expected|

data/lib/mortgage_calc/mortgage_util.rb

@@ -1,13 +1,12 @@
 module MortgageCalc
   class MortgageUtil
-    attr_accessor :loan_amount, :interest_rate, :period, :fees, :points
+    attr_accessor :loan_amount, :interest_rate, :period, :fee
 
-    def initialize(loan_amount, interest_rate, period=360, fees=0, points=0.0)
+    def initialize(loan_amount, interest_rate, fee, period=360)
       self.loan_amount = Float(loan_amount.to_s)
       self.interest_rate = Float(interest_rate.to_s)
       self.period = Integer(period.to_s)
-      self.fees = fees
-      self.points = Float(points.to_s)
+      self.fee = Float(fee.to_s)
     end
 
     def apr
@@ -19,13 +18,7 @@ module MortgageCalc
     end
 
     def monthly_payment_with_fees
-      @monthly_payment_with_fees ||= calculate_monthly_payment(self.loan_amount + total_fees, monthly_interest_rate, self.period)
-    end
-
-    def total_fees(negative_allowed = true)
-      #fees may not be negative (borrower is not paid)
-      total_fees = calculate_total_fees
-      !negative_allowed && total_fees < 0 ? 0 : total_fees
+      @monthly_payment_with_fees ||= calculate_monthly_payment(self.loan_amount + fee, monthly_interest_rate, self.period)
     end
 
     private
@@ -37,10 +30,6 @@ module MortgageCalc
       amount * (monthly_rate/(1 - (1 + monthly_rate)**(-period)))
     end
 
-    def calculate_total_fees
-      self.fees + (self.loan_amount * points/100)
-    end
-
     # solves APR
     # [a (1 + a)^N] / [(1 + a)^N - 1] - P/C = 0
     # where a = APR/1200, N = period, P = monthly payment, C = loan_amount

data/mortgage_calculations.gemspec

@@ -5,11 +5,11 @@
 
 Gem::Specification.new do |s|
   s.name = %q{mortgage_calculations}
-  s.version = "0.1.10"
+  s.version = "0.2.1"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Perry Hertler"]
-  s.date = %q{2010-11-24}
+  s.date = %q{2011-02-14}
   s.description = %q{Utilities for Mortgage related calculations (APR and Monthly Payments)}
   s.email = %q{perry@hertler.org}
   s.extra_rdoc_files = [

data/spec/mortgage_calc/mortgage_util_spec.rb

@@ -1,17 +1,20 @@
 require File.dirname(__FILE__) + '/../spec_helper'
 module MortgageCalc
   describe MortgageUtil do
-    def assert_monthly_apr_payment_matches(loan_amount, rate, period, fee, points)
-      mortgage_util = MortgageUtil.new(loan_amount, rate, period, fee, points)
+    def assert_monthly_apr_payment_matches(loan_amount, rate, fee, period)
+      mortgage_util = MortgageUtil.new(loan_amount, rate, fee, period)
       monthly_payment_with_fees = mortgage_util.monthly_payment_with_fees
-      monthly_payment_from_apr = MortgageUtil.new(loan_amount, mortgage_util.apr, period, 0, 0).monthly_payment
+      monthly_payment_from_apr = MortgageUtil.new(loan_amount, mortgage_util.apr, calc_total_fee(loan_amount, 0, 0), period).monthly_payment
       monthly_payment_with_fees.should be_within(0.01).of(monthly_payment_from_apr)
     end
 
+    def calc_total_fee(loan_amount, points, fee)
+      loan_amount * points/100 + fee
+    end
+
     context "with valid MortgageUtil" do
       before(:all) do
-        @mortgage_util = MortgageUtil.new(100000, 6.0, 360, 1200, 1.25)
-        @mortgage_util_with_apr_as_rate = MortgageUtil.new(100000, @mortgage_util.apr, 360, 1200, 1.25)
+        @mortgage_util = MortgageUtil.new(100_000, 6.0, calc_total_fee(100_000, 1.25, 1200), 360)
       end
       it "should have proper monthly interest rate" do
         @mortgage_util.send(:monthly_interest_rate).should == 0.005
@@ -20,68 +23,44 @@ module MortgageCalc
         @mortgage_util.monthly_payment.should be_within(0.001).of(599.55)
       end
       it "should have proper total fees" do
-        @mortgage_util.total_fees.should be_within(0.001).of(2450)
+        @mortgage_util.fee.should be_within(0.001).of(2450)
       end
       it "should have proper APR" do
         @mortgage_util.apr.should be_within(0.00001).of(6.22726)
       end
     end
+
     it "should calculate original monthly payment from APR" do
-      assert_monthly_apr_payment_matches(300000, 6.5, 360, 1200, 1.25)
-      assert_monthly_apr_payment_matches(300000, 6.5, 360, 0, 0)
-      assert_monthly_apr_payment_matches(400000, 1.1, 180, 1200, 1.25)
-      assert_monthly_apr_payment_matches(300000, 6.5, 360, 0, 7.25)
-      assert_monthly_apr_payment_matches(300000, 6.5, 360, 10000, 7.25)
+      assert_monthly_apr_payment_matches(300_000, 6.5, calc_total_fee(300_000, 1.25, 1200), 360)
+      assert_monthly_apr_payment_matches(300_000, 6.5, calc_total_fee(300_000, 0, 0), 360)
+      assert_monthly_apr_payment_matches(400_000, 1.1, calc_total_fee(400_000, 1.25, 1200), 180)
+      assert_monthly_apr_payment_matches(300_000, 6.5, calc_total_fee(300_000, 7.25, 0), 360)
+      assert_monthly_apr_payment_matches(300_000, 6.5, calc_total_fee(300_000, 7.25, 10000), 360)
     end
 
-    #  context "with very small loan amount" do
-    #    it "should calculate proper apr when loan_amount is very small" do
-    #      @mortgage_util = MortgageUtil.new(5000, 6.0, 360, 1200, 1.25)
-    #      puts "@mortgage_util.apr = #{@mortgage_util.apr}"
-    #    end
-    #  end
-
     # APR calculations from following web site are assumed to be accurate:
     # http://www.debtconsolidationcare.com/calculator/apr.html
     context "test apr calculation" do
       it "should calculate proper apr" do
-        @mortgage_util = MortgageUtil.new(125000, 6.5, 360, 5000, 0)
+        @mortgage_util = MortgageUtil.new(125000, 6.5, calc_total_fee(125_000, 0, 5000))
         @mortgage_util.apr.should be_within(0.001).of(6.881)
       end
-      it "should calculate apr < interest_rate properly" do
-        @mortgage_util = MortgageUtil.new(125000, 6.5, 360, -5000, 0)
-        @mortgage_util.apr.should be_within(0.001).of(6.112)
-      end
-    end
-
-    context "net negative fees" do
-      before(:all) do
-        @mortgage_util =  MortgageUtil.new(100000, 6.0, 360, 1200, -11.25)
-        @mortgage_util.total_fees.should eql -10050.0
-      end
-      it "calculate total fees should return actual total fees is less than 0" do
-        @mortgage_util.send(:calculate_total_fees).should eql -10050.0
-      end
-      it "total fees should return 0 if total fees is less than 0" do
-        @mortgage_util.total_fees(false).should eql 0
-      end
-      it "total fees should return actual fees if negative parameter is true" do
-        @mortgage_util.total_fees(true).should eql -10050.0
-      end
-      it "should not return APR less than interest rate" do
+      it "should calculate APR less than interest rate" do
+        @mortgage_util =  MortgageUtil.new(100_000, 6.0, calc_total_fee(100_000, -11.25, 1200))
+        @mortgage_util.fee.should eql -10050.0
         @mortgage_util.apr.should be_within(0.00001).of(5.04043)
       end
     end
 
     context "initialize convert to best types" do
       before(:all) do
-        @mortgage_util =  MortgageUtil.new('100000', '6.0', 360, 1200, '-1.25')
+        @mortgage_util =  MortgageUtil.new('100_000', '6.0', calc_total_fee(100_000, -1.25, 1200))
       end
       it "should convert rate to float if necessary" do
         @mortgage_util.interest_rate.class.should == Float
       end
-      it "should convert points to float if necessary" do
-        @mortgage_util.points.class.should == Float
+      it "should convert fee to float if necessary" do
+        @mortgage_util.fee.class.should == Float
       end
       it "should convert loan_amount to float if necessary" do
         @mortgage_util.loan_amount.class.should == Float

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: mortgage_calculations
 version: !ruby/object:Gem::Version 
-  hash: 15
+  hash: 21
   prerelease: false
   segments: 
   - 0
+  - 2
   - 1
-  - 10
-  version: 0.1.10
+  version: 0.2.1
 platform: ruby
 authors: 
 - Perry Hertler
@@ -15,11 +15,14 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-11-24 00:00:00 -06:00
+date: 2011-02-14 00:00:00 -06:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
-  requirement: &id001 !ruby/object:Gem::Requirement 
+  prerelease: false
+  type: :development
+  name: rspec
+  version_requirements: &id001 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
     - - ~>
@@ -30,12 +33,12 @@ dependencies:
         - 1
         - 0
         version: 2.1.0
-  type: :development
-  name: rspec
-  prerelease: false
-  version_requirements: *id001
+  requirement: *id001
 - !ruby/object:Gem::Dependency 
-  requirement: &id002 !ruby/object:Gem::Requirement 
+  prerelease: false
+  type: :development
+  name: cucumber
+  version_requirements: &id002 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
     - - ">="
@@ -44,12 +47,12 @@ dependencies:
         segments: 
         - 0
         version: "0"
-  type: :development
-  name: cucumber
-  prerelease: false
-  version_requirements: *id002
+  requirement: *id002
 - !ruby/object:Gem::Dependency 
-  requirement: &id003 !ruby/object:Gem::Requirement 
+  prerelease: false
+  type: :development
+  name: bundler
+  version_requirements: &id003 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
     - - ~>
@@ -60,12 +63,12 @@ dependencies:
         - 0
         - 0
         version: 1.0.0
-  type: :development
-  name: bundler
-  prerelease: false
-  version_requirements: *id003
+  requirement: *id003
 - !ruby/object:Gem::Dependency 
-  requirement: &id004 !ruby/object:Gem::Requirement 
+  prerelease: false
+  type: :development
+  name: jeweler
+  version_requirements: &id004 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
     - - ~>
@@ -76,12 +79,12 @@ dependencies:
         - 5
         - 1
         version: 1.5.1
-  type: :development
-  name: jeweler
-  prerelease: false
-  version_requirements: *id004
+  requirement: *id004
 - !ruby/object:Gem::Dependency 
-  requirement: &id005 !ruby/object:Gem::Requirement 
+  prerelease: false
+  type: :development
+  name: rcov
+  version_requirements: &id005 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
     - - ">="
@@ -90,10 +93,7 @@ dependencies:
         segments: 
         - 0
         version: "0"
-  type: :development
-  name: rcov
-  prerelease: false
-  version_requirements: *id005
+  requirement: *id005
 description: Utilities for Mortgage related calculations (APR and Monthly Payments)
 email: perry@hertler.org
 executables: []