ruby-progressbar 1.6.1 → 1.7.0

data/lib/ruby-progressbar/timer.rb

@@ -0,0 +1,72 @@
+require 'ruby-progressbar/time'
+
+class   ProgressBar
+class   Timer
+  attr_accessor :started_at,
+                :stopped_at
+
+  def initialize(options = {})
+    self.time = options[:time] || Time
+  end
+
+  def start
+    self.started_at = stopped? ? time.now - (stopped_at - started_at) : time.now
+    self.stopped_at = nil
+  end
+
+  def stop
+    return unless started?
+
+    self.stopped_at = time.now
+  end
+
+  def pause
+    stop
+  end
+
+  def resume
+    start
+  end
+
+  def started?
+    started_at
+  end
+
+  def stopped?
+    stopped_at
+  end
+
+  def reset
+    self.started_at = nil
+    self.stopped_at = nil
+  end
+
+  def reset?
+    !started_at
+  end
+
+  def restart
+    reset
+    start
+  end
+
+  def elapsed_seconds
+    ((stopped_at || time.now) - started_at)
+  end
+
+  def elapsed_whole_seconds
+    elapsed_seconds.floor
+  end
+
+  def divide_seconds(seconds)
+    hours, seconds   = seconds.divmod(3600)
+    minutes, seconds = seconds.divmod(60)
+
+    [hours, minutes, seconds]
+  end
+
+  protected
+
+  attr_accessor :time
+end
+end

data/lib/ruby-progressbar/version.rb

@@ -1,3 +1,3 @@
-class ProgressBar
-  VERSION = '1.6.1'
+class   ProgressBar
+  VERSION = '1.7.0'
 end

data/spec/fixtures/benchmark.rb

@@ -1,11 +1,28 @@
-# bundle exec ruby-prof --printer=graph_html --file=../results.html --require 'ruby-progressbar' --sort=total ./spec/fixtures/benchmark.rb
+# bundle exec ruby-prof --printer=graph_html
+#                       --file=../results.html
+#                       --require 'ruby-progressbar'
+#                       --sort=total ./spec/fixtures/benchmark.rb
 
-total  = 10
+total  = 100_000
 # output = File.open('/Users/jfelchner/Downloads/benchmark.txt', 'w+')
 output = $stdout
-bar    = ProgressBar.create(:output => output, :length => 80, :start => 0, :total => total)
+
+# Progressbar gem
+# bar = ProgressBar.new('Progress', total)
+#
+# total.times do |i|
+#   bar.inc
+# end
+#
+# bar.finish
+
+# Ruby/ProgressBar
+bar = ProgressBar.create(:output => output,
+                         :length => 80,
+                         :start  => 0,
+                         :total  => total)
 
 total.times do |i|
-  bar.log i
+  # bar.log i
   bar.increment
 end

data/spec/{lib/ruby-progressbar → ruby-progressbar}/base_spec.rb

@@ -21,13 +21,13 @@ describe ProgressBar::Base do
     it 'can properly handle outputting the bar when the length changes on the fly to less than the minimum width' do
       progressbar = ProgressBar::Base.new(:output => output, :title => 'a' * 25, :format => '%t%B', :throttle_rate => 0.0)
 
-      allow(progressbar).to receive(:terminal_width).
-                            and_return 30
+      allow(progressbar.send(:output).send(:length_calculator)).to receive(:terminal_width).
+                                                                   and_return 30
 
       progressbar.start
 
-      allow(progressbar).to receive(:terminal_width).
-                            and_return 20
+      allow(progressbar.send(:output).send(:length_calculator)).to receive(:terminal_width).
+                                                                   and_return 20
 
       progressbar.increment
 
@@ -39,8 +39,8 @@ describe ProgressBar::Base do
       it 'returns the proper string' do
         progressbar = ProgressBar::Base.new(:output => output, :title => ('*' * 21), :starting_at => 5, :total => 10, :autostart => false)
 
-        allow(progressbar).to receive(:terminal_width).
-                              and_return 20
+        allow(progressbar.send(:output).send(:length_calculator)).to receive(:terminal_width).
+                                                                     and_return 20
 
         expect(progressbar.to_s('%t%w')).to eql '*********************'
       end
@@ -50,8 +50,8 @@ describe ProgressBar::Base do
       it 'returns the proper string' do
         progressbar = ProgressBar::Base.new(:output => output, :title => ('*' * 21), :autostart => false)
 
-        allow(progressbar).to receive(:terminal_width).
-                              and_return 20
+        allow(progressbar.send(:output).send(:length_calculator)).to receive(:terminal_width).
+                                                                     and_return 20
 
         expect(progressbar.to_s('%t%i')).to eql '*********************'
       end
@@ -59,8 +59,8 @@ describe ProgressBar::Base do
       it 'returns the proper string' do
         progressbar = ProgressBar::Base.new(:output => output, :title => ('*' * 21), :starting_at => 5, :total => 10, :autostart => false)
 
-        allow(progressbar).to receive(:terminal_width).
-                              and_return 20
+        allow(progressbar.send(:output).send(:length_calculator)).to receive(:terminal_width).
+                                                                     and_return 20
 
         expect(progressbar.to_s('%t%i')).to eql '*********************'
       end
@@ -70,8 +70,8 @@ describe ProgressBar::Base do
       it 'returns the proper string' do
         progressbar = ProgressBar::Base.new(:output => output, :title => ('*' * 19), :starting_at => 5, :total => 10, :autostart => false)
 
-        allow(progressbar).to receive(:terminal_width).
-                              and_return 20
+        allow(progressbar.send(:output).send(:length_calculator)).to receive(:terminal_width).
+                                                                     and_return 20
 
         expect(progressbar.to_s('%t%B')).to eql '******************* '
       end
@@ -79,8 +79,8 @@ describe ProgressBar::Base do
       it 'returns the proper string' do
         progressbar = ProgressBar::Base.new(:output => output, :title => ('*' * 19), :starting_at => 5, :total => 10, :autostart => false)
 
-        allow(progressbar).to receive(:terminal_width).
-                              and_return 20
+        allow(progressbar.send(:output).send(:length_calculator)).to receive(:terminal_width).
+                                                                     and_return 20
 
         expect(progressbar.to_s('%t%w%i')).to eql '******************* '
       end
@@ -93,13 +93,13 @@ describe ProgressBar::Base do
 
       describe '#title' do
         it 'returns the default title' do
-          expect(progressbar.send(:title).to_s).to eql ProgressBar::Base::DEFAULT_TITLE
+          expect(progressbar.send(:title).to_s).to eql ProgressBar::Components::Title::DEFAULT_TITLE
         end
       end
 
       describe '#output' do
         it 'returns the default output stream' do
-          expect(progressbar.send(:output)).to eql ProgressBar::Base::DEFAULT_OUTPUT_STREAM
+          expect(progressbar.send(:output).send(:stream)).to eql ProgressBar::Output::DEFAULT_OUTPUT_STREAM
         end
       end
 
@@ -110,7 +110,7 @@ describe ProgressBar::Base do
 
           it 'returns the length of the environment variable as an integer' do
             progressbar = ProgressBar::Base.new
-            expect(progressbar.send(:length)).to eql 44
+            expect(progressbar.send(:output).send(:length_calculator).send(:length)).to eql 44
           end
         end
 
@@ -120,21 +120,21 @@ describe ProgressBar::Base do
           context 'but the length option was passed in' do
             it 'returns the length specified in the option' do
               progressbar = ProgressBar::Base.new(:length => 88)
-              expect(progressbar.send(:length)).to eql 88
+              expect(progressbar.send(:output).send(:length_calculator).send(:length)).to eql 88
             end
           end
 
           context 'and no length option was passed in' do
             it 'returns the width of the terminal if it is a Unix environment' do
-              allow(progressbar).to receive(:terminal_width).and_return(99)
-              progressbar.send(:reset_length)
-              expect(progressbar.send(:length)).to eql 99
+              allow(progressbar.send(:output).send(:length_calculator)).to receive(:terminal_width).and_return(99)
+              progressbar.send(:output).send(:length_calculator).send(:reset_length)
+              expect(progressbar.send(:output).send(:length_calculator).send(:length)).to eql 99
             end
 
             it 'returns 80 if it is not a Unix environment' do
-              allow(progressbar).to receive(:unix?).and_return(false)
-              progressbar.send(:reset_length)
-              expect(progressbar.send(:length)).to eql 80
+              allow(progressbar.send(:output).send(:length_calculator)).to receive(:unix?).and_return(false)
+              progressbar.send(:output).send(:length_calculator).send(:reset_length)
+              expect(progressbar.send(:output).send(:length_calculator).send(:length)).to eql 80
             end
           end
         end
@@ -152,13 +152,13 @@ describe ProgressBar::Base do
 
       describe '#output' do
         it 'returns the overridden output stream' do
-          expect(progressbar.send(:output)).to eql STDOUT
+          expect(progressbar.send(:output).send(:stream)).to eql STDOUT
         end
       end
 
       describe '#length' do
         it 'returns the overridden length' do
-          expect(progressbar.send(:length)).to eql 88
+          expect(progressbar.send(:output).send(:length_calculator).send(:length)).to eql 88
         end
       end
     end
@@ -202,16 +202,16 @@ describe ProgressBar::Base do
 
     context 'which includes ANSI SGR codes in the format string' do
       it 'properly calculates the length of the bar by removing the long version of the ANSI codes from the calculated length' do
-        @color_code     = "\e[0m\e[32m\e[7m\e[1m"
-        @reset_code     = "\e[0m"
-        @progress_mark  = "#{@color_code} #{@reset_code}"
+        @color_code    = "\e[0m\e[32m\e[7m\e[1m"
+        @reset_code    = "\e[0m"
+        @progress_mark = "#{@color_code} #{@reset_code}"
         progressbar    = ProgressBar::Base.new(:format        => "#{@color_code}Processing... %b%i#{@reset_code}#{@color_code} %p%%#{@reset_code}",
-                                                :progress_mark => @progress_mark,
-                                                :output        => output,
-                                                :length        => 24,
-                                                :starting_at   => 3,
-                                                :total         => 6,
-                                                :throttle_rate => 0.0)
+                                               :progress_mark => @progress_mark,
+                                               :output        => output,
+                                               :length        => 24,
+                                               :starting_at   => 3,
+                                               :total         => 6,
+                                               :throttle_rate => 0.0)
 
         progressbar.increment
         progressbar.increment
@@ -221,16 +221,16 @@ describe ProgressBar::Base do
       end
 
       it 'properly calculates the length of the bar by removing the short version of the ANSI codes from the calculated length' do
-        @color_code     = "\e[0;32;7;1m"
-        @reset_code     = "\e[0m"
-        @progress_mark  = "#{@color_code} #{@reset_code}"
+        @color_code    = "\e[0;32;7;1m"
+        @reset_code    = "\e[0m"
+        @progress_mark = "#{@color_code} #{@reset_code}"
         progressbar    = ProgressBar::Base.new(:format        => "#{@color_code}Processing... %b%i#{@reset_code}#{@color_code} %p%%#{@reset_code}",
-                                                :progress_mark => @progress_mark,
-                                                :output        => output,
-                                                :length        => 24,
-                                                :starting_at   => 3,
-                                                :total         => 6,
-                                                :throttle_rate => 0.0)
+                                               :progress_mark => @progress_mark,
+                                               :output        => output,
+                                               :length        => 24,
+                                               :starting_at   => 3,
+                                               :total         => 6,
+                                               :throttle_rate => 0.0)
 
         progressbar.increment
         progressbar.increment
@@ -300,7 +300,7 @@ describe ProgressBar::Base do
 
         3.times { progressbar.increment }
 
-        progressbar.title = "Testing"
+        progressbar.title = 'Testing'
         progressbar.stop
 
         non_tty_output.rewind
@@ -323,7 +323,7 @@ describe ProgressBar::Base do
   end
 
   context 'when a bar is about to be completed' do
