exonio 0.1.1 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: a78b47da7f327af032c2c2eb15b19873b3633216
-  data.tar.gz: c307fa7b9e8e3b8072e14fa2ad9f56fdf660eab8
+  metadata.gz: c9595c1bffef30730dadb4b4274742bc3113ef5e
+  data.tar.gz: 335f53e02bb83504bfcaaa8186d0debfeb7f09cd
 SHA512:
-  metadata.gz: 6cb43b81c45f8fd358a3ec755bfb92c9f76d90de0cc81c8bbe50db6eed48df939ae2e45d48b7e660295bf1445e15c08216a790d610cc7ff81284287695186b3b
-  data.tar.gz: 5d63764dfe31e91ad66ad82b30567a1c68d41450c536cefc0a3ee0361eed55fef9b5a146b05e4d583f512f817f2b0f88766bc1770ff6ba0e503ed662a7bbb25d
+  metadata.gz: e656084a10f77e0d48f7a32be71625863a6427bc34532229daf3692fef734784b9d0ded1ed556f67304ef9cbefb890d659fba7dcb3c6b94fa216cc752d67af02
+  data.tar.gz: 53bf0c5c0f905d0d86d1f7deb15b3e3c9cbffa4c7134ca6dbd92129ca62c797359688ef74e19943e6b4a7b662e6939935291357107741b481836f446e4816d28

data/Gemfile.lock

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

data/README.md

@@ -67,6 +67,20 @@ In order to pay-off (i.e., have a future-value of 0) the $200,000 obtained
 today, a monthly payment of $1,854.02 would be required.  Note that this
 example illustrates usage of `fv` (future value) having a default value of 0.
 
+### PV
+
+What is the present value (e.g., the initial investment) of an investment
+that needs to total $20,000.00 after 10 years of saving $100 every month?
+Assume the interest rate is 5% (annually) compounded monthly.
+
+```ruby
+Exonio.pv(0.05 / 12, 12 * 10, -100, 20_000) # ==> -2715.0857731569663
+```
+
+By convention, the negative sign represents cash flow out (i.e., money not available today).
+Thus, to end up with $20,000.00 in 10 years saving $100 a month at 5% annual
+interest, an initial deposit of $2715,09 should be made.
+
 ## TODO
 
 There's a lot of formulas to be implemented, including:
@@ -82,7 +96,6 @@ There's a lot of formulas to be implemented, including:
 * MIRR
 * NPV
 * PPMT
-* PV
 * RATE
 * SLN
 * SYD

data/lib/exonio/financial.rb

@@ -66,5 +66,27 @@ module Exonio
 
       -(fv + pv * temp) / fact
     end
+
+    # Calculates the present value of an annuity 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 nper [Integer] The number of payments to be made (number of periods)
+    # @param pmt [Float] The amount per period to be paid
+    # @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.pv(0.05/12, 12*10, -100, 20_000) # ==> -2715.0857731569663
+    #
+    def pv(rate, nper, pmt, fv = 0, end_or_beginning = 0)
+      temp = (1 + rate) ** nper
+      fact = (1 + rate * end_or_beginning) * (temp - 1) / rate
+
+      -(fv + pmt * fact) / temp
+    end
   end
 end

data/lib/exonio/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: exonio
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.2.0
 platform: ruby
 authors:
 - Rafael Izidoro
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2016-01-22 00:00:00.000000000 Z
+date: 2016-01-26 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler