powerbar 1.0.1 → 1.0.2

data/bin/powerbar-demo

@@ -53,6 +53,11 @@ def demo_4
   total = 100000
   step = 1000
   text = "\e[0mDEMO 4 - Colors!"
+  interstitial = [
+    "Oh, btw, know what?\n",
+    "You may use PowerBar#print to print messages while the bar is running.\n",
+    "Awesome, right?\n"
+  ]
   p = PowerBar.new
   p.settings.tty.finite.template.main = \
         "${<msg>} ${<bar> }\e[0m${<rate>/s} \e[33;1m${<percent>%} " +
@@ -73,6 +78,9 @@ def demo_4
   (0..total).step(step).each do |i|
     p.show({:msg => text, :done => i, :total => total})
     j += 1
+    if 0 == j % 25
+      p.print interstitial.shift
+    end
     sleep 0.1
   end
   p.close
@@ -122,6 +130,9 @@ def demo_7
   (0..total).step(step).each do |i|
     p.show({:msg => text, :done => i, :total => total})
     j += 1
+    if j == 60
+      p.print "Hint: Of course PowerBar#print also works when in :notty-mode\n"
+    end
     sleep 0.1
   end
   p.close
@@ -136,12 +147,15 @@ def demo_8
   p = PowerBar.new
   p.settings.force_mode = :notty
   p.settings.notty.finite.output = Proc.new { |s|
-    log.debug(s) unless s == ''
+    log.debug(s.chomp) unless s == ''
   }
   j = 0
   (0..total).step(step).each do |i|
     p.show({:msg => text, :done => i, :total => total})
     j += 1
+    if j == 60
+      p.print "Hint: Yes, PowerBar#print also works here. ;)\n"
+    end
     sleep 0.1
   end
   p.close
@@ -153,7 +167,7 @@ def demo_9
   step = 1000
 
   puts "DEMO 9 - No output by PowerBar."
-  puts "We only use it to collect stats and then roll our own output...\n---"
+  puts "Here we use it to collect stats silently, and then we roll our own output:\n-"
   p = PowerBar.new
   j = 0
   (0..total).step(step).each do |i|
@@ -168,7 +182,7 @@ def demo_9
       puts "total is: #{p.total}, humanized done is: #{p.h_total}"
       puts "total is: #{p.total}, humanized done is: #{p.h_total}"
       puts "bar is: #{p.bar}"
-      puts "---"
+      puts "-"
     end
     sleep 0.1
   end

data/lib/powerbar.rb

@@ -24,11 +24,10 @@ require 'powerbar/version'
 require 'ansi'
 require 'hashie/mash'
 
+#
+# This is PowerBar - The last progressbar-library you'll ever need.
+#
 class PowerBar
-  #
-  # This is PowerBar - The last progressbar-library you'll ever need.
-  #
-
   STRIP_ANSI = Regexp.compile '\e\[(\d+)(;\d+)?(;\d+)?[m|K]', nil
 
   def initialize(opts={})
@@ -67,7 +66,7 @@ class PowerBar
               # evaluates to something other than nil.
               :main => '${<msg>}: ${[<bar>] }${<rate>/s }${<percent>% }${<elapsed>}${, ETA: <eta>}',
               :post => '',             # printed after the progressbar
-              :wipe => "\e[1000D\e[K", # printed when 'wipe' is called
+              :wipe => "\e[0m\e[1000D\e[K", # printed when 'wipe' is called
               :close => "\e[?25h\n",   # printed when 'close' is called
               :exit => "\e[?25h",      # printed if the process exits unexpectedly
               :barchar => "\u2588",    # fill-char for the progress-bar
@@ -81,7 +80,7 @@ class PowerBar
               :pre  => "\e[1000D\e[?25l",
               :main => "${<msg>}: ${<done> }${<rate>/s }${<elapsed>}",
               :post => "\e[K",
-              :wipe => "\e[1000D\e[K",
+              :wipe => "\e[0m\e[1000D\e[K",
               :close => "\e[?25h\n",
               :exit => "\e[?25h",
               :barchar => "\u2588",
@@ -126,12 +125,12 @@ class PowerBar
     }.merge(opts) )
   end
 
-  # Access the settings-hash
+  # settings-hash
   def settings
     @state.settings
   end
 
