time_value 1.0.0 → 1.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 0c6e6b94a394a16cbd8e93aa1af3110fccff9377
-  data.tar.gz: 032d98858c34aa563b7d1e7a1407c9fefd6673d7
+  metadata.gz: 8cb8d84e2f74389800bec8f0d5bf9c8858dbecf5
+  data.tar.gz: 009f75557b934dd9cf8bd71ad9b8d83db6889d29
 SHA512:
-  metadata.gz: db23d74db7237412e2bc019cfa4859b1239db26d32fabcb1bdd4ebd3dc7b789d7916e5f93d9702fe92f877ad6b26b106e37d95ca77346fe24d8b7c65c7d03be4
-  data.tar.gz: 2561d85d74677bbc4a3e77d37716bc8573219e5fb047494e4d632a00e51402b567b6544232b84f3cb7bf41782de4a4d4ecc9240dee7268767045ee5c48696dd0
+  metadata.gz: ea2d1631b57c1d0b95df5886981c312c8c1bc2ed7a0a704b4c3e24391e7ab7e3d1074656347e1dd321b224746756f67f3cd5cf9c7060172dab0e67ba9c5b59c9
+  data.tar.gz: 95e053b40b686c0d961de9991648b448b810fe0f369536ba61716f99bb159aa8bcce1ccf7d37af7a926009677cb76b53a7d7309e20ab2700288673875644fa77

data/lib/solver.rb

@@ -1,40 +1,42 @@
+# frozen_string_literal: true
 class Solver
   PRECISION = 3
-  INTERVAL = 10 ** (-1 * PRECISION)
+  INTERVAL = 10**(-1 * PRECISION)
   MAX_ITERATIONS = 20
   attr_reader :time_value, :goal
-  attr_accessor :lower_bound, :upper_bound, :upper_cap_met
+  attr_accessor :lower_bound, :upper_bound, :upper_cap_met, :iteration_count
 
-  def initialize(time_value:, lower_bound: 0.00, upper_bound: nil, guess: 0.00)
+  def initialize(time_value:, lower_bound: 0.00, upper_bound: nil, guess: 10.00)
     @upper_bound = upper_bound || guess
     @lower_bound = lower_bound
     @time_value = time_value.dup
     @time_value.i = guess
     @goal = time_value.fv
     @upper_cap_met = false
+    @iteration_count = 0
   end
 
   def solve!
-    iteration_count = 0
-    while (upper_bound - lower_bound).round(PRECISION) > INTERVAL &&
-      iteration_count < MAX_ITERATIONS
-      iteration_count += 1
-      begin
-        result = time_value.calc_fv
-      rescue FloatDomainError
-        return nil
-      end
-      adjust_bounds!(result)
+    while !within_range? && iteration_count < MAX_ITERATIONS
+      result = time_value.calc_fv
+      adjust_bounds!(result: result)
       time_value.i = new_guess
+      self.iteration_count += 1
     end
     # TODO: This will not handle the case where the 20th iteration
     # finds the solution
-    rate if iteration_count < MAX_ITERATIONS
+    return rate if iteration_count < MAX_ITERATIONS
+  rescue FloatDomainError
+    return nil
   end
 
   private
 
-  def adjust_bounds!(result)
+  def within_range?
+    (upper_bound - lower_bound).round(PRECISION) <= INTERVAL
+  end
+
+  def adjust_bounds!(result:)
     if result > goal
       # interest rate too high
       self.upper_cap_met = true

data/lib/time_value.rb

@@ -1,51 +1,61 @@
+# frozen_string_literal: true
 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
+    @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
+  # Base formula, ordinary annuity: -PV = [FV/((1+i)^n)] +
+  # (PMT/i)*[1-(1/(1+i)^n)]
+  # rubocop:disable Metrics/AbcSize
+  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 = -1 * (pvf + pva)
+    # Round
+    @pv = (@pv * 100).round / 100.0
   end
+  # rubocop:enable Metrics/AbcSize
 
-  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
+  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 = -1 * (fvp + fva)
+    # 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)
+  def calc_n
+    i = @i / 100.0
+    numerator = Math.log((@pmt - (i * @fv)) / (@pmt + (i * @pv)))
+    denominator = Math.log(1 + i)
+    @n = (numerator / denominator).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
+  # rubocop:disable Metrics/AbcSize
+  def calc_pmt
+    i = @i / 100.0
+    numerator = (-i * (@fv + (@pv * ((1 + i)**n))))
+    denominator = (((1 + i)**n) - 1)
+    @pmt = numerator / denominator
+    @pmt = (@pmt * 100).round / 100.0
   end
+  # rubocop:enable Metrics/AbcSize
 
-  def calc_i(guess: 10.0)
+  def calc_i
     solver = Solver.new(time_value: self, lower_bound: 0.00, guess: 10.00)
     solver.solve!
   end

data/lib/time_value/version.rb

@@ -1,3 +1,3 @@
 module TimeValue
-  VERSION = '1.0.0'
+  VERSION = '1.1.0'
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: time_value
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 1.1.0
 platform: ruby
 authors:
 - Randall Reed, Jr.