tty-progressbar 0.11.0 → 0.12.0

data/lib/tty/progressbar/configuration.rb

@@ -14,6 +14,8 @@ module TTY
 
       attr_accessor :complete
 
+      attr_accessor :head
+
       attr_accessor :hide_cursor
 
       attr_accessor :clear
@@ -30,10 +32,12 @@ module TTY
         @no_width    = options.fetch(:no_width) { false }
         @incomplete  = options.fetch(:incomplete) { ' ' }
         @complete    = options.fetch(:complete) { '=' }
+        @head        = options.fetch(:head) { @complete || '=' }
         @hide_cursor = options.fetch(:hide_cursor) { false }
         @clear       = options.fetch(:clear) { false }
         @output      = options.fetch(:output) { $stderr }
         @frequency   = options.fetch(:frequency) { 0 } # 0Hz
+        @interval    = options.fetch(:interval) { 1 } # 1 sec
       end
 
       def total=(value)

data/lib/tty/progressbar/converter.rb

@@ -1,4 +1,5 @@
-# coding: utf-8
+# encoding: utf-8
+# frozen_string_literal: true
 
 module TTY
   class ProgressBar

data/lib/tty/progressbar/formatter.rb

@@ -1,4 +1,5 @@
-# coding: utf-8
+# encoding: utf-8
+# frozen_string_literal: true
 
 require_relative 'pipeline'
 

data/lib/tty/progressbar/formatter/bar.rb

@@ -1,4 +1,5 @@
-# coding: utf-8
+# encoding: utf-8
+# frozen_string_literal: true
 
 module TTY
   class ProgressBar
@@ -35,6 +36,7 @@ module TTY
         complete_length = (width * @progress.ratio).round
         complete   = Array.new(complete_length, @progress.complete)
         incomplete = Array.new(width - complete_length, @progress.incomplete)
+        complete[-1] = @progress.head if complete_length > 0
 
         bar = ''
         bar += complete.join

data/lib/tty/progressbar/formatter/byte_rate.rb

@@ -1,4 +1,5 @@
-# coding: utf-8
+# encoding: utf-8
+# frozen_string_literal: true
 
 require_relative '../converter'
 

data/lib/tty/progressbar/formatter/current.rb

@@ -1,4 +1,5 @@
-# coding: utf-8
+# encoding: utf-8
+# frozen_string_literal: true
 
 module TTY
   class ProgressBar

data/lib/tty/progressbar/formatter/current_byte.rb

@@ -1,4 +1,5 @@
-# coding: utf-8
+# encoding: utf-8
+# frozen_string_literal: true
 
 require_relative '../converter'
 

data/lib/tty/progressbar/formatter/elapsed.rb

@@ -1,4 +1,5 @@
-# coding: utf-8
+# encoding: utf-8
+# frozen_string_literal: true
 
 require_relative '../converter'
 

data/lib/tty/progressbar/formatter/estimated.rb

@@ -1,4 +1,5 @@
-# coding: utf-8
+# encoding: utf-8
+# frozen_string_literal: true
 
 require_relative '../converter'
 

data/lib/tty/progressbar/formatter/mean_byte.rb

@@ -1,4 +1,5 @@
-# coding: utf-8
+# encoding: utf-8
+# frozen_string_literal: true
 
 require_relative '../converter'
 

data/lib/tty/progressbar/formatter/mean_rate.rb

@@ -1,4 +1,5 @@
-# coding: utf-8
+# encoding: utf-8
+# frozen_string_literal: true
 
 require_relative '../converter'
 

data/lib/tty/progressbar/formatter/percent.rb

@@ -1,4 +1,5 @@
-# coding: utf-8
+# encoding: utf-8
+# frozen_string_literal: true
 
 module TTY
   class ProgressBar

data/lib/tty/progressbar/formatter/rate.rb

@@ -1,4 +1,5 @@
-# coding: utf-8
+# encoding: utf-8
+# frozen_string_literal: true
 
 require_relative '../converter'
 

data/lib/tty/progressbar/formatter/total.rb

@@ -1,4 +1,5 @@
-# coding: utf-8
+# encoding: utf-8
+# frozen_string_literal: true
 
 module TTY
   class ProgressBar

data/lib/tty/progressbar/formatter/total_byte.rb

