tty-progressbar 0.11.0 → 0.12.0

data/examples/failure.rb

@@ -0,0 +1,14 @@
+# encoding: utf-8
+
+require 'tty-progressbar'
+
+bar = TTY::ProgressBar.new("downloading [:bar] :percent", head: '>', total: 30)
+30.times do |i|
+  if i == 15
+    bar.update(head: 'x')
+    bar.stop
+    break
+  end
+  sleep(0.1)
+  bar.advance
+end

data/examples/iterator.rb

@@ -0,0 +1,7 @@
+# encoding: utf-8
+
+require 'tty-progressbar'
+
+bar = TTY::ProgressBar.new("[:bar]")
+
+bar.iterate(30.times) { sleep(0.1) }

data/examples/multi/main_bar.rb

@@ -0,0 +1,17 @@
+# encoding: utf-8
+
+require 'tty-progressbar'
+
+bars = TTY::ProgressBar::Multi.new("main [:bar] :percent")
+
+bar1 = bars.register "foo [:bar] :percent", total: 20
+bar2 = bars.register "bar [:bar] :percent", total: 30
+bar3 = bars.register "baz [:bar] :percent", total: 10
+
+bars.start
+
+th1 = Thread.new { 20.times { sleep(0.2); bar1.advance } }
+th2 = Thread.new { 30.times { sleep(0.1); bar2.advance } }
+th3 = Thread.new { 10.times { sleep(0.3); bar3.advance } }
+
+[th1, th2, th3].each(&:join)

data/examples/multi/simple.rb

@@ -0,0 +1,15 @@
+# encoding: utf-8
+
+require 'tty-progressbar'
+
+bars = TTY::ProgressBar::Multi.new
+
+bar1 = bars.register "foo [:bar] :percent", total: 20
+bar2 = bars.register "bar [:bar] :percent", total: 30
+bar3 = bars.register "baz [:bar] :percent", total: 10
+
+th1 = Thread.new { 20.times { sleep(0.2); bar1.advance } }
+th2 = Thread.new { 30.times { sleep(0.1); bar2.advance } }
+th3 = Thread.new { 10.times { sleep(0.3); bar3.advance } }
+
+[th1, th2, th3].each(&:join)

data/examples/threaded.rb

@@ -0,0 +1,16 @@
+# encoding: utf-8
+
+require 'tty-progressbar'
+
+threads = []
+
+bar = TTY::ProgressBar.new("[:bar] :percent", total: 30)
+
+threads << Thread.new {
+  15.times { sleep(0.1); bar.update(complete: '-', head: '-'); bar.advance(); }
+}
+threads << Thread.new {
+  15.times { sleep(0.1); bar.update(complete: '+', head: '+'); bar.advance(); }
+}
+
+threads.map(&:join)

data/lib/tty-progressbar.rb

@@ -1,3 +1,4 @@
-# coding: utf-8
+# encoding: utf-8
 
-require 'tty/progressbar'
+require_relative 'tty/progressbar'
+require_relative 'tty/progressbar/multi'

data/lib/tty/progressbar.rb

@@ -1,7 +1,10 @@
-# coding: utf-8
+# encoding: utf-8
+# frozen_string_literal: true
 
 require 'io/console'
 require 'forwardable'
+require 'monitor'
+require 'tty-cursor'
 require 'tty-screen'
 
 require_relative 'progressbar/configuration'
@@ -15,24 +18,28 @@ module TTY
   # @api public
   class ProgressBar
     extend Forwardable
+    include MonitorMixin
 
     ECMA_ESC = "\e".freeze
     ECMA_CSI = "\e[".freeze
-    ECMA_CHA = 'G'.freeze
     ECMA_CLR = 'K'.freeze
 
     DEC_RST  = 'l'.freeze
     DEC_SET  = 'h'.freeze
     DEC_TCEM = '?25'.freeze
 
+    CURSOR_LOCK = Monitor.new
+
     attr_reader :format
 
     attr_reader :current
 
     attr_reader :start_at
 
+    attr_reader :row
+
     def_delegators :@configuration, :total, :width, :no_width,
-                   :complete, :incomplete, :hide_cursor, :clear,
+                   :complete, :incomplete, :head, :hide_cursor, :clear,
                    :output, :frequency, :interval, :width=
 
     def_delegators :@meter, :rate, :mean_rate
@@ -65,33 +72,63 @@ module TTY
     #
     # @api public
     def initialize(format, options = {})
-      @format        = format
+      super()
+      @format = format
+      if format.is_a?(Hash)
+        raise ArgumentError, "Expected bar formatting string, " \
+                             "got `#{format}` instead."
+      end
       @configuration = TTY::ProgressBar::Configuration.new(options)
       yield @configuration if block_given?
 