-    let(:progressbar) { ProgressBar::Base.new(:starting_at => 5, :total => 6, :output => output, :length => 20) }
+    let(:progressbar) { ProgressBar::Base.new(:starting_at => 5, :total => 6, :output => output, :length => 20, :throttle_rate => 0.0) }
 
     context 'and it is incremented' do
       before { progressbar.increment }
@@ -347,7 +347,7 @@ describe ProgressBar::Base do
   end
 
   context 'when a bar with autofinish=false is about to be completed' do
-    let(:progressbar) { ProgressBar::Base.new(:autofinish => false, :starting_at => 5, :total => 6, :output => output, :length => 20) }
+    let(:progressbar) { ProgressBar::Base.new(:autofinish => false, :starting_at => 5, :total => 6, :output => output, :length => 20, :throttle_rate => 0.0) }
 
     context 'and it is incremented' do
       before { progressbar.increment }
@@ -385,7 +385,7 @@ describe ProgressBar::Base do
 
         output.rewind
 
-        expect(output.read).to end_with "                    \rProgress: |======  |\rProgress: |========|\n"
+        expect(output.read).to end_with "                    \rProgress: |======  |\rProgress: |========|\rProgress: |========|\n"
       end
     end
   end
@@ -509,7 +509,7 @@ describe ProgressBar::Base do
       progressbar.clear
 
       output.rewind
-      expect(output.read).to match(/^#{progressbar.send(:clear_string)}/)
+      expect(output.read).to match(/^#{progressbar.send(:output).send(:clear_string)}/)
     end
   end
 
@@ -518,7 +518,7 @@ describe ProgressBar::Base do
       progressbar.start
 
       output.rewind
-      expect(output.read).to match(/^#{progressbar.send(:clear_string)}/)
+      expect(output.read).to match(/^#{progressbar.send(:output).send(:clear_string)}/)
     end
 
     it 'prints the bar for the first time' do
@@ -554,7 +554,7 @@ describe ProgressBar::Base do
       let(:progressbar) { ProgressBar::Base.new(:format => '%B %p%%') }
 
       context 'if called with no arguments' do
-        before { progressbar.format }
+        before { progressbar.format = nil }
 
         it 'resets the format back to the default' do
           expect(progressbar.to_s).to match(/^Progress: \|\s+\|\z/)
@@ -562,7 +562,7 @@ describe ProgressBar::Base do
       end
 
       context 'if called with a specific format string' do
-        before { progressbar.format '%t' }
+        before { progressbar.format = '%t' }
 
         it 'sets it as the new format for the bar' do
           expect(progressbar.to_s).to match(/^Progress\z/)
@@ -841,16 +841,9 @@ describe ProgressBar::Base do
         expect(progressbar.to_s('%%')).to match(/^%\z/)
       end
 
-      # Autostarting for now.  This will be applicable later.
-      # context "when called before #start" do
-        # it "displays unknown time elapsed when using the %a flag" do
-        # expect(progressbar.to_s('%a')).to match(/^Time: --:--:--\z/)
-        # end
-      # end
-
       context 'when called after #start' do
         before do
-          Timecop.travel(-3723) do
+          Timecop.travel(-3_723) do
             progressbar.start
           end
         end
@@ -877,7 +870,7 @@ describe ProgressBar::Base do
 
       context 'when called after #start' do
         let(:progressbar) do
-          Timecop.travel(-3723) do
+          Timecop.travel(-3_723) do
             progressbar = ProgressBar::Base.new(:starting_at => 0, :output => output, :smoothing => 0.0)
             progressbar.start
             progressbar.progress = 50
@@ -900,7 +893,7 @@ describe ProgressBar::Base do
 
       context 'when it could take 100 hours or longer to finish' do
         let(:progressbar) do
-          Timecop.travel(-120000) do
+          Timecop.travel(-120_000) do
             progressbar = ProgressBar::Base.new(:starting_at => 0, :total => 100, :output => output, :smoothing => 0.0)
             progressbar.start
             progressbar.progress = 25

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
+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
+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