progress_bar 0.1.0 → 0.2.0

data/lib/progress_bar/version.rb

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

data/lib/progress_bar.rb

@@ -2,26 +2,27 @@
 require 'options'
 require 'highline'
 
-require File.join(File.dirname(__FILE__), 'progress_bar', 'time_formatter')
-require File.join(File.dirname(__FILE__), 'progress_bar', 'meter')
-require File.join(File.dirname(__FILE__), 'progress_bar', 'meters')
-
 class ProgressBar
 
-  attr_accessor :count, :max, :start
+  attr_accessor :count, :max, :start, :meters
+
+  def initialize(max = 100, meters = :all)
 
-  def initialize *args, &block
-    args, options = Options.parse args
+    @count  = 0
+    @max    = max
+    @start  = Time.now
 
-    @count = options[:count] || 0
-    @max = options[:max] || 100
-    @start = Time.now
+    if meters == :all
+      @meters = [:bar, :counter, :percentage, :elapsed, :eta, :rate]
+    else
+      @meters = meters
+    end
 
     @hl = HighLine.new
   end
 
-  def increment!
-    self.count = count.succ
+  def increment!(count = 1)
+    self.count += count
     write
   end
 
@@ -30,33 +31,38 @@ class ProgressBar
     print to_s
   end
 
-  def bar(width = terminal_width)
-    Bar.new(count, max, width)
+  def remaining
+    max - count
   end
 
-  def counter
-    Counter.new(count, max)
+  def ratio
+    count.to_f / max
   end
 
   def percentage
-    Percentage.new(count, max)
+    ratio * 100
   end
 
   def elapsed
-    Elapsed.new(start)
+    Time.now - start
+  end
+
+  def rate
+    if count > 0
+      count / elapsed
+    else
+      0
+    end
   end
 
   def eta
-    ETA.new(start, count, max)
+    remaining / rate
   end
 
   def to_s
-    width = terminal_width -
-              (counter.width + 1) -
-              (percentage.width + 1) -
-              (elapsed.width + 1) -
-              (eta.width + 1)
-    "#{bar(width)} #{counter} #{percentage} #{elapsed} #{eta}"
+    meters.inject("") do |text, meter|
+      text << render(meter) + " "
+    end.strip
   end
 
   protected
@@ -65,8 +71,86 @@ class ProgressBar
     print "\r"
   end
 
+  def render(meter)
+    send(:"render_#{meter}")
+  end
+
+  def width_of(meter)
+    send(:"#{meter}_width")
+  end
+
+  def render_bar
+    "[" +
+      "#" * (ratio * (bar_width - 2)).ceil +
+      " " * ((1-ratio) * (bar_width - 2)).floor +
+    "]"
+  end
+
+  def render_counter
+    "[%#{max.to_s.length}i/%i]" % [count, max]
+  end
+
+  def render_percentage
+    format = (max % 10 == 0 ? "%3i" : "%6.2f")
+    "[#{format}%%]" % percentage
+  end
+
+  def render_elapsed
+    "[#{format_interval(elapsed)}]"
+  end
+
+  def render_eta
+    "[#{format_interval(eta)}]"
+  end
+
+  def render_rate
+    "[%.2f/s]" % rate
+  end
+
   def terminal_width
     @hl.output_cols.to_i
   end
 
+  def bar_width
+    terminal_width - non_bar_width
+  end
+
+  def non_bar_width
+    meters.reject { |m| m == :bar }.inject(0) do |width, meter|
+      width += width_of(meter) + 1
+    end
+  end
+
+  def counter_width   # [  1/100]
+    max.to_s.length * 2 + 3
+  end
+
+  def percentage_width
+    if max == 100     # [ 24%]
+      6
+    else              # [ 24.0%]
+      8
+    end
+  end
+
+  def elapsed_width
+    format_interval(elapsed).length + 2
+  end
+
+  def eta_width
+    format_interval(eta).length + 2
+  end
+
+  def rate_width     # [ 23.45/s]
+    render_rate.length
+  end
+
+  def format_interval(interval)
+    if interval > 3600
+      "%02i:%02i:%02i" % [interval/3600, interval%3600/60, interval%60]
+    else
+      "%02i:%02i" % [interval/60, interval%60]
+    end
+  end
+
 end

metadata

@@ -1,8 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: progress_bar
 version: !ruby/object:Gem::Version 
+  hash: 23
   prerelease: 
-  version: 0.1.0
+  segments: 
+  - 0
+  - 2
+  - 0
+  version: 0.2.0
 platform: ruby
 authors: 
 - Paul Sasauskas
@@ -10,7 +15,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2011-04-06 00:00:00 -06:00
+date: 2011-04-08 00:00:00 -06:00
 default_executable: 
 dependencies: []
 
