progress_bar 0.2.0 → 0.3.0

data/.rspec

@@ -0,0 +1,4 @@
+--format
+documentation
+--color
+--backtrace

data/Gemfile

@@ -4,7 +4,9 @@ source "http://rubygems.org"
 gem "highline"
 gem "options"
 
-group :development do
+group :development, :test do
+  gem "rspec"
+  gem "timecop"
 end
 
 

data/lib/progress_bar.rb

@@ -6,13 +6,13 @@ class ProgressBar
 
   attr_accessor :count, :max, :start, :meters
 
-  def initialize(max = 100, meters = :all)
+  def initialize(max = 100, *meters)
 
     @count  = 0
     @max    = max
     @start  = Time.now
 
-    if meters == :all
+    if meters.empty?
       @meters = [:bar, :counter, :percentage, :elapsed, :eta, :rate]
     else
       @meters = meters
@@ -56,7 +56,11 @@ class ProgressBar
   end
 
   def eta
-    remaining / rate
+    if count > 0
+      remaining / rate
+    else
+      0
+    end
   end
 
   def to_s
@@ -67,6 +71,10 @@ class ProgressBar
 
   protected
 
+  def print(str)
+    $stderr.write str
+  end
+
   def clear!
     print "\r"
   end
@@ -87,11 +95,11 @@ class ProgressBar
   end
 
   def render_counter
-    "[%#{max.to_s.length}i/%i]" % [count, max]
+    "[%#{max_width}i/%i]" % [count, max]
   end
 
   def render_percentage
-    format = (max % 10 == 0 ? "%3i" : "%6.2f")
+    format = (max == 100 ? "%3i" : "%6.2f")
     "[#{format}%%]" % percentage
   end
 
@@ -104,7 +112,7 @@ class ProgressBar
   end
 
   def render_rate
-    "[%.2f/s]" % rate
+    "[%#{max_width+3}.2f/s]" % rate
   end
 
   def terminal_width
@@ -122,13 +130,13 @@ class ProgressBar
   end
 
   def counter_width   # [  1/100]
-    max.to_s.length * 2 + 3
+    max_width * 2 + 3
   end
 
   def percentage_width
-    if max == 100     # [ 24%]
+    if max == 100      # [ 24%]
       6
-    else              # [ 24.0%]
+    else               # [ 24.0%]
       8
     end
   end
@@ -145,6 +153,10 @@ class ProgressBar
     render_rate.length
   end
 
+  def max_width
+    max.to_s.length
+  end
+
   def format_interval(interval)
     if interval > 3600
       "%02i:%02i:%02i" % [interval/3600, interval%3600/60, interval%60]

data/lib/progress_bar/version.rb

@@ -1,3 +1,3 @@
 module ProgressBar
-  VERSION = "0.2.0"
+  VERSION = "0.3.0"
 end

data/lib/progress_bar/version.rbc

@@ -0,0 +1,130 @@
+!RBIX
+4271523011621227713
+x
+M
+1
+n
+n
+x
+10
+__script__
+i
+28
+99
+7
+0
+65
+49
+1
+2
+13
+99
+12
+7
+2
+12
+7
+3
+12
+65
+12
+49
+4
+4
+15
+49
+2
+0
+15
+2
+11
+I
+6
+I
+0
+I
+0
+I
+0
+n
+p
+5
+x
+11
+ProgressBar
+x
+11
+open_module
+x
+15
+__module_init__
+M
+1
+n
+n
+x
+11
+ProgressBar
+i
+12
+5
+66
+65
+7
+0
+7
+1
+64
+49
+2
+2
+11
+I
+3
+I
+0
+I
+0
+I
+0
+n
+p
+3
+x
+7
+VERSION
+s
+5
+0.2.0
+x
+9
+const_set
+p
+3
+I
+2
+I
+2
+I
+c
+x
+67
+/Users/rando/Code/personal/progress_bar/lib/progress_bar/version.rb
+p
+0
+x
+13
+attach_method
+p
+3
+I
+0
+I
+1
+I
+1c
+x
+67
+/Users/rando/Code/personal/progress_bar/lib/progress_bar/version.rb
+p
+0

