ruby-progressbar 0.11.0 → 1.0.0rc1

data/spec/progress_bar/components/bar_spec.rb

@@ -0,0 +1,198 @@
+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
+          @progressbar.total.should eql ProgressBar::Components::Bar::DEFAULT_TOTAL
+        end
+      end
+
+      describe '#progress_mark' do
+        it 'returns the default mark' do
+          @progressbar.progress_mark.should eql ProgressBar::Components::Bar::DEFAULT_PROGRESS_MARK
+        end
+      end
+
+      context 'and the bar has not been started' do
+        describe '#progress' do
+          it 'returns the default beginning position' do
+            @progressbar.progress.should 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
+            @progressbar.progress.should 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
+            @progressbar.progress.should eql 10
+          end
+        end
+      end
+    end
+
+    context 'and options are passed' do
+      before { @progressbar = ProgressBar::Components::Bar.new(:total => 12, :progress_mark => 'x') }
+
+      describe '#total' do
+        it 'returns the overridden total' do
+          @progressbar.total.should eql 12
+        end
+      end
+
+      describe '#progress_mark' do
+        it 'returns the overridden mark' do
+          @progressbar.progress_mark.should eql 'x'
+        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
+        @progressbar.percentage_completed.should eql 0
+      end
+    end
+
+    describe '#to_s' do
+      it 'displays the bar with no indication of progress' do
+        @progressbar.to_s.should 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
+        @progressbar.progress.should eql 1
+      end
+
+      describe '#percentage_completed' do
+        it 'calculates the amount completed' do
+          @progressbar.percentage_completed.should eql 2
+        end
+      end
+
+      describe '#to_s' do
+        it 'displays the bar with an indication of progress' do
+          @progressbar.to_s.should eql '==                                                                                                  '
+        end
+      end
+    end
+
+    describe '#percentage_completed' do
+      it 'is zero' do
+        @progressbar.percentage_completed.should eql 0
+      end
+    end
+
+    describe '#to_s' do
+      it 'displays the bar with no indication of progress' do
+        @progressbar.to_s.should 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
+        @progressbar.percentage_completed.should eql 0
+      end
+    end
+
+    describe '#to_s' do
+      it 'displays the bar with no indication of progress' do
+        @progressbar.to_s.should 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
+        @progressbar.progress.should eql 50
+        @progressbar.percentage_completed.should eql 100
+      end
+
+      describe '#to_s' do
+        it 'displays the bar as 100% complete' do
+          @progressbar.to_s.should eql '=' * 100
+        end
+      end
+    end
+
+    context 'and the bar is decremented' do
+      before { @progressbar.decrement }
+
+      it 'removes some progress from the bar' do
+        @progressbar.progress.should eql 49
+        @progressbar.percentage_completed.should eql 98
+      end
+
+      describe '#to_s' do
+        it 'displays the bar as 98% complete' do
+          @progressbar.to_s.should eql "#{'=' * 98}  "
+        end
+      end
+    end
+
+    describe '#to_s' do
+      it 'displays the bar as 100% complete' do
+        @progressbar.to_s.should 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)
+        lambda { @progressbar.start :at => 11 }.should raise_error "You can't set the item's current value to be greater than the total."
+      end
+    end
+  end
+end

data/spec/progress_bar/components/elapsed_timer_spec.rb

@@ -0,0 +1,79 @@
+require 'spec_helper'
+require 'timecop'
+
+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
+        @timer.to_s.should eql 'Time: --:--:--'
+      end
+    end
+
+    context 'when it has just been started' do
+      it 'displays "Time: 00:00:00"' do
+        @timer.start
+        @timer.to_s.should 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
+            @timer.to_s.should eql 'Time: --:--:--'
+          end
+        end
+
+        it 'displays "Time: 04:27:41"' do
+          @timer.to_s.should eql 'Time: 04:27:41'
+        end
+      end
+
+      context 'and #reset is called' do
+        before { @timer.reset }
+
+        it 'displays "Time: --:--:--"' do
+          @timer.to_s.should eql 'Time: --:--:--'
+        end
+      end
+
+      it 'displays "Time: 04:28:13"' do
+        @timer.to_s.should 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
+            @timer.should_not be_stopped
+          end
+        end
+      end
+    end
+  end
+end

data/spec/progress_bar/components/estimated_timer_spec.rb

@@ -0,0 +1,173 @@
+require 'spec_helper'
+
+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)
+      lambda{ @estimated_time.progress = 101 }.should raise_error "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
+        @estimated_time.to_s.should eql ' ETA: ??:??:??'
+      end
+
+      context 'and it is incremented' do
+        it 'should not display unknown time remaining' do
+          @estimated_time.increment
+          @estimated_time.to_s.should_not 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
+              @estimated_time.to_s.should eql ' ETA: 08:38:28'
+            end
+          end
+
+          context 'when #reset is called' do
+            before { @estimated_time.reset }
+
+            it 'displays unknown time remaining' do
+              @estimated_time.to_s.should eql ' ETA: ??:??:??'
+            end
+          end
+
+          it 'displays the correct time remaining' do
+            @estimated_time.to_s.should 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
+              @estimated_time.to_s.should 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
+              @estimated_time.to_s.should eql ' ETA: ??:??:??'
+            end
+          end
+
+          it 'displays the correct time remaining' do
+            @estimated_time.to_s.should 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
+              @estimated_time.to_s.should eql ' ETA: 08:14:34'
+            end
+          end
+
+          context 'when #reset is called' do
+            before { @estimated_time.reset }
+
+            it 'displays unknown time remaining' do
+              @estimated_time.to_s.should eql ' ETA: ??:??:??'
+            end
+          end
+
+          it 'displays the correct time remaining' do
+            @estimated_time.to_s.should 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
+              @estimated_time.to_s.should 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
+              @estimated_time.to_s.should eql ' ETA: ??:??:??'
+            end
+          end
+
+          it 'displays the correct time remaining' do
+            @estimated_time.to_s.should eql ' ETA: 105:33:19'
+          end
+        end
+      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)
+        lambda{ @estimated_time.out_of_bounds_time_format = :foo }.should raise_error('Invalid Out Of Bounds time format.  Valid formats are [:unknown, :friendly, nil]')
+      end
+    end
+  end
+end