mortgage_calc 0.1.6 → 0.1.7

data/Manifest

@@ -7,5 +7,6 @@ features/step_definitions/apr_steps.rb
 features/support/env.rb
 lib/mortgage_calc.rb
 lib/mortgage_calc/mortgage_util.rb
+mortgage_calc.gemspec
 spec/mortgage_calc/mortgage_util_spec.rb
 spec/spec_helper.rb

data/README.rdoc

@@ -1,5 +1,7 @@
 = mortgage_calc
 
+http://www.pathf.com/blogs/2010/02/mortcalc-gem/
+
 Calculates mortgage APR, monthly payments, and fees.
 
 == INSTALL

data/Rakefile

@@ -10,7 +10,7 @@ require 'spec/rake/spectask'
 
 Echoe.new("mortgage_calc", MortgageCalc::VERSION) do |p|
   p.description = "Mortgage utilities"
-  p.url = "http://github.com/perry3819/mortgage_calc"
+  p.url = "http://www.pathf.com/blogs/2010/02/mortcalc-gem/"
   p.author = "Perry Hertler"
   p.email = "perry@hertler.org"
   p.ignore_pattern = ["tmp/*", "script/*, .idea/*"]

data/Version.yml

@@ -1,4 +1,4 @@
 ---
 :major: 0
 :minor: 1
-:patch: 6
+:patch: 7

data/features/apr.feature

@@ -1,4 +1,4 @@
-Feature Calculate APR
+Feature: Calculate APR
   In order to show sorted APR search results
   As a person navigating OMT
   I want to see correct APRs
@@ -10,10 +10,13 @@ Feature Calculate APR
   Scenarios: with APR fields
     | loan_amount | fees  | points  | rate   | period | apr   |
     | 125000      | 5000  | 0       | 6.5    | 360    | 6.881 |
-    | 125000      | 5000  | -1.25   | 6.5    | 360    | 6.881 |
+    | 125000      | 5000  | -1.25   | 6.5    | 360    | 6.763 |
     | 400000      | 1200  | 0       | 5.25   | 180    | 5.296 |
     | 125000      | 811   | 0.375   | 6.125  | 360    | 6.221 |
-    | 125000      | 811   | -0.375  | 6.5    | 360    | 6.562 |
+    | 125000      | 811   | -0.375  | 6.5    | 360    | 6.526 |
     | 100000      | 1000  | 0       | 7.0    | 360    | 7.099 |
     | 100000      | 0     | 0       | 7.0    | 360    | 7.0   |
-    | 250000      | 3135  | 2.125   | 6.5    | 360    | 6.822 |
+    | 250000      | 3135  | 2.125   | 6.5    | 360    | 6.822 |
+    | 80000       | 800   | 1.2     | 5.125  | 360    | 5.319 |
+    | 100000      | 2000  | 0       | 5.9    | 480    | 6.056 |
+    | 400000      | 3159  | 0       | 4.375  | 360    | 4.442 |

data/lib/mortgage_calc/mortgage_util.rb

@@ -1,12 +1,12 @@
 module MortgageCalc
   class MortgageUtil
-    attr_accessor :loan_amount, :interest_rate, :period, :lender_fee, :points
+    attr_accessor :loan_amount, :interest_rate, :period, :fees, :points
 
-    def initialize(loan_amount, interest_rate, period=360, lender_fee=0, points=0.0)
+    def initialize(loan_amount, interest_rate, period=360, fees=0, points=0.0)
       self.loan_amount = Float(loan_amount.to_s)
       self.interest_rate = Float(interest_rate.to_s)
       self.period = Integer(period.to_s)
-      self.lender_fee = lender_fee
+      self.fees = fees
       self.points = Float(points.to_s)
     end
 
@@ -15,11 +15,11 @@ module MortgageCalc
     end
 
     def monthly_payment
-      @monthly_payment ||= calculate_monthly_payment(self.loan_amount, monthly_interst_rate, self.period)
+      @monthly_payment ||= calculate_monthly_payment(self.loan_amount, monthly_interest_rate, self.period)
     end
 
     def monthly_payment_with_fees
