progressbar 0.21.0 → 1.8.1

data/spec/ruby-progressbar/calculators/length_calculator_spec.rb

@@ -0,0 +1,17 @@
+require 'rspectacular'
+require 'ruby-progressbar/calculators/running_average'
+
+class           ProgressBar
+module          Calculators
+RSpec.describe  Length do
+  it 'can properly calculate the length even if IO.console is nil' do
+    calculator = Length.new
+
+    expect(IO).to         receive(:console).and_return nil
+    expect(calculator).to receive(:dynamic_width_via_system_calls).and_return 123_456
+
+    expect(calculator.calculate_length).to eql 123_456
+  end
+end
+end
+end

data/spec/ruby-progressbar/calculators/running_average_spec.rb

@@ -0,0 +1,19 @@
+require 'rspectacular'
+require 'ruby-progressbar/calculators/running_average'
+
+class           ProgressBar
+module          Calculators
+RSpec.describe  RunningAverage do
+  it 'can properly calculate a running average' do
+    first_average = RunningAverage.calculate(4.5,  12,  0.1)
+    expect(first_average).to be_within(0.001).of 11.25
+
+    second_average = RunningAverage.calculate(8.2,  51,  0.7)
+    expect(second_average).to be_within(0.001).of 21.04
+
+    third_average = RunningAverage.calculate(41.8, 100, 0.59)
+    expect(third_average).to be_within(0.001).of 65.662
+  end
+end
+end
+end

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

@@ -0,0 +1,234 @@
+require 'rspectacular'
+require 'ruby-progressbar/components/bar'
+
+class           ProgressBar
+module          Components
+RSpec.describe  Bar do
+  it 'has a default mark when a new bar is created and no parameters are passed' do
+    expect(Bar.new.progress_mark).to eql Bar::DEFAULT_PROGRESS_MARK
+  end
+
+  it 'has a default remainder mark when a new bar is created and no parameters ' \
+     'are passed' do
+
+    expect(Bar.new.remainder_mark).to eql Bar::DEFAULT_REMAINDER_MARK
+  end
+
+  it 'returns the overridden mark when a new bar is created and options are passed' do
+    progressbar = Bar.new(:progress_mark => 'x')
+
+    expect(progressbar.progress_mark).to eql 'x'
+  end
+
+  it 'returns the overridden remainder mark when a new bar is created and options ' \
+     'are passed' do
+
+    progressbar = Bar.new(:remainder_mark => 'o')
+
+    expect(progressbar.remainder_mark).to eql 'o'
+  end
+
+  it 'displays the bar with no indication of progress when just begun' do
+    progress    = Progress.new(:total => 50)
+    progressbar = Bar.new(:progress => progress,
+                          :length   => 100)
+
+    expect(progressbar.to_s).to eql ' ' * 100
+  end
+
+  it 'displays the bar with an indication of progress when nothing has been ' \
+     'completed and the bar is incremented' do
+
+    progress    = Progress.new :total    => 50
+    progressbar = Bar.new      :progress => progress,
+                               :length   => 100
+    progress.increment
+
+    expect(progressbar.to_s).to eql '==' + (' ' * 98)
+  end
+
+  it 'displays the bar with no indication of progress when nothing has been ' \
+     'completed and the bar is incremented' do
+
+    progress    = Progress.new :total    => 50
+    progressbar = Bar.new      :progress => progress,
+                               :length   => 100
+
+    expect(progressbar.to_s).to eql ' ' * 100
+  end
+
+  it 'displays the bar with no indication of progress when a fraction of a percentage ' \
+     'has been completed' do
+
+    progress    = Progress.new :total    => 200
+    progressbar = Bar.new      :progress => progress,
+                               :length   => 100
+    progress.start :at => 1
+
+    expect(progressbar.to_s).to eql(' ' * 100)
+  end
+
+  it 'displays the bar as 100% complete when completed' do
+    progress    = Progress.new :total    => 50
+    progressbar = Bar.new      :progress => progress,
+                               :length   => 100
+    progress.start :at => 50
+    progress.increment
+
+    expect(progressbar.to_s).to eql '=' * 100
+  end
+
+  it 'displays the bar as 100% complete when completed and the bar is incremented' do
+    progress    = Progress.new :total    => 50
+    progressbar = Bar.new      :progress => progress,
+                               :length   => 100
+    progress.start :at => 50
+    progress.increment
+
+    expect(progressbar.to_s).to eql '=' * 100
+  end
+
+  it 'displays the bar as 98% complete when completed and the bar is decremented' do
+    progress    = Progress.new :total    => 50
+    progressbar = Bar.new      :progress => progress,
+                               :length   => 100
+    progress.start :at => 50
+    progress.decrement
+
+    expect(progressbar.to_s).to eql(('=' * 98) + (' ' * 2))
+  end
+
+  it 'is represented correctly when a bar has an unknown amount to completion' do
+    progress    = Progress.new :total    => nil
+    progressbar = Bar.new      :progress => progress,
+                               :length   => 80
+
+    expect(progressbar.to_s).to eql('=---' * 20)
+  end
+
+  it 'is represented after being incremented once when a bar has an unknown amount ' \
+     'to completion' do
+
+    progress    = Progress.new :total    => nil
+    progressbar = Bar.new      :progress => progress,
+                               :length   => 80
+
+    progress.increment
+
+    expect(progressbar.to_s).to eql('-=--' * 20)
+  end
+
+  it 'is represented after being incremented twice when a bar has an unknown amount ' \
+     'to completion' do
+
+    progress    = Progress.new :total    => nil
+    progressbar = Bar.new      :progress => progress,
+                               :length   => 80
+
+    2.times { progress.increment }
+
+    expect(progressbar.to_s).to eql('--=-' * 20)
+  end
+
+  it 'is represented correctly when a bar has a customized unknown animation' do
+    progress    = Progress.new :total                            => nil
+    progressbar = Bar.new      :progress                         => progress,
+                               :unknown_progress_animation_steps => ['*--', '-*-', '--*'],
+                               :length                           => 80
+
+    expect(progressbar.to_s).to eql(('*--' * 26) + '*-')
+  end
+
+  it 'displays the bar with an integrated percentage properly when empty' do
+    progress    = Progress.new :total    => 100
+    progressbar = Bar.new      :progress => progress,
+                               :length   => 100
+
+    bar_text = progressbar.to_s(:format => :integrated_percentage)
+    expect(bar_text).to eql ' ' * 100
+  end
+
+  it 'displays the bar with an integrated percentage properly just before' \
+     'the percentage is displayed' do
+
+    progress    = Progress.new :total    => 100
+    progressbar = Bar.new      :progress => progress,
+                               :length   => 100
+
+    4.times { progress.increment }
+
+    bar_text = progressbar.to_s(:format => :integrated_percentage)
+    expect(bar_text).to eql '====' + (' ' * 96)
+  end
+
+  it 'displays the bar with an integrated percentage properly immediately after' \
+     'the percentage is displayed' do
+
+    progress    = Progress.new :total    => 100
+    progressbar = Bar.new      :progress => progress,
+                               :length   => 100
+
+    5.times { progress.increment }
+
+    bar_text = progressbar.to_s(:format => :integrated_percentage)
+    expect(bar_text).to eql '= 5 =' + (' ' * 95)
+  end
+
+  it 'displays the bar with an integrated percentage properly on double digit' \
+     'percentage' do
+
+    progress    = Progress.new :total    => 100
+    progressbar = Bar.new      :progress => progress,
+                               :length   => 100
+
+    10.times { progress.increment }
+
+    bar_text = progressbar.to_s(:format => :integrated_percentage)
+    expect(bar_text).to eql '=== 10 ===' + (' ' * 90)
+  end
+
+  it 'displays the bar with an integrated percentage properly when finished' do
+
+    progress    = Progress.new :total    => 100
+    progressbar = Bar.new      :progress => progress,
+                               :length   => 100
+    progress.finish
+
+    bar_text = progressbar.to_s(:format => :integrated_percentage)
+    expect(bar_text).to eql(('=' * 47) + ' 100 ' + ('=' * 48))
+  end
+
+  it 'calculates the remaining negative space properly with an integrated percentage ' \
+     'bar of 0 percent' do
+
+    progress    = Progress.new :total    => 200
+    progressbar = Bar.new      :progress => progress,
+                               :length   => 100
+
+    bar_text = progressbar.to_s(:format => :integrated_percentage)
+    expect(bar_text).to eql ' ' * 100
+
+    9.times { progress.increment }
+
+    bar_text = progressbar.to_s(:format => :integrated_percentage)
+    expect(bar_text).to eql '====' + (' ' * 96)
+
+    progress.increment
+
+    bar_text = progressbar.to_s(:format => :integrated_percentage)
+    expect(bar_text).to eql '= 5 =' + (' ' * 95)
+  end
+
+  it 'raises an error when attempting to set the current value of the bar to be ' \
+     'greater than the total' do
+
+    progress     = Progress.new :total    => 10
+    _progressbar = Bar.new      :progress => progress
+
+    expect { progress.start :at => 11 }.to \
+    raise_error(InvalidProgressError,
+                "You can't set the item's current value to be greater than the total.")
+  end
+end
+end
+end

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

