ruby-progressbar 1.3.2 → 1.4.0

data/README.md

@@ -19,6 +19,7 @@ Supported Rubies
 It's Better Than The Other 186,312 Progress Bar Libraries Because...
 --------------------------------
 * Full test suite [![Build Status](https://secure.travis-ci.org/jfelchner/ruby-progressbar.png?branch=master)](http://travis-ci.org/jfelchner/ruby-progressbar)
+* _**ZERO**_ dependencies
 * Used by tons of other open source projects (which means we find out about bugs quickly)
 * It's pretty [freakin' sweet](https://www.youtube.com/watch?v=On3IoVhf_GM)
 * We have a road map of new features to make it even better
@@ -393,5 +394,5 @@ And a special thanks to [Satoru Takabayashi](http://namazu.org/~satoru/) who was
 License
 --------------------------------
 
-ruby-progressbar 1.0 is Copyright © 2011-2012 The Kompanee. It is free software, and may be redistributed under the terms specified in the LICENSE file.
+ruby-progressbar 1.0 is Copyright © 2011-2014 The Kompanee. It is free software, and may be redistributed under the terms specified in the LICENSE file.
 ruby-progressbar 0.9.0 is Copyright © 2008 [Satoru Takabayashi](http://namazu.org/~satoru/)

data/lib/ruby-progressbar/base.rb

@@ -27,7 +27,7 @@ class ProgressBar
 
       with_update do
         with_progressables(:start, options)
-        @elapsed_time.start
+        with_timers(:start)
       end
     end
 
@@ -35,26 +35,26 @@ class ProgressBar
     # Updating The Bar's Progress
     #
     def decrement
-      with_update { with_progressables(:decrement) }
+      update_progress(:decrement)
     end
 
     def increment
-      with_update { with_progressables(:increment) }
+      update_progress(:increment)
     end
 
     def progress=(new_progress)
-      with_update { with_progressables(:progress=, new_progress) }
+      update_progress(:progress=, new_progress)
     end
 
     def total=(new_total)
-      with_update { with_progressables(:total=, new_total) }
+      update_progress(:total=, new_total)
     end
 
     ###
     # Stopping The Bar
     #
     def finish
-      with_update { with_progressables(:finish) } unless finished?
+      with_update { with_progressables(:finish); with_timers(:stop) } unless finished?
     end
 
     def pause
@@ -83,7 +83,11 @@ class ProgressBar
     alias :paused? :stopped?
 
     def finished?
-      @bar.progress == @bar.total
+      @estimated_time.finished? && @bar.finished?
+    end
+
+    def started?
+      @estimated_time.started? && @elapsed_time.started? && @bar.started?
     end
 
     ###
@@ -158,14 +162,19 @@ class ProgressBar
       @elapsed_time.send(*args)
     end
 
+    def update_progress(*args)
+      with_update do
+        with_progressables(*args)
+        with_timers(:stop) if finished?
+      end
+    end
+
     def with_update
       yield
       update
     end
 
     def update(options = {})
-      with_timers(:stop) if finished?
-
       if length_changed?
         clear
         reset_length

data/lib/ruby-progressbar/components/estimated_timer.rb

@@ -32,9 +32,9 @@ class ProgressBar
 
     private
       def estimated_time
-        return '??:??:??' if progress_made.zero?
+        return '??:??:??' if progress_made.zero? || total.nil?
 
-        hours, minutes, seconds = divide_seconds(estimated_seconds_remaining)
+        hours, minutes, seconds = *divide_seconds(estimated_seconds_remaining)
 
         if hours > 99 && @out_of_bounds_time_format
           out_of_bounds_time

data/lib/ruby-progressbar/components/progressable.rb

@@ -1,3 +1,5 @@
+require 'ruby-progressbar/errors/invalid_progress_error'
+
 class ProgressBar
   module Components
     module Progressable
@@ -29,11 +31,19 @@ class ProgressBar
         !!self.starting_position
       end
 
+      def finished?
+        self.progress == self.total
+      end
+
       def increment
+        STDOUT.puts "WARNING: Your progress bar is currently at #{progress} out of #{total} and cannot be incremented. In v2.0.0 this will become a ProgressBar::InvalidProgressError." if progress == total
+
         self.progress += 1 unless progress == total
       end
 
       def decrement
+        STDOUT.puts "WARNING: Your progress bar is currently at #{progress} out of #{total} and cannot be decremented. In v2.0.0 this will become a ProgressBar::InvalidProgressError." if progress == 0
+
         self.progress -= 1 unless progress == 0
       end
 
@@ -76,11 +86,11 @@ class ProgressBar
 
     private
       def validate_total(new_total)
-        (progress.nil? || new_total.nil? || new_total >= progress) || raise("You can't set the item's total value to be less than the current progress.")
+        (progress.nil? || new_total.nil? || new_total >= progress) || raise(ProgressBar::InvalidProgressError, "You can't set the item's total value to be less than the current progress.")
       end
 
       def validate_progress(new_progress)
-        (total.nil? || new_progress <= total) || raise("You can't set the item's current value to be greater than the total.")
+        (total.nil? || new_progress <= total) || raise(ProgressBar::InvalidProgressError, "You can't set the item's current value to be greater than the total.")
       end
 
       def progress_made

data/lib/ruby-progressbar/components/timer.rb

@@ -51,8 +51,7 @@ class ProgressBar
       def elapsed_time
         return '--:--:--' unless started?
 
-        hours, seconds = elapsed_whole_seconds.divmod(3600)
-        minutes, seconds = seconds.divmod(60)
+        hours, minutes, seconds = *divide_seconds(elapsed_whole_seconds)
 
         sprintf TIME_FORMAT, hours, minutes, seconds
       end

data/lib/ruby-progressbar/errors/invalid_progress_error.rb

@@ -0,0 +1,4 @@
+class   ProgressBar
+class   InvalidProgressError < RuntimeError
+end
+end

data/lib/ruby-progressbar/version.rb

@@ -1,3 +1,3 @@
 class ProgressBar
-  VERSION = '1.3.2'
+  VERSION = '1.4.0'
 end

data/spec/lib/ruby-progressbar/base_spec.rb

@@ -20,14 +20,12 @@ 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)
 
-      IO.stub_chain(:console, :winsize).and_return [1, 30]
-      allow(progressbar).to receive(:dynamic_width_stty).
+      allow(progressbar).to receive(:terminal_width).
                             and_return 30
 
       progressbar.start
 
-      IO.stub_chain(:console, :winsize).and_return [1, 20]
-      allow(progressbar).to receive(:dynamic_width_stty).
+      allow(progressbar).to receive(:terminal_width).
                             and_return 20
 
       progressbar.increment
@@ -40,8 +38,7 @@ 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)
 
-        IO.stub_chain(:console, :winsize).and_return [1, 20]
-        allow(progressbar).to receive(:dynamic_width_stty).
+        allow(progressbar).to receive(:terminal_width).
                               and_return 20
 
         progressbar.to_s('%t%w').should eql '*********************'
@@ -52,8 +49,7 @@ describe ProgressBar::Base do
       it 'returns the proper string' do
         progressbar = ProgressBar::Base.new(:output => output, :title => ('*' * 21), :autostart => false)
 
-        IO.stub_chain(:console, :winsize).and_return [1, 20]
-        allow(progressbar).to receive(:dynamic_width_stty).
+        allow(progressbar).to receive(:terminal_width).
                               and_return 20
 
         progressbar.to_s('%t%i').should eql '*********************'
@@ -62,8 +58,7 @@ 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)
 
-        IO.stub_chain(:console, :winsize).and_return [1, 20]
-        allow(progressbar).to receive(:dynamic_width_stty).
+        allow(progressbar).to receive(:terminal_width).
                               and_return 20
 
         progressbar.to_s('%t%i').should eql '*********************'
@@ -74,8 +69,7 @@ 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)
 
