finance_rb 0.2.0 → 0.2.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: d76ff15f6be262332aa729708a548d775f1caaaefaa3135c1d545660c34717ca
-  data.tar.gz: 2d75e526b34bf1704686e3fb9bf5198b4b2d302f05e714207d8d06833ce96acf
+  metadata.gz: 52d806b7797622aa42c8a3d13197ddd3e66817dd41199751cc402d2e2ede4741
+  data.tar.gz: 3404f5b73ededdd707d82f976a61bed2b575a3e00b448c1b056a06c92169bd5a
 SHA512:
-  metadata.gz: 9545eebb0c540d6e5f3d75cdbf8a5b7fabe0ed75860601dd278f2c0b13ca05285a9d0865d978837532c92c2fb70815c5f450a10d6ff7bd008330ae81ac4d915b
-  data.tar.gz: bffcb93c73279bea34db04dbc39d0b6747e9d609e91a3a5f8006aaefe6ca08be2a4109b033b622a3382a4232a4e3ffba4d1a2eb168fbf6f1e6fe73fd971ab20c
+  metadata.gz: b2114092617e4120fc0b4e61d5e98cd0c227c882605e10fb0bfafdeb761f8c6dc8124a82ac729b548f4365f1a7fa17b061ad14a1e8d1befb6608ced7f4d68634
+  data.tar.gz: c42f87903359390b44fdb6472baacf24f6fc60934961cd16c007675e1adb231c0122bfca514c4ceffab7506f66b13b95736474c85ae23b4d4d103259f747f718

data/CHANGELOG.md

@@ -1,3 +1,16 @@
+## [0.2.1] - 2021-05-01
+
+### Added
+* Implement `Finance::Loan#nper`
+
+## [0.2.0] - 2021-04-30
+
+### Added
+* Implement `Finance::Loan#ppmt`
+
+### Changed
+* By default `Finance::Loan#pmt` returns negative values.
+
 ## [0.1.2] - 2021-04-05
 
 ### Added

data/README.md

@@ -15,7 +15,7 @@ which are as follows:
 | ipmt                         |   ✅   |   Computes interest payment for a loan|
 | 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|
+| nper                         |    ✅   |    Computes the number of periodic payments|
 | pv                           |       |   Computes the present value of a payment|
 | rate                         |     |    Computes the rate of interest per period|
 | irr                          |    ✅    |    Computes the internal rate of return|

data/lib/finance/loan.rb

@@ -132,6 +132,22 @@ module Finance
       pmt - ipmt
     end
 
+    # Nper computes the number of periodic payments.
+    #
+    #   Required Loan arguments: payment, nominal_rate, period, amount, future_value*
+    #
+    # @return [Float] Number of periodic payments.
+    #
+    # @example
+    #   require 'finance_rb'
+    #   Finance::Loan.new(nominal_rate: 0.07, amount: 8000, payment: -150).nper
+    #   #=> 64.0733487706618586
+    def nper
+      z = payment * (1.0 + monthly_rate * ptype) / monthly_rate
+
+      Math.log(-future_value + z / (amount + z)) / Math.log(1.0 + monthly_rate)
+    end
+
     # Fv computes future value at the end of some periods (duration).
     #   Required Loan arguments: nominal_rate, duration, payment, amount*
     #

data/lib/finance/version.rb

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

data/spec/finance/loan_spec.rb

@@ -146,4 +146,24 @@ RSpec.describe Finance::Loan do
       end
     end
   end
+
+  describe '#nper' do
+    context 'with normal arguments' do
+      it 'calculates correct nper value' do
+        loan = Finance::Loan.new(
+          nominal_rate: 0.07, amount: 8000, payment: -150, future_value: 0 
+        )
+        expect(loan.nper).to eq(64.0733487706618586)
+      end
+    end
+
+    context 'with incorrect arguments' do
+      it 'raises Math::DomainError' do
+        loan = Finance::Loan.new(
+          nominal_rate: 1e100, amount: 8000, payment: -150, future_value: 0 
+        )
+        expect { loan.nper }.to raise_error(Math::DomainError)
+      end
+    end
+  end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: finance_rb
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.2.1
 platform: ruby
 authors:
 - Vlad Dyachenko
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2021-04-30 00:00:00.000000000 Z
+date: 2021-05-01 00:00:00.000000000 Z
 dependencies: []
 description: A ruby port of numpy-financial functions. This library provides a Ruby
   interface for working with interest rates, mortgage amortization, and cashflows