-      @monthly_payment_with_fees ||= calculate_monthly_payment(self.loan_amount + total_fees, monthly_interst_rate, self.period)
+      @monthly_payment_with_fees ||= calculate_monthly_payment(self.loan_amount + total_fees, monthly_interest_rate, self.period)
     end
 
     def total_fees
@@ -27,7 +27,7 @@ module MortgageCalc
     end
 
     private
-    def monthly_interst_rate
+    def monthly_interest_rate
       self.interest_rate / 100 / 12
     end
 
@@ -36,36 +36,36 @@ module MortgageCalc
     end
 
     def calculate_total_fees
-      buyer_points = self.points <= 0 ? 0 : self.points
-      self.lender_fee + (self.loan_amount * buyer_points.abs/100)
+      total = self.fees + (self.loan_amount * points/100)
+      #fees may not be negative (borrower is not paid)
+      total < 0 ? 0 : total
     end
 
     # solves APR
-    # where a = APR/1200, N = period, P = monthly payment, C = loan_amount
     # [a (1 + a)^N] / [(1 + a)^N - 1] - P/C = 0
+    # where a = APR/1200, N = period, P = monthly payment, C = loan_amount
     # calculate APR uses the Newton-Raphson to find the root (the value for 'a' that makes f(a) = 0)
-    # for best performance call this with 'start'= interest rate
     def calculate_apr
       payment_ratio = monthly_payment_with_fees / loan_amount
       f = lambda {|k| (k**(self.period + 1) - (k**self.period * (payment_ratio + 1)) + payment_ratio)}
-      f_slope = lambda { |k| ((self.period + 1) * k**self.period) - (self.period * (payment_ratio + 1) * k**(self.period - 1))}
+      f_deriv = lambda { |k| ((self.period + 1) * k**self.period) - (self.period * (payment_ratio + 1) * k**(self.period - 1))}
 
-      root = newton_raphson(f, f_slope, monthly_interst_rate + 1)
+      root = newton_raphson(f, f_deriv, monthly_interest_rate + 1)
       100 * 12 * (root - 1).to_f
     end
 
     # if 'start' is the monthly_interest_rate, Newton Raphson will find the apr root very quickly
     # k1 = k0 - f(k0)/f'(k0)
-    # k_plus_one = k - f(k)/f_slope(k)
+    # k_plus_one = k - f(k)/f_deriv(k)
     # We find the k-intercept of the tangent line at point k_plus_one and compare k to k_plus_one.
     # This is repeated until a sufficiently accurate value is reached, which can be specified with the 'precision' parameter
-    def newton_raphson(f, f_slope, start, precision = 5)
+    def newton_raphson(f, f_deriv, start, precision = 5)
       k_plus_one = start
       k = 0.0
 
       while ((k - 1) * 10**precision).to_f.floor !=  ((k_plus_one - 1) * 10**precision).to_f.floor
         k = k_plus_one
-        k_plus_one = k - f.call(k) / f_slope.call(k)
+        k_plus_one = k - f.call(k) / f_deriv.call(k)
       end
       k_plus_one
     end

data/mortgage_calc.gemspec

@@ -2,16 +2,16 @@
 
 Gem::Specification.new do |s|
   s.name = %q{mortgage_calc}
-  s.version = "0.1.6"
+  s.version = "0.1.7"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 1.2") if s.respond_to? :required_rubygems_version=
   s.authors = ["Perry Hertler"]
-  s.date = %q{2010-02-15}
+  s.date = %q{2010-07-07}
   s.description = %q{Mortgage utilities}
   s.email = %q{perry@hertler.org}
   s.extra_rdoc_files = ["README.rdoc", "lib/mortgage_calc.rb", "lib/mortgage_calc/mortgage_util.rb"]