-  # Access settings under current scope (e.g. tty.infinite)
+  # settings under current scope (e.g. tty.infinite)
   def scope
     scope_hash = [settings.force_mode,state.total].hash
     return @state.scope unless @state.scope.nil? or scope_hash != @state.scope_hash
@@ -152,7 +151,7 @@ class PowerBar
     state.scope
   end
 
-  # Hook at_exit to ensure cleanup when we get interrupted
+  # Hook at_exit to ensure cleanup if we get interrupted
   def hook_exit
     return if @@exit_hooked
     if scope.template.exit
@@ -163,13 +162,19 @@ class PowerBar
     @@exit_hooked = true
   end
 
-  # This prints the close-template which normally prints a newline.
+  # Print the close-template and defuse the exit-hook.
   # Be a good citizen, always close your PowerBars!
   def close
     scope.output.call(scope.template.close) unless scope.template.close.nil?
     state.closed = true
   end
 
+  # Remove progress-bar, print a message
+  def print(s)
+    wipe
+    scope.output.call(s)
+  end
+
   # Update state (and settings) without printing anything.
   def update(opts={})
     state.merge!(opts)
@@ -182,18 +187,20 @@ class PowerBar
     @rate.append(state.time_now, state.done)
   end
 
-  # Display the PowerBar.
+  # Output the PowerBar.
+  # Returns true if bar was shown, false otherwise.
   def show(opts={})
-    if scope.interval <= Time.now - state.time_last_show
-      update(opts)
-      hook_exit
-
-      state.time_last_show = Time.now
-      state.closed = false
-      scope.output.call(scope.template.pre)
-      scope.output.call(render)
-      scope.output.call(scope.template.post)
-    end
+    return false if scope.interval > Time.now - state.time_last_show
+
+    update(opts)
+    hook_exit
+
+    state.time_last_show = Time.now
+    state.closed = false
+    scope.output.call(scope.template.pre)
+    scope.output.call(render)
+    scope.output.call(scope.template.post)
+    true
   end
 
   # Render the PowerBar and return as a string.
@@ -343,19 +350,19 @@ class PowerBar
 
   class Rate < Array
     attr_reader :last_sample_at
-    def initialize(at, len, max_interval=10, interval_step=0.1)
+    def initialize(at, window, max_interval=10, interval_step_up=0.1)
       super([])
       @last_sample_at = at
       @sample_interval = 0
-      @sample_interval_step = interval_step
+      @sample_interval_step_up = interval_step_up
       @sample_interval_max = max_interval
       @counter = 0
-      @len = len
+      @window = window
     end
 
     def append(at, v)
       return if @sample_interval > at - @last_sample_at
-      @sample_interval += @sample_interval_step if @sample_interval < @sample_interval_max
+      @sample_interval += @sample_interval_step_up if @sample_interval < @sample_interval_max
 
       rate = (v - @counter) / (at - @last_sample_at).to_f
       return if rate.nan?
@@ -364,9 +371,9 @@ class PowerBar
       @counter = v
 
       self << rate
-      if length > @len
-        shift
-      end
+      shift while @window < length
+
+      self
     end
 
     def sum

data/lib/powerbar/version.rb

@@ -1,3 +1,3 @@
-module Powerbar
-  VERSION = "1.0.1"
+class Powerbar
+  VERSION = "1.0.2"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: powerbar
 version: !ruby/object:Gem::Version
-  version: 1.0.1
+  version: 1.0.2
   prerelease: 
 platform: ruby
 authors:
@@ -13,7 +13,7 @@ date: 2011-12-07 00:00:00.000000000Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: ansi
-  requirement: &15214280 !ruby/object:Gem::Requirement
+  requirement: &9714940 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -21,10 +21,10 @@ dependencies:
         version: 1.4.0
   type: :runtime
   prerelease: false
-  version_requirements: *15214280
+  version_requirements: *9714940
 - !ruby/object:Gem::Dependency
   name: hashie
-  requirement: &15213600 !ruby/object:Gem::Requirement
+  requirement: &9713660 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -32,7 +32,7 @@ dependencies:
         version: 1.1.0
   type: :runtime
   prerelease: false
-  version_requirements: *15213600
+  version_requirements: *9713660
 description: The last progressbar-library you'll ever need
 email:
 - moe@busyloop.net