progressbar 0.9.2 → 0.10.0

data/{README.rd → README.rdoc}

@@ -76,6 +76,10 @@ The latest version of Ruby/ProgressBar is available at
     Use  :stat_for_file_transfer instead of :stat to display
     transfered bytes and transfer rate.
 
+--- ProgressBar#long_running
+    Use adaptative running average ton compute ETA, more effective for
+    long-running jobs of jobs whose pseed may vary.
+
 
 ReverseProgressBar class is also available.  The
 functionality is identical to ProgressBar but the direction

data/lib/progressbar.rb

@@ -53,6 +53,10 @@ private
     if @finished_p then elapsed else eta end
   end
 
+  def fmt_stat_for_long_run
+    if @finished_p then elapsed else eta_running_average end
+  end
+
   def fmt_stat_for_file_transfer
     if @finished_p then
       sprintf("%s %s %s", bytes, transfer_rate, elapsed)
@@ -91,7 +95,7 @@ private
     sec = t % 60
     min  = (t / 60) % 60
     hour = t / 3600
-    sprintf("%02d:%02d:%02d", hour, min, sec);
+    sprintf("% 3d:%02d:%02d", hour, min, sec);
   end
 
   # ETA stands for Estimated Time of Arrival.
@@ -101,7 +105,35 @@ private
     else
       elapsed = Time.now - @start_time
       eta = elapsed * @total / @current - elapsed;
-      sprintf("ETA:  %s", format_time(eta))
+      sprintf("ETA: %s", format_time(eta))
+    end
+  end
+
+  # Compute ETA with running average (better suited to long running tasks)
+  def eta_running_average
+    now = Time.now
+
+    # update throughput running average
+    if @total > 0 && @eta_previous && @eta_previous_time
+      current_elapsed = @current - @eta_previous
+      alpha = 0.9 ** current_elapsed
+      current_progress = 1.0 * current_elapsed
+      current_throughput = current_progress / (now - @eta_previous_time)
+      if @eta_throughput
+        @eta_throughput = @eta_throughput * alpha + current_throughput * (1-alpha)
+      else
+        @eta_throughput = current_throughput
+      end
+    end
+
+    @eta_previous = @current
+    @eta_previous_time = now
+
+    if @eta_throughput && @eta_throughput > 0
+      eta = (@total - @current) / @eta_throughput;
+      sprintf("ETA: %s", format_time(eta))
+    else
+      "ETA:  --:--:--"
     end
   end
 
@@ -200,6 +232,10 @@ public
     @format_arguments = [:title, :percentage, :bar, :stat_for_file_transfer]
   end
 
+  def long_running
+    @format_arguments = [:title, :percentage, :bar, :stat_for_long_run]
+  end
+
   def format= (format)
     @format = format
   end

data/progressbar.gemspec

@@ -2,7 +2,7 @@
 
 Gem::Specification.new do |s|
   s.name        = "progressbar"
-  s.version     = "0.9.2"
+  s.version     = "0.10.0"
   s.platform    = Gem::Platform::RUBY
   s.authors     = ["Satoru Takabayashi", "Jose Peleteiro"]
   s.email       = ["satoru@0xcc.net", "jose@peleteiro.net"]

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: progressbar
 version: !ruby/object:Gem::Version
-  version: 0.9.2
+  version: 0.10.0
   prerelease: 
 platform: ruby
 authors:
@@ -10,12 +10,12 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2011-11-22 00:00:00.000000000 -02:00
+date: 2012-02-02 00:00:00.000000000 -02:00
 default_executable: 
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
-  requirement: &70165027226020 !ruby/object:Gem::Requirement
+  requirement: &70119801398300 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -23,10 +23,10 @@ dependencies:
         version: 1.0.0
   type: :development
   prerelease: false
-  version_requirements: *70165027226020
+  version_requirements: *70119801398300
 - !ruby/object:Gem::Dependency
   name: minitest
-  requirement: &70165027225560 !ruby/object:Gem::Requirement
+  requirement: &70119801397840 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -34,10 +34,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70165027225560
+  version_requirements: *70119801397840
 - !ruby/object:Gem::Dependency
   name: yard
-  requirement: &70165027225100 !ruby/object:Gem::Requirement
+  requirement: &70119801429620 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -45,10 +45,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70165027225100
+  version_requirements: *70119801429620
 - !ruby/object:Gem::Dependency
   name: rake
-  requirement: &70165027256880 !ruby/object:Gem::Requirement
+  requirement: &70119801429160 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -56,10 +56,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70165027256880
+  version_requirements: *70119801429160
 - !ruby/object:Gem::Dependency
   name: simplecov
-  requirement: &70165027256420 !ruby/object:Gem::Requirement
+  requirement: &70119801428700 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -67,10 +67,10 @@ dependencies:
         version: 0.3.5
   type: :development
   prerelease: false
-  version_requirements: *70165027256420
+  version_requirements: *70119801428700
 - !ruby/object:Gem::Dependency
   name: bluecloth
-  requirement: &70165027255960 !ruby/object:Gem::Requirement
+  requirement: &70119801428240 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -78,7 +78,7 @@ dependencies:
         version: 0.3.5
   type: :development
   prerelease: false
-  version_requirements: *70165027255960
+  version_requirements: *70119801428240
 description: Ruby/ProgressBar is a text progress bar library for Ruby. It can indicate
   progress with percentage, a progress bar, and estimated remaining time.
 email:
@@ -95,7 +95,7 @@ files:
 - Gemfile
 - Gemfile.lock
 - LICENSE
-- README.rd
+- README.rdoc
 - Rakefile
 - lib/progressbar.rb
 - progressbar.gemspec