Refactor: Remove out_of_bounds_time_format Instance Variable

Author: jfelchner

lib/ruby-progressbar/components/time.rb

@@ -19,13 +19,12 @@ class   Time
   }.freeze
 
   def initialize(options = {})
-    self.out_of_bounds_time_format = options[:out_of_bounds_time_format]
-    self.timer                     = options[:timer]
-    self.progress                  = options[:progress]
+    self.timer    = options[:timer]
+    self.progress = options[:progress]
   end
 
-  def estimated_with_label
-    "#{ESTIMATED_LABEL}: #{estimated}"
+  def estimated_with_label(out_of_bounds_time_format = nil)
+    "#{ESTIMATED_LABEL}: #{estimated(out_of_bounds_time_format)}"
   end
 
   def elapsed_with_label
@@ -35,21 +34,15 @@ def elapsed_with_label
   protected
 
   def estimated_with_no_oob
-    self.out_of_bounds_time_format = nil
-
-    estimated_with_elapsed_fallback
+    estimated_with_elapsed_fallback(nil)
   end
 
   def estimated_with_unknown_oob
-    self.out_of_bounds_time_format = :unknown
-
-    estimated_with_elapsed_fallback
+    estimated_with_elapsed_fallback(:unknown)
   end
 
   def estimated_with_friendly_oob
-    self.out_of_bounds_time_format = :friendly
-
-    estimated_with_elapsed_fallback
+    estimated_with_elapsed_fallback(:friendly)
   end
 
   def estimated_wall_clock
@@ -63,29 +56,20 @@ def estimated_wall_clock
       strftime(WALL_CLOCK_FORMAT)
   end
 
-  attr_reader   :out_of_bounds_time_format
   attr_accessor :timer,
                 :progress
 
-  def out_of_bounds_time_format=(format)
-    unless OOB_TIME_FORMATS.include? format
-      fail StandardError, "Invalid Out Of Bounds time format.  Valid formats are #{OOB_TIME_FORMATS.inspect}"
-    end
-
-    @out_of_bounds_time_format = format
-  end
-
   private
 
-  def estimated
+  def estimated(out_of_bounds_time_format)
     memo_estimated_seconds_remaining = estimated_seconds_remaining
 
     return OOB_UNKNOWN_TIME_TEXT unless memo_estimated_seconds_remaining
 
     hours, minutes, seconds = timer.divide_seconds(memo_estimated_seconds_remaining)
 
     if hours > OOB_LIMIT_IN_HOURS && out_of_bounds_time_format
-      OOB_TEXT_TO_FORMAT[out_of_bounds_time_format]
+      OOB_TEXT_TO_FORMAT.fetch(out_of_bounds_time_format)
     else
       TIME_FORMAT % [hours, minutes, seconds]
     end
@@ -99,8 +83,8 @@ def elapsed
     TIME_FORMAT % [hours, minutes, seconds]
   end
 
-  def estimated_with_elapsed_fallback
-    progress.finished? ? elapsed_with_label : estimated_with_label
+  def estimated_with_elapsed_fallback(out_of_bounds_time_format)
+    progress.finished? ? elapsed_with_label : estimated_with_label(out_of_bounds_time_format)
   end
 
   def estimated_seconds_remaining

spec/lib/ruby-progressbar/components/time_spec.rb

@@ -14,7 +14,7 @@ module   Components
 
     timer.start
 
-    expect(time.estimated_with_label).to eql ' ETA: ??:??:??'
+    expect(time.estimated_with_label(:unknown)).to eql ' ETA: ??:??:??'
   end
 
   it 'does not display unknown time remaining when the timer has been started and ' \
@@ -59,7 +59,7 @@ module   Components
 
     progress.reset
 
-    expect(time.estimated_with_label).to eql ' ETA: ??:??:??'
+    expect(time.estimated_with_label(:unknown)).to eql ' ETA: ??:??:??'
   end
 
   it 'displays unsmoothed time remaining when progress has been made even after the ' \
@@ -94,7 +94,7 @@ module   Components
 
     Timecop.return
 
-    expect(time.estimated_with_label).to eql ' ETA: > 4 Days'
+    expect(time.estimated_with_label(:friendly)).to eql ' ETA: > 4 Days'
   end
 
   it 'displays estimated time of "??:??:??" when estimated time is out of bounds ' \
@@ -111,7 +111,7 @@ module   Components
 
     Timecop.return
 
-    expect(time.estimated_with_label).to eql ' ETA: ??:??:??'
+    expect(time.estimated_with_label(:unknown)).to eql ' ETA: ??:??:??'
   end
 
   it 'displays actual estimated time when estimated time is out of bounds and the ' \
@@ -128,7 +128,7 @@ module   Components
 
     Timecop.return
 
-    expect(time.estimated_with_label).to eql ' ETA: 100:00:00'
+    expect(time.estimated_with_label(nil)).to eql ' ETA: 100:00:00'
   end
 
   it 'displays smoothed estimated time properly even when taking decrements into ' \
@@ -164,7 +164,7 @@ module   Components
 
     progress.reset
 
-    expect(time.estimated_with_label).to eql ' ETA: ??:??:??'
+    expect(time.estimated_with_label(:unknown)).to eql ' ETA: ??:??:??'
   end
 
   it 'displays smoothed estimated time after progress has been made' do
@@ -288,13 +288,6 @@ module   Components
     expect(time.elapsed_with_label).to eql 'Time: --:--:--'
   end
 
-  it 'raises an exception when an invalid out of bounds time format is specified' do
-    expect { Time.new(:out_of_bounds_time_format => :foo) }.
-      to \
-        raise_error 'Invalid Out Of Bounds time format.  Valid formats are ' \
-                    '[:unknown, :friendly, nil]'
-  end
-
   it 'displays the wall clock time as unknown when the timer has been reset' do
     progress = Progress.new
     time     = Time.new(:timer    => timer,