@@ -1,4 +1,5 @@
-# coding: utf-8
+# encoding: utf-8
+# frozen_string_literal: true
 
 require_relative '../converter'
 

data/lib/tty/progressbar/meter.rb

@@ -1,4 +1,5 @@
-# coding: utf-8
+# encoding: utf-8
+# frozen_string_literal: true
 
 module TTY
   class ProgressBar

data/lib/tty/progressbar/multi.rb

@@ -0,0 +1,221 @@
+# encoding: utf-8
+# frozen_string_literal: true
+
+require 'forwardable'
+require 'monitor'
+
+require_relative '../progressbar'
+
+module TTY
+  class ProgressBar
+    # Used for managing multiple terminal progress bars
+    #
+    # @api public
+    class Multi
+      include Enumerable
+      include MonitorMixin
+
+      extend Forwardable
+
+      def_delegators :@bars, :each, :empty?, :length, :[]
+
+      DEFAULT_INSET = {
+        top:    Gem.win_platform? ? '+ '   : "\u250c ",
+        middle: Gem.win_platform? ? '|-- ' : "\u251c\u2500\u2500 ",
+        bottom: Gem.win_platform? ? '|__ ' : "\u2514\u2500\u2500 "
+      }.freeze
+
+      # Number of currently occupied rows in terminal display
+      attr_reader :rows
+
+      # Create a multibar
+      #
+      # @example
+      #   bars = TTY::ProgressBar::Multi.new
+      #
+      # @example
+      #   bars = TTY::ProgressBar::Multi.new("main [:bar]")
+      #
+      # @param [String] format
+      #   the formatting string to display this bar
+      #
+      # @param [Hash] options
+      #
+      # @api public
+      def initialize(*args)
+        super()
+        @options = args.last.is_a?(::Hash) ? args.pop : {}
+        format = args.empty? ? nil : args.pop
+        @inset_opts = @options.delete(:style) { DEFAULT_INSET }
+        @bars = []
+        @rows = 0
+        @top_bar = nil
+        @top_bar = register(format) if format
+
+        @callbacks = {
+          progress: [],
+          stopped:  [],
+          done:     []
+        }
+      end
+
+      # Register a new progress bar
+      #
+      # @param [String] format
+      #   the formatting string to display the bar
+      #
+      # @api public
+      def register(format, options = {})
+        bar = TTY::ProgressBar.new(format, @options.merge(options))
+
+        synchronize do
+          bar.attach_to(self)
+          @bars << bar
+
+          if @top_bar
+            @top_bar.update(total: total, width: total)
+            observe(bar)
+          end
+        end
+
+        bar
+      end
+
+      # Increase row count
+      #
+      # @api public
+      def next_row
+        synchronize do
+          @rows += 1
+        end
+      end
+
+      # Observe a bar for emitted events
+      #
+      # @param [TTY::ProgressBar] bar
+      #   the bar to observe for events
+      #
+      # @api public
+      def observe(bar)
+        bar.on(:progress) { top_bar.current = current; emit(:progress) }
+           .on(:done)     { top_bar.finish; emit(:done) if complete?  }
+           .on(:stopped)  { top_bar.stop; emit(:stopped) if stopped? }
+      end
+
+      # Get the top level bar if it exists
+      #
+      # @api public
+      def top_bar
+        raise "No top level progress bar" unless @top_bar
+
+        @top_bar
+      end
+
+      def start
+        raise "No top level progress bar" unless @top_bar
+
+        @top_bar.start
+      end
+
+      # Calculate total maximum progress of all bars
+      #
+      # @return [Integer]
+      #
+      # @api public
+      def total
+        (@bars - [@top_bar]).dup.map(&:total).reduce(&:+)
+      end
+
+      # Calculate total current progress of all bars
+      #
+      # @return [Integer]
+      #
+      # @api public
+      def current
+        (@bars - [@top_bar]).dup.map(&:current).reduce(&:+)
+      end
+
+      # Check if all progress bars are complete
+      #
+      # @return [Boolean]
+      #
+      # @api public
+      def complete?
+        (@bars - [@top_bar]).dup.all?(&:complete?)
+      end
+
+      # Check if any of the registered progress bars is stopped
+      #
+      # @return [Boolean]
+      #
+      # @api public
+      def stopped?
+        (@bars - [@top_bar]).dup.any?(&:stopped?)
+      end
+
+      # Stop all progress bars
+      #
+      # @api public
+      def stop
+        @bars.dup.each(&:stop)
+      end
+
+      # Finish all progress bars
+      #
+      # @api public
+      def finish
+        @top_bar.finish if @top_bar
+        @bars.dup.each(&:finish)
+      end
+
+      # Find the number of characters to move into the line
+      # before printing the bar
+      #
+      # @param [TTY::ProgressBar] bar
+      #   the progress bar for which line inset is calculated
+      #
+      # @return [String]
+      #   the inset
+      #
+      # @api public
+      def line_inset(bar)
+        return '' if @top_bar.nil?
+
+        case bar.row
+        when @top_bar.row
+          @inset_opts[:top]
+        when rows
+          @inset_opts[:bottom]
+        else
+          @inset_opts[:middle]
+        end
+      end
+
+      # Listen on event
+      #
+      # @param [Symbol] name
+      #   the event name to listen on
+      #
+      # @api public
+      def on(name, &callback)
+        unless @callbacks.key?(name)
+          raise ArgumentError, "The event #{name} does not exist. "\
+                               " Use :progress, :stopped, or :done instead"
+        end
+        @callbacks[name] << callback
+        self
+      end
+
+      private
+
+      # Fire an event by name
+      #
+      # @api private
+      def emit(name, *args)
+        @callbacks[name].each do |callback|
+          callback.(*args)
+        end
+      end
+    end # Multi
+  end # ProgressBar
+end # TTY