data/test/bar_test.rb

@@ -0,0 +1,44 @@
+require File.expand_path(File.join(File.dirname(__FILE__), 'spec_helper'))
+
+describe 'ProgressBar bar output' do
+  before do
+    @progress_bar = ProgressBar.new(100, :bar)
+    @progress_bar.stub(:terminal_width) { 12 }
+  end
+
+  subject { @progress_bar.to_s }
+
+  describe 'at count=0' do
+    before do
+      @progress_bar.count = 0
+    end
+
+    it { should == "[          ]" }
+  end
+
+  describe 'at count=50' do
+    before do
+      @progress_bar.count = 50
+    end
+
+    it { should == "[#####     ]" }
+  end
+
+  describe 'at count=100' do
+    before do
+      @progress_bar.count = 100
+    end
+
+    it { should == "[##########]" }
+  end
+
+  describe 'at count=25 (non-integer divide, should round up)' do
+    before do
+      @progress_bar.count = 25
+    end
+
+    it { should == "[###       ]" }
+  end
+
+end
+

data/test/counter_test.rb

@@ -0,0 +1,50 @@
+require File.expand_path(File.join(File.dirname(__FILE__), 'spec_helper'))
+
+describe 'ProgressBar counter output' do
+  before do
+    @progress_bar = ProgressBar.new(100, :counter)
+  end
+
+  subject { @progress_bar.to_s }
+
+  describe 'at count=0' do
+    before do
+      @progress_bar.count = 0
+    end
+
+    it { should == "[  0/100]" }
+  end
+
+  describe 'at count=50' do
+    before do
+      @progress_bar.count = 50
+    end
+
+    it { should == "[ 50/100]" }
+  end
+
+  describe 'at count=100' do
+    before do
+      @progress_bar.count = 100
+    end
+
+    it { should == "[100/100]" }
+  end
+
+  describe 'with a shorter max' do
+    before do
+      @progress_bar = ProgressBar.new(42, :counter)
+    end
+
+    it { should == '[ 0/42]' }
+  end
+
+  describe 'with a longer max' do
+    before do
+      @progress_bar = ProgressBar.new(4242, :counter)
+    end
+
+    it { should == '[   0/4242]' }
+  end
+
+end

data/test/elapsed_test.rb

@@ -0,0 +1,48 @@
+
+require File.expand_path(File.join(File.dirname(__FILE__), 'spec_helper'))
+
+describe 'ProgressBar elapsed output' do
+  before do
+    Timecop.freeze Time.utc(2010, 3, 10, 0, 0, 0)
+    @progress_bar = ProgressBar.new(100, :elapsed)
+    Timecop.freeze Time.utc(2010, 3, 10, 0, 0, 10) # 10 seconds later
+  end
+
+  subject { @progress_bar.to_s }
+
+  describe 'at count=0' do
+    before do
+      @progress_bar.count = 0
+    end
+
+    it { should == "[00:10]" }
+  end
+
+  describe 'at count=50' do
+    before do
+      @progress_bar.count = 50
+    end
+
+    it { should == "[00:10]" }
+  end
+
+  describe 'at count=100' do
+    before do
+      @progress_bar.count = 100
+    end
+
+    it { should == "[00:10]" }
+  end
+
+  describe 'with times over 1 hour' do
+    before do
+      Timecop.freeze Time.utc(2010, 3, 10, 0, 0, 0)
+      @progress_bar = ProgressBar.new(42, :elapsed)
+      Timecop.freeze Time.utc(2010, 3, 10, 2, 0, 0) # 2 hours later
+    end
+
+    it { should == '[02:00:00]' }
+  end
+
+end
+

data/test/eta_test.rb