@@ -29,19 +34,13 @@ files:
 - README.mkd
 - Rakefile
 - lib/progress_bar.rb
-- lib/progress_bar/meter.rb
-- lib/progress_bar/meters.rb
 - lib/progress_bar/meters/bar.rb
 - lib/progress_bar/meters/counter.rb
 - lib/progress_bar/meters/elapsed.rb
 - lib/progress_bar/meters/eta.rb
 - lib/progress_bar/meters/percentage.rb
-- lib/progress_bar/time_formatter.rb
 - lib/progress_bar/version.rb
 - progress_bar.gemspec
-- test/counter_test.rb
-- test/elapsed_test.rb
-- test/eta_test.rb
 - test/progres_bar_test.rb
 - test/test_helper.rb
 has_rdoc: true
@@ -58,23 +57,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.6.2
+rubygems_version: 1.5.2
 signing_key: 
 specification_version: 3
 summary: Simple Progress Bar for output to a terminal
 test_files: 
-- test/counter_test.rb
-- test/elapsed_test.rb
-- test/eta_test.rb
 - test/progres_bar_test.rb
 - test/test_helper.rb

data/lib/progress_bar/meter.rb

@@ -1,5 +0,0 @@
-
-class ProgressBar
-  class Meter
-  end
-end

data/lib/progress_bar/meters.rb

@@ -1,10 +0,0 @@
-
-%w[
-  counter
-  bar
-  percentage
-  elapsed
-  eta
-].each do |meter|
-  require File.join(File.dirname(__FILE__), 'meters', meter)
-end

data/lib/progress_bar/time_formatter.rb

@@ -1,15 +0,0 @@
-
-class ProgressBar
-  module TimeFormatter
-
-    def format_interval(interval)
-      if interval > 3600
-        "%02i:%02i:%02i" % [interval/3600, interval%3600/60, interval%60]
-      else
-        "%02i:%02i" % [interval/60, interval%60]
-      end
-    end
-
-  end
-end
-

data/test/counter_test.rb

@@ -1,15 +0,0 @@
-require File.expand_path(File.join(File.dirname(__FILE__), 'test_helper'))
-
-describe "Counter formatter" do
-  before do
-    @counter = ProgressBar::Counter.new(50, 100)
-  end
-
-  it 'should format properly' do
-    @counter.to_s.must_equal "[ 50/100]"
-  end
-
-  it 'should have the correct width' do
-    @counter.width.must_equal 9
-  end
-end

data/test/elapsed_test.rb

@@ -1,33 +0,0 @@
-require File.expand_path(File.join(File.dirname(__FILE__), 'test_helper'))
-
-describe "Elapsed formatter" do
-  before do
-    start = Time.now - 60
-    @elapsed = ProgressBar::Elapsed.new(start)
-  end
-
-  it 'should format properly' do
-    @elapsed.to_s.must_equal "[01:00]"
-  end
-
-  it 'should have the correct width' do
-    @elapsed.width.must_equal 7
-  end
-
-  describe "long running tasks" do
-    before do
-      start = Time.now - 6*3600
-      @elapsed = ProgressBar::Elapsed.new(start)
-    end
-
-    it 'should format properly' do
-      @elapsed.to_s.must_equal "[06:00:00]"
-    end
-
-    it 'should have the correct width' do
-      @elapsed.width.must_equal 10
-    end
-
-  end
-
-end

data/test/eta_test.rb

@@ -1,44 +0,0 @@
-require File.expand_path(File.join(File.dirname(__FILE__), 'test_helper'))
-
-describe "ETA formatter" do
-  before do
-    start = Time.now - 60
-    @eta = ProgressBar::ETA.new(start, 50, 100)
-  end
-
-  it 'should format properly' do
-    @eta.to_s.must_equal "[ETA: 01:00]"
-  end
-
-  it 'should have the correct width' do
-    @eta.width.must_equal 12
-  end
-
-  it 'should be 0 at the end' do
-    eta = ProgressBar::ETA.new(Time.now - 5, 100, 100)
-    eta.remaining.must_equal 0
-  end
-
-  it 'should not have an error at the start' do
-    eta = ProgressBar::ETA.new(Time.now, 0, 100)
-    eta.remaining.must_equal 0
-    eta.to_s.must_equal "[ETA: 00:00]"
-  end
-
-  describe "long running tasks" do
-    before do
-      start = Time.now - 6*3600
-      @eta = ProgressBar::ETA.new(start, 50, 100)
-    end
-
-    it 'should format properly' do
-      @eta.to_s.must_equal "[ETA: 06:00:00]"
-    end
-
-    it 'should have the correct width' do
-      @eta.width.must_equal 15
-    end
-
-  end
-
-end