-  s.files = ["Manifest", "README.rdoc", "Rakefile", "Version.yml", "features/apr.feature", "features/step_definitions/apr_steps.rb", "features/support/env.rb", "lib/mortgage_calc.rb", "lib/mortgage_calc/mortgage_util.rb", "spec/mortgage_calc/mortgage_util_spec.rb", "spec/spec_helper.rb", "mortgage_calc.gemspec"]
-  s.homepage = %q{http://github.com/perry3819/mortgage_calc}
+  s.files = ["Manifest", "README.rdoc", "Rakefile", "Version.yml", "features/apr.feature", "features/step_definitions/apr_steps.rb", "features/support/env.rb", "lib/mortgage_calc.rb", "lib/mortgage_calc/mortgage_util.rb", "mortgage_calc.gemspec", "spec/mortgage_calc/mortgage_util_spec.rb", "spec/spec_helper.rb"]
+  s.homepage = %q{http://www.pathf.com/blogs/2010/02/mortcalc-gem/}
   s.rdoc_options = ["--line-numbers", "--inline-source", "--title", "Mortgage_calc", "--main", "README.rdoc"]
   s.require_paths = ["lib"]
   s.rubyforge_project = %q{mortgage_calc}

data/spec/mortgage_calc/mortgage_util_spec.rb

@@ -1,5 +1,4 @@
-require File.join(File.dirname(__FILE__), "..", "spec_helper")
-
+require File.dirname(__FILE__) + '/../spec_helper'
 module MortgageCalc
   describe MortgageUtil do
     def assert_monthly_apr_payment_matches(loan_amount, rate, period, fee, points)
@@ -15,7 +14,7 @@ module MortgageCalc
         @mortgage_util_with_apr_as_rate = MortgageUtil.new(100000, @mortgage_util.apr, 360, 1200, 1.25)
       end
       it "should have proper monthly interest rate" do
-        @mortgage_util.send(:monthly_interst_rate).should == 0.005
+        @mortgage_util.send(:monthly_interest_rate).should == 0.005
       end
       it "should have proper monthly payment" do
         @mortgage_util.monthly_payment.should be_close(599.55, 0.001)
@@ -35,18 +34,26 @@ module MortgageCalc
       assert_monthly_apr_payment_matches(300000, 6.5, 360, 10000, 7.25)
     end
   end
-  context "ignore lender points paid to broker" do
-    it "the fee should not include negative points" do
-      mortgage_util = MortgageUtil.new(100000, 6.0, 360, 1200, -1.25)
-      1200.should == mortgage_util.total_fees
+
+  context "net negative fees" do
+     before(:all) do
+      @mortgage_util =  MortgageUtil.new(100000, 6.0, 360, 1200, -11.25)
+      @mortgage_util.total_fees.should be 0
+    end
+    it "calculate total fees should return 0 if total fees is less than 0" do
+       @mortgage_util.send(:calculate_total_fees).should be 0
+    end
+    it "should not return APR less than interest rate" do
+      @mortgage_util.apr.should be_close 6.0, 0.00000001
     end
   end
+
   context "initialize convert to best types" do
     before(:all) do
       @mortgage_util =  MortgageUtil.new('100000', '6.0', 360, 1200, '-1.25')
     end
     it "should convert rate to float if necessary" do
-       @mortgage_util.interest_rate.class.should == Float
+      @mortgage_util.interest_rate.class.should == Float
     end
     it "should convert points to float if necessary" do
       @mortgage_util.points.class.should == Float

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: mortgage_calc
 version: !ruby/object:Gem::Version 
-  version: 0.1.6
+  version: 0.1.7
 platform: ruby
 authors: 
 - Perry Hertler
@@ -9,7 +9,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-02-15 00:00:00 -06:00
+date: 2010-07-07 00:00:00 -05:00
 default_executable: 
 dependencies: []
 
@@ -33,11 +33,11 @@ files:
 - features/support/env.rb
 - lib/mortgage_calc.rb
 - lib/mortgage_calc/mortgage_util.rb
+- mortgage_calc.gemspec
 - spec/mortgage_calc/mortgage_util_spec.rb
 - spec/spec_helper.rb
-- mortgage_calc.gemspec
 has_rdoc: true
-homepage: http://github.com/perry3819/mortgage_calc
+homepage: http://www.pathf.com/blogs/2010/02/mortcalc-gem/
 licenses: []
 
 post_install_message: