tty-progressbar 0.17.0 → 0.18.0

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

@@ -1,31 +1,25 @@
 # frozen_string_literal: true
 
+require_relative "../formatter"
+
 module TTY
   class ProgressBar
     # Used by {Pipeline} to format :percent token
     #
     # @api private
     class PercentFormatter
-      MATCHER = /:percent\b/.freeze
-
-      def initialize(progress, *args, &block)
-        @progress = progress
-      end
+      include TTY::ProgressBar::Formatter[/:percent\b/.freeze]
 
-      # Determines whether this formatter is applied or not.
+      # Format :percent token
       #
-      # @param [Object] value
+      # @param [String] value
+      #  the value to format
       #
-      # @return [Boolean]
-      #
-      # @api private
-      def matches?(value)
-        !!(value.to_s =~ MATCHER)
-      end
-
-      def format(value)
+      # @api public
+      def call(value)
         percent = @progress.width == 0 ? 100 : (@progress.ratio * 100).to_i
-        value.gsub(MATCHER, percent.to_s + '%')
+        display = @progress.indeterminate? ? "-" : percent.to_s
+        value.gsub(matcher, "#{display}%")
       end
     end # PercentFormatter
   end # ProgressBar

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

@@ -1,6 +1,7 @@
 # frozen_string_literal: true
 
-require_relative '../converter'
+require_relative "../converter"
+require_relative "../formatter"
 
 module TTY
   class ProgressBar
@@ -8,22 +9,7 @@ module TTY
     #
     # @api private
     class RateFormatter
-      MATCHER = /:rate/i.freeze
-
-      def initialize(progress)
-        @progress  = progress
-      end
-
-      # Determines whether this formatter is applied or not.
-      #
-      # @param [Object] value
-      #
-      # @return [Boolean]
-      #
-      # @api private
-      def matches?(value)
-        !!(value.to_s =~ MATCHER)
-      end
+      include TTY::ProgressBar::Formatter[/:rate/i.freeze]
 
       # Format :rate token
       #
@@ -31,9 +17,9 @@ module TTY
       #  the value being formatted
       #
       # @api public
-      def format(value)
+      def call(value)
         formatted = Converter.to_seconds(@progress.rate)
-        value.gsub(MATCHER, formatted)
+        value.gsub(matcher, formatted)
       end
     end # RateFormatter
   end # ProgressBar

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

@@ -1,30 +1,24 @@
 # frozen_string_literal: true
 
+require_relative "../formatter"
+
 module TTY
   class ProgressBar
     # Used by {Pipeline} to format :total token
     #
     # @api private
     class TotalFormatter
-      MATCHER = /:total\b/i.freeze
-
-      def initialize(progress, *args, &block)
-        @progress = progress
-      end
+      include TTY::ProgressBar::Formatter[/:total\b/i.freeze]
 
-      # Determines whether this formatter is applied or not.
+      # Format :total token
       #
-      # @param [Object] value
+      # @param [String] value
+      #  the value to format
       #
-      # @return [Boolean]
-      #
-      # @api private
-      def matches?(value)
-        !!(value.to_s =~ MATCHER)
-      end
-
-      def format(value)
-        value.gsub(MATCHER, @progress.total.to_s)
+      # @api public
+      def call(value)
+        display = @progress.indeterminate? ? "-" : @progress.total.to_s
+        value.gsub(matcher, display)
       end
     end # TotalFormatter
   end # ProgressBar

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

@@ -1,6 +1,7 @@
 # frozen_string_literal: true
 
-require_relative '../converter'
+require_relative "../converter"
+require_relative "../formatter"
 
 module TTY
   class ProgressBar
@@ -8,26 +9,21 @@ module TTY
     #
     # @api private
     class TotalByteFormatter
-      MATCHER = /:total_byte/i.freeze
+      include TTY::ProgressBar::Formatter[/:total_byte/i.freeze]
 
-      def initialize(progress, *args, &block)
-        @progress = progress
-      end
-
-      # Determines whether this formatter is applied or not.
-      #
-      # @param [Object] value
+      # Format :total_byte token
       #
-      # @return [Boolean]
+      # @param [String] value
+      #  the value to format
       #
-      # @api private
-      def matches?(value)
-        !!(value.to_s =~ MATCHER)
-      end
-
-      def format(value)
-        bytes = Converter.to_bytes(@progress.total)
-        value.gsub(MATCHER, bytes)
+      # @api public
+      def call(value)
+        bytes = if @progress.indeterminate?
+                  "-B"
+                else
+                  Converter.to_bytes(@progress.total)
+                end
+        value.gsub(matcher, bytes)
       end
     end # TotalByteFormatter
   end # ProgressBar

