financial_calculator 3.2.0 → 3.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 57f4d8c3b636807234e0abea5bda7cb5137c0bd8147677f9dec480303c68e214
-  data.tar.gz: 9df5a5db44050c530da5e66bf3afcb2a57dedc5aa28cc96d98520b33a01affdd
+  metadata.gz: dbbac869b96fed665ef26160601fa702b89bfa8753f9a36d02b4ad4b37e3054c
+  data.tar.gz: 19b4235429baa31c6ef21ed758af7d6355825d5d0ba09a406c800bde628f37e5
 SHA512:
-  metadata.gz: b43701fce76029ec660519740cfbc31e0ce3b4b9180a5ec47f2b3bcf080c6d6b7650188d852c6e79d44505ba9704b750227ff9b334a646a2bc43596a412216de
-  data.tar.gz: 648eaa40c214a467c40fe148be87fc1fb7b2b4ffec7f04cff640904a7720b96709fa28fd0d92333380e2f638eb838579735dd486d3e0b8ebd51bfd0c352d2040
+  metadata.gz: 5d8981744d1ffef65c9c2e932c7ad5577a4ec731e138e51cd87596f650176f97cdf6896e5015bf18a3591c38d83c7303b1e9f83891e431956da8db3ff8df5133
+  data.tar.gz: 42ef34bd41ea46bb8bfcab9cd56d2bab2221fbef0c8bef74a47e22bf0d4b8cb60b9d544cebba986ed5bbd8cf83ba0e2948121de9159f04ae5705be9107320bbd

data/CHANGELOG.md

@@ -4,7 +4,13 @@ All notable changes to this project will be documented in this file
 The format is based on [Keep a Changelog](http://keepachangelog.com/en/1.0.0/)
 and this project adheres to [Semantic Versioning](http://semver.org/spec/v2.0.0.html).
 
-## [Unreleased]
+## [3.3.0] - 2018-07-13
+### Added
+- New class for NPER
+
+### Removed
+
+### Changed
 
 ## [3.2.0] - 2018-06-09
 ### Added

data/README.md

@@ -1,4 +1,4 @@
-# FINANCE
+# FINANCIAL CALCULATOR
 [![Build Status](https://travis-ci.org/mfalzone/financial_calculator.svg?branch=master)](https://travis-ci.org/mfalzone/financial_calculator)
 [![Coverage Status](https://coveralls.io/repos/github/mfalzone/financial_calculator/badge.svg?branch=master)](https://coveralls.io/github/mfalzone/financial_calculator?branch=master)
 

data/lib/financial_calculator.rb

@@ -16,6 +16,7 @@ module FinancialCalculator
   require 'financial_calculator/irr'
   require 'financial_calculator/ppmt'
   require 'financial_calculator/pv'
+  require 'financial_calculator/nper'
   require 'financial_calculator/npv'
   require 'financial_calculator/xnpv'
   require 'financial_calculator/xirr'

data/lib/financial_calculator/nper.rb

@@ -0,0 +1,70 @@
+module FinancialCalculator
+  # Calculates the number of periods in an annuity
+  class Nper
+    include ::Validator
+
+    # @return [Numeric] The rate used for calculating the number of payments
+    # @api public
+    attr_reader :rate
+
+    # @return [Numeric] The amount of each payment made
+    # @api public
+    attr_reader :payment
+
+    # @return [Numeric] The current value of the annuity
+    # @api public
+    attr_reader :present_value
+
+    # @return [Numeric] The ending value of the annuity. Defaults to 0
+    # @api public
+    attr_reader :future_value
+
+    # @return [Boolean] Whether the payment is made at the beginning of the 
+    #   period (true) or end of the period (false)
+    # @api public
+    attr_reader :pay_at_beginning
+
+    # @return [DecNum] Result of the PMT calculation
+    # @api public
+    attr_reader :result
+
+    # Create a new object for calculating the periodic payment of an ordinary annuity
+    # @param [Numeric] rate The discount (interest) rate
+    # @param [Numeric] payment The amount of each payment made
+    # @param [Numeric] present_value The current value of the annuity 
+    # @param [Numeric] future_value The ending value of the annuity
+    # @param [Boolean] pay_at_beginning. Whether the payment is made at the beginning
+    #   of the period (true) or end of the period (false) 
+    # @return [FinancialCalculator::Nper] An instance of NPER calculation
+    def initialize(rate, payment, present_value, future_value = 0, pay_at_beginning = false)
+      validate_numerics(rate: rate, payment: payment, present_value: present_value, future_value: future_value)
+
+      @rate             = Flt::DecNum(rate.to_s)
+      @payment          = Flt::DecNum(payment.to_s)
+      @present_value    = Flt::DecNum(present_value.to_s)
+      @future_value     = Flt::DecNum(future_value || "0")
+      @pay_at_beginning = pay_at_beginning || false
+      @result           = solve(@rate, @payment, @present_value, @future_value, @pay_at_beginning)
+    end
+
+    # @return [Boolean] Whether the payments are made at the beginning of each period
+    # @api public
+    def pays_at_beginning?
+      @pay_at_beginning
+    end
+
+    def inspect
+      "NPER(#{result})"
+    end
+
+    private
+
+    def solve(rate, pmt, pv, fv, pay_at_beginning)
+      type = pay_at_beginning ? 1 : 0
+      initial = pmt * (1 + rate * type)
+
+      # TODO: Insert better error handling if either argument is negative.
+      @result = Math.log((initial - fv * rate) / (initial + pv * rate)) / Math.log(1.0 + rate)
+    end
+  end
+end

data/lib/financial_calculator/version.rb

@@ -1,3 +1,3 @@
 module FinancialCalculator
-  VERSION = '3.2.0'
+  VERSION = '3.3.0'
 end

data/spec/nper_spec.rb

@@ -0,0 +1,53 @@
+require_relative 'spec_helper'
+
+describe "Nper" do
+  let(:rate)          { 0.1 }
+  let(:payment)       { 4500 }
+  let(:present_value) { 0 }
+  let(:future_value)  { 0 }
+  let(:nper)          { Nper.new(rate, payment, present_value, future_value) }
+
+  subject { Nper.new(rate, payment, present_value, future_value) }
+
+  it 'has a rate attribute' do
+    expect(subject).to have_attributes(rate: rate)
+  end
+
+  it 'has a payment attribute' do
+    expect(subject).to have_attributes(payment: payment)
+  end
+  
+  it 'has a present_value attribute' do
+    expect(subject).to have_attributes(present_value: present_value)
+  end
+
+  it 'has a future_value attribute' do
+    expect(subject).to have_attributes(future_value: future_value)
+  end
+
+  it 'has a pays_at_beginning? attribute that defaults to false' do
+    expect(subject).to have_attributes(pays_at_beginning?: false)
+  end
+
+  it 'has a result attribute' do
+    expect(subject.result).to be_a Numeric
+  end
+
+  context 'when provided a non-numeric rate' do
+    let(:rate) { 'string' }
+
+    it 'raises an ArgumentError' do
+      expect { subject }.to raise_error ArgumentError
+    end
+  end
+
+  describe '#inspect' do
+    subject { nper.inspect }
+
+    it { is_expected.to be_a String }
+    it { is_expected.to include 'NPER' }
+    it 'includes the result of the Nper calculation' do
+      expect(subject).to include nper.result.to_s
+    end
+  end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: financial_calculator
 version: !ruby/object:Gem::Version
-  version: 3.2.0
+  version: 3.3.0
 platform: ruby
 authors:
 - Mike Falzone
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-06-10 00:00:00.000000000 Z
+date: 2018-07-14 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: flt
@@ -163,6 +163,7 @@ files:
 - lib/financial_calculator/fv.rb
 - lib/financial_calculator/ipmt.rb
 - lib/financial_calculator/irr.rb
+- lib/financial_calculator/nper.rb
 - lib/financial_calculator/npv.rb
 - lib/financial_calculator/pmt.rb
 - lib/financial_calculator/ppmt.rb
@@ -177,6 +178,7 @@ files:
 - spec/fv_spec.rb
 - spec/ipmt_spec.rb
 - spec/irr_spec.rb
+- spec/nper_spec.rb
 - spec/npv_spec.rb
 - spec/pmt_spec.rb
 - spec/ppmt_spec.rb
@@ -217,6 +219,7 @@ test_files:
 - spec/fv_spec.rb
 - spec/ipmt_spec.rb
 - spec/irr_spec.rb
+- spec/nper_spec.rb
 - spec/npv_spec.rb
 - spec/pmt_spec.rb
 - spec/ppmt_spec.rb