exonio 0.2.0 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: c9595c1bffef30730dadb4b4274742bc3113ef5e
-  data.tar.gz: 335f53e02bb83504bfcaaa8186d0debfeb7f09cd
+  metadata.gz: d7c8540cc0960cf7ecaa4ca890b9fcffa0e83188
+  data.tar.gz: 7242e19ab28e0746c164d6d7144763830ddd86a9
 SHA512:
-  metadata.gz: e656084a10f77e0d48f7a32be71625863a6427bc34532229daf3692fef734784b9d0ded1ed556f67304ef9cbefb890d659fba7dcb3c6b94fa216cc752d67af02
-  data.tar.gz: 53bf0c5c0f905d0d86d1f7deb15b3e3c9cbffa4c7134ca6dbd92129ca62c797359688ef74e19943e6b4a7b662e6939935291357107741b481836f446e4816d28
+  metadata.gz: 5060942e118057edcd050a004ec2f0a84ba4ed8054f6c0d6021bd9ee121dc25006bbd0b8a65f7bdc4dedf7b2e79c901a4446feddb8a7d82044c0804f775639e6
+  data.tar.gz: 220d4df06a167c0966b72f98042e6032a13aef295178f88e1dc8cefa60d4b8055e9e53bfd40ee41d1aa47a6e9c2558bbcff6571605f17267c5dcf871aa031b84

data/CHANGELOG.md

@@ -1,5 +1,13 @@
 # CHANGELOG
 
+## 0.3.0
+
+* Implements `ipmt` method
+
+## 0.2.0
+
+* Implements `pv` method
+
 ## 0.1.1
 
 * Remove round from `pmt` and `fv` methods

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    exonio (0.2.0)
+    exonio (0.3.0)
 
 GEM
   remote: https://rubygems.org/

data/README.md

@@ -43,6 +43,17 @@ By convention, the negative sign represents cash flow out (i.e. money not
 available today).  Thus, saving $100 a month at 5% annual interest leads
 to $15,692.93 available to spend in 10 years.
 
+### IPMT
+
+What is the interest part of a payment in the 8th period (i.e., 8th month),
+having a $5,000 loan to be paid in 2 years at an annual interest rate of 7.5%?
+
+```ruby
+Exonio.ipmt(0.075 / 12, 8, 12 * 2, 5_000.00) # ==> -22.612926783996798
+```
+
+So, in the 8th payment, $22.61 are the interest part.
+
 ### NPER
 
 If you only had $150/month to pay towards the loan, how long would it take
@@ -91,7 +102,6 @@ There's a lot of formulas to be implemented, including:
 * AMORLINC
 * DB
 * DDB
-* IPMT
 * IRR
 * MIRR
 * NPV

data/lib/exonio/financial.rb

@@ -22,6 +22,29 @@ module Exonio
       -(pv * temp + pmt * fact)
     end
 
+    # Calculates the payment on interest for an investment based on
+    # constant-amount periodic payments and a constant interest rate.
+    #
+    # @param rate [Float] The interest rate as decimal (not per cent) per period
+    # @param per [Integer] The amortization period, in terms of number of periods
+    # @param nper [Integer] The number of payments to be made
+    # @param pv [Float] The present value
+    # @param fv [Float] The future value remaining after the final payment has been made
+    # @param end_or_begining [Integer] Whether payments are due at the end (0) or
+    #   beggining (1) of each period
+    #
+    # @return [Float]
+    #
+    # @example
+    #   Exonio.ipmt(0.075 / 12, 8, 12 * 2, 5000) # ==> -22.612926783996798
+    #
+    def ipmt(rate, per, nper, pv, fv = 0, end_or_beginning = 0)
+      pmt = self.pmt(rate, nper, pv, fv, end_or_beginning)
+      fv = self.fv(rate, (per - 1), pmt, pv, end_or_beginning) * rate
+      temp = end_or_beginning == 1 ? fv / (1 + rate) : fv
+
+      (per == 1 && end_or_beginning == 1) ? 0.0 : temp
+    end
 
     # Calculates the number of payment periods for an investment based on
     # constant-amount periodic payments and a constant interest rate.

data/lib/exonio/version.rb

@@ -1,3 +1,3 @@
 module Exonio
-  VERSION = "0.2.0"
+  VERSION = "0.3.0"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: exonio
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.3.0
 platform: ruby
 authors:
 - Rafael Izidoro