ruby-progressbar 1.6.1 → 1.7.0

data/lib/ruby-progressbar/length_calculator.rb

@@ -1,64 +0,0 @@
-class ProgressBar
-  module LengthCalculator
-    def initialize(options)
-      @length_override = ENV['RUBY_PROGRESS_BAR_LENGTH'] || options[:length]
-      @length_override = @length_override.to_i if @length_override
-      @current_length  = nil
-
-      super()
-    end
-
-  private
-    def length
-      @current_length || reset_length
-    end
-
-    def length_changed?
-      @current_length != calculate_length
-    end
-
-    def calculate_length
-      @length_override || terminal_width || 80
-    end
-
-    def reset_length
-      @current_length = calculate_length
-    end
-
-    # This code was copied and modified from Rake, available under MIT-LICENSE
-    # Copyright (c) 2003, 2004 Jim Weirich
-    def terminal_width
-      return 80 unless unix?
-
-      result = dynamic_width
-      (result < 20) ? 80 : result
-    rescue
-      80
-    end
-
-    begin
-      require 'io/console'
-
-      def dynamic_width
-        _rows, columns = IO.console.winsize
-        columns
-      end
-    rescue LoadError
-      def dynamic_width
-        dynamic_width_stty.nonzero? || dynamic_width_tput
-      end
-
-      def dynamic_width_stty
-        %x{stty size 2>/dev/null}.split[1].to_i
-      end
-
-      def dynamic_width_tput
-        %x{tput cols 2>/dev/null}.to_i
-      end
-    end
-
-    def unix?
-      RUBY_PLATFORM =~ /(aix|darwin|linux|(net|free|open)bsd|cygwin|solaris|irix|hpux)/i
-    end
-  end
-end

data/lib/ruby-progressbar/running_average_calculator.rb

@@ -1,7 +0,0 @@
-class ProgressBar
-  class RunningAverageCalculator
-    def self.calculate(current_average, new_value_to_average, smoothing_factor)
-      new_value_to_average * (1.0 - smoothing_factor) + current_average * smoothing_factor
-    end
-  end
-end

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

@@ -1,210 +0,0 @@
-require 'spec_helper'
-
-describe ProgressBar::Components::Bar do
-  context 'when a new bar is created' do
-    context 'and no parameters are passed' do
-      before { @progressbar = ProgressBar::Components::Bar.new }
-
-      describe '#total' do
-        it 'returns the default total' do
-          expect(@progressbar.total).to eql ProgressBar::Components::Bar::DEFAULT_TOTAL
-        end
-      end
-
-      describe '#progress_mark' do
-        it 'returns the default mark' do
-          expect(@progressbar.progress_mark).to eql ProgressBar::Components::Bar::DEFAULT_PROGRESS_MARK
-        end
-      end
-
-      describe '#remainder_mark' do
-        it 'returns the default remainder mark' do
-          expect(@progressbar.remainder_mark).to eql ProgressBar::Components::Bar::DEFAULT_REMAINDER_MARK
-        end
-      end
-
-      context 'and the bar has not been started' do
-        describe '#progress' do
-          it 'returns the default beginning position' do
-            expect(@progressbar.progress).to be_zero
-          end
-        end
-      end
-
-      context 'and the bar has been started with no starting value given' do
-        before { @progressbar.start }
-
-        describe '#progress' do
-          it 'returns the default starting value' do
-            expect(@progressbar.progress).to eql ProgressBar::Components::Progressable::DEFAULT_BEGINNING_POSITION
-          end
-        end
-      end
-
-      context 'and the bar has been started with a starting value' do
-        before { @progressbar.start :at => 10 }
-
-        describe '#progress' do
-          it 'returns the given starting value' do
-            expect(@progressbar.progress).to eql 10
-          end
-        end
-      end
-    end
-
-    context 'and options are passed' do
-      before { @progressbar = ProgressBar::Components::Bar.new(:total => 12, :progress_mark => 'x', :remainder_mark => '.') }
-
-      describe '#total' do
-        it 'returns the overridden total' do
-          expect(@progressbar.total).to eql 12
-        end
-      end
-
-      describe '#progress_mark' do
-        it 'returns the overridden mark' do
-          expect(@progressbar.progress_mark).to eql 'x'
-        end
-      end
-
-      describe '#remainder_mark' do
-        it 'returns the overridden mark' do
-          expect(@progressbar.remainder_mark).to eql '.'
-        end
-      end
-    end
-  end
-
-  context 'when just begun' do
-    before do
-      @progressbar = ProgressBar::Components::Bar.new(:total => 50)
-      @progressbar.length = 100
-      @progressbar.start
-    end
-
-    describe '#percentage_completed' do
-      it 'calculates the amount' do
-        expect(@progressbar.percentage_completed).to eql 0
-      end
-    end
-
-    describe '#to_s' do
-      it 'displays the bar with no indication of progress' do
-        expect(@progressbar.to_s).to eql '                                                                                                    '
-      end
-    end
-  end
-
-  context 'when nothing has been completed' do
-    before do
-      @progressbar = ProgressBar::Components::Bar.new(:total => 50)
-      @progressbar.length = 100
-      @progressbar.start
-    end
-
-    context 'and the bar is incremented' do
-      before { @progressbar.increment }
-
-      it 'adds to the progress amount' do
-        expect(@progressbar.progress).to eql 1
-      end
-
-      describe '#percentage_completed' do
-        it 'calculates the amount completed' do
-          expect(@progressbar.percentage_completed).to eql 2
-        end
-      end
-
-      describe '#to_s' do
-        it 'displays the bar with an indication of progress' do
-          expect(@progressbar.to_s).to eql '==                                                                                                  '
-        end
-      end
-    end
-
-    describe '#percentage_completed' do
-      it 'is zero' do
-        expect(@progressbar.percentage_completed).to eql 0
-      end
-    end
-
-    describe '#to_s' do
-      it 'displays the bar with no indication of progress' do
-        expect(@progressbar.to_s).to eql '                                                                                                    '
-      end
-    end
-  end
-
-  context 'when a fraction of a percentage has been completed' do
-    before do
-      @progressbar = ProgressBar::Components::Bar.new(:total => 200)
-      @progressbar.length = 100
-      @progressbar.start :at => 1
-    end
-
-    describe '#percentage_completed' do
-      it 'always rounds down' do
-        expect(@progressbar.percentage_completed).to eql 0
-      end
-    end
-
-    describe '#to_s' do
-      it 'displays the bar with no indication of progress' do
-        expect(@progressbar.to_s).to eql '                                                                                                    '
-      end
-    end
-  end
-
-  context 'when completed' do
-    before do
-      @progressbar = ProgressBar::Components::Bar.new(:total => 50)
-      @progressbar.length = 100
-      @progressbar.start :at => 50
-    end
-
-    context 'and the bar is incremented' do
-      before { @progressbar.increment }
-
-      it 'does not increment past the total' do
-        expect(@progressbar.progress).to eql 50
-        expect(@progressbar.percentage_completed).to eql 100
-      end
-
-      describe '#to_s' do
-        it 'displays the bar as 100% complete' do
-          expect(@progressbar.to_s).to eql '=' * 100
-        end
-      end
-    end
-
-    context 'and the bar is decremented' do
-      before { @progressbar.decrement }
-
-      it 'removes some progress from the bar' do
-        expect(@progressbar.progress).to eql 49
-        expect(@progressbar.percentage_completed).to eql 98
-      end
-
-      describe '#to_s' do
-        it 'displays the bar as 98% complete' do
-          expect(@progressbar.to_s).to eql "#{'=' * 98}  "
-        end
-      end
-    end
-
-    describe '#to_s' do
-      it 'displays the bar as 100% complete' do
-        expect(@progressbar.to_s).to eql ('=' * 100)
-      end
-    end
-  end
-
-  context "when attempting to set the bar's current value to be greater than the total" do
-    describe '#new' do
-      it 'raises an error' do
-        @progressbar = ProgressBar::Components::Bar.new(:total => 10)
-        expect { @progressbar.start :at => 11 }.to raise_error(ProgressBar::InvalidProgressError, "You can't set the item's current value to be greater than the total.")
-      end
-    end
-  end
-end

data/spec/lib/ruby-progressbar/components/elapsed_timer_spec.rb

@@ -1,91 +0,0 @@
-require 'spec_helper'
-
-describe ProgressBar::Components::ElapsedTimer do
-  before { @timer = ProgressBar::Components::ElapsedTimer.new }
-
-  describe '#to_s' do
-    context 'when the timer has not been started' do
-      it 'displays "Time: --:--:--"' do
-        expect(@timer.to_s).to eql 'Time: --:--:--'
-      end
-    end
-
-    context 'when it has just been started' do
-      it 'displays "Time: 00:00:00"' do
-        @timer.start
-        expect(@timer.to_s).to eql 'Time: 00:00:00'
-      end
-    end
-
-    context 'when it was started 4 hours, 28 minutes and 13 seconds ago' do
-      before do
-        Timecop.travel(-16093) do
-          @timer.start
-        end
-      end
-
-      context 'and it was stopped 32 seconds ago' do
-        before do
-          Timecop.travel(-32) do
-            @timer.stop
-          end
-        end
-
-        context 'and #reset is called' do
-          before { @timer.reset }
-
-          it 'displays "Time: --:--:--"' do
-            expect(@timer.to_s).to eql 'Time: --:--:--'
-          end
-        end
-
-        it 'displays "Time: 04:27:41"' do
-          expect(@timer.to_s).to eql 'Time: 04:27:41'
-        end
-      end
-
-      context 'and #reset is called' do
-        before { @timer.reset }
-
-        it 'displays "Time: --:--:--"' do
-          expect(@timer.to_s).to eql 'Time: --:--:--'
-        end
-      end
-
-      it 'displays "Time: 04:28:13"' do
-        expect(@timer.to_s).to eql 'Time: 04:28:13'
-      end
-    end
-  end
-
-  describe '#stopped?' do
-    context 'when the timer is started' do
-      before { @timer.start }
-
-      context 'and then it is stopped' do
-        before { @timer.stop }
-
-        context 'and then it is restarted' do
-          before { @timer.start }
-
-          it 'is false' do
-            expect(@timer).not_to be_stopped
-          end
-        end
-      end
-    end
-
-    context "when the timer has yet to be started" do
-      it 'is false' do
-        expect(@timer).not_to be_stopped
-      end
-    end
-
-    context "when the timer is stopped without having been started" do
-      before { @timer.stop }
-      it 'is false' do
-        expect(@timer).not_to be_stopped
-      end
-    end
-  end
-end

data/spec/lib/ruby-progressbar/components/estimated_timer_spec.rb

@@ -1,241 +0,0 @@
-require 'spec_helper'
-require 'support/time'
-
-describe ProgressBar::Components::EstimatedTimer do
-  describe '#progress=' do
-    it 'raises an error when passed a number larger than the total' do
-      @estimated_time = ProgressBar::Components::EstimatedTimer.new(:total => 100)
-      expect { @estimated_time.progress = 101 }.to raise_error(ProgressBar::InvalidProgressError, "You can't set the item's current value to be greater than the total.")
-    end
-  end
-
-  describe '#to_s' do
-    context 'when the timer has been started but no progress has been made' do
-      before do
-        @estimated_time = ProgressBar::Components::EstimatedTimer.new(:total => 100)
-        @estimated_time.start
-      end
-
-      it 'displays an unknown time remaining' do
-        expect(@estimated_time.to_s).to eql ' ETA: ??:??:??'
-      end
-
-      context 'and it is incremented' do
-        it 'should not display unknown time remaining' do
-          @estimated_time.increment
-          expect(@estimated_time.to_s).not_to eql ' ETA: ??:??:??'
-        end
-      end
-    end
-
-    context 'when half the progress has been made' do
-      context 'and smoothing is turned off' do
-        let(:smoothing) { 0.0 }
-
-        context 'and it took 3:42:12 to do it' do
-          before do
-            @estimated_time = ProgressBar::Components::EstimatedTimer.new(:starting_at => 0, :total => 100, :smoothing => smoothing)
-
-            Timecop.travel(-13332) do
-              @estimated_time.start
-              50.times { @estimated_time.increment }
-            end
-          end
-
-          context 'when #decrement is called' do
-            before { 20.times { @estimated_time.decrement } }
-
-            it 'displays the correct time remaining' do
-              expect(@estimated_time.to_s).to eql ' ETA: 08:38:28'
-            end
-          end
-
-          context 'when #reset is called' do
-            before { @estimated_time.reset }
-
-            it 'displays unknown time remaining' do
-              expect(@estimated_time.to_s).to eql ' ETA: ??:??:??'
-            end
-          end
-
-          it 'displays the correct time remaining' do
-            expect(@estimated_time.to_s).to eql ' ETA: 03:42:12'
-          end
-        end
-
-        context 'when it is estimated to take longer than 99:59:59' do
-          before do
-            @estimated_time = ProgressBar::Components::EstimatedTimer.new(:starting_at => 0, :total => 100, :smoothing => smoothing)
-
-            Timecop.travel(-120000) do
-              @estimated_time.start
-              25.times { @estimated_time.increment }
-            end
-          end
-
-          context 'and the out of bounds time format has been set to "friendly"' do
-            before { @estimated_time.out_of_bounds_time_format = :friendly }
-
-            it 'displays "> 4 Days" remaining' do
-              expect(@estimated_time.to_s).to eql ' ETA: > 4 Days'
-            end
-          end
-
-          context 'and the out of bounds time format has been set to "unknown"' do
-            before { @estimated_time.out_of_bounds_time_format = :unknown }
-
-            it 'displays "??:??:??" remaining' do
-              expect(@estimated_time.to_s).to eql ' ETA: ??:??:??'
-            end
-          end
-
-          it 'displays the correct time remaining' do
-            expect(@estimated_time.to_s).to eql ' ETA: 100:00:00'
-          end
-        end
-      end
-
-      context 'and smoothing is turned on' do
-        let(:smoothing) { 0.5 }
-
-        context 'and it took 3:42:12 to do it' do
-          before do
-            @estimated_time = ProgressBar::Components::EstimatedTimer.new(:starting_at => 0, :total => 100, :smoothing => smoothing)
-
-            Timecop.travel(-13332) do
-              @estimated_time.start
-              50.times { @estimated_time.increment }
-            end
-          end
-
-          context 'when #decrement is called' do
-            before { 20.times { @estimated_time.decrement } }
-
-            it 'displays the correct time remaining' do
-              expect(@estimated_time.to_s).to eql ' ETA: 08:14:34'
-            end
-          end
-
-          context 'when #reset is called' do
-            before { @estimated_time.reset }
-
-            it 'displays unknown time remaining' do
-              expect(@estimated_time.to_s).to eql ' ETA: ??:??:??'
-            end
-          end
-
-          it 'displays the correct time remaining' do
-            expect(@estimated_time.to_s).to eql ' ETA: 03:51:16'
-          end
-        end
-
-        context 'when it is estimated to take longer than 99:59:59' do
-          before do
-            @estimated_time = ProgressBar::Components::EstimatedTimer.new(:starting_at => 0, :total => 100, :smoothing => smoothing)
-
-            Timecop.travel(-120000) do
-              @estimated_time.start
-              25.times { @estimated_time.increment }
-            end
-          end
-
-          context 'and the out of bounds time format has been set to "friendly"' do
-            before { @estimated_time.out_of_bounds_time_format = :friendly }
-
-            it 'displays "> 4 Days" remaining' do
-              expect(@estimated_time.to_s).to eql ' ETA: > 4 Days'
-            end
-          end
-
-          context 'and the out of bounds time format has been set to "unknown"' do
-            before { @estimated_time.out_of_bounds_time_format = :unknown }
-
-            it 'displays "??:??:??" remaining' do
-              expect(@estimated_time.to_s).to eql ' ETA: ??:??:??'
-            end
-          end
-
-          it 'displays the correct time remaining' do
-            expect(@estimated_time.to_s).to eql ' ETA: 105:33:20'
-          end
-        end
-      end
-    end
-
-    it 'displays a good estimate for regular increments' do
-      begin
-        Timecop.freeze(t = Time.now)
-        n = 10
-        estimated_time = ProgressBar::Components::EstimatedTimer.new(:total => n)
-        estimated_time.start
-        results = (1..n).map do |i|
-          Timecop.freeze(t + 0.5 * i)
-          estimated_time.increment
-          estimated_time.to_s
-        end
-
-        expect(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',
-        ])
-      ensure
-        Timecop.return
-      end
-    end
-  end
-
-  describe '#out_of_bounds_time_format=' do
-    context 'when set to an invalid format' do
-      it 'raises an exception' do
-        @estimated_time = ProgressBar::Components::EstimatedTimer.new(:total => 100)
-        expect { @estimated_time.out_of_bounds_time_format = :foo }.to raise_error('Invalid Out Of Bounds time format.  Valid formats are [:unknown, :friendly, nil]')
-      end
-    end
-  end
-
-  describe '#start' do
-
-    ###
-    # Using ruby-debug under jruby pulls in ruby-debug-base, which defines
-    # Kernel.start. This causes a bug, as EstimatedTimer::As::method_missing calls
-    # Kernel.start instead of EstimatedTimer.start. This spec duplicates the bug.
-    # Without the fix, this results in the following exception:
-    #
-    # 1) ruby-debug-base doesn't stop the progressbar from working
-    #    Failure/Error: COUNT.times { bar.increment }
-    #    NoMethodError:
-    #      undefined method `+' for nil:NilClass
-    #    # ./lib/ruby-progressbar/components/progressable.rb:33:in `increment'
-    #
-    it 'properly delegates' do
-      @output = StringIO.new('', 'w+')
-
-      module Kernel
-        def start(options={}, &block)
-          puts "Kernel.start has been called"
-          return nil
-        end
-      end
-
-      begin
-        COUNT = 100
-
-        bar = ProgressBar.create(:output => @output, :title => 'ruby-debug-base', :total => COUNT)
-
-        COUNT.times { bar.increment }
-      ensure
-        module Kernel
-          remove_method :start
-        end
-      end
-    end
-  end
-end