ruby-multi-progressbar 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: b4503aefab48b055748422c629156860afb406eb
+  data.tar.gz: 7bfa320e01ea00909a8d2d5df1aeb4959c366d4c
+SHA512:
+  metadata.gz: ce67aaf23552b8c0bcc5c54e27072a6ff32070386606e80ab11d1c230d46e24fecb2b061a67886f62b8fa6311aeb038698f7c907118846dc3b0c1af73f20170a
+  data.tar.gz: aeca9899def674e523d95bd95c45ac91bc8b7c4f374fdfb9c749105503fd553228b3017661aa3c8199de52e4a67a584486bd6730728206a4a4000e5947e6d619

data/README.md

@@ -0,0 +1,10 @@
+== Ruby-MultiProgressBar
+
+Displays multiple progress bars using Ncurses and ruby-progressbar
+Useful for displaying the status of multiple test runs or multipile threads.
+
+Uses +ruby-progressbar+ to render the bars.
+
+== Credits
+
+* Thanks to Peter Jaros for the initial version (https://github.com/Peeja/multi_progress_bar).

data/lib/ruby-multi-progressbar.rb

@@ -0,0 +1,93 @@
+require 'ncurses'
+require 'ruby-progressbar'
+require 'delegate'
+
+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)
+      Ncurses.start_color
+
+      (0..7).each { |color_number| Ncurses.init_pair(color_number, color_number, Ncurses::COLOR_BLACK); }
+
+      @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)
+
+      trap("SIGWINCH") do
+        Ncurses.endwin
+        Ncurses.refresh
+
+        refresh_window_positions
+
+        @bars.each do |bar|
+          bar.width = @bars_window.getmaxx
+          bar.show
+        end
+      end
+    end
+
+    # Restore the terminal to normal function.  Always call this before exiting.
+    def end
+      # Give an extra line below the output for the shell to prompt on.
+      add_bar(nil)
+
+      Ncurses.endwin
+    end
+
+    # Write +text+ to the space above the progress bars.
+    def log(text)
+      text = text.to_s
+
+      # Parse ANSI escape codes.
+      text.scan(/([^\e]*)(?:\e\[(\d+.))?/) do |normal_text, code|
+        @log_window.addstr(normal_text)
+        case code
+          when /3(\d)m/
+            @log_window.attron(Ncurses.COLOR_PAIR($1.to_i))
+          when /0m/
+            @log_window.attron(Ncurses.COLOR_PAIR(7))
+        end
+      end
+      @log_window.addstr("\n")
+      @log_window.refresh
+    end
+
+    def width  #:nodoc:
+      @bars_window.getmaxx
+    end
+
+    def refresh_window_positions
+      @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 add_bar(bar)  #:nodoc:
+      @bars += [bar]
+      refresh_window_positions
+    end
+
+    def update_bar(bar, rendered_bar)  #:nodoc:
+      @bars_window.move(bars.index(bar), 0)
+      @bars_window.attron(Ncurses.COLOR_PAIR(bar.color)) if bar.color
+      @bars_window.addstr(rendered_bar)
+      @bars_window.attroff(Ncurses.COLOR_PAIR(bar.color)) if bar.color
+      @bars_window.refresh
+    end
+  end
+end
+
+require 'ruby-multi-progressbar/version'
+require 'ruby-multi-progressbar/bar_renderer'
+require 'ruby-multi-progressbar/bar'
+require 'ruby-multi-progressbar/total_bar'

data/lib/ruby-multi-progressbar/bar.rb

@@ -0,0 +1,69 @@
+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.
+  #
+  # MultiProgressBar::Bar makes two additional format arguments available: :current
+  # and :total.  These display the current and total values respectively.
+  class Bar < DelegateClass(BarRenderer)
+    attr_reader :color
+
+    # 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
+
+    # Set the progress to 100% and display elapsed time instead of ETA.
+    def finish
+      super
+      notify_observers
+    end
+
+    def color=(color)
+      @color = color
+      show
+    end
+
+    def observe(&b)  #:nodoc:
+      @observers << b
+    end
+
+    private
+    def notify_observers
+      @observers.each { |b| b.call(self) }
+    end
+  end
+end

data/lib/ruby-multi-progressbar/bar_renderer.rb

@@ -0,0 +1,50 @@
+module MultiProgressBar
+  class BarRenderer < ProgressBar  #:nodoc:
+    attr_writer :total
+    attr_accessor :width
+
+    def initialize(title, total, width, &block)
+      @block = block
+      @buffer = StringIO.new
+      @width = width
+      super(title, total, @buffer)
+    end
+
+    def fmt_current
+      @current
+    end
+
+    def fmt_total
+      @total
+    end
+
+    def show
+      super
+      @block.call(@buffer.string)
+      @buffer.string = ""
+    end
+
+    def title=(new_title)
+      @title = new_title
+      show
+    end
+
+    def get_width
+      @width
+    end
+
+    def restart
+      set(0)
+      @start_time = Time.now
+      @previous_time = @start_time
+    end
+
+    def do_percentage
+      if @current.zero?
+        0
+      else
+        super
+      end
+    end
+  end
+end

data/lib/ruby-multi-progressbar/total_bar.rb

@@ -0,0 +1,36 @@
+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 }
+      total_total   = @bars.inject(0) { |sum, bar| sum + bar.total }
+      finished      = @bars.all? { |bar| bar.finished? }
+      @renderer.total = total_total
+      @renderer.set(total_current)
+      @renderer.finish if finished
+    end
+  end
+end

data/lib/ruby-multi-progressbar/version.rb

@@ -0,0 +1,3 @@
+module MultiProgressBar
+	VERSION = '1.0.0'
+end

metadata

@@ -0,0 +1,54 @@
+--- !ruby/object:Gem::Specification
+name: ruby-multi-progressbar
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- shaharhd
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-04-11 00:00:00.000000000 Z
+dependencies: []
+description: |
+  Displays multiple progress bars using Ncurses and ruby-progressbar
+  Useful for displaying the status of multiple test runs or multipile threads.
+email: shaharhd@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files:
+- README.md
+files:
+- README.md
+- lib/ruby-multi-progressbar.rb
+- lib/ruby-multi-progressbar/bar.rb
+- lib/ruby-multi-progressbar/bar_renderer.rb
+- lib/ruby-multi-progressbar/total_bar.rb
+- lib/ruby-multi-progressbar/version.rb
+homepage: https://github.com/ShaharHD/ruby-multi-progressbar
+licenses:
+- LICENSE
+metadata: {}
+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'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: ruby-multi-progressbar
+rubygems_version: 2.2.2
+signing_key: 
+specification_version: 4
+summary: Displays multiple progress bars using Ncurses.
+test_files: []