+      @formatter = TTY::ProgressBar::Formatter.new
+      @meter     = TTY::ProgressBar::Meter.new(interval)
+      @callbacks = Hash.new { |h, k| h[k] = [] }
+
+      @formatter.load
+      reset
+    end
+
+    # Reset progress to default configuration
+    #
+    # @api public
+    def reset
       @width             = 0 if no_width
       @render_period     = frequency == 0 ? 0 : 1.0 / frequency
       @current           = 0
-      @readings          = 0
       @last_render_time  = Time.now
       @last_render_width = 0
       @done              = false
+      @stopped           = false
       @start_at          = Time.now
       @started           = false
       @tokens            = {}
-      @formatter         = TTY::ProgressBar::Formatter.new
-      @meter             = TTY::ProgressBar::Meter.new(options.fetch(:interval, 1))
+      @multibar          = nil
+      @row               = nil
+      @first_render      = true
 
-      @formatter.load
+      @meter.clear
+    end
+
+    # Attach this bar to multi bar
+    #
+    # @param [TTY::ProgressBar::Multi] multibar
+    #   the multibar under which this bar is registered
+    #
+    # @api private
+    def attach_to(multibar)
+      @multibar = multibar
     end
 
     # Start progression by drawing bar and setting time
     #
     # @api public
     def start
-      @started  = true
-      @start_at = Time.now
-      @meter.start
+      synchronize do
+        @started  = true
+        @start_at = Time.now
+        @meter.start
+      end
 
       advance(0)
     end
@@ -102,25 +139,66 @@ module TTY
     #
     # @api public
     def advance(progress = 1, tokens = {})
-      #handle_signals
-      return if @done
-
-      if progress.respond_to?(:to_hash)
-        tokens, progress = progress, 1
+      return if done?
+
+      synchronize do
+        if progress.respond_to?(:to_hash)
+          tokens, progress = progress, 1
+        end
+        @start_at  = Time.now if @current.zero? && !@started
+        @current  += progress
+        @tokens    = tokens
+        @meter.sample(Time.now, progress)
+
+        if !no_width && @current >= total
+          finish && return
+        end
+
+        now = Time.now
+        return if (now - @last_render_time) < @render_period
+        render
+        emit(:progress)
       end
-      @start_at  = Time.now if @current.zero? && !@started
-      @readings += 1
-      @current  += progress
-      @tokens    = tokens
-      @meter.sample(Time.now, progress)
-
-      if !no_width && @current >= total
-        finish && return
+    end
+
+    # Iterate over collection either yielding computation to block
+    # or provided Enumerator.
+    #
+    # @example
+    #   bar.iterate(30.times) { ... }
+    #
+    # @param [Enumerable] collection
+    #   the collection to iterate over
+    #
+    # @param [Integer] progress
+    #   the amount to move progress bar by
+    #
+    # @return [Enumerator]
+    #
+    # @api public
+    def iterate(collection, progress = 1, &block)
+      update(total: collection.count)
+      prog = Enumerator.new do |iter|
+        collection.each do |elem|
+          advance(progress)
+          iter.yield(elem)
+        end
       end
+      block_given? ? prog.each(&block) : prog
+    end
 
-      now = Time.now
-      return if (now - @last_render_time) < @render_period
-      render
+    # Update configuration options for this bar
+    #
+    # @param [Hash[Symbol]] options
+    #   the configuration options to update
+    #
+    # @api public
+    def update(options = {})
+      synchronize do
+        options.each do |name, val|
+          @configuration.public_send("#{name}=", val)
+        end
+      end
     end
 
     # Advance the progress bar to the updated value
@@ -152,15 +230,17 @@ module TTY
     #
     # @api public
     def ratio
-      proportion = total > 0 ? (@current.to_f / total) : 0
-      [[proportion, 0].max, 1].min
+      synchronize do
+        proportion = total > 0 ? (@current.to_f / total) : 0
+        [[proportion, 0].max, 1].min
+      end
     end
 
     # Render progress to the output
     #
     # @api private
     def render
-      return if @done
+      return if done?
       if hide_cursor && @last_render_width == 0 && !(@current >= total)
         write(ECMA_CSI + DEC_TCEM + DEC_RST)
       end
@@ -175,15 +255,43 @@ module TTY
       @last_render_width = formatted.length
     end
 
+    # Move cursor to a row of the current bar if the bar is rendered
+    # under a multibar. Otherwise, do not move and yield on current row.
+    #
+    # @api private
+    def move_to_row
+      if @multibar
+        CURSOR_LOCK.synchronize do
+          if @first_render
+            @row = @multibar.next_row
+            yield if block_given?
+            output.print "\n"
+            @first_render = false
+          else
+            lines_up = (@multibar.rows + 1) - @row
+            output.print TTY::Cursor.save
+            output.print TTY::Cursor.up(lines_up)
+            yield if block_given?
+            output.print TTY::Cursor.restore
+          end
+        end
+      else
+        yield if block_given?
+      end
+    end
+
     # Write out to the output
     #
     # @param [String] data
     #
     # @api private
     def write(data, clear_first = false)
-      output.print(ECMA_CSI + '1' + ECMA_CHA) if clear_first
-      output.print(data)
-      output.flush
+      move_to_row do
+        output.print(TTY::Cursor.column(1)) if clear_first
+        characters_in = @multibar.line_inset(self) if @multibar
+        output.print("#{characters_in}#{data}")
+        output.flush
+      end
     end
 
     # Resize progress bar with new configuration
@@ -193,10 +301,12 @@ module TTY
     #
     # @api public
     def resize(new_width = nil)
-      return if @done
-      clear_line
-      if new_width
-        self.width = new_width
+      return if done?
+      synchronize do
+        clear_line
+        if new_width
+          self.width = new_width
+        end
       end
     end
 
@@ -208,31 +318,38 @@ module TTY
       if hide_cursor && @last_render_width != 0
         write(ECMA_CSI + DEC_TCEM + DEC_SET, false)
       end
-      return if @done
+      return if done?
       @current = total unless no_width
       render
       clear ? clear_line : write("\n", false)
+    ensure
       @meter.clear
       @done = true
+      emit(:done)
     end
 
-    # Clear current line
+    # Stop and cancel the progress at the current position
     #
     # @api public
-    def clear_line
-      output.print(ECMA_CSI + '0m' + ECMA_CSI + '1000D' + ECMA_CSI + ECMA_CLR)
+    def stop
+      # reenable cursor if it is turned off
+      if hide_cursor && @last_render_width != 0
+        write(ECMA_CSI + DEC_TCEM + DEC_SET, false)
+      end
+      return if done?
+      render
+      clear ? clear_line : write("\n", false)
+    ensure
+      @meter.clear
+      @stopped = true
+      emit(:stopped)
     end
 
-    # Reset progress to default configuration
+    # Clear current line
     #
     # @api public
-    def reset
-      @current  = 0
-      @readings = 0
-      @done     = false
-      @meter.clear
-
-      advance(0) # rerender with new configuration
+    def clear_line
+      output.print(ECMA_CSI + '0m' + ECMA_CSI + '1000D' + ECMA_CSI + ECMA_CLR)
     end
 
     # Check if progress is finised
@@ -245,6 +362,39 @@ module TTY
       @done
     end
 
+    # Check if progress is stopped
+    #
+    # @return [Boolean]
+    #
+    # @api public
+    def stopped?
+      @stopped
+    end
+
+    # Check if progress is finished or stopped
+    #
+    # @return [Boolean]
+    #
+    # @api public
+    def done?
+      @done || @stopped
+    end
+
+    # Register callback with this bar
+    #
+    # @param [Symbol] name
+    #   the name for the event to listen for, e.i. :complete
+    #
+    # @return [self]
+    #
+    # @api public
+    def on(name, &callback)
+      synchronize do
+        @callbacks[name] << callback
+      end
+      self
+    end
+
     # Log message above the current progress bar
     #
     # @param [String] message
@@ -253,7 +403,7 @@ module TTY
     # @api public
     def log(message)
       sanitized_message = message.gsub(/\r|\n/, ' ')
-      if @done
+      if done?
         write(sanitized_message + "\n", false)
         return
       end
@@ -287,14 +437,15 @@ module TTY
     #
     # @api public
     def inspect
-      output = "#<#{self.class.name} "
-      output << "@format=\"#{format}\", "
-      output << "@current=\"#{@current}\", "
-      output << "@total=\"#{total}\", "
-      output << "@width=\"#{width}\", "
-      output << "@complete=\"#{complete}\", "
-      output << "@incomplete=\"#{incomplete}\", "
-      output << "@interval=\"#{interval}\">"
+      "#<#{self.class.name} " \
+      "@format=\"#{format}\", " \
+      "@current=\"#{@current}\", " \
+      "@total=\"#{total}\", " \
+      "@width=\"#{width}\", " \
+      "@complete=\"#{complete}\", " \
+      "@head=\"#{head}\", " \
+      "@incomplete=\"#{incomplete}\", " \
+      "@interval=\"#{interval}\">"
     end
 
     private
@@ -309,5 +460,17 @@ module TTY
       end
       message
     end
+
+    # Emit callback by name
+    #
+    # @param [Symbol]
+    #   the event name
+    #
+    # @api private
+    def emit(name, *args)
+      @callbacks[name].each do |callback|
+        callback.call(*args)
+      end
+    end
   end # ProgressBar
 end # TTY