multi_progress_bar 0.0.0

data/README.rdoc

@@ -0,0 +1,11 @@
+== MultiProgressBar
+
+Displays multiple progress bars using Ncurses.  Useful for displaying the status of multiple test runs, say, distributed across different machines.  Which is exactly why I wrote it.
+
+Uses +ruby-progressbar+ to render the bars.
+
+== Credits
+
+* Codes by Peter Jaros.
+* Thanks to Nick Evans for the inspiration (http://ekenosen.net/nick/devblog/2008/12/better-progress-bar-for-rspec/).
+* Thanks to Satoru Takabayashi for +ruby-progressbar+ (http://0xcc.net/ruby-progressbar/index.html.en).

data/Rakefile

@@ -0,0 +1,27 @@
+begin
+  require 'jeweler'
+  Jeweler::Tasks.new do |gemspec|
+    gemspec.name = "multi_progress_bar"
+    gemspec.summary = "Displays multiple progress bars using Ncurses."
+    gemspec.description = "Displays multiple progress bars using Ncurses.  Useful for displaying the status of multiple test runs, say, distributed across different machines.  Which is exactly why I wrote it."
+    gemspec.email = "peter.a.jaros@gmail.com"
+    gemspec.homepage = "http://github.com/Peeja/multi_progress_bar/tree/master/"
+    gemspec.authors = ["Peter Jaros"]
+  end
+rescue LoadError
+  puts "Jeweler not available. For gem tasks, install it with: sudo gem install jeweler"
+end
+
+
+begin
+  require 'hanna/rdoctask'
+rescue LoadError
+  require 'rake/rdoctask'
+end
+
+desc 'Generate RDoc documentation.'
+Rake::RDocTask.new(:rdoc) do |rdoc|
+  rdoc.main = "README.rdoc"
+  rdoc.rdoc_dir = 'doc'
+  rdoc.options << '--webcvs=http://github.com/Peeja/multi_progress_bar/tree/master/'
+end

data/examples/example.rb

@@ -0,0 +1,35 @@
+#!/usr/bin/env ruby
+
+require 'rubygems'
+
+$LOAD_PATH.unshift File.dirname(__FILE__)+"/../lib"
+require 'multi_progress_bar'
+
+
+begin
+  MultiProgressBar.start
+
+  # Demo.
+  make_machine_bar = lambda { MultiProgressBar::Bar.new("(Waiting...)", 100) }
+  machine_bars = [make_machine_bar[], make_machine_bar[]]
+  total = MultiProgressBar::TotalBar.new("-Total-")
+
+  machine_names = ["bleeker", "montrose"]
+
+  until machine_bars.all? { |bar| bar.current == bar.total }
+    sleep(0.1)
+
+    # Simulate machines becoming available.
+    machine_bars.each do |bar|
+      if bar.title == "(Waiting...)"
+        bar.title = machine_names.pop if rand(10) == 0
+      else
+        bar.inc(rand(10))
+      end
+    end
+
+    MultiProgressBar.log(rand(2000))
+  end
+ensure
+  MultiProgressBar.end
+end

data/examples/loop.rb

@@ -0,0 +1,40 @@
+#!/usr/local/bin/ruby -w
+
+# Not actually an example, but a script to run the example every
+# time a file changes, for testing.
+# 
+#   example/loop example/example.rb
+
+command = ARGV.shift
+file_patterns_to_watch = (ARGV.length > 0 ? ARGV : ['**/*.rb'])
+
+files = {}
+
+file_patterns_to_watch.each do |arg|
+  Dir[arg].each { |file|
+    files[file] = File.mtime(file)
+  }
+end
+
+trap('INT') do
+  puts "\nQuitting..."
+  exit
+end
+
+
+loop do
+  system command
+
+  loop do
+    sleep 0.1
+
+    changed_file, last_changed = files.find { |file, last_changed|
+      File.mtime(file) > last_changed
+    }
+
+    if changed_file
+      files[changed_file] = File.mtime(changed_file)
+      break
+    end
+  end
+end

data/lib/multi_progress_bar/bar.rb

@@ -0,0 +1,53 @@
+module MultiProgressBar
+  # Represents a progress bar at the bottom of the screen.
+  #
+  # +Bar+ exposes the same interface as +ProgressBar+ from the +progressbar+
+  # gem which backs its display.
+  #
+  #   file_progress = MultiProgressBar::Bar.new("file_1", 2596)
+  #   file_progress.inc     # Increment value by 1.
+  #   file_progress.inc(10) # Increment value by 10.
+  #   file_progress.set(30) # Set value to 30.
+  #
+  #   # Change bar format.
+  #   file_progress.format = "%-14s (%s) %3d%% %s"
+  #   file_progress.format_arguments = [:title, :stat, :percentage, :bar].
+  #
+  # See the +ruby-progressbar+ gem (http://0xcc.net/ruby-progressbar/index.html.en)
+  # for more details.
+  class Bar < DelegateClass(BarRenderer)
+    # Create a new Bar with a +title+ and a +total+ value.
+    def initialize(title, total)
+      MultiProgressBar.add_bar(self)
+
+      @observers = []
+
+      @renderer = BarRenderer.new(title, total, MultiProgressBar.width) do |rendered_bar|
+        MultiProgressBar.update_bar(self, rendered_bar)
+      end
+
+      super @renderer
+    end
+
+    # Increment the current value of the bar.
+    def inc(step = 1)
+      super
+      notify_observers
+    end
+
+    # Set the current value of the bar absolutely.
+    def set(count)
+      super
+      notify_observers
+    end
+
+    def observe(&b)  #:nodoc:
+      @observers << b
+    end
+
+    private
+    def notify_observers
+      @observers.each { |b| b.call(self) }
+    end
+  end
+end

data/lib/multi_progress_bar/bar_renderer.rb

@@ -0,0 +1,22 @@
+module MultiProgressBar
+  class BarRenderer < ProgressBar  #:nodoc:
+    attr_writer :title
+
+    def initialize(title, total, width, &block)
+      @block = block
+      @buffer = StringIO.new
+      @width = width
+      super(title, total, @buffer)
+    end
+
+    def show
+      super
+      @block.call(@buffer.string)
+      @buffer.string = ""
+    end
+
+    def get_width
+      @width
+    end
+  end
+end

data/lib/multi_progress_bar/total_bar.rb

@@ -0,0 +1,32 @@
+module MultiProgressBar
+  # Works just like +Bar+, but displays the total of other bars.
+  # TotalBar#inc and TotalBar#set don't work.
+  class TotalBar < Bar
+    # Create a new TotalBar.  +bars+ is an array of Bar objects, and defaults to
+    # all existing bars.
+    def initialize(title, bars = MultiProgressBar.bars.dup)
+      @bars = bars
+
+      @bars.each do |bar|
+        bar.observe do
+          update_total
+        end
+      end
+
+      total_total = @bars.inject(0) { |sum, bar| sum + bar.total }
+      super title, total_total
+    end
+
+    [:inc, :set].each do |name|
+      define_method(name) do
+        raise NoMethodError, "NoMethodError: private method `#{name}' called for #{self}"
+      end
+    end
+
+    private
+    def update_total
+      total_current = @bars.inject(0) { |sum, bar| sum + bar.current }
+      @renderer.set(total_current)
+    end
+  end
+end

data/lib/multi_progress_bar.rb

@@ -0,0 +1,59 @@
+require 'ncurses'
+require 'progressbar'
+require 'delegate'
+require 'abstraction'
+
+module MultiProgressBar
+  class << self
+    attr_reader :bars
+
+    # Set up the screen.  Always call +MultiProgressBar.start+ before using progress bars.
+    def start
+      @bars = [].freeze
+
+      Ncurses.initscr
+      Ncurses.curs_set(0)
+
+      @bars_window = Ncurses::WINDOW.new(1, 0, Ncurses.LINES-1, 0)
+      @log_window  = Ncurses::WINDOW.new(Ncurses.LINES-1, 0, 0, 0)
+      @log_window.scrollok(true)
+    end
+
+    # Restore the terminal to normal function.  Always call this before exiting.
+    def end
+      Ncurses.endwin
+      puts
+    end
+
+    # Write +text+ to the space above the progress bars.
+    def log(text)
+      @log_window.addstr("#{text}\n")
+      @log_window.refresh
+    end
+
+    def width  #:nodoc:
+      @bars_window.getmaxx
+    end
+
+    def add_bar(bar)  #:nodoc:
+      @bars += [bar]
+
+      @bars_window.mvwin(Ncurses.LINES-bars.size, @bars_window.getbegx)
+      @bars_window.resize(bars.size, @bars_window.getmaxx)
+      @bars_window.refresh
+
+      @log_window.resize(Ncurses.LINES-bars.size, @log_window.getmaxx)
+      @log_window.refresh
+    end
+
+    def update_bar(bar, rendered_bar)  #:nodoc:
+      @bars_window.move(bars.index(bar), 0)
+      @bars_window.addstr(rendered_bar)
+      @bars_window.refresh
+    end
+  end
+end
+
+require 'multi_progress_bar/bar_renderer'
+require 'multi_progress_bar/bar'
+require 'multi_progress_bar/total_bar'

metadata

@@ -0,0 +1,63 @@
+--- !ruby/object:Gem::Specification 
+name: multi_progress_bar
+version: !ruby/object:Gem::Version 
+  version: 0.0.0
+platform: ruby
+authors: 
+- Peter Jaros
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2009-11-15 00:00:00 -05:00
+default_executable: 
+dependencies: []
+
+description: Displays multiple progress bars using Ncurses.  Useful for displaying the status of multiple test runs, say, distributed across different machines.  Which is exactly why I wrote it.
+email: peter.a.jaros@gmail.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- README.rdoc
+files: 
+- README.rdoc
+- Rakefile
+- examples/example.rb
+- examples/loop.rb
+- lib/multi_progress_bar.rb
+- lib/multi_progress_bar/bar.rb
+- lib/multi_progress_bar/bar_renderer.rb
+- lib/multi_progress_bar/total_bar.rb
+has_rdoc: true
+homepage: http://github.com/Peeja/multi_progress_bar/tree/master/
+licenses: []
+
+post_install_message: 
+rdoc_options: 
+- --charset=UTF-8
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.3.5
+signing_key: 
+specification_version: 3
+summary: Displays multiple progress bars using Ncurses.
+test_files: 
+- examples/example.rb
+- examples/loop.rb