progress_bar 0.1.0

data/.gitignore

@@ -0,0 +1,4 @@
+*.gem
+.bundle
+Gemfile.lock
+pkg/*

data/Gemfile

@@ -0,0 +1,10 @@
+# A sample Gemfile
+source "http://rubygems.org"
+
+gem "highline"
+gem "options"
+
+group :development do
+end
+
+

data/README.mkd

@@ -0,0 +1,67 @@
+
+# ProgressBar
+
+*ProgressBar* is a simple Ruby library for displaying progress of
+long-running tasks on the console. It is intended to be easy to use
+first, and configurable for additional needs.
+
+# Installation
+
+    gem install progress_bar
+
+# Examples
+
+## The Easy Way
+
+
+    require 'progress_bar'
+    bar = ProgressBar.new
+
+    100.times do
+      sleep 0.1
+      bar.increment!
+    end
+
+Produces output like:
+
+    [#######################################                           ] [ 59.00%] [00:06]
+
+*Note: It may not be exactly like this. I might have changed the default
+meters between now and when I wrote this readme, and forgotten to update
+it.*
+
+## Setting the Max
+
+Usually, the defaults should be fine, the only thing you'll need to
+tweak is the max.
+
+    bar = ProgressBar.new(1000)
+
+## Larger Steps
+
+If you want to process several things, and update less often, you can
+pass a number to `#increment!`
+
+    bar.increment! 42
+
+## The Configurable Way
+
+    bar = ProgressBar.new do |cfg|
+      cfg.width = 60
+      cfg.max   = 1000
+      cfg.color = true
+      cfg.meters = [:bar, :eta]
+
+      cfg.bar.width = 40
+      cfg.bar.fill = '#'
+      cfg.bar.empty = ' '
+      cfg.bar.prefix = '['
+      cfg.bar.suffix = ']'
+
+      cfg.eta.format = "%H:%M:%S"
+    end
+
+
+
+
+

data/Rakefile

@@ -0,0 +1,2 @@
+require 'bundler'
+Bundler::GemHelper.install_tasks

data/lib/progress_bar/meter.rb

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

data/lib/progress_bar/meters/bar.rb

@@ -0,0 +1,31 @@
+
+class ProgressBar
+  class Bar < Meter
+
+    attr_reader :count, :max, :width
+
+    def initialize(count, max, width)
+      @count, @max, @width = count, max, width
+    end
+
+    def to_s
+      "[" +
+        "#" * progress_width +
+        " " * remaining_width +
+      "]"
+    end
+
+    def bar_width
+      width - 2
+    end
+
+    def progress_width
+      ((count.to_f / max) * bar_width).ceil
+    end
+
+    def remaining_width
+      bar_width - progress_width
+    end
+
+  end
+end

data/lib/progress_bar/meters/counter.rb

@@ -0,0 +1,24 @@
+
+class ProgressBar
+  class Counter < Meter
+
+    attr_reader :count, :max
+
+    def initialize(count, max)
+      @count, @max = count, max
+    end
+
+    def to_s
+      "[%#{max_counter_width}i/%i]" % [count, max]
+    end
+
+    def width
+      max.to_s.length * 2 + 3
+    end
+
+    def max_counter_width
+      max.to_s.length
+    end
+
+  end
+end

data/lib/progress_bar/meters/elapsed.rb

@@ -0,0 +1,26 @@
+class ProgressBar
+  class Elapsed < Meter
+
+    include TimeFormatter
+
+    attr_reader :start
+
+    def initialize start
+      @start = start
+    end
+
+    def elapsed
+      Time.now - start
+    end
+
+    def to_s
+      "[#{format_interval(elapsed)}]"
+    end
+
+    def width
+      format_interval(elapsed).length + 2
+    end
+
+  end
+end
+

data/lib/progress_bar/meters/eta.rb

@@ -0,0 +1,36 @@
+class ProgressBar
+  class ETA < Meter
+
+    include TimeFormatter
+
+    attr_reader :start, :count, :max
+
+    def initialize start, count, max
+      @start, @count, @max = start, count, max
+    end
+
+    def elapsed
+      Time.now - start
+    end
+
+    def average
+      if count == 0
+        0
+      else
+        elapsed / count
+      end
+    end
+
+    def remaining
+      (max - count) * average
+    end
+
+    def to_s
+      "[ETA: #{format_interval(remaining)}]"
+    end
+
+    def width
+      format_interval(elapsed).length + 7
+    end
+  end
+end

data/lib/progress_bar/meters/percentage.rb

@@ -0,0 +1,20 @@
+
+class ProgressBar
+  class Percentage < Meter
+
+    attr_reader :count, :max
+
+    def initialize count, max
+      @count, @max = count, max
+    end
+
+    def to_s
+      "[%6.2f%%]" % (count.to_f / max * 100)
+    end
+
+    def width
+      9
+    end
+
+  end
+end

data/lib/progress_bar/meters.rb

@@ -0,0 +1,10 @@
+
+%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

@@ -0,0 +1,15 @@
+
+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/lib/progress_bar/version.rb

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

data/lib/progress_bar.rb

@@ -0,0 +1,72 @@
+
+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
+
+  def initialize *args, &block
+    args, options = Options.parse args
+
+    @count = options[:count] || 0
+    @max = options[:max] || 100
+    @start = Time.now
+
+    @hl = HighLine.new
+  end
+
+  def increment!
+    self.count = count.succ
+    write
+  end
+
+  def write
+    clear!
+    print to_s
+  end
+
+  def bar(width = terminal_width)
+    Bar.new(count, max, width)
+  end
+
+  def counter
+    Counter.new(count, max)
+  end
+
+  def percentage
+    Percentage.new(count, max)
+  end
+
+  def elapsed
+    Elapsed.new(start)
+  end
+
+  def eta
+    ETA.new(start, count, max)
+  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}"
+  end
+
+  protected
+
+  def clear!
+    print "\r"
+  end
+
+  def terminal_width
+    @hl.output_cols.to_i
+  end
+
+end

data/progress_bar.gemspec

@@ -0,0 +1,21 @@
+# -*- encoding: utf-8 -*-
+$:.push File.expand_path("../lib", __FILE__)
+require "progress_bar/version"
+
+Gem::Specification.new do |s|
+  s.name        = "progress_bar"
+  s.version     = ProgressBar::VERSION
+  s.platform    = Gem::Platform::RUBY
+  s.authors     = ["Paul Sasauskas"]
+  s.email       = ["psadauskas@gmail.com"]
+  s.homepage    = "http://www.github.com/paul/progress_bar"
+  s.summary     = %q{Simple Progress Bar for output to a terminal}
+  s.description = %q{Give people feedback about long-running tasks without overloading them with information: Use a progress bar, like Curl or Wget!}
+
+  s.rubyforge_project = "progress_bar"
+
+  s.files         = `git ls-files`.split("\n")
+  s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
+  s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
+  s.require_paths = ["lib"]
+end

data/test/counter_test.rb

@@ -0,0 +1,15 @@
+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

@@ -0,0 +1,33 @@
+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

@@ -0,0 +1,44 @@
+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

data/test/progres_bar_test.rb

@@ -0,0 +1,9 @@
+
+require File.expand_path(File.join(File.dirname(__FILE__), '..', 'lib/progress_bar'))
+
+bar = ProgressBar.new
+
+100.times do
+  sleep 0.1
+  bar.increment!
+end

data/test/test_helper.rb

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

metadata

@@ -0,0 +1,80 @@
+--- !ruby/object:Gem::Specification 
+name: progress_bar
+version: !ruby/object:Gem::Version 
+  prerelease: 
+  version: 0.1.0
+platform: ruby
+authors: 
+- Paul Sasauskas
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2011-04-06 00:00:00 -06:00
+default_executable: 
+dependencies: []
+
+description: "Give people feedback about long-running tasks without overloading them with information: Use a progress bar, like Curl or Wget!"
+email: 
+- psadauskas@gmail.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- .gitignore
+- Gemfile
+- 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
+homepage: http://www.github.com/paul/progress_bar
+licenses: []
+
+post_install_message: 
+rdoc_options: []
+
+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: "0"
+requirements: []
+
+rubyforge_project: progress_bar
+rubygems_version: 1.6.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