powerbar 1.0.3 → 1.0.4

data/README.rdoc

@@ -13,7 +13,7 @@ This is PowerBar - The last progressbar-library you'll ever need.
 
 * Fully customizable; all output is template-driven.
 
-* All output is optional. You may use PowerBar to silently collect progress
+* All output is optional. You may set PowerBar to silently collect progress
   information (percentage-done, throughput, ETA, etc.) and then use the
   computed values elsewhere in your app.
 
@@ -50,7 +50,7 @@ Then look at the {source-code}[https://github.com/busyloop/powerbar/blob/master/
 
  p = PowerBar.new
 
- # Override some default values to demonstrate how the settings work
+ # Override some defaults to demonstrate how the settings work
  p.settings.tty.finite.template.barchar = '*'
  p.settings.tty.finite.template.padchar = '.'
 

data/bin/powerbar-demo

@@ -8,11 +8,23 @@ def demo_1
   step = 1000
 
   p = PowerBar.new
+
+  # This is how you alter the settings.
+  # (see the source-code for all available settings)
+  p.settings.tty.finite.show_eta = true
+
   (0..total).step(step).each do |i|
     p.show({:msg => 'DEMO 1 - Ten seconds of progress', :done => i, :total => total})
     sleep 0.1
   end
-  p.close
+  
+  # close(true) will set the bar to 100% before closing.
+  # use this when you are sure your operation has finished but
+  # for some reason 'done' may still be smaller than 'total'.
+  #
+  # this is not necessary in this example, and usually a bad idea,
+  # but demonstrating here so you know it exists.
+  p.close(true)
 end
 
 # DEMO 2
@@ -236,7 +248,7 @@ def demo_10
     sleep 0.1
   end
   p.wipe
-  p.close
+  puts "Thanks for watching! ;-)"
 end
 
 begin

data/lib/powerbar.rb

@@ -49,7 +49,8 @@ class PowerBar
           :finite => { # <== Settings for a finite progress bar (when total != :unknown)
             # The :output Proc is called to draw on the screen --------------------.
             :output => Proc.new{ |s| $stderr.print s[0..terminal_width()-1] }, # <-'
-            :interval => 0.1, # Minimum interval between screen refreshes (in seconds)
+            :interval => 0.1,  # Minimum interval between screen refreshes (in seconds)
+            :show_eta => true, # Set to false if you want to hide the ETA without changing the template
             :template => { # <== template for a finite progress bar on a tty
               :pre  => "\e[1000D\e[?25l",  # printed before the progress-bar
               #
@@ -77,6 +78,7 @@ class PowerBar
           :infinite => { # <== Settings for an infinite progress "bar" (when total is :unknown)
             :output => Proc.new{ |s| $stderr.print s[0..terminal_width()-1] },
             :interval => 0.1,
+            :show_eta => false,
             :template => {
               :pre  => "\e[1000D\e[?25l",
               :main => "${<msg>}: ${<done> }${<rate>/s }${<elapsed>}",
@@ -94,6 +96,7 @@ class PowerBar
             # You may want to hook in your favorite Logger-Library here. ---.
             :output => Proc.new{ |s| $stderr.print s },  # <----------------'
             :interval => 1,
+            :show_eta => true,
             :line_width => 78, # Maximum output line width
             :template => {
               :pre  => '',
@@ -109,6 +112,7 @@ class PowerBar
           :infinite => {
             :output => Proc.new{ |s| $stderr.print s },
             :interval => 1,
+            :show_eta => false,
             :line_width => 78,
             :template => {
               :pre  => "",
@@ -165,7 +169,19 @@ class PowerBar
 
   # Print the close-template and defuse the exit-hook.
   # Be a good citizen, always close your PowerBars!
-  def close
+  def close(fill=false)
+    show(
+      {
+        :done => fill && !state.total.is_a?(Symbol) ? state.total : state.done,
+        :tty => {
+                  :finite => { :show_eta => false },
+                  :infinite => { :show_eta => false },
+                },
+        :notty => {
+                  :finite => { :show_eta => false },
+                  :infinite => { :show_eta => false },
+                },
+      }, true)
     scope.output.call(scope.template.close) unless scope.template.close.nil?
     state.closed = true
   end
@@ -190,8 +206,8 @@ class PowerBar
 
   # Output the PowerBar.
   # Returns true if bar was shown, false otherwise.
-  def show(opts={})
-    return false if scope.interval > Time.now - state.time_last_show
+  def show(opts={}, force=false)
+    return false if scope.interval > Time.now - state.time_last_show and force == false
 
     update(opts)
     hook_exit
@@ -246,6 +262,7 @@ class PowerBar
 
   # returns nil when eta is < 1 second
   def h_eta
+    return nil unless scope.show_eta
     1 < eta ? humanize_interval(eta) : nil
   end
 

data/lib/powerbar/version.rb

@@ -1,3 +1,3 @@
 class Powerbar
-  VERSION = "1.0.3"
+  VERSION = "1.0.4"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: powerbar
 version: !ruby/object:Gem::Version
-  version: 1.0.3
+  version: 1.0.4
   prerelease: 
 platform: ruby
 authors:
@@ -9,11 +9,11 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2011-12-08 00:00:00.000000000Z
+date: 2012-01-17 00:00:00.000000000Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: ansi
-  requirement: &18446200 !ruby/object:Gem::Requirement
+  requirement: &17713320 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -21,10 +21,10 @@ dependencies:
         version: 1.4.0
   type: :runtime
   prerelease: false
-  version_requirements: *18446200
+  version_requirements: *17713320
 - !ruby/object:Gem::Dependency
   name: hashie
-  requirement: &18432940 !ruby/object:Gem::Requirement
+  requirement: &17712340 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -32,7 +32,7 @@ dependencies:
         version: 1.1.0
   type: :runtime
   prerelease: false
-  version_requirements: *18432940
+  version_requirements: *17712340
 description: The last progressbar-library you'll ever need
 email:
 - moe@busyloop.net