tty-progressbar 0.17.0 → 0.18.0

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

@@ -1,27 +1,14 @@
 # frozen_string_literal: true
 
+require_relative "../formatter"
+
 module TTY
   class ProgressBar
     # Used by {Pipeline} to format bar
     #
     # @api private
     class BarFormatter
-      MATCHER = /:bar/.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[/:bar/i.freeze]
 
       # Format :bar token
       #
@@ -29,30 +16,90 @@ module TTY
       #  the value being formatted
       #
       # @api public
-      def format(value)
-        without_bar = value.gsub(/:bar/, '')
+      def call(value)
+        without_bar = value.gsub(/:bar/, "")
         available_space = [0, ProgressBar.max_columns -
                               ProgressBar.display_columns(without_bar) -
                               @progress.inset].max
-        width = [@progress.width, available_space].min
+        width = [@progress.width.to_i, available_space].min
+
+        # When we don't know the total progress, use either user
+        # defined width or rely on terminal width detection
+        if @progress.indeterminate?
+          width = available_space if width.zero?
+
+          format_indeterminate(value, width)
+        else
+          format_determinate(value, width)
+        end
+      end
+
+      private
+
+      # @api private
+      def format_indeterminate(value, width)
+        buffer = []
+        possible_width = width
+        unknown_char_length    = ProgressBar.display_columns(@progress.unknown)
+        complete_char_length   = ProgressBar.display_columns(@progress.complete)
+        incomplete_char_length = ProgressBar.display_columns(@progress.incomplete)
+        head_char_length       = ProgressBar.display_columns(@progress.head)
+
+        possible_width -= unknown_char_length
+        max_char_length = [complete_char_length, incomplete_char_length,
+                           head_char_length].max
+        # figure out how many unicode chars would fit normally
+        # when the bar has total to prevent resizing
+        possible_width = (possible_width / max_char_length) * max_char_length
+        complete = (possible_width * @progress.ratio).round
+        incomplete = possible_width - complete
+
+        buffer << " " * complete
+        buffer << @progress.unknown
+        buffer << " " * incomplete
+
+        value.gsub(matcher, buffer.join)
+      end
+
+      # @api private
+      def format_determinate(value, width)
         complete_bar_length    = (width * @progress.ratio).round
         complete_char_length   = ProgressBar.display_columns(@progress.complete)
         incomplete_char_length = ProgressBar.display_columns(@progress.incomplete)
+        head_char_length       = ProgressBar.display_columns(@progress.head)
 
-        # decimal number of items only when unicode chars are used
+        # division by char length only when unicode chars are used
         # otherwise it has no effect on regular ascii chars
-        complete_items   = (complete_bar_length / complete_char_length.to_f).round
-        incomplete_items = (width - complete_items * complete_char_length) / incomplete_char_length
+        complete_items = [
+          complete_bar_length / complete_char_length,
+          # or see how many incomplete (unicode) items fit
+          (complete_bar_length / incomplete_char_length) * incomplete_char_length
+        ].min
+
+        complete_width = complete_items * complete_char_length
+        incomplete_width = width - complete_width
+        incomplete_items = [
+          incomplete_width / incomplete_char_length,
+          # or see how many complete (unicode) items fit
+          (incomplete_width / complete_char_length) * complete_char_length
+        ].min
 
         complete   = Array.new(complete_items, @progress.complete)
         incomplete = Array.new(incomplete_items, @progress.incomplete)
-        complete[-1] = @progress.head if complete_bar_length > 0
 
-        bar = ''
-        bar += complete.join
-        bar += incomplete.join
+        if complete_items > 0 && head_char_length > 0 &&
+           (incomplete_items > 0 || incomplete_items.zero? && !@progress.clear_head)
+          # see how many head chars per complete char
+          times = (head_char_length / complete_char_length.to_f).round
+          if complete_items < times # not enough complete chars to fit
+            incomplete.pop(times - complete_items)
+          end
+          complete.pop(times)
+          extra_space = " " * (times * complete_char_length - head_char_length)
+          complete << "#{@progress.head}#{extra_space}"
+        end
 
-        value.gsub(MATCHER, bar)
+        value.gsub(matcher, "#{complete.join}#{incomplete.join}")
       end
     end # BarFormatter
   end #  ProgressBar

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

@@ -1,6 +1,7 @@
 # frozen_string_literal: true
 
-require_relative '../converter'
+require_relative "../converter"
+require_relative "../formatter"
 
 module TTY
   class ProgressBar
@@ -8,32 +9,17 @@ module TTY
     #
     # @api private
     class ByteRateFormatter
-      MATCHER = /:byte_rate/i
-
-      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[/:byte_rate/i.freeze]
 
       # Format :byte_rate token
       #
       # @param [String] value
-      #  the value being formatted
+      #  the value to format
       #
       # @api public
-      def format(value)
+      def call(value)
         formatted = Converter.to_bytes(@progress.rate)
-        value.gsub(MATCHER, formatted)
+        value.gsub(matcher, formatted)
       end
     end # ByteRateFormatter
   end # ProgressBar

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

@@ -6,31 +6,16 @@ module TTY
     #
     # @api private
     class CurrentFormatter
-      MATCHER = /:current\b/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[/:current\b/i.freeze]
 
       # Format :current token
       #
       # @param [String] value
-      #  the value being formatted
+      #  the value to format
       #
       # @api public
-      def format(value)
-        value.gsub(MATCHER, @progress.current.to_s)
+      def call(value)
+        value.gsub(matcher, @progress.current.to_s)
       end
     end # CurrentFormatter
   end # ProgressBar

data/lib/tty/progressbar/formatter/current_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,17 @@ module TTY
     #
     # @api private
     class ByteFormatter
-      MATCHER = /(:current_byte|:byte)\b/i.freeze
+      include TTY::ProgressBar::Formatter[/(:current_byte|:byte)\b/i.freeze]
 
-      def initialize(progress)
-        @progress = progress
-      end
-
-      # Determines whether this formatter is applied or not.
-      #
-      # @param [Object] value
+      # Format :current_byte token
       #
-      # @return [Boolean]
+      # @param [String] value
+      #  the value to format
       #
-      # @api private
-      def matches?(value)
-        !!(value.to_s =~ MATCHER)
-      end
-
-      def format(value)
+      # @api public
+      def call(value)
         bytes = Converter.to_bytes(@progress.current)
-        value.gsub(MATCHER, bytes)
+        value.gsub(matcher, bytes)
       end
     end # ByteFormatter
   end # ProgressBar

data/lib/tty/progressbar/formatter/elapsed.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,16 @@ module TTY
     #
     # @api private
     class ElapsedFormatter
-      MATCHER = /:elapsed/.freeze
+      include TTY::ProgressBar::Formatter[/:elapsed/.freeze]
 
-      def initialize(progress)
-        @progress  = progress
-      end
-
-      # Determines whether this formatter is applied or not.
-      #
-      # @param [Object] value
+      # Format :elapsed token
       #
-      # @return [Boolean]
+      # @param [String] value
+      #  the value to format
       #
-      # @api private
-      def matches?(value)
-        !!(value.to_s =~ MATCHER)
-      end
-
-      def format(value)
-        elapsed = (Time.now - @progress.start_at)
-        value.gsub(MATCHER, Converter.to_time(elapsed))
+      # @api public
+      def call(value)
+        value.gsub(matcher, Converter.to_time(@progress.elapsed_time))
       end
     end # ElapsedFormatter
   end # ProgressBar

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

@@ -1,6 +1,7 @@
 # frozen_string_literal: true
 
-require_relative '../converter'
+require_relative "../converter"
+require_relative "../formatter"
 
 module TTY
   class ProgressBar
@@ -8,29 +9,24 @@ module TTY
     #
     # @api private
     class EstimatedFormatter
-      MATCHER = /:eta/.freeze
+      include TTY::ProgressBar::Formatter[/:eta/.freeze]
 
-      def initialize(progress)
-        @progress  = progress
-      end
-
-      # Determines whether this formatter is applied or not.
+      # Format :eta token
       #
-      # @param [Object] value
+      # @param [String] value
+      #  the value to format
       #
-      # @return [Boolean]
-      #
-      # @api private
-      def matches?(value)
-        !!(value.to_s =~ MATCHER)
-      end
+      # @api public
+      def call(value)
+        if @progress.indeterminate?
+          return value.gsub(matcher, "--s")
+        end
 
-      def format(value)
-        elapsed   = Time.now - @progress.start_at
+        elapsed = @progress.elapsed_time
         estimated = (elapsed / @progress.ratio).to_f - elapsed
         estimated = (estimated.infinite? || estimated < 0) ? 0.0 : estimated
-        value.gsub(MATCHER, Converter.to_time(estimated))
+        value.gsub(matcher, Converter.to_time(estimated))
       end
-    end # ElapsedFormatter
+    end # EstimatedFormatter
   end # ProgressBar
 end # TTY

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

@@ -0,0 +1,37 @@
+# frozen_string_literal: true
+
+module TTY
+  class ProgressBar
+    # Used by {Pipeline} to format :eta_time token
+    #
+    # @api private
+    class EstimatedTimeFormatter
+      include TTY::ProgressBar::Formatter[/:eta_time/.freeze]
+
+      # Format :eta_time token
+      #
+      # @param [String] value
+      #   the value to format
+      #
+      # @api public
+      def call(value)
+        if @progress.indeterminate?
+          return value.gsub(matcher, "--:--:--")
+        end
+
+        elapsed = @progress.elapsed_time
+        estimated = (elapsed / @progress.ratio).to_f - elapsed
+        estimated = (estimated.infinite? || estimated < 0) ? 0.0 : estimated
+
+        time_format = if estimated >= 86_400 # longer than a day
+                        "%Y-%m-%d %H:%M:%S"
+                      else
+                        "%H:%M:%S"
+                      end
+        completion_time = Time.now + estimated
+        eta_time = completion_time.strftime(time_format)
+        value.gsub(matcher, eta_time)
+      end
+    end # EstimatedTimeFormatter
+  end # ProgressBar
+end # TTY

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

@@ -1,6 +1,7 @@
 # frozen_string_literal: true
 
-require_relative '../converter'
+require_relative "../converter"
+require_relative "../formatter"
 
 module TTY
   class ProgressBar
@@ -8,32 +9,17 @@ module TTY
     #
     # @api private
     class MeanByteFormatter
-      MATCHER = /:mean_byte/i.freeze
+      include TTY::ProgressBar::Formatter[/:mean_byte/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
-
-      # Format :rate token
+      # Format :mean_byte token
       #
       # @param [String] value
       #  the value being formatted
       #
       # @api public
-      def format(value)
+      def call(value)
         formatted = Converter.to_bytes(@progress.mean_rate)
-        value.gsub(MATCHER, formatted)
+        value.gsub(matcher, formatted)
       end
     end # MeanByteFormatter
   end # ProgressBar

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

@@ -1,6 +1,7 @@
 # frozen_string_literal: true
 
-require_relative '../converter'
+require_relative "../converter"
+require_relative "../formatter"
 
 module TTY
   class ProgressBar
@@ -8,32 +9,17 @@ module TTY
     #
     # @api private
     class MeanRateFormatter
-      MATCHER = /:mean_rate/i.freeze
+      include TTY::ProgressBar::Formatter[/:mean_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
-
-      # Format :rate token
+      # Format :mean_rate token
       #
       # @param [String] value
       #  the value being formatted
       #
       # @api public
-      def format(value)
+      def call(value)
         formatted = Converter.to_seconds(@progress.mean_rate)
-        value.gsub(MATCHER, formatted)
+        value.gsub(matcher, formatted)
       end
     end # MeanRateFormatter
   end # ProgressBar