data/lib/tty/progressbar/formatters.rb

@@ -0,0 +1,53 @@
+# frozen_string_literal: true
+
+require "forwardable"
+
+require_relative "pipeline"
+
+require_relative "formatter/bar"
+require_relative "formatter/current"
+require_relative "formatter/current_byte"
+require_relative "formatter/elapsed"
+require_relative "formatter/estimated"
+require_relative "formatter/estimated_time"
+require_relative "formatter/percent"
+require_relative "formatter/rate"
+require_relative "formatter/byte_rate"
+require_relative "formatter/mean_rate"
+require_relative "formatter/mean_byte"
+require_relative "formatter/total"
+require_relative "formatter/total_byte"
+
+module TTY
+  class ProgressBar
+    class Formatters
+      extend Forwardable
+
+      def_delegators :@pipeline, :decorate, :use
+
+      # @api private
+      def initialize(pipeline = nil)
+        @pipeline = pipeline || TTY::ProgressBar::Pipeline.new
+      end
+
+      # Prepare default pipeline formatters
+      #
+      # @api private
+      def load(progress)
+        @pipeline.use TTY::ProgressBar::CurrentFormatter.new(progress)
+        @pipeline.use TTY::ProgressBar::TotalFormatter.new(progress)
+        @pipeline.use TTY::ProgressBar::TotalByteFormatter.new(progress)
+        @pipeline.use TTY::ProgressBar::ElapsedFormatter.new(progress)
+        @pipeline.use TTY::ProgressBar::EstimatedTimeFormatter.new(progress)
+        @pipeline.use TTY::ProgressBar::EstimatedFormatter.new(progress)
+        @pipeline.use TTY::ProgressBar::PercentFormatter.new(progress)
+        @pipeline.use TTY::ProgressBar::ByteFormatter.new(progress)
+        @pipeline.use TTY::ProgressBar::ByteRateFormatter.new(progress)
+        @pipeline.use TTY::ProgressBar::RateFormatter.new(progress)
+        @pipeline.use TTY::ProgressBar::MeanRateFormatter.new(progress)
+        @pipeline.use TTY::ProgressBar::MeanByteFormatter.new(progress)
+        @pipeline.use TTY::ProgressBar::BarFormatter.new(progress)
+      end
+    end # Formatters
+  end # ProgressBar
+end # TTY

data/lib/tty/progressbar/meter.rb

@@ -5,7 +5,7 @@ module TTY
     # Used by {ProgressBar} to measure progress rate per interval
     # by default 1s
     #
-    # @api privatek
+    # @api private
     class Meter
       # Create Meter
       #
@@ -103,7 +103,7 @@ module TTY
           last_value / (last_at - @start_time)
         end
       end
-      alias_method :avg_rate, :mean_rate
+      alias avg_rate mean_rate
 
       # Reset the meter by clearing out it's metrics
       #

data/lib/tty/progressbar/multi.rb

@@ -1,9 +1,9 @@
 # frozen_string_literal: true
 
-require 'forwardable'
-require 'monitor'
+require "forwardable"
+require "monitor"
 
-require_relative '../progressbar'
+require_relative "../progressbar"
 
 module TTY
   class ProgressBar
