finance_rb 0.2.1 → 0.2.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 52d806b7797622aa42c8a3d13197ddd3e66817dd41199751cc402d2e2ede4741
-  data.tar.gz: 3404f5b73ededdd707d82f976a61bed2b575a3e00b448c1b056a06c92169bd5a
+  metadata.gz: 07e154f5ba5d444fe1e2c782c39a3d21a79b9fd3d413fba6e7c5285fa5f07df4
+  data.tar.gz: bef7aea3a7f54df1fc69d05619e9416637c717ce7e8b4d3a211573fbfbf5a6df
 SHA512:
-  metadata.gz: b2114092617e4120fc0b4e61d5e98cd0c227c882605e10fb0bfafdeb761f8c6dc8124a82ac729b548f4365f1a7fa17b061ad14a1e8d1befb6608ced7f4d68634
-  data.tar.gz: c42f87903359390b44fdb6472baacf24f6fc60934961cd16c007675e1adb231c0122bfca514c4ceffab7506f66b13b95736474c85ae23b4d4d103259f747f718
+  metadata.gz: bf67fafbda3defb85d73581d02b3dc00b26f83c6b03e4f35bd5c2d3a0ac661a823cd737d8055c54309b8a6d6feba8be7d03675b39ddb95b2e8f7ceaa94a7e472
+  data.tar.gz: 4f429be0368ac5e986c689fcd6afd146cec1676741d149ced828ae6d03e38e2d2e1ebdfeae88fce1d76de1a31c51a08fb0809577362f07f1de0e70e761bfa8b1

data/CHANGELOG.md

@@ -1,3 +1,8 @@
+## [0.2.2] - 2021-05-01
+
+### Added
+* Implement `Finance::Loan#pv`
+
 ## [0.2.1] - 2021-05-01
 
 ### Added

data/README.md

@@ -16,7 +16,7 @@ which are as follows:
 | pmt                          |  ✅    |   Computes the fixed periodic payment(principal + interest) made against a loan amount|
 | ppmt                         |   ✅   |   Computes principal payment for a loan|
 | nper                         |    ✅   |    Computes the number of periodic payments|
-| pv                           |       |   Computes the present value of a payment|
+| pv                           |    ✅  |   Computes the present value of a payment|
 | rate                         |     |    Computes the rate of interest per period|
 | irr                          |    ✅    |    Computes the internal rate of return|
 | npv                          |  ✅   |   Computes the net present value of a series of cash flow|

data/lib/finance/loan.rb

@@ -25,6 +25,7 @@ module Finance
 
     # @return [Float] The number of periods to be compounded for. (I.e. Nper())
     #   Defaults to 1.
+    #   You can use #nper method to calculate value if param is not defined.
     attr_accessor :duration
 
     # @return [Float] Future value.
@@ -178,6 +179,29 @@ module Finance
       -((amount * factor) + (final_payment.to_f * second_factor))
     end
 
+    # Pv computes present value.
+    #   Required Loan arguments: nominal_rate, duration, payment, future_value, *ptype
+    #
+    # @return [Float] The present value.
+    #
+    # @example
+    #   require 'finance_rb'
+    #   Finance::Loan.new(nominal_rate: 0.24, duration: 12, future_value: 1000, payment: -300, ptype: :ending).pv
+    #   #=> 2384.1091906935
+    #
+    # @see http://www.oasis-open.org/committees/documents.php?wg_abbrev=office-formulaOpenDocument-formula-20090508.odt
+    # @see [WRW] Wheeler, D. A., E. Rathke, and R. Weir (Eds.) (2009, May).
+    #   Open Document Format for Office Applications (OpenDocument)v1.2,
+    #   Part 2: Recalculated Formula (OpenFormula) Format - Annotated Version,
+    #   Pre-Draft 12. Organization for the Advancement of Structured Information
+    #   Standards (OASIS). Billerica, MA, USA. [ODT Document].
+    def pv
+      factor = (1.0 + monthly_rate)**duration
+      second_factor = (factor - 1) * (1 + monthly_rate * ptype) / monthly_rate
+
+      -(future_value + (payment.to_f * second_factor)) / factor
+    end
+
     private
 
     def initialize_payment_type(ptype)

data/lib/finance/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Finance
-  VERSION = "0.2.1"
+  VERSION = "0.2.2"
 end

data/spec/finance/loan_spec.rb

@@ -71,6 +71,26 @@ RSpec.describe Finance::Loan do
     end
   end
 
+  describe '#pv' do
+    context 'when :ptype == beginning' do
+      it 'calculates correct pv value' do
+        loan = Finance::Loan.new(
+          nominal_rate: 0.24, duration: 12, future_value: 1000, payment: -300, ptype: :beginning
+        )
+        expect(loan.pv).to eq(2447.5612380190028)
+      end
+    end
+
+    context 'when :ptype == ending' do
+      it 'calculates correct pv value' do
+        loan = Finance::Loan.new(
+          nominal_rate: 0.24, duration: 12, future_value: 1000, payment: -300, ptype: :ending
+        )
+        expect(loan.pv).to eq(2384.1091906935)
+      end
+    end
+  end
+
   describe '#ipmt' do
     context 'when 1 period' do
       it 'calculates correct ipmt value' do

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: finance_rb
 version: !ruby/object:Gem::Version
-  version: 0.2.1
+  version: 0.2.2
 platform: ruby
 authors:
 - Vlad Dyachenko