mortgage-buddy 0.1.0 → 0.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 1c4dcd770517fb8d88b02c5bb62accfb05268f4a
-  data.tar.gz: a82c613cbfad5ba13ee19d7b0c9b3785da790902
+  metadata.gz: 57d7dfa4923485c7c5c7d832249a7d655019f228
+  data.tar.gz: 9db923e6a6a4bf5a89064e066f4901d82fc13660
 SHA512:
-  metadata.gz: dfe96325cb57d7484509cdd76289de0c4a30acceb423f1ad37e6bb3854ade42b5adc16dbd2db2de919bcda70d68261facdaf4e362b43b3c28adf36098fc435aa
-  data.tar.gz: ce526f2e8094c38f7901ba0158a7892eeb9df64ec7882ff8c2025a052dc45f1852e676337af3d792cca40136ee2c08fc76ef074f93ea5ea1a9fe60164556cbeb
+  metadata.gz: c7fe975c98ab2a0a72c171598bdc14504f95eb76c3c50d4a3c31ccc2d114b45e431674676b4758ab6c7ac43d572098d50a41503cac8f49252e5e2f2fa5534c77
+  data.tar.gz: 1673be619c7ec677eb68af1cb69649f7d1beb0a13d7a2c0fe54857f7f3ab0a059d1f22d3a18ade8f5f5a8e5ea7134b96ba12349413bae5f97ba3d69f0a2f464d

data/README.md

@@ -1,14 +1,9 @@
-https://travis-ci.org/perryqh/mortgage-buddy.svg?branch=master
-
 # MortgageBuddy
-[![Gem Version](https://badge.fury.io/rb/g5_updatable.svg)](http://badge.fury.io/rb/g5_updatable)
+[![Gem Version](https://badge.fury.io/rb/mortgage-buddy.svg)](https://badge.fury.io/rb/mortgage-buddy)
 [![Build Status](https://travis-ci.org/perryqh/mortgage-buddy.svg?branch=master)](https://travis-ci.org/perryqh/mortgage-buddy)
 
 This gem will calculate APR and Amoratization.
 
-The Amoratization class can really help you if you're trying to decide on refinancing.
-
-
 
 ## Installation
 
@@ -28,39 +23,55 @@ Or install it yourself as:
 
 ## Usage
 ```ruby
-mortgage_cost = MortgageBuddy::MortgageCost.new(loan_amount:   550000,
-                                                interest_rate: 3.0,
-                                                period:        360,
-                                                fees:          600,
-                                                points:        0)
+
+loan_amount   = 550000
+interest_rate = 3.0
+period        = 360 # 12 months * 30 years
+fees          = 600 # $600 closing costs
+points        = 0 # no points to get this loan
+
+mortgage_cost = MortgageBuddy::MortgageCost.new(loan_amount:   loan_amount,
+                                                interest_rate: interest_rate,
+                                                period:        period,
+                                                fees:          fees,
+                                                points:        points)
 puts mortgage_cost.apr # 3.01% (rounded)
 puts mortgage_cost.monthly_payment_with_fees # $2321.35 (rounded)
 
-amoratizer = MortgageBuddy::Amoratizer.new(interest_rate: mortgage_cost.apr,
-                                           loan_amount:   550000,
-                                           period:        360)
+amoratizer_30_year = MortgageBuddy::Amoratizer.new(interest_rate: interest_rate,
+                                                   loan_amount:   loan_amount,
+                                                   period:        period)
 
-puts amoratizer.total_num_payments # 360 or 30 years (no extra payment)
-puts amoratizer.total_interest # $285,684.09 (disturbing)
-puts amoratizer.payments # an array of openstructs with every payment amount, interest, principal, etc
+puts amoratizer_30_year.total_num_payments # 360 or 30 years (no extra payment)
+puts amoratizer_30_year.total_interest # $284,773.56 (disturbing)
+puts amoratizer_30_year.payments # an array of openstructs with every payment amount, interest, principal, etc
 
 # Now let's see what happens when we pay extra
-
-amoratizer_with_extra = MortgageBuddy::Amoratizer.new(interest_rate:         mortgage_cost.apr,
-                                                      loan_amount:           550000,
-                                                      period:                360,
-                                                      extra_monthly_payment: 1000)
-
-puts amoratizer_with_extra.total_num_payments # 215 or just under 18 years
-puts amoratizer_with_extra.total_interest # $161532.46
-puts amoratizer.total_interest - amoratizer_with_extra.total_interest # a savings of $124,151.63
+amoratizer_with_pay_extra = MortgageBuddy::Amoratizer.new(interest_rate:         interest_rate,
+                                                          loan_amount:           loan_amount,
+                                                          period:                period,
+                                                          extra_monthly_payment: 1000)
+
+puts amoratizer_with_pay_extra.total_num_payments # 215 or just under 18 years
+puts amoratizer_with_pay_extra.total_interest # $161053.35
+puts amoratizer_30_year.total_interest - amoratizer_with_pay_extra.total_interest # a savings of $123720.21
+
+# What if we can get a little bit lower rate on a 15 year?
+amoratizer_15_year = MortgageBuddy::Amoratizer.new(interest_rate:         2.9,
+                                                   loan_amount:           loan_amount,
+                                                   period:                180,
+                                                   extra_monthly_payment: 0)
+puts amoratizer_15_year.total_num_payments # 180 15 years
+puts amoratizer_15_year.total_interest # $128,923.59
+puts amoratizer_15_year.actual_monthly_payment # $3771.80
+puts amoratizer_30_year.total_interest - amoratizer_15_year.total_interest # a savings of $155,849.97
 
 
 ```
 
 ## Development
 
-After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
 
 To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
 

data/lib/mortgage_buddy.rb

@@ -3,6 +3,8 @@ require 'active_support/core_ext/object/blank'
 require 'mortgage_buddy/version'
 require 'mortgage_buddy/safe_num'
 require 'mortgage_buddy/monthly'
+require 'mortgage_buddy/standard_rounding'
+require 'mortgage_buddy/floor_rounding'
 require 'mortgage_buddy/apr_calculator'
 require 'mortgage_buddy/mortgage_cost'
 require 'mortgage_buddy/payment_plan'

data/lib/mortgage_buddy/amoratizer.rb

@@ -10,14 +10,15 @@ module MortgageBuddy
     # [:period] Number of months of the loan. 30 yr is 360. 15 yr is 189
     # [:extra_monthly_payment] This is the extra monthly principal payment. Optional and defaults to 0
     def initialize(params={})
-      @interest_rate         = safe_float params[:interest_rate]
-      @loan_amount           = safe_float params[:loan_amount]
-      @period                = safe_int params[:period]
-      @extra_monthly_payment = safe_float(params.fetch(:extra_monthly_payment, 0))
+      @interest_rate              = safe_float params[:interest_rate]
+      @loan_amount                = safe_float params[:loan_amount]
+      @period                     = safe_int params[:period]
+      @extra_monthly_payment      = safe_float(params.fetch(:extra_monthly_payment, 0))
+      @interest_rounding_strategy = params[:interest_rounding_strategy]
     end
 
     def total_interest
-      payments.inject(0){|sum,pay| sum + pay.interest }.round(2)
+      payments.inject(0) { |sum, pay| sum + pay.interest }.round(2)
     end
 
     # A = [i * P * (1 + i)^n] / [(1 + i)^n - 1]
@@ -30,17 +31,23 @@ module MortgageBuddy
     end
 
     def actual_monthly_payment
-      minimum_monthly_payment + @extra_monthly_payment
+      (minimum_monthly_payment + @extra_monthly_payment).round(2)
     end
 
     def total_num_payments
       payments.length
     end
 
+    def last_monthly_payment
+      payments.last.payment
+    end
+
     def payments
-      @payments ||= MortgageBuddy::PaymentPlan.build(loan_amount:           self.loan_amount,
-                                                     monthly_payment:       actual_monthly_payment,
-                                                     monthly_interest_rate: monthly_interest_rate)
+      @payments ||= MortgageBuddy::PaymentPlan.build(loan_amount:                self.loan_amount,
+                                                     period:                     self.period,
+                                                     monthly_payment:            actual_monthly_payment,
+                                                     monthly_interest_rate:      monthly_interest_rate,
+                                                     interest_rounding_strategy: @interest_rounding_strategy)
     end
 
     private

data/lib/mortgage_buddy/floor_rounding.rb

@@ -0,0 +1,9 @@
+module MortgageBuddy
+  class FloorRounding
+    class << self
+      def round(num)
+        (num * 100).floor.to_f / 100
+      end
+    end
+  end
+end

data/lib/mortgage_buddy/mortgage_cost.rb

@@ -45,11 +45,11 @@ module MortgageBuddy
 
     private
     def calculate_monthly_payment(amount, monthly_rate, period)
-      amount * (monthly_rate/(1 - (1 + monthly_rate)**(-period)))
+      (amount * (monthly_rate/(1 - (1 + monthly_rate)**(-period)))).round(2)
     end
 
     def calculate_total_fees
-      @fees + (@loan_amount * points/100)
+      (@fees + (@loan_amount * points/100)).round(2)
     end
   end
 end

data/lib/mortgage_buddy/payment_plan.rb

@@ -7,10 +7,12 @@ module MortgageBuddy
     end
 
     def initialize(params)
-      @loan_amount           = params[:loan_amount]
-      @monthly_payment       = params[:monthly_payment]
-      @monthly_interest_rate = params[:monthly_interest_rate]
-      @remaining_loan_amount = @loan_amount
+      @loan_amount                = params[:loan_amount]
+      @monthly_payment            = params[:monthly_payment]
+      @monthly_interest_rate      = params[:monthly_interest_rate]
+      @interest_rounding_strategy = params[:interest_rounding_strategy] || MortgageBuddy::StandardRounding
+      @period                     = params[:period]
+      @remaining_loan_amount      = @loan_amount
     end
 
     def payments
@@ -20,34 +22,35 @@ module MortgageBuddy
     def build_payments
       payments       = []
       payment_number = 1
-      while @remaining_loan_amount > 0
-        interest = next_payment_interest
-        principal = next_payment_principal(interest)
-        if principal >= @remaining_loan_amount
-          difference             = principal - @remaining_loan_amount
-          principal              = @remaining_loan_amount.round(2)
-          payment                = (@monthly_payment - difference).round(2)
-          @remaining_loan_amount = 0
-        else
-          @remaining_loan_amount -= principal
-          payment                = @monthly_payment
-        end
-        payments << OpenStruct.new(payment:   payment,
+      while @remaining_loan_amount > 0.0
+        interest               = next_payment_interest
+        principal              = next_payment_principal(interest, payments.length + 1)
+        payment                = interest + principal
+        @remaining_loan_amount = (@remaining_loan_amount - principal).round(2)
+        payments << OpenStruct.new(payment:   payment.round(2),
                                    interest:  interest,
                                    principal: principal,
                                    number:    payment_number,
-                                   balance:   @remaining_loan_amount.round(2))
+                                   balance:   @remaining_loan_amount)
         payment_number += 1
       end
       payments
     end
 
-    def next_payment_principal(interest)
-      (@monthly_payment - interest).round(2)
+    def next_payment_principal(interest, payment_number)
+      principal = @monthly_payment - interest
+      if principal > @remaining_loan_amount || last_payment?(payment_number)
+        principal = @remaining_loan_amount
+      end
+      principal.round(2)
     end
 
     def next_payment_interest
-      (@monthly_interest_rate * @remaining_loan_amount * 100).floor.to_f / 100
+      @interest_rounding_strategy.round(@monthly_interest_rate * @remaining_loan_amount)
+    end
+
+    def last_payment?(payment_number)
+      @period == payment_number
     end
   end
 end

data/lib/mortgage_buddy/standard_rounding.rb

@@ -0,0 +1,9 @@
+module MortgageBuddy
+  class StandardRounding
+    class << self
+      def round(num)
+        num.round(2)
+      end
+    end
+  end
+end

data/lib/mortgage_buddy/version.rb

@@ -1,3 +1,3 @@
 module MortgageBuddy
-  VERSION = '0.1.0'
+  VERSION = '0.1.1'
 end

data/mortgage-buddy.gemspec

@@ -22,6 +22,6 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency "rspec"
   spec.add_development_dependency "rspec-its"
   spec.add_development_dependency "cucumber"
-  spec.add_development_dependency "pry"
+  spec.add_development_dependency "pry-nav"
   spec.add_dependency "activesupport"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: mortgage-buddy
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.1
 platform: ruby
 authors:
 - Perry Hertler
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2015-10-20 00:00:00.000000000 Z
+date: 2015-12-19 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -81,7 +81,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: pry
+  name: pry-nav
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -129,11 +129,14 @@ files:
 - lib/mortgage_buddy.rb
 - lib/mortgage_buddy/amoratizer.rb
 - lib/mortgage_buddy/apr_calculator.rb
+- lib/mortgage_buddy/floor_rounding.rb
 - lib/mortgage_buddy/monthly.rb
 - lib/mortgage_buddy/mortgage_cost.rb
 - lib/mortgage_buddy/payment_plan.rb
 - lib/mortgage_buddy/safe_num.rb
+- lib/mortgage_buddy/standard_rounding.rb
 - lib/mortgage_buddy/version.rb
+- mortgage-buddy-0.1.0.gem
 - mortgage-buddy.gemspec
 homepage: https://github.com/perryqh/mortgage-buddy
 licenses:
@@ -160,3 +163,4 @@ signing_key:
 specification_version: 4
 summary: Some mortgage calculation helpers
 test_files: []
+has_rdoc: