finance_rb 0.0.4 → 0.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 82235bcca3f51afff5ec345707da9d1ed2e8472a20488bb3847a4967baf6932c
-  data.tar.gz: '02029b9b9151d52ad860b1f985cc708199d734f8f210e574cda50fc7290f4231'
+  metadata.gz: 6a3ce7fbe55b1715dc8b2b636326a1bb99eb4b8638f2a3c111e0decfe1b4d126
+  data.tar.gz: a5568d0deadc00bdd55ffac1cb05dee7a7d8abb8bee87015d321916f59694705
 SHA512:
-  metadata.gz: 38348b526019d3124c6cff67c4cd39427600d7a52ea584ea9b583328bedcfceb6680783bbbfdb8f9b45b686ff612e6295e670f1a09d882e09f4540fcf23a3aea
-  data.tar.gz: 879a9b9b6e01efd654e32a1bbc77a9e07e8a9b1cebbbb1061f6d20f3e0aa723b8150fbf8a56e66dee87bf3eb69a14301dc4d9a51fd62f87e9414f69f47aab5d6
+  metadata.gz: cd349f4f6aa4cf20fab8db9064da6b77f1199b61b927af170f491dd447cfdb3889aeea97d07de34706ca12493cfae56d1089aa8cfb2ff80e351ddd951d3e92e9
+  data.tar.gz: fdef6ff2746503b68a2a83494b6a006f05a7216f87125a71967dfdf7de05d4dcae80563f4cfbac0cf8ce7b91c5510cfd4cc4111cbe49f6573e43dc37fc21d4f2

data/CHANGELOG.md

@@ -1,12 +1,19 @@
+## [0.1.0] - 2021-03-28
+
+### Added
+* Create a basic structure for `Finance::Loan`
+* Implement `Finance::Loan#pmt`
+
+
 ## [0.0.4] - 2021-03-25
 
 ### Added
-* Implement Finance::Calculations#mirr
+* Implement `Finance::Calculations#mirr`
 
 ## [0.0.3] - 2021-03-23
 
 ### Added
-* Implement Finance::Calculations#irr using Newton's method
+* Implement `Finance::Calculations#irr` using Newton's method
 
 ## [0.0.2] - 2021-03-22
 

data/README.md

@@ -13,7 +13,7 @@ which are as follows:
 |:------------------------:    |:------------------:  | :------------------|
 | fv                           |       |   Computes the  future value|
 | ipmt                         |       |   Computes interest payment for a loan|
-| pmt                          |       |   Computes the fixed periodic payment(principal + interest) made against a loan amount|
+| 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|

data/lib/finance/loan.rb

@@ -2,24 +2,82 @@
 
 module Finance
   class Loan
-    def initialize(**options)
-    end
+    PAYMENT_TYPE_MAPPING = { end: 0, beginning: 1 }.freeze
 
-    def pmt()
-    end
+    # @return [Float] The amount of loan request (I.e. a present value)
+    #   Defaults to 0.
+    attr_accessor :amount
 
-    def ipmt()
-    end
+    # @return [Integer] Specification of whether payment is made
+    #   at the beginning (ptype = 1) or the end (ptype = 0) of each period.
+    #   Defaults to {:end, 0}.
+    attr_accessor :ptype
+
+    # @return [Float] The nominal annual rate of interest as decimal (not per cent).
+    #   (e.g., 13% -> 0.13)
+    #   Defaults to 0.
+    attr_accessor :nominal_rate
+
+    # @return [Float] The monthly rate is the nominal annual rate divided by 12.
+    #   Defaults to 0.
+    attr_reader :monthly_rate
 
-    def ppmt()
+    # @return [Float] The number of periods to be compounded for. (I.e. Nper())
+    #   Defaults to 1.
+    attr_accessor :duration
+
+    # @return [Float] Future value.
+    #   Defaults to 0.
+    attr_accessor :future_value
+
+    def initialize(**options)
+      initialize_payment_type(options[:ptype])
+      @nominal_rate  = options.fetch(:nominal_rate, 0).to_f
+      @duration      = options.fetch(:duration, 1).to_f
+      @amount        = options.fetch(:amount, 0).to_f
+      @future_value  = options.fetch(:future_value, 0).to_f
+      @monthly_rate = @nominal_rate / 12
     end
 
-    def fv();end
+    # Pmt computes the payment against a loan principal plus interest (future_value = 0).
+    #   It can also be used to calculate the recurring payments needed to achieve
+    #   a certain future value given an initial deposit,
+    #   a fixed periodically compounded interest rate, and the total number of periods.
+    #
+    # @return [Numeric] The (fixed) periodic payment.
+    #
+    # @example
+    #   require 'finance_rb'
+    #   Finance::Loan.new(nominal_rate: 0.1, duration: 12, amount: 1000, ptype: :end).pmt
+    #   #=> 87.9158872300099
+    #
+    # @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 pmt
+      factor = (1.0 + monthly_rate)**duration
+      second_factor =
+        if monthly_rate.zero?
+          duration
+        else
+          (factor - 1) * (1 + monthly_rate * ptype) / monthly_rate
+        end
 
-    def pv();end
+      (-future_value + amount * factor) / second_factor
+    end
 
-    def nper();end
+    private
 
-    def rate();end
+    def initialize_payment_type(ptype)
+      @ptype =
+        if ptype.nil? || !PAYMENT_TYPE_MAPPING.keys.include?(ptype)
+          PAYMENT_TYPE_MAPPING[:end]
+        else
+          PAYMENT_TYPE_MAPPING[ptype]
+        end
+    end
   end
 end

data/lib/finance/version.rb

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

data/spec/finance/loan_spec.rb

@@ -0,0 +1,41 @@
+require 'spec_helper'
+
+RSpec.describe Finance::Loan do
+  describe '#pmt' do
+    context 'w/o a full set of params' do
+      it 'calculates correct pmt value w/o :ptype' do
+        loan = Finance::Loan.new(nominal_rate: 0.1, duration: 12, amount: 1000)
+        expect(loan.pmt).to eq(87.9158872300099)
+      end
+
+      it 'calculates correct pmt value w/o :nominal_rate' do
+        loan = Finance::Loan.new(duration: 12, amount: 1200, ptype: :end)
+        expect(loan.pmt).to eq(100)
+      end
+    end
+
+    context 'with zero rates' do
+      it 'calculates correct pmt value for 3 years' do
+        loan = Finance::Loan.new(nominal_rate: 0, duration: 36, amount: 10_000, ptype: :end)
+        expect(loan.pmt).to eq(277.77777777777777)
+      end
+
+      it 'calculates correct pmt value for 6 months' do
+        loan = Finance::Loan.new(nominal_rate: 0, duration: 6, amount: 10_000, ptype: :end)
+        expect(loan.pmt).to eq(1666.6666666666667)
+      end
+    end
+
+    context 'with :beginning ptype' do
+      it 'calculates correct pmt value' do
+        loan = Finance::Loan.new(nominal_rate: 0.12, duration: 6, amount: 1000, ptype: :beginning)
+        expect(loan.pmt).to eq(170.8399670404763)
+      end
+    end
+
+    it 'calculates correct pmt value' do
+      loan = Finance::Loan.new(nominal_rate: 0.13, duration: 90, amount: 1_000_000, ptype: :end)
+      expect(loan.pmt).to eq(17_449.90775727763)
+    end
+  end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: finance_rb
 version: !ruby/object:Gem::Version
-  version: 0.0.4
+  version: 0.1.0
 platform: ruby
 authors:
 - Vlad Dyachenko
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2021-03-24 00:00:00.000000000 Z
+date: 2021-03-28 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
@@ -27,6 +27,7 @@ files:
 - lib/finance/version.rb
 - lib/finance_rb.rb
 - spec/finance/calculations_spec.rb
+- spec/finance/loan_spec.rb
 - spec/spec_helper.rb
 homepage: https://github.com/wowinter13/finance_rb
 licenses:
@@ -57,4 +58,5 @@ specification_version: 4
 summary: A library for finance manipulations in Ruby.
 test_files:
 - spec/finance/calculations_spec.rb
+- spec/finance/loan_spec.rb
 - spec/spec_helper.rb