@@ -0,0 +1,9 @@
+require 'rspectacular'
+require 'ruby-progressbar/components/percentage'
+
+class           ProgressBar
+module          Components
+RSpec.describe  Percentage do
+end
+end
+end

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

@@ -0,0 +1,9 @@
+require 'rspectacular'
+require 'ruby-progressbar/components/rate'
+
+class           ProgressBar
+module          Components
+RSpec.describe  Rate do
+end
+end
+end

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

@@ -0,0 +1,157 @@
+require 'rspectacular'
+require 'ruby-progressbar/progress'
+
+class           ProgressBar
+RSpec.describe  Throttle do
+  let(:timer) { ProgressBar::Timer.new(:time => ::Time) }
+
+  it 'yields the first time if the throttle rate is given and the timer is not started' do
+    throttle = ProgressBar::Throttle.new(:throttle_rate  => 10,
+                                         :throttle_timer => timer)
+
+    yielded = false
+
+    throttle.choke do
+      yielded = true
+    end
+
+    expect(yielded).to be_a TrueClass
+  end
+
+  it 'does not yield after the initial yield if the period has not passed yet' do
+    throttle = ProgressBar::Throttle.new(:throttle_rate  => 10,
+                                         :throttle_timer => timer)
+    timer.start
+
+    throttle.choke {}
+
+    yielded = false
+
+    9.times do
+      Timecop.freeze(1)
+
+      throttle.choke do
+        yielded = true
+      end
+    end
+
+    Timecop.return
+
+    expect(yielded).to be_a FalseClass
+  end
+
+  it 'always yields if forced to, even after the initial yield or if the period ' \
+     'has not passed' do
+
+    throttle = ProgressBar::Throttle.new(:throttle_rate  => 10,
+                                         :throttle_timer => timer)
+    timer.start
+
+    throttle.choke {}
+
+    yielded = 0
+
+    25.times do
+      Timecop.freeze(1)
+
+      throttle.choke(:force_update_if => true) do
+        yielded += 1
+      end
+    end
+
+    Timecop.return
+
+    expect(yielded).to eql 25
+  end
+
+  it 'yields if the period has passed, even after the initial yield' do
+    throttle = ProgressBar::Throttle.new(:throttle_rate  => 10,
+                                         :throttle_timer => timer)
+    timer.start
+
+    throttle.choke {}
+
+    yielded = false
+
+    Timecop.freeze(11)
+
+    throttle.choke do
+      yielded = true
+    end
+
+    Timecop.return
+
+    expect(yielded).to eql true
+  end
+
+  it 'does not yield after a previous yield if the period has not passed yet' do
+    throttle = ProgressBar::Throttle.new(:throttle_rate  => 10,
+                                         :throttle_timer => timer)
+
+    Timecop.freeze(0)
+
+    timer.start
+
+    Timecop.freeze(15)
+
+    throttle.choke {}
+
+    yielded = false
+
+    9.times do
+      Timecop.freeze(1)
+
+      throttle.choke do
+        yielded = true
+      end
+
+      expect(yielded).to eql false
+    end
+
+    Timecop.return
+  end
+
+  it 'yields after the period has passed, even after a previous yield' do
+    throttle = ProgressBar::Throttle.new(:throttle_rate  => 10,
+                                         :throttle_timer => timer)
+
+    Timecop.freeze(0)
+
+    timer.start
+
+    Timecop.freeze(15)
+
+    throttle.choke {}
+
+    yielded = false
+
+    Timecop.freeze(10)
+
+    throttle.choke do
+      yielded = true
+    end
+
+    Timecop.return
+
+    expect(yielded).to eql true
+  end
+
+  it 'does not throttle if no throttle rate is given' do
+    throttle    = Throttle.new(:throttle_timer => timer,
+                               :throttle_rate  => nil)
+    yield_count = 0
+
+    25.times do
+      Timecop.freeze(1)
+
+      throttle.choke do
+        yield_count += 1
+      end
+    end
+
+    Timecop.return
+
+    expect(yield_count).to eql 25
+  end
+end
+end