progressbar 0.21.0 → 1.8.1

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

@@ -0,0 +1,307 @@
+require 'rspectacular'
+require 'ruby-progressbar/components/time'
+
+class           ProgressBar
+module          Components
+RSpec.describe  Time do
+  let(:timer) { Timer.new(:time => ::Time) }
+
+  it 'displays an unknown estimated time remaining when the timer has been started ' \
+     'but no progress has been made' do
+
+    progress = Progress.new(:total => 100)
+    time     = Time.new(:timer    => timer,
+                        :progress => progress)
+
+    timer.start
+
+    expect(time.estimated_with_label).to eql ' ETA: ??:??:??'
+  end
+
+  it 'does not display unknown time remaining when the timer has been started and ' \
+     'it is incremented' do
+
+    progress = Progress.new(:total => 100)
+    time = Time.new(:timer    => timer,
+                    :progress => progress)
+
+    timer.start
+    progress.increment
+
+    expect(time.estimated_with_label).to eql ' ETA: 00:00:00'
+  end
+
+  it 'displays unsmoothed time remaining when progress has been made' do
+    progress = Progress.new(:total => 100, :smoothing => 0.0)
+    time     = Time.new(:timer    => timer,
+                        :progress => progress)
+
+    Timecop.freeze(-13_332)
+
+    timer.start
+    50.times { progress.increment }
+
+    Timecop.return
+
+    expect(time.estimated_with_label).to eql ' ETA: 03:42:12'
+  end
+
+  it 'displays unknown time remaining when progress has been made and then progress ' \
+     'is reset' do
+
+    progress = Progress.new(:total => 100)
+    time     = Time.new(:timer    => timer,
+                        :progress => progress)
+
+    Timecop.freeze(-13_332)
+
+    timer.start
+    50.times { progress.increment }
+
+    Timecop.return
+
+    progress.reset
+
+    expect(time.estimated_with_label).to eql ' ETA: ??:??:??'
+  end
+
+  it 'displays unsmoothed time remaining when progress has been made even after the ' \
+     'bar is decremented' do
+
+    progress = Progress.new(:total => 100, :smoothing => 0.0)
+    time     = Time.new(:timer    => timer,
+                        :progress => progress)
+
+    Timecop.freeze(-13_332)
+
+    timer.start
+    50.times { progress.increment }
+
+    Timecop.return
+
+    20.times { progress.decrement }
+
+    expect(time.estimated_with_label).to eql ' ETA: 08:38:28'
+  end
+
+  it 'displays estimated time of "> 4 Days" when estimated time is out of bounds ' \
+     'and the out of bounds format is set to "friendly"' do
+
+    progress = Progress.new(:total => 100, :smoothing => 0.0)
+    time     = Time.new(:out_of_bounds_time_format => :friendly,
+                        :timer                     => timer,
+                        :progress                  => progress)
+
+    Timecop.freeze(-120_000)
+
+    timer.start
+    25.times { progress.increment }
+
+    Timecop.return
+
+    expect(time.estimated_with_label).to eql ' ETA: > 4 Days'
+  end
+
+  it 'displays estimated time of "??:??:??" when estimated time is out of bounds ' \
+     'and the out of bounds format is set to "unknown"' do
+
+    progress = Progress.new(:total => 100, :smoothing => 0.0)
+    time     = Time.new(:out_of_bounds_time_format => :unknown,
+                        :timer                     => timer,
+                        :progress                  => progress)
+
+    Timecop.freeze(-120_000)
+
+    timer.start
+    25.times { progress.increment }
+
+    Timecop.return
+
+    expect(time.estimated_with_label).to eql ' ETA: ??:??:??'
+  end
+
+  it 'displays actual estimated time when estimated time is out of bounds and the ' \
+     'out of bounds format is unset' do
+
+    progress = Progress.new(:total => 100, :smoothing => 0.0)
+    time     = Time.new(:out_of_bounds_time_format => nil,
+                        :timer                     => timer,
+                        :progress                  => progress)
+
+    Timecop.freeze(-120_000)
+
+    timer.start
+    25.times { progress.increment }
+
+    Timecop.return
+
+    expect(time.estimated_with_label).to eql ' ETA: 100:00:00'
+  end
+
+  it 'displays smoothed estimated time properly even when taking decrements into ' \
+     'account' do
+
+    progress = Progress.new(:total => 100, :smoothing => 0.5)
+    time     = Time.new(:timer    => timer,
+                        :progress => progress)
+
+    Timecop.freeze(-13_332)
+
+    timer.start
+    50.times { progress.increment }
+
+    Timecop.return
+
+    20.times { progress.decrement }
+
+    expect(time.estimated_with_label).to eql ' ETA: 08:14:34'
+  end
+
+  it 'displays smoothed unknown estimated time when reset is called after progress ' \
+     'is made' do
+
+    progress = Progress.new(:total => 100, :smoothing => 0.5)
+    time     = Time.new(:timer    => timer,
+                        :progress => progress)
+
+    Timecop.freeze(-13_332)
+
+    timer.start
+    50.times { progress.increment }
+
+    Timecop.return
+
+    progress.reset
+
+    expect(time.estimated_with_label).to eql ' ETA: ??:??:??'
+  end
+
+  it 'displays smoothed estimated time after progress has been made' do
+    progress = Progress.new(:total => 100, :smoothing => 0.5)
+    time     = Time.new(:timer    => timer,
+                        :progress => progress)
+
+    Timecop.freeze(-13_332)
+
+    timer.start
+    50.times { progress.increment }
+
+    Timecop.return
+
+    expect(time.estimated_with_label).to eql ' ETA: 03:51:16'
+  end
+
+  it 'displays the estimated time remaining properly even for progress increments ' \
+     'very short intervals' do
+
+    progress = Progress.new(:total => 10, :smoothing => 0.1)
+    time     = Time.new(:timer    => timer,
+                        :progress => progress)
+
+    estimated_time_results = []
+    now                    = ::Time.now
+
+    Timecop.freeze(now)
+
+    timer.start
+
+    10.times do
+      Timecop.freeze(now += 0.5)
+      progress.increment
+
+      estimated_time_results << time.estimated_with_label
+    end
+
+    Timecop.return
+
+    expect(estimated_time_results).to eql(
+      [
+        ' ETA: 00:00:05',
+        ' ETA: 00:00:04',
+        ' ETA: 00:00:04',
+        ' ETA: 00:00:03',
+        ' ETA: 00:00:03',
+        ' ETA: 00:00:02',
+        ' ETA: 00:00:02',
+        ' ETA: 00:00:01',
+        ' ETA: 00:00:01',
+        ' ETA: 00:00:00',
+      ]
+    )
+  end
+
+  it 'displays unknown elapsed time when the timer has not been started' do
+    progress = Progress.new
+    time     = Time.new(:timer    => timer,
+                        :progress => progress)
+
+    expect(time.elapsed_with_label).to eql 'Time: --:--:--'
+  end
+
+  it 'displays elapsed time when the timer has just been started' do
+    progress = Progress.new
+    time     = Time.new(:timer    => timer,
+                        :progress => progress)
+
+    timer.start
+
+    expect(time.elapsed_with_label).to eql 'Time: 00:00:00'
+  end
+
+  it 'displays elapsed time if it was previously started' do
+    progress = Progress.new
+    time     = Time.new(:timer    => timer,
+                        :progress => progress)
+
+    Timecop.freeze(-16_093)
+
+    timer.start
+
+    Timecop.return
+
+    expect(time.elapsed_with_label).to eql 'Time: 04:28:13'
+  end
+
+  it 'displays elapsed time frozen to a specific time if it was previously stopped' do
+    progress = Progress.new
+    time     = Time.new(:timer    => timer,
+                        :progress => progress)
+
+    Timecop.freeze(-16_093)
+
+    timer.start
+
+    Timecop.return
+    Timecop.freeze(-32)
+
+    timer.stop
+
+    Timecop.return
+
+    expect(time.elapsed_with_label).to eql 'Time: 04:27:41'
+  end
+
+  it 'displays unknown elapsed time after reset has been called' do
+    progress = Progress.new
+    time     = Time.new(:timer    => timer,
+                        :progress => progress)
+
+    Timecop.freeze(-16_093)
+
+    timer.start
+
+    Timecop.return
+
+    timer.reset
+
+    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
+end
+end
+end

data/spec/ruby-progressbar/components/title_spec.rb

@@ -0,0 +1,12 @@
+require 'rspectacular'
+require 'ruby-progressbar/components/title'
+
+class           ProgressBar
+module          Components
+RSpec.describe  Title do
+  it 'can use the default title if none is specified' do
+    expect(Title.new.title).to eql Title::DEFAULT_TITLE
+  end
+end
+end
+end

data/spec/ruby-progressbar/format/formatter_spec.rb

@@ -0,0 +1,9 @@
+require 'rspectacular'
+require 'ruby-progressbar/format/formatter'
+
+class           ProgressBar
+module          Format
+RSpec.describe  Formatter do
+end
+end
+end

data/spec/ruby-progressbar/format/molecule_spec.rb

@@ -0,0 +1,30 @@
+require 'rspectacular'
+require 'ruby-progressbar/format/molecule'
+
+class           ProgressBar
+module          Format
+RSpec.describe  Molecule do
+  it 'sets the key when initialized' do
+    molecule = Molecule.new('t')
+
+    expect(molecule.key).to eql 't'
+  end
+
+  it 'sets the method name when initialized' do
+    molecule = Molecule.new('t')
+
+    expect(molecule.method_name).to eql [:title_comp, :title]
+  end
+
+  it 'can retrieve the full key for itself' do
+    molecule = Molecule.new('t')
+
+    expect(molecule.full_key).to eql '%t'
+  end
+
+  it 'can determine if it is a bar molecule' do
+    expect(Molecule.new('B')).to be_bar_molecule
+  end
+end
+end
+end

data/spec/ruby-progressbar/format/string_spec.rb

@@ -0,0 +1,9 @@
+require 'rspectacular'
+require 'ruby-progressbar/format/string'
+
+class           ProgressBar
+module          Format
+RSpec.describe  String do
+end
+end
+end

