time_value 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 96e4ad82d62c670fec471ea4f8aadf88af94b5f2
+  data.tar.gz: d4caa002f101a1941564dbd097966a3972877a54
+SHA512:
+  metadata.gz: e6697021a95ef94d39cc788855c7cf54fd87f032a0430534eab0226c8965b8083259821ce3c5ee094d30146a0783932248dea59fc85f05846db955e33b13a7c5
+  data.tar.gz: a99e9e6a7fcd828dae68f38040fd3f9dc0ec30152a751823a7aea9bbf09dc844c9f7ab97ae85f78fdcfc92836f59dbce7e80c3ce9613e36292b1728bd26759f3

data/CHANGELOG.md

@@ -0,0 +1,12 @@
+# Changelog
+
+## 0.1.0
+
+* 1 minor enhancement
+  * Update docs, add License and Changelog
+* 2 major enhancement:
+  * Add ability to calculate interest rate (I)
+
+## 0.1.0
+
+Initial project; ability to calculate present value (PV), payments (PMT), future value (FV), and number of periods (N) given other values

data/LICENSE

@@ -0,0 +1,23 @@
+LICENSE
+
+The MIT License
+
+Copyright (c) 2014-2016 Randall Reed, Jr.
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -0,0 +1,34 @@
+# Time Value of Money calculator
+
+## Performs financial calculations for:
+* n (number of periods)
+* pv (present value)
+* pmt (payment amount)
+* fv (future value)
+* i (interest rate)
+
+**NOTE:** Only supports annuity due.
+
+## Usage
+
+Initialize with values:
+```
+time_value = TimeValue.new(n, i, pv, pmt, fv)
+```
+
+Or set values after initialization:
+```
+time_value = TimeValue.new()
+time_value.n = my_n
+time_value.i = my_i
+time_value.pv = my_pv
+time_value.pmt = my_pmt
+my_fv = time_value.calc_fv()
+```
+
+Remember to follow a convention for signs of values:
+
+* Money being paid should have a negative value (-)
+* Money being received should have a positive value (+)
+
+Failing to follow this convention may yield unexpected results

data/lib/solver.rb

@@ -0,0 +1,42 @@
+class Solver
+  attr_reader :time_value, :goal
+  attr_accessor :guess, :lower_bound, :upper_bound, :upper_cap_met
+
+  def initialize(time_value, guess = 10.00, lower_bound = 0.00, upper_bound = 10.00)
+    @upper_bound = upper_bound
+    @lower_bound = lower_bound
+    @guess = guess
+    @time_value = time_value
+    @goal = time_value.fv
+    @upper_cap_met = false
+  end
+
+  def solve!
+    iteration_count = 0
+    time_value.i = guess
+    while (upper_bound - lower_bound).round(2) > 0.01 && iteration_count < 100
+      iteration_count += 1
+      begin
+        result = time_value.calc_fv
+      rescue FloatDomainError => error
+        return nil
+      end
+      adjust_bounds(result)
+      time_value.i = guess
+    end
+    guess if iteration_count < 100
+  end
+
+  def adjust_bounds(result)
+    if result > goal
+      # interest rate too high
+      self.upper_cap_met = true
+      self.upper_bound = guess
+    elsif result < goal
+      # interest rate too low
+      self.upper_bound *= 2 unless upper_cap_met
+      self.lower_bound = guess
+    end
+    self.guess = ((upper_bound + lower_bound) / 2).round(2)
+  end
+end

data/lib/time_value.rb

@@ -0,0 +1,54 @@
+require 'byebug'
+require 'solver'
+
+class TimeValue
+    
+    attr_accessor :n, :i, :pv, :pmt, :fv
+    
+    def initialize(n = 0, i = 0, pv = 0.0, pmt = 0.0, fv = 0.0)
+        @n = n
+        @i = i.to_f
+        @pv = pv.to_f
+        @pmt = pmt.to_f
+        @fv = fv.to_f
+    end
+    
+  #Base formula, ordinary annuity: -PV = [FV/((1+i)^n)] + (PMT/i)*[1-(1/(1+i)^n)]
+    def calc_pv()
+        i = @i / 100.0
+        #Initial contribution
+        pvf = @fv / ((1 + i) ** @n)
+        #Present value of annuity
+        pva = (@pmt/i) * (1-(1/((1+i)**@n)))
+        @pv = (pvf + pva) * (-1)
+        #Round
+        @pv = (@pv*100).round / 100.0
+    end
+    
+    def calc_fv()
+        i = @i / 100.0
+        #Growth of initial contribution
+        fvp = @pv * ((1 + i) ** @n)
+        #Growth of payments
+        fva = @pmt * (((1 + i) ** @n)-1) / i
+        @fv = (fvp + fva) * (-1)
+        #Round
+        @fv = (@fv*100).round / 100.0
+    end
+    
+    def calc_n()
+        i = @i / 100.0
+        @n = (Math.log((@pmt - (i * @fv))/(@pmt + (i * @pv)))/Math.log(1 + i)).round(0)
+    end
+
+    def calc_pmt()
+        i = @i / 100.0
+        @pmt = (-i*(@fv+(@pv*((1+i)**n))))/(((1+i)**n)-1)
+        @pmt = (@pmt*100).round / 100.0
+    end
+
+    def calc_i(guess = 10.0)
+      solver = Solver.new(self, 10.00, 0.00, 10.00)
+      solver.solve!
+    end
+end

metadata

@@ -0,0 +1,63 @@
+--- !ruby/object:Gem::Specification
+name: time_value
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Randall Reed, Jr.
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2016-03-27 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.2'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.2'
+description: Perform time value of money calculations using financial calculator variables
+  n, i, PV, PMT, and FV
+email: randallreedjr@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- CHANGELOG.md
+- LICENSE
+- README.md
+- lib/solver.rb
+- lib/time_value.rb
+homepage: http://rubygems.org/gems/timevalue
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.4.6
+signing_key: 
+specification_version: 4
+summary: Time value of money financial calculations
+test_files: []