-        IO.stub_chain(:console, :winsize).and_return [1, 20]
-        allow(progressbar).to receive(:dynamic_width_stty).
+        allow(progressbar).to receive(:terminal_width).
                               and_return 20
 
         progressbar.to_s('%t%B').should eql '******************* '
@@ -84,8 +78,7 @@ 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)
 
-        IO.stub_chain(:console, :winsize).and_return [1, 20]
-        allow(progressbar).to receive(:dynamic_width_stty).
+        allow(progressbar).to receive(:terminal_width).
                               and_return 20
 
         progressbar.to_s('%t%w%i').should eql '******************* '
@@ -346,7 +339,10 @@ describe ProgressBar::Base do
     end
 
     it 'displays the proper ETA' do
-      progressbar.to_s('%i%e').should eql '=--=--=--=--=--=--=--=--=--=--=--=--=--=--=--=--=--=--=--=--=--=-- ETA: ??:??:??'
+      progressbar.increment
+
+      progressbar.to_s('%i%e').should eql '-=--=--=--=--=--=--=--=--=--=--=--=--=--=--=--=--=--=--=--=--=--=- ETA: ??:??:??'
+      progressbar.to_s('%i%E').should eql '-=--=--=--=--=--=--=--=--=--=--=--=--=--=--=--=--=--=--=--=--=--=- ETA: ??:??:??'
     end
   end
 

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

@@ -203,7 +203,7 @@ describe ProgressBar::Components::Bar 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."
+        lambda { @progressbar.start :at => 11 }.should raise_error(ProgressBar::InvalidProgressError, "You can't set the item's current value to be greater than the total.")
       end
     end
   end

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

@@ -4,7 +4,7 @@ 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."
+      lambda{ @estimated_time.progress = 101 }.should raise_error(ProgressBar::InvalidProgressError, "You can't set the item's current value to be greater than the total.")
     end
   end
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: ruby-progressbar
 version: !ruby/object:Gem::Version
-  version: 1.3.2
+  version: 1.4.0
   prerelease: 
 platform: ruby
 authors:
@@ -10,7 +10,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-12-15 00:00:00.000000000 Z
+date: 2013-12-28 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rspec
@@ -83,6 +83,7 @@ files:
 - lib/ruby-progressbar/components/throttle.rb
 - lib/ruby-progressbar/components/timer.rb
 - lib/ruby-progressbar/components.rb
+- lib/ruby-progressbar/errors/invalid_progress_error.rb
 - lib/ruby-progressbar/format/base.rb
 - lib/ruby-progressbar/format/molecule.rb
 - lib/ruby-progressbar/format.rb