@@ -21,9 +21,9 @@ module TTY
       def_delegators :@top_bar, :width, :width=
 
       DEFAULT_INSET = {
-        top:    Gem.win_platform? ? '+ '   : "\u250c ",
-        middle: Gem.win_platform? ? '|-- ' : "\u251c\u2500\u2500 ",
-        bottom: Gem.win_platform? ? '|__ ' : "\u2514\u2500\u2500 "
+        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
@@ -54,12 +54,13 @@ module TTY
         @top_bar = register(format, observable: false) if format
 
         @width = @options[:width]
-        @top_bar.update(width: @width) if @width
+        @top_bar.update(width: @width) if @top_bar && @width
 
         @callbacks = {
           progress: [],
-          stopped:  [],
-          done:     []
+          stopped: [],
+          paused: [],
+          done: []
         }
       end
 
@@ -79,6 +80,7 @@ module TTY
           observe(bar) if observable
           if @top_bar
             @top_bar.update(total: total)
+            @top_bar.resume if @top_bar.done?
             @top_bar.update(width: total) unless @width
           end
         end
@@ -104,14 +106,15 @@ module TTY
       def observe(bar)
         bar.on(:progress, &progress_handler)
            .on(:done) { emit(:done) if complete? }
-           .on(:stopped)  { emit(:stopped) if stopped? }
+           .on(:stopped) { emit(:stopped) if stopped? }
+           .on(:paused) { emit(:paused) if paused? }
       end
 
       # Handle the progress event
       #
       # @api private
       def progress_handler
-        -> (progress) do
+        ->(progress) do
           @top_bar.advance(progress) if @top_bar
           emit(:progress, progress)
         end
@@ -139,7 +142,7 @@ module TTY
       # @api public
       def total
         synchronize do
-          (@bars - [@top_bar]).dup.map(&:total).reduce(&:+)
+          (@bars - [@top_bar]).map(&:total).reduce(&:+)
         end
       end
 
@@ -150,7 +153,7 @@ module TTY
       # @api public
       def current
         synchronize do
-          (@bars - [@top_bar]).dup.map(&:current).reduce(&:+)
+          (@bars - [@top_bar]).map(&:current).reduce(&:+)
         end
       end
 
@@ -161,18 +164,40 @@ module TTY
       # @api public
       def complete?
         synchronize do
-          (@bars - [@top_bar]).dup.all?(&:complete?)
+          (@bars - [@top_bar]).all?(&:complete?)
         end
       end
 
-      # Check if any of the registered progress bars is stopped
+      # Check if all of the registered progress bars is stopped
       #
       # @return [Boolean]
       #
       # @api public
       def stopped?
         synchronize do
-          (@bars - [@top_bar]).dup.any?(&:stopped?)
+          (@bars - [@top_bar]).all?(&:stopped?)
+        end
+      end
+
+      # Check if all bars are stopped or finished
+      #
+      # @return [Boolean]
+      #
+      # @api public
+      def done?
+        synchronize do
+          (@bars - [@top_bar]).all?(&:done?)
+        end
+      end
+
+      # Check if all bars are paused
+      #
+      # @return [Boolean]
+      #
+      # @api public
+      def paused?
+        synchronize do
+          (@bars - [@top_bar]).all?(&:paused?)
         end
       end
 
@@ -180,14 +205,28 @@ module TTY
       #
       # @api public
       def stop
-        @bars.dup.each(&:stop)
+        @bars.each(&:stop)
       end
 
       # Finish all progress bars
       #
       # @api public
       def finish
-        @bars.dup.each(&:finish)
+        @bars.each(&:finish)
+      end
+
+      # Pause all progress bars
+      #
+      # @api public
+      def pause
+        @bars.each(&:pause)
+      end
+
+      # Resume all progress bars
+      #
+      # @api public
+      def resume
+        @bars.each(&:resume)
       end
 
       # Find the number of characters to move into the line
@@ -201,7 +240,7 @@ module TTY
       #
       # @api public
       def line_inset(bar)
-        return '' if @top_bar.nil?
+        return "" if @top_bar.nil?
 
         case bar.row
         when @top_bar.row
@@ -221,8 +260,9 @@ module TTY
       # @api public
       def on(name, &callback)
         unless @callbacks.key?(name)
-          raise ArgumentError, "The event #{name} does not exist. "\
-                               " Use :progress, :stopped, or :done instead"
+          raise ArgumentError, "The event #{name} does not exist. " \
+                               "Use :progress, :stopped, :paused or " \
+                               ":done instead"
         end
         @callbacks[name] << callback
         self

data/lib/tty/progressbar/pipeline.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module TTY
   class ProgressBar
     # Used by {ProgressBar} to decorate format string
@@ -17,24 +19,29 @@ module TTY
       # Add a new formatter
       #
       # @example
-      #   use(TTY::ProgressBar::TotalFormatter)
+      #   use(TTY::ProgressBar::TotalFormatter.new(progress_bar))
       #
       # @api public
       def use(formatter)
-        formatters << proc { |progress| formatter.new(progress) }
+        formatters << formatter
       end
 
       # Decorate the tokenized string with actual values
       #
+      # @example
+      #   decorate("[:bar] :current :elapsed")
+      #
+      # @param [String] tokenized
+      #   the string with tokens
+      #
       # @return [nil]
       #
       # @api private
-      def decorate(progress, tokenized)
+      def decorate(tokenized)
         base = tokenized.dup
         formatters.inject(base) do |formatted, formatter|
-          instance = formatter.call(progress)
-          if instance.respond_to?(:matches?) && instance.matches?(formatted)
-            instance.format(formatted)
+          if formatter.respond_to?(:matches?) && formatter.matches?(formatted)
+            formatter.(formatted)
           else
             formatted
           end