@@ -0,0 +1,50 @@
+require File.expand_path(File.join(File.dirname(__FILE__), 'spec_helper'))
+
+describe 'ProgressBar eta output' do
+  before do
+    Timecop.freeze Time.utc(2010, 3, 10, 0, 0, 0)
+    @progress_bar = ProgressBar.new(100, :eta)
+    Timecop.freeze Time.utc(2010, 3, 10, 0, 0, 10) # 10 seconds later
+  end
+
+  subject { @progress_bar.to_s }
+
+  describe 'at count=0' do
+    before do
+      @progress_bar.count = 0
+    end
+
+    it { should == "[00:00]" }
+  end
+
+  describe 'at count=50' do
+    before do
+      @progress_bar.count = 50
+    end
+
+    it { should == "[00:10]" }
+  end
+
+  describe 'at count=100' do
+    before do
+      @progress_bar.count = 100
+    end
+
+    it { should == "[00:00]" }
+  end
+
+  describe 'with times over 1 hour' do
+    before do
+      Timecop.freeze Time.utc(2010, 3, 10, 0, 0, 0)
+      @progress_bar = ProgressBar.new(42, :eta)
+      @progress_bar.count = 21
+      Timecop.freeze Time.utc(2010, 3, 10, 2, 0, 0) # 2 hours later
+    end
+
+    it { should == '[02:00:00]' }
+  end
+
+end
+
+
+

data/test/percentage_test.rb

@@ -0,0 +1,44 @@
+require File.expand_path(File.join(File.dirname(__FILE__), 'spec_helper'))
+
+describe 'ProgressBar percentage output' do
+  before do
+    @progress_bar = ProgressBar.new(100, :percentage)
+  end
+
+  subject { @progress_bar.to_s }
+
+  describe 'at count=0' do
+    before do
+      @progress_bar.count = 0
+    end
+
+    it { should == "[  0%]" }
+  end
+
+  describe 'at count=50' do
+    before do
+      @progress_bar.count = 50
+    end
+
+    it { should == "[ 50%]" }
+  end
+
+  describe 'at count=100' do
+    before do
+      @progress_bar.count = 100
+    end
+
+    it { should == "[100%]" }
+  end
+
+  describe 'with a max that is not 100' do
+    before do
+      @progress_bar = ProgressBar.new(42, :percentage)
+      @progress_bar.count = 21
+    end
+
+    it { should == '[ 50.00%]' }
+  end
+
+end
+

data/test/progress_bar_test.rb

@@ -0,0 +1,39 @@
+require File.expand_path(File.join(File.dirname(__FILE__), 'spec_helper'))
+
+describe 'ProgressBar bar output' do
+  before do
+    Timecop.freeze Time.utc(2010, 3, 10, 0, 0, 0)
+    @progress_bar = ProgressBar.new(100)
+    @progress_bar.stub(:terminal_width) { 60 }
+    Timecop.freeze Time.utc(2010, 3, 10, 0, 0, 10) # 10 seconds later
+  end
+
+  subject { @progress_bar.to_s }
+
+  describe 'at count=0' do
+    before do
+      @progress_bar.count = 0
+    end
+
+    it { should == "[              ] [  0/100] [  0%] [00:10] [00:00] [  0.00/s]" }
+  end
+
+  describe 'at count=50' do
+    before do
+      @progress_bar.count = 50
+    end
+
+    it { should == "[#######       ] [ 50/100] [ 50%] [00:10] [00:10] [  5.00/s]" }
+  end
+
+  describe 'at count=100' do
+    before do
+      @progress_bar.count = 100
+    end
+
+    it { should == "[##############] [100/100] [100%] [00:10] [00:00] [ 10.00/s]" }
+  end
+
+end
+
+

data/test/rate_test.rb

