mortgage_calc 0.1.5 → 0.1.6

data/Manifest

@@ -1,3 +1,4 @@
+Manifest
 README.rdoc
 Rakefile
 Version.yml
@@ -8,4 +9,3 @@ lib/mortgage_calc.rb
 lib/mortgage_calc/mortgage_util.rb
 spec/mortgage_calc/mortgage_util_spec.rb
 spec/spec_helper.rb
-Manifest

data/Rakefile

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

data/Version.yml

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

data/lib/mortgage_calc/mortgage_util.rb

@@ -11,20 +11,19 @@ module MortgageCalc
     end
 
     def apr
-      calculate_apr_with_newton_raphson(self.period, monthly_payment_with_fees, self.loan_amount, monthly_interst_rate + 1)
+      @apr ||= calculate_apr
     end
 
     def monthly_payment
-      calculate_monthly_payment(self.loan_amount, monthly_interst_rate, self.period)
+      @monthly_payment ||= calculate_monthly_payment(self.loan_amount, monthly_interst_rate, self.period)
     end
 
     def 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_interst_rate, self.period)
     end
 
     def total_fees
-      buyer_points = self.points <= 0 ? 0 : self.points
-      self.lender_fee + (self.loan_amount * buyer_points.abs/100)
+      @total_fees ||= calculate_total_fees
     end
 
     private
@@ -36,23 +35,39 @@ module MortgageCalc
       amount * (monthly_rate/(1 - (1 + monthly_rate)**(-period)))
     end
 
+    def calculate_total_fees
+      buyer_points = self.points <= 0 ? 0 : self.points
+      self.lender_fee + (self.loan_amount * buyer_points.abs/100)
+    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
     # 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_with_newton_raphson(periods, monthly_payment, loan_amount, start=1.1)
-      payment_ratio = monthly_payment / loan_amount
-      f = lambda {|k| (k**(periods + 1) - (k**periods * (payment_ratio + 1)) + payment_ratio)}
-      f_slope = lambda { |k| ((periods + 1) * k**periods) - (periods * (payment_ratio + 1) * k**(periods - 1))}
+    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))}
+
+      root = newton_raphson(f, f_slope, monthly_interst_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)
+    # 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)
       k_plus_one = start
       k = 0.0
 
-      while ((k - 1) * 100000).to_f.floor !=  ((k_plus_one - 1) * 100000).to_f.floor
+      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)
       end
-      100 * 12 * (k_plus_one - 1).to_f
+      k_plus_one
     end
   end
 end

data/mortgage_calc.gemspec

@@ -2,16 +2,16 @@
 
 Gem::Specification.new do |s|
   s.name = %q{mortgage_calc}
-  s.version = "0.1.5"
+  s.version = "0.1.6"
 
   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-13}
+  s.date = %q{2010-02-15}
   s.description = %q{Mortgage utilities}
-  s.email = %q{phertler@pathf.com}
+  s.email = %q{perry@hertler.org}
   s.extra_rdoc_files = ["README.rdoc", "lib/mortgage_calc.rb", "lib/mortgage_calc/mortgage_util.rb"]
-  s.files = ["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", "Manifest", "mortgage_calc.gemspec"]
-  s.homepage = %q{http://github.com/pathfinderdev/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", "spec/mortgage_calc/mortgage_util_spec.rb", "spec/spec_helper.rb", "mortgage_calc.gemspec"]
+  s.homepage = %q{http://github.com/perry3819/mortgage_calc}
   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

@@ -46,16 +46,16 @@ module MortgageCalc
       @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.type.should == Float
+       @mortgage_util.interest_rate.class.should == Float
     end
     it "should convert points to float if necessary" do
-      @mortgage_util.points.type.should == Float
+      @mortgage_util.points.class.should == Float
     end
     it "should convert loan_amount to float if necessary" do
-      @mortgage_util.loan_amount.type.should == Float
+      @mortgage_util.loan_amount.class.should == Float
     end
     it "should convert period to integer if necessary" do
-      @mortgage_util.period.type.should == Fixnum
+      @mortgage_util.period.class.should == Fixnum
     end
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: mortgage_calc
 version: !ruby/object:Gem::Version 
-  version: 0.1.5
+  version: 0.1.6
 platform: ruby
 authors: 
 - Perry Hertler
@@ -9,12 +9,12 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-02-13 00:00:00 -06:00
+date: 2010-02-15 00:00:00 -06:00
 default_executable: 
 dependencies: []
 
 description: Mortgage utilities
-email: phertler@pathf.com
+email: perry@hertler.org
 executables: []
 
 extensions: []
@@ -24,6 +24,7 @@ extra_rdoc_files:
 - lib/mortgage_calc.rb
 - lib/mortgage_calc/mortgage_util.rb
 files: 
+- Manifest
 - README.rdoc
 - Rakefile
 - Version.yml
@@ -34,10 +35,9 @@ files:
 - lib/mortgage_calc/mortgage_util.rb
 - spec/mortgage_calc/mortgage_util_spec.rb
 - spec/spec_helper.rb
-- Manifest
 - mortgage_calc.gemspec
 has_rdoc: true
-homepage: http://github.com/pathfinderdev/mortgage_calc
+homepage: http://github.com/perry3819/mortgage_calc
 licenses: []
 
 post_install_message: