time_value 0.1.2 → 1.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: b8d062fe004503ddf10aa4868b97ae5de157d066
-  data.tar.gz: 1bb4988314cb5add83dc1961c433e69933b93bdf
+  metadata.gz: 0c6e6b94a394a16cbd8e93aa1af3110fccff9377
+  data.tar.gz: 032d98858c34aa563b7d1e7a1407c9fefd6673d7
 SHA512:
-  metadata.gz: e9af1844641632a746306d97b8739f08c51ac39fb32934c98c6037a546af7aab600da7cd51ee0806c6ea6dd2822f1a870c1009e36d1521fe9548852f3138e250
-  data.tar.gz: df779a51ed6d53b9192c33a0fd9f8fda36e5cdd7ddf65d6715d47a99497c95d01e9820e8d6bc8b74b669683154f79ea5652566942bba3d320593ff0a6f4954a4
+  metadata.gz: db23d74db7237412e2bc019cfa4859b1239db26d32fabcb1bdd4ebd3dc7b789d7916e5f93d9702fe92f877ad6b26b106e37d95ca77346fe24d8b7c65c7d03be4
+  data.tar.gz: 2561d85d74677bbc4a3e77d37716bc8573219e5fb047494e4d632a00e51402b567b6544232b84f3cb7bf41782de4a4d4ecc9240dee7268767045ee5c48696dd0

data/lib/solver.rb

@@ -3,20 +3,19 @@ class Solver
   INTERVAL = 10 ** (-1 * PRECISION)
   MAX_ITERATIONS = 20
   attr_reader :time_value, :goal
-  attr_accessor :guess, :lower_bound, :upper_bound, :upper_cap_met
+  attr_accessor :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
+  def initialize(time_value:, lower_bound: 0.00, upper_bound: nil, guess: 0.00)
+    @upper_bound = upper_bound || guess
     @lower_bound = lower_bound
-    @guess = guess
-    @time_value = time_value
+    @time_value = time_value.dup
+    @time_value.i = guess
     @goal = time_value.fv
     @upper_cap_met = false
   end
 
   def solve!
     iteration_count = 0
-    time_value.i = guess
     while (upper_bound - lower_bound).round(PRECISION) > INTERVAL &&
       iteration_count < MAX_ITERATIONS
       iteration_count += 1
@@ -25,22 +24,33 @@ class Solver
       rescue FloatDomainError
         return nil
       end
-      adjust_bounds(result)
-      time_value.i = guess
+      adjust_bounds!(result)
+      time_value.i = new_guess
     end
-    guess.round(2) if iteration_count < MAX_ITERATIONS
+    # TODO: This will not handle the case where the 20th iteration
+    # finds the solution
+    rate if iteration_count < MAX_ITERATIONS
   end
 
-  def adjust_bounds(result)
+  private
+
+  def adjust_bounds!(result)
     if result > goal
       # interest rate too high
       self.upper_cap_met = true
-      self.upper_bound = guess
+      self.upper_bound = rate
     elsif result < goal
       # interest rate too low
       self.upper_bound *= 2 unless upper_cap_met
-      self.lower_bound = guess
+      self.lower_bound = rate
     end
-    self.guess = ((upper_bound + lower_bound) / 2).round(PRECISION)
+  end
+
+  def new_guess
+    ((upper_bound + lower_bound) / 2).round(PRECISION)
+  end
+
+  def rate
+    time_value.i.round(2)
   end
 end

data/lib/time_value.rb

@@ -1,53 +1,52 @@
 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
+  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(time_value: self, lower_bound: 0.00, guess: 10.00)
+    solver.solve!
+  end
 end

data/lib/time_value/version.rb

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

metadata

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