data/spec/ruby-progressbar/output_spec.rb

@@ -0,0 +1,7 @@
+require 'rspectacular'
+require 'ruby-progressbar/output'
+
+class           ProgressBar
+RSpec.describe  Output do
+end
+end

data/spec/ruby-progressbar/outputs/non_tty_spec.rb

@@ -0,0 +1,9 @@
+require 'rspectacular'
+require 'ruby-progressbar/outputs/non_tty'
+
+class           ProgressBar
+module          Outputs
+RSpec.describe  NonTty do
+end
+end
+end

data/spec/ruby-progressbar/outputs/tty_spec.rb

@@ -0,0 +1,9 @@
+require 'rspectacular'
+require 'ruby-progressbar/outputs/tty'
+
+class           ProgressBar
+module          Outputs
+RSpec.describe  Tty do
+end
+end
+end

data/spec/ruby-progressbar/progress_spec.rb

@@ -0,0 +1,156 @@
+require 'rspectacular'
+require 'ruby-progressbar/progress'
+
+class           ProgressBar
+RSpec.describe  Progress do
+  it 'knows the default total when no parameters are passed' do
+    progress = Progress.new
+
+    expect(progress.total).to eql Progress::DEFAULT_TOTAL
+  end
+
+  it 'knows the default beginning progress when no parameters are passed and ' \
+     'the progress has not been started' do
+
+    progress = Progress.new
+
+    expect(progress.progress).to be_zero
+  end
+
+  it 'knows the default starting value when no parameters are passed and the ' \
+     'progress has been started' do
+
+    progress = Progress.new
+
+    progress.start
+
+    expect(progress.progress).to eql Progress::DEFAULT_BEGINNING_POSITION
+  end
+
+  it 'knows the given starting value when no parameters are passed and the ' \
+     'progress is started with a starting value' do
+
+    progress = Progress.new
+
+    progress.start :at => 10
+
+    expect(progress.progress).to eql 10
+  end
+
+  it 'knows how to finish itself even if the total is unknown' do
+    progress = Progress.new :total => nil
+
+    expect(progress.finish).to be_nil
+  end
+
+  it 'knows the overridden total when the total is passed in' do
+    progress = Progress.new(:total          => 12,
+                            :progress_mark  => 'x',
+                            :remainder_mark => '.')
+
+    expect(progress.total).to eql 12
+  end
+
+  it 'knows the percentage completed when begun with no progress' do
+    progress = Progress.new
+
+    progress.start
+
+    expect(progress.percentage_completed).to eql 0
+  end
+
+  it 'knows the progress after it has been incremented' do
+    progress = Progress.new
+
+    progress.start
+    progress.increment
+
+    expect(progress.progress).to eql 1
+  end
+
+  it 'knows the percentage completed after it has been incremented' do
+    progress = Progress.new(:total => 50)
+
+    progress.start
+    progress.increment
+
+    expect(progress.percentage_completed).to eql 2
+  end
+
+  it 'knows to always round down the percentage completed' do
+    progress = Progress.new(:total => 200)
+
+    progress.start :at => 1
+
+    expect(progress.percentage_completed).to eql 0
+  end
+
+  it 'cannot increment past the total' do
+    progress = Progress.new(:total => 50)
+
+    progress.start :at => 50
+    progress.increment
+
+    expect(progress.progress).to eql 50
+    expect(progress.percentage_completed).to eql 100
+  end
+
+  it 'allow progress to be decremented once it is finished' do
+    progress = Progress.new(:total => 50)
+
+    progress.start :at => 50
+    progress.decrement
+
+    expect(progress.progress).to eql 49
+    expect(progress.percentage_completed).to eql 98
+  end
+
+  it 'knows the running average even when progress has been made' do
+    progress = Progress.new(:total => 50)
+
+    progress.running_average = 10
+    progress.start :at => 0
+
+    expect(progress.running_average).to be_zero
+
+    progress.progress += 40
+
+    expect(progress.running_average).to eql 36.0
+  end
+
+  it 'knows the running average is reset even after progress is started' do
+    progress = Progress.new(:total => 50)
+
+    progress.running_average = 10
+    progress.start :at => 0
+
+    expect(progress.running_average).to be_zero
+
+    progress.start :at => 40
+
+    expect(progress.running_average).to eql 0.0
+  end
+
+  it 'allows the default smoothing to be overridden' do
+    expect(Progress.new(:smoothing => 0.3).smoothing).to eql 0.3
+  end
+
+  it 'has a default smoothing value' do
+    expect(Progress.new.smoothing).to eql 0.1
+  end
+
+  it 'knows the percentage completed is 100% if the total is zero' do
+    progress = Progress.new(:total => 0)
+
+    expect(progress.percentage_completed).to eql 100
+  end
+
+  it 'raises an error when passed a number larger than the total' do
+    progress = Progress.new(:total => 100)
+
+    expect { progress.progress = 101 }.to \
+    raise_error(InvalidProgressError,
+                "You can't set the item's current value to be greater than the total.")
+  end
+end
+end