ruby-progressbar 0.0.10 → 0.11.0

data/lib/progressbar.rb

@@ -21,11 +21,11 @@ class ProgressBar
     @current = 0
     @previous = 0
     @finished_p = false
-    @start_time = Time.now
+    @start_time = time_now
     @previous_time = @start_time
-    @title_width = 14
-    @format = "%-#{@title_width}s %3d%% %s %s"
     @format_arguments = [:title, :percentage, :bar, :stat]
+    @smoothing = 0.9
+    @running_average = 0
     clear
     show
   end
@@ -34,12 +34,26 @@ class ProgressBar
   attr_reader   :total
   attr_accessor :start_time
   attr_writer   :bar_mark
+  attr_writer   :title_width
+
+  def title_width
+    @title_width ||= 14
+  end
+
+  def format
+    @format || "%-#{title_width}s %3d%% %s %s"
+  end
+
+  # Exponential smoothing helps keep jitter out of the time-remaining estimate.
+  # The value may be anything from 0.0 to 1.0. Contrary to intuition, LOWER
+  # values make the average smoother, and 1.0 is equivalent to no smoothing
+  # whatsoever (the classic behavior). Default value is 0.9.
+  attr_accessor :smoothing
 
   private
   def fmt_bar
-    bar_width = do_percentage * @terminal_width / 100
-    sprintf("|%s%s|", 
-            @bar_mark * bar_width, 
+    sprintf("|%s%s|",
+            @bar_mark * bar_width,
             " " *  (@terminal_width - bar_width))
   end
 
@@ -52,15 +66,19 @@ class ProgressBar
   end
 
   def fmt_stat_for_file_transfer
-    if @finished_p then 
+    if @finished_p then
       sprintf("%s %s %s", bytes, transfer_rate, elapsed)
-    else 
+    else
       sprintf("%s %s %s", bytes, transfer_rate, eta)
     end
   end
 
   def fmt_title
-    @title[0,(@title_width - 1)] + ":"
+    @title[0,(title_width - 1)] + ":"
+  end
+
+  def bar_width
+    do_percentage * @terminal_width / 100
   end
 
   def convert_bytes (bytes)
@@ -76,7 +94,7 @@ class ProgressBar
   end
 
   def transfer_rate
-    bytes_per_second = @current.to_f / (Time.now - @start_time)
+    bytes_per_second = @current.to_f / (time_now - @start_time)
     sprintf("%s/s", convert_bytes(bytes_per_second))
   end
 
@@ -85,29 +103,29 @@ class ProgressBar
   end
 
   def format_time (t)
-    t = t.to_i
-    sec = t % 60
-    min  = (t / 60) % 60
-    hour = t / 3600
-    sprintf("%02d:%02d:%02d", hour, min, sec);
+    if t < 0 or t.infinite? or t.nan?   # "not a number"
+      '--:--:--'
+    else
+      t = t.to_i
+      sec = t % 60
+      min  = (t / 60) % 60
+      hour = t / 3600
+      sprintf("%02d:%02d:%02d", hour, min, sec);
+    end
   end
 
   # ETA stands for Estimated Time of Arrival.
   def eta
-    if @current == 0
-      "ETA:  --:--:--"
-    else
-      elapsed = Time.now - @start_time
-      eta = elapsed * @total / @current - elapsed;
-      sprintf("ETA:  %s", format_time(eta))
-    end
+    elapsed = time_now - @start_time
+    eta = elapsed * @total / @running_average - elapsed;
+    sprintf("ETA:  %s", format_time(eta))
   end
 
   def elapsed
-    elapsed = Time.now - @start_time
+    elapsed = time_now - @start_time
     sprintf("Time: %s", format_time(elapsed))
   end
-  
+
   def eol
     if @finished_p then "\n" else "\r" end
   end
@@ -138,24 +156,47 @@ class ProgressBar
   end
 
   def show
-    arguments = @format_arguments.map {|method| 
+    tty? ? show_tty : show_no_tty
+    @previous_time = time_now
+  end
+
+  # Print output to a tty device.
+  def show_tty
+    arguments = @format_arguments.map {|method|
       method = sprintf("fmt_%s", method)
       send(method)
     }
-    line = sprintf(@format, *arguments)
+    line = sprintf(format, *arguments)
 
     width = get_width
-    if line.length == width - 1 
-      @out.print(line + eol)
-      @out.flush
+    if line.length == width - 1
+      @out.write(line + eol)
     elsif line.length >= width
       @terminal_width = [@terminal_width - (line.length - width + 1), 0].max
-      if @terminal_width == 0 then @out.print(line + eol) else show end
+      if @terminal_width == 0 then @out.write(line + eol) else show end
     else # line.length < width - 1
       @terminal_width += width - line.length + 1
       show
     end
-    @previous_time = Time.now
+  end
+
+  # Print output to a non-terminal device, such as a log file.
+  # The terminal width is set to 80 columns.
+  def show_no_tty
+    @out.print("| " + elapsed + eol) and return if finished?
+
+    # Draw title the first time
+    if @last_bar_width.nil?
+      @last_bar_width = 0
+      @terminal_width = @terminal_width - fmt_title.size - elapsed.size - 4
+      @out.print(fmt_title + " |")
+    else
+      bar_width_change = bar_width - @last_bar_width
+      if bar_width_change > 0
+        @out.print(@bar_mark * bar_width_change)
+        @last_bar_width = bar_width
+      end
+    end
   end
 
   def show_if_needed
@@ -168,21 +209,38 @@ class ProgressBar
     end
 
     # Use "!=" instead of ">" to support negative changes
-    if cur_percentage != prev_percentage || 
-        Time.now - @previous_time >= 1 || @finished_p
+    if cur_percentage != prev_percentage ||
+        time_now - @previous_time >= 1 || @finished_p
       show
     end
   end
 
+  def time_now
+    # Ignore Timecop time mocking
+    if Time.respond_to?(:now_without_mock_time)
+      Time.now_without_mock_time
+    # Ignore Delorean time mocking
+    elsif Time.respond_to?(:now_without_delorean)
+      Time.now_without_delorean
+    else
+      Time.now
+    end
+  end
+
+  def tty?
+    @out.tty?
+  end
+
   public
   def clear
+    return unless tty?
     @out.print "\r"
     @out.print(" " * (get_width - 1))
     @out.print "\r"
   end
 
   def finish
-    @current = @total
+    @current = @previous = @running_average = @total
     @finished_p = true
     show
   end
@@ -209,18 +267,21 @@ class ProgressBar
   end
 
   def inc (step = 1)
-    @current += step
-    @current = @total if @current > @total
-    show_if_needed
-    @previous = @current
+    set(@current + step)
   end
 
   def set (count)
-    if count < 0 || count > @total
-      raise "invalid count: #{count} (total: #{@total})"
-    end
-    @current = count
+    # Constrain input to 0 <= count <= 100
+    @current = [ [count, @total].min, 0 ].max
+
+    # Update the exponentially-smoothed average
+    @running_average = @previous * @smoothing +
+                       @running_average * (1.0 - @smoothing)
+
+    # If this makes the percentage change by a tick or more, show it
     show_if_needed
+    
+    # Update for the next iteration
     @previous = @current
   end
 
@@ -234,4 +295,3 @@ class ReversedProgressBar < ProgressBar
     100 - super
   end
 end
-

data/test.rb

@@ -1,9 +1,13 @@
 require 'test/unit'
-require 'lib/progressbar'
+require File.expand_path('../lib/progressbar', __FILE__)
 
 class ProgressBarTest < Test::Unit::TestCase
   SleepUnit = 0.01
 
+  def teardown
+    Time.clear_stubs
+  end
+
   def do_make_progress_bar (title, total)
     ProgressBar.new(title, total)
   end
@@ -106,6 +110,89 @@ class ProgressBarTest < Test::Unit::TestCase
     }
     pbar.finish
   end
+
+  def test_custom_bar
+    custom_bar_class = Class.new(ProgressBar) do
+      def title_width
+        20
+      end
+    end
+    pbar = custom_bar_class.new('test(custom)', 100)
+    total = 100
+    total.times {
+      sleep(SleepUnit)
+      pbar.inc
+    }
+    pbar.finish
+  end
+
+  def test_timecop
+    offset = 3905
+    total = 10000
+    pbar = do_make_progress_bar("test(timecop)", total)
+    Time.stub(:now_without_mock_time, lambda { Time.now_without_stubbing })
+    Time.stub(:now, lambda { Time.now_without_stubbing - offset })
+    0.step(500, 1) {|x|
+      Time.stub(:now, lambda { Time.now_without_stubbing + offset }) if x == 250
+      sleep(SleepUnit)
+      pbar.set(x)
+    }
+    pbar.halt
+  end
+
+  def test_delorean
+    offset = 3905
+    total = 10000
+    pbar = do_make_progress_bar("test(delorean)", total)
+    Time.stub(:now_without_delorean, lambda { Time.now_without_stubbing })
+    Time.stub(:now, lambda { Time.now_without_stubbing - offset })
+    0.step(500, 1) {|x|
+      Time.stub(:now, lambda { Time.now_without_stubbing + offset }) if x == 250
+      sleep(SleepUnit)
+      pbar.set(x)
+    }
+    pbar.halt
+  end
+
+  def test_vary
+    total = 5000
+    pbar = do_make_progress_bar("test(vary)", total)
+    0.step(500, 1) {|x|
+      pbar.set(x)
+      sleep(SleepUnit)
+    }
+    500.step(2000, 3) {|x|
+      pbar.set(x)
+      sleep(SleepUnit)
+    }
+    500.times {
+      pbar.set(2000)
+      sleep(SleepUnit)
+    }
+    2000.step(1500, -1) {|x|
+      pbar.set(x)
+      sleep(SleepUnit)
+    }
+    1500.step(5000, 5) {|x|
+      pbar.set(x)
+      sleep(SleepUnit)
+    }
+    pbar.halt
+  end
+
+  class StubbedTtyProgressBar < ProgressBar
+    def tty?; false; end
+  end
+
+  def test_non_tty
+    total = 1024 * 1024
+    pbar = StubbedTtyProgressBar.new("non-tty compatible", total)
+    0.step(total, 2**14) {|x|
+      pbar.set(x)
+      sleep(SleepUnit)
+    }
+    pbar.finish
+  end
 end
 
 class ReversedProgressBarTest < ProgressBarTest
@@ -114,3 +201,47 @@ class ReversedProgressBarTest < ProgressBarTest
   end
 end
 
+module Stubbing
+  def stub(method_name, value=nil)
+    stubs[method_name.to_sym] = value
+  end
+
+  def clear_stubs
+    stubs.clear
+  end
+
+  def respond_to?(method_name, include_private=false)
+    has_stub?(method_name) || super
+  end
+
+  def method_missing(method_name, *args, &blk)
+    has_stub?(method_name) ? invoke_stub(method_name) : super
+  end
+
+  private
+
+  def stubs
+    @stubs ||= {}
+  end
+
+  def has_stub?(method_name)
+    stubs.keys.include? method_name.to_sym
+  end
+
+  def invoke_stub(method_name)
+    stub = stubs[method_name]
+    stub.respond_to?(:call) ? stub.call : stub
+  end
+end
+
+class Time
+  extend Stubbing
+
+  class << self
+    alias_method :now_without_stubbing, :now
+
+    def now
+      has_stub?(:now) ? invoke_stub(:now) : now_without_stubbing
+    end
+  end
+end

metadata

@@ -1,60 +1,50 @@
---- !ruby/object:Gem::Specification 
+--- !ruby/object:Gem::Specification
 name: ruby-progressbar
-version: !ruby/object:Gem::Version 
+version: !ruby/object:Gem::Version
+  version: 0.11.0
   prerelease: 
-  version: 0.0.10
 platform: ruby
-authors: 
+authors:
 - Satoru Takabayashi
 autorequire: 
 bindir: bin
 cert_chain: []
-
-date: 2009-02-16 00:00:00 -06:00
-default_executable: 
+date: 2012-07-30 00:00:00.000000000 Z
 dependencies: []
-
 description: Ruby/ProgressBar is a text progress bar library for Ruby.
 email: satoru@namazu.org
 executables: []
-
 extensions: []
-
 extra_rdoc_files: []
-
-files: 
+files:
 - GPL_LICENSE
 - RUBY_LICENSE
 - README.md
 - lib/progressbar.rb
 - test.rb
-has_rdoc: true
 homepage: http://github.com/nex3/ruby-progressbar
 licenses: []
-
 post_install_message: 
 rdoc_options: []
-
-require_paths: 
+require_paths:
 - lib
-required_ruby_version: !ruby/object:Gem::Requirement 
+required_ruby_version: !ruby/object:Gem::Requirement
   none: false
-  requirements: 
-  - - ">="
-    - !ruby/object:Gem::Version 
-      version: "0"
-required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
-  requirements: 
-  - - ">="
-    - !ruby/object:Gem::Version 
-      version: "0"
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
 requirements: []
-
 rubyforge_project: 
-rubygems_version: 1.6.1
+rubygems_version: 1.8.24
 signing_key: 
 specification_version: 3
-summary: Ruby/ProgressBar is a text progress bar library for Ruby. It can indicate progress with percentage, a progress bar, and estimated remaining time.
+summary: Ruby/ProgressBar is a text progress bar library for Ruby. It can indicate
+  progress with percentage, a progress bar, and estimated remaining time.
 test_files: []
-