progressbar_zobar 0.9.2.1 → 0.21.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: fb5b18eadd00416944ea4ddbbc2efc3857067781
+  data.tar.gz: a043ca73987bb4c2c601636213d120e4557b72e7
+SHA512:
+  metadata.gz: 56587a8c0cb68fb7fe6472fa138de8b9924aead465612ad95f577986a58b0f78158a3e7749412984a7388df25bf0dcdc50252901e5068e896910d189db2b8ace
+  data.tar.gz: 17b47f96eae5bbbe7871895bb5129166b6b2a8561bdab31fa41eb862d857162989647f77e747465dc0bd25c825579c1f45b6c7dafabe2774da411cc5605840d3

data/.gitignore

@@ -16,8 +16,10 @@ tmtags
 ## PROJECT::GENERAL
 .document
 coverage
+*.gem
+.rbenv-gemsets
 rdoc
 pkg
 
 ## PROJECT::SPECIFIC
-*.gem
+/.rake_t_cache

data/.ruby-version

@@ -0,0 +1 @@
+2.1.0

data/.travis.yml

@@ -2,7 +2,5 @@ rvm:
   - 1.8.7
   - 1.9.2
   - 1.9.3
-  - rbx-2.0
   - jruby
-  - ruby-head
   - ree

data/Gemfile

@@ -1,4 +1,4 @@
-source :rubygems
+source "https://rubygems.org"
 
 # Specify your gem's dependencies in ruby-duration.gemspec
 gemspec

data/Gemfile.lock

@@ -1,10 +1,10 @@
 PATH
   remote: .
   specs:
-    progressbar_zobar (0.9.2.1)
+    progressbar_zobar (0.21.0.1)
 
 GEM
-  remote: http://rubygems.org/
+  remote: https://rubygems.org/
   specs:
     bluecloth (2.1.0)
     minitest (2.2.2)

data/{README.rd → README.rdoc}

@@ -11,7 +11,7 @@ Ruby/ProgressBar is a text progress bar library for Ruby.
 It can indicate progress with percentage, a progress bar,
 and estimated remaining time.
 