data/lib/tty/progressbar/version.rb

@@ -2,6 +2,6 @@
 
 module TTY
   class ProgressBar
-    VERSION = '0.11.0'
+    VERSION = '0.12.0'
   end # ProgressBar
 end # TTY

data/spec/unit/events_spec.rb

@@ -0,0 +1,35 @@
+# encoding: utf-8
+
+RSpec.describe TTY::ProgressBar, 'events' do
+  let(:output) { StringIO.new('', 'w+') }
+
+  it "emits :progress event when advancing" do
+    events = []
+    bar = TTY::ProgressBar.new("[:bar]", output: output, total: 5)
+    bar.on(:progress) { events << :progress }
+
+    bar.advance
+
+    expect(events).to eq([:progress])
+  end
+
+  it "emits :done event when finished" do
+    events = []
+    bar = TTY::ProgressBar.new("[:bar]", output: output, total: 5)
+    bar.on(:done) { events << :done }
+
+    bar.finish
+
+    expect(events).to eq([:done])
+  end
+
+  it "emits :stopped event" do
+    events = []
+    bar = TTY::ProgressBar.new("[:bar]", output: output, total: 5)
+    bar.on(:stopped) { events << :stopped }
+
+    bar.stop
+
+    expect(events).to eq([:stopped])
+  end
+end

data/spec/unit/formatter/elapsed_spec.rb

@@ -53,7 +53,6 @@ RSpec.describe TTY::ProgressBar, ':elapsed token' do
       "\e[1G 3s",
       "\e[1G 4s\n",
       "\e[1G 0s",
-      "\e[1G 0s",
       "\e[1G 1s"
     ].join)
     Timecop.return

data/spec/unit/head_spec.rb

@@ -0,0 +1,34 @@
+# encoding: utf-8
+
+RSpec.describe TTY::ProgressBar, ':head' do
+  let(:output) { StringIO.new('', 'w+')}
+
+  it "animates head" do
+    progress = TTY::ProgressBar.new("[:bar]", output: output, head: '>', total: 5)
+    5.times { progress.advance }
+    output.rewind
+    expect(output.read).to eq([
+      "\e[1G[>    ]",
+      "\e[1G[=>   ]",
+      "\e[1G[==>  ]",
+      "\e[1G[===> ]",
+      "\e[1G[====>]\n"
+    ].join)
+  end
+
+  it "customises all output characters" do
+    progress = TTY::ProgressBar.new("[:bar]",
+      output: output,
+      head: 'ᗧ',
+      complete: '-', incomplete: '.', total: 5)
+    5.times { progress.advance }
+    output.rewind
+    expect(output.read).to eq([
+      "\e[1G[ᗧ....]",
+      "\e[1G[-ᗧ...]",
+      "\e[1G[--ᗧ..]",
+      "\e[1G[---ᗧ.]",
+      "\e[1G[----ᗧ]\n"
+    ].join)
+  end
+end