@@ -0,0 +1,63 @@
+require File.expand_path(File.join(File.dirname(__FILE__), 'spec_helper'))
+
+describe 'ProgressBar rate output' do
+  before do
+    Timecop.freeze Time.utc(2010, 3, 10, 0, 0, 0)
+    @progress_bar = ProgressBar.new(100, :rate)
+    Timecop.freeze Time.utc(2010, 3, 10, 0, 0, 10) # 10 seconds later
+  end
+
+  subject { @progress_bar.to_s }
+
+  describe 'at count=0' do
+    before do
+      @progress_bar.count = 0
+    end
+
+    it { should == "[  0.00/s]" }
+  end
+
+  describe 'at count=50' do
+    before do
+      @progress_bar.count = 50
+    end
+
+    it { should == "[  5.00/s]" }
+  end
+
+  describe 'at count=100' do
+    before do
+      @progress_bar.count = 100
+    end
+
+    it { should == "[ 10.00/s]" }
+  end
+
+  describe 'with a shorter max' do
+    before do
+      Timecop.freeze Time.utc(2010, 3, 10, 0, 0, 0)
+      @progress_bar = ProgressBar.new(42, :rate)
+      @progress_bar.count = 21
+      Timecop.freeze Time.utc(2010, 3, 10, 0, 0, 10) # 10 seconds later
+    end
+
+    it { should == '[ 2.10/s]' }
+  end
+
+  describe 'with a longer max' do
+    before do
+      Timecop.freeze Time.utc(2010, 3, 10, 0, 0, 0)
+      @progress_bar = ProgressBar.new(4242, :rate)
+      @progress_bar.count = 21
+      Timecop.freeze Time.utc(2010, 3, 10, 0, 0, 10) # 10 seconds later
+    end
+
+    it { should == '[   2.10/s]' }
+  end
+
+end
+
+
+
+
+

data/test/spec_helper.rb

@@ -0,0 +1,12 @@
+
+require File.expand_path(File.join(File.dirname(__FILE__), '..', 'lib/progress_bar'))
+
+require 'rspec'
+require 'timecop'
+
+RSpec.configure do |cfg|
+  cfg.after do
+    Timecop.return
+  end
+end
+

metadata

@@ -1,13 +1,8 @@
 --- !ruby/object:Gem::Specification 
 name: progress_bar
 version: !ruby/object:Gem::Version 
-  hash: 23
   prerelease: 
-  segments: 
-  - 0
-  - 2
-  - 0
-  version: 0.2.0
+  version: 0.3.0
 platform: ruby
 authors: 
 - Paul Sasauskas
@@ -15,7 +10,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2011-04-08 00:00:00 -06:00
+date: 2011-04-10 00:00:00 -06:00
 default_executable: 
 dependencies: []
 
@@ -30,9 +25,11 @@ extra_rdoc_files: []
 
 files: 
 - .gitignore
+- .rspec
 - Gemfile
 - README.mkd
 - Rakefile
+- examples/simple.rb
 - lib/progress_bar.rb
 - lib/progress_bar/meters/bar.rb
 - lib/progress_bar/meters/counter.rb
@@ -40,9 +37,16 @@ files:
 - lib/progress_bar/meters/eta.rb
 - lib/progress_bar/meters/percentage.rb
 - lib/progress_bar/version.rb
+- lib/progress_bar/version.rbc
 - progress_bar.gemspec
-- test/progres_bar_test.rb
-- test/test_helper.rb
+- test/bar_test.rb
+- test/counter_test.rb
+- test/elapsed_test.rb
+- test/eta_test.rb
+- test/percentage_test.rb
+- test/progress_bar_test.rb
+- test/rate_test.rb
+- test/spec_helper.rb
 has_rdoc: true
 homepage: http://www.github.com/paul/progress_bar
 licenses: []
@@ -57,26 +61,26 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
-      hash: 3
-      segments: 
-      - 0
       version: "0"
 required_rubygems_version: !ruby/object:Gem::Requirement 
   none: false
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
-      hash: 3
-      segments: 
-      - 0
       version: "0"
 requirements: []
 
 rubyforge_project: progress_bar
-rubygems_version: 1.5.2
+rubygems_version: 1.6.2
 signing_key: 
 specification_version: 3
 summary: Simple Progress Bar for output to a terminal
 test_files: 
-- test/progres_bar_test.rb
-- test/test_helper.rb
+- test/bar_test.rb
+- test/counter_test.rb
+- test/elapsed_test.rb
+- test/eta_test.rb
+- test/percentage_test.rb
+- test/progress_bar_test.rb
+- test/rate_test.rb
+- test/spec_helper.rb

data/test/test_helper.rb

@@ -1,6 +0,0 @@
-
-require 'minitest/spec'
-require 'minitest/autorun'
-
-require File.expand_path(File.join(File.dirname(__FILE__), '..', 'lib/progress_bar'))
-