-The latest version of Ruby/ProgressBar is available at 
+The latest version of Ruby/ProgressBar is available at
 ((<URL:http://namazu.org/~satoru/ruby-progressbar/>))
 .
 
@@ -29,9 +29,15 @@ The latest version of Ruby/ProgressBar is available at
   >> (1..100).each{|x| sleep(0.1); pbar.set(x)}; pbar.finish
   test:           67% |oooooooooooooooooooooooooo              | ETA:  00:00:03
 
+  >> ProgressBar.new("test", 100) do |pbar|
+  >>   100.times { sleep(0.1); pbar.inc }
+  >> end
+  test:          100% |oooooooooooooooooooooooooooooooooooooooo| Time: 00:00:10
+
+
 == API
 
---- ProgressBar#new (title, total, out = STDERR)
+--- ProgressBar#new (title, total, out = STDERR, &block)
     Display the initial progress bar and return a
     ProgressBar object.  ((|title|)) specifies the title,
     and ((|total|)) specifies the total cost of processing.
@@ -41,6 +47,9 @@ The latest version of Ruby/ProgressBar is available at
     more percent is proceeded or one or more seconds are
     elapsed from the previous display.
 
+    It also accepts a block in case you prefer not needing
+    to .finish the bar (see example above).
+
 --- ProgressBar#inc (step = 1)
     Increase the internal counter by ((|step|)) and update
     the display of the progress bar. Display the estimated
@@ -82,6 +91,10 @@ The latest version of Ruby/ProgressBar is available at
 --- ProgressBar#total=
     Change the progress bar's maximum value.
 
+--- ProgressBar#long_running
+    Use adaptative running average to compute ETA, more effective for
+    long-running jobs or jobs whose speed may vary.
+
 
 ReverseProgressBar class is also available.  The
 functionality is identical to ProgressBar but the direction

data/lib/progressbar.rb

@@ -10,7 +10,7 @@
 #
 
 class ProgressBar
-  VERSION = "0.9"
+  VERSION = "0.21.0.1"
 
   def initialize (title, total, out = STDERR)
     @title = title
@@ -28,6 +28,10 @@ class ProgressBar
     @format_arguments = [:title, :percentage, :bar, :stat]
     clear
     show
+    if block_given?
+      yield(self)
+      finish
+    end
   end
 
   attr_reader   :title
@@ -53,6 +57,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 +99,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 +109,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
 
@@ -124,7 +160,7 @@ private
 
   DEFAULT_WIDTH = 80
   def get_term_width
-    if ENV['COLUMNS'] =~ /^\d+$/
+    term_width = if ENV['COLUMNS'] =~ /^\d+$/
       ENV['COLUMNS'].to_i
     elsif (RUBY_PLATFORM =~ /java/ || (!STDIN.tty? && ENV['TERM'])) && shell_command_exists?('tput')
       `tput cols`.to_i
@@ -133,6 +169,12 @@ private
     else
       DEFAULT_WIDTH
     end
+
+    if term_width > 0
+      term_width
+    else
+      DEFAULT_WIDTH
+    end
   rescue
     DEFAULT_WIDTH
   end
@@ -203,6 +245,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

@@ -1,12 +1,13 @@
 # -*- encoding: utf-8 -*-
+require File.expand_path("../lib/progressbar", __FILE__)
 
 Gem::Specification.new do |s|
   s.name        = "progressbar_zobar"
-  s.version     = "0.9.2.1"
+  s.version     = ProgressBar::VERSION
   s.platform    = Gem::Platform::RUBY
   s.authors     = ["Satoru Takabayashi", "Jose Peleteiro", 'David P Kleinschmidt']
   s.email       = ["satoru@0xcc.net", "jose@peleteiro.net", 'david@kleinschmidt.name']
-  s.homepage    = "http://github.com/zobar/progressbar"
+  s.homepage    = "http://bitbucket.org/zobar/progressbar"
   s.summary     = 'Text progress bar library for Ruby, forked from progressbar.'
   s.description = "Fork of progressbar that allows changing the progress bar's title and total while still in progress."
 

data/test/test.rb

@@ -4,8 +4,8 @@ require 'progressbar'
 class ProgressBarTest < Test::Unit::TestCase
   SleepUnit = 0.01
 
-  def do_make_progress_bar (title, total)
-    ProgressBar.new(title, total)
+  def do_make_progress_bar(title, total, &block)
+    ProgressBar.new(title, total, &block)
   end
 
   def test_bytes
@@ -128,10 +128,20 @@ class ProgressBarTest < Test::Unit::TestCase
     }
     pbar.finish
   end
+  
+  def test_with_block
+    total = 100
+    do_make_progress_bar("test(block)", total) do |pbar|
+      total.times {
+        sleep(SleepUnit)
+        pbar.inc
+      }
+    end
+  end
 end
 
 class ReversedProgressBarTest < ProgressBarTest
-  def do_make_progress_bar (title, total)
-    ReversedProgressBar.new(title, total)
+  def do_make_progress_bar(title, total, &block)
+    ReversedProgressBar.new(title, total, &block)
   end
 end

metadata

@@ -1,8 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: progressbar_zobar
 version: !ruby/object:Gem::Version
-  version: 0.9.2.1
-  prerelease: 
+  version: 0.21.0.1
 platform: ruby
 authors:
 - Satoru Takabayashi
@@ -11,74 +10,92 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2011-11-28 00:00:00.000000000Z
+date: 2014-03-16 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
-  requirement: &2153885500 !ruby/object:Gem::Requirement
-    none: false
+  requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ! '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: 1.0.0
   type: :development
   prerelease: false
-  version_requirements: *2153885500
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.0.0
 - !ruby/object:Gem::Dependency
   name: minitest
-  requirement: &2153885040 !ruby/object:Gem::Requirement
-    none: false
+  requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ! '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *2153885040
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: yard
-  requirement: &2153884580 !ruby/object:Gem::Requirement
-    none: false
+  requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ! '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *2153884580
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: rake
-  requirement: &2153884120 !ruby/object:Gem::Requirement
-    none: false
+  requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ! '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *2153884120
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: simplecov
-  requirement: &2153883660 !ruby/object:Gem::Requirement
-    none: false
+  requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ! '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: 0.3.5
   type: :development
   prerelease: false
-  version_requirements: *2153883660
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.3.5
 - !ruby/object:Gem::Dependency
   name: bluecloth
-  requirement: &2153883200 !ruby/object:Gem::Requirement
-    none: false
+  requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ! '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: 0.3.5
   type: :development
   prerelease: false
-  version_requirements: *2153883200
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.3.5
 description: Fork of progressbar that allows changing the progress bar's title and
   total while still in progress.
 email:
@@ -89,41 +106,40 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- .gitignore
-- .rvmrc
-- .travis.yml
+- ".gitignore"
+- ".ruby-version"
+- ".travis.yml"
 - ChangeLog
 - Gemfile
 - Gemfile.lock
 - LICENSE
-- README.rd
+- README.rdoc
 - Rakefile
 - lib/progressbar.rb
 - progressbar.gemspec
 - test/test.rb
-homepage: http://github.com/zobar/progressbar
+homepage: http://bitbucket.org/zobar/progressbar
 licenses: []
+metadata: {}
 post_install_message: 
 rdoc_options:
-- --charset=UTF-8
+- "--charset=UTF-8"
 require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
-  none: false
   requirements:
-  - - ! '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 required_rubygems_version: !ruby/object:Gem::Requirement
-  none: false
   requirements:
-  - - ! '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: 1.3.6
 requirements: []
 rubyforge_project: 
-rubygems_version: 1.8.10
+rubygems_version: 2.2.0
 signing_key: 
-specification_version: 3
+specification_version: 4
 summary: Text progress bar library for Ruby, forked from progressbar.
 test_files: []

data/.rvmrc

@@ -1 +0,0 @@
-rvm 1.9.2@progressbar