progressbar 0.21.0 → 1.8.1

data/lib/ruby-progressbar/calculators/length.rb

@@ -0,0 +1,88 @@
+class   ProgressBar
+module  Calculators
+class   Length
+  attr_reader   :length_override
+  attr_accessor :current_length
+
+  def initialize(options = {})
+    self.length_override = options[:length]
+    self.current_length  = nil
+  end
+
+  def length
+    current_length || reset_length
+  end
+
+  def length_changed?
+    previous_length     = current_length
+    self.current_length = calculate_length
+
+    previous_length != current_length
+  end
+
+  def calculate_length
+    length_override || terminal_width || 80
+  end
+
+  def reset_length
+    self.current_length = calculate_length
+  end
+
+  def length_override=(other)
+    @length_override ||= ENV['RUBY_PROGRESS_BAR_LENGTH'] || other
+    @length_override = @length_override.to_i if @length_override
+  end
+
+  private
+
+  # This code was copied and modified from Rake, available under MIT-LICENSE
+  # Copyright (c) 2003, 2004 Jim Weirich
+  def terminal_width
+    return 80 unless unix?
+
+    result = dynamic_width
+    result < 20 ? 80 : result
+  rescue
+    80
+  end
+
+  # rubocop:disable Lint/DuplicateMethods
+  begin
+    require 'io/console'
+
+    def dynamic_width
+      if IO.console
+        dynamic_width_via_io_object
+      else
+        dynamic_width_via_system_calls
+      end
+    end
+  rescue LoadError
+    def dynamic_width
+      dynamic_width_via_system_calls
+    end
+  end
+
+  def dynamic_width_via_io_object
+    _rows, columns = IO.console.winsize
+    columns
+  end
+
+  def dynamic_width_via_system_calls
+    dynamic_width_stty.nonzero? || dynamic_width_tput
+  end
+
+  def dynamic_width_stty
+    `stty size 2>/dev/null`.split[1].to_i
+  end
+
+  def dynamic_width_tput
+    `tput cols 2>/dev/null`.to_i
+  end
+
+  def unix?
+    RUBY_PLATFORM =~ /(aix|darwin|linux|(net|free|open)bsd|cygwin|solaris|irix|hpux)/i
+  end
+end
+end
+end

data/lib/ruby-progressbar/calculators/length_spec.rb

@@ -0,0 +1,9 @@
+require 'rspectacular'
+require 'ruby-progressbar/calculators/length'
+
+class     ProgressBar
+module    Calculators
+describe  Length do
+end
+end
+end

data/lib/ruby-progressbar/calculators/running_average.rb

@@ -0,0 +1,9 @@
+class   ProgressBar
+module  Calculators
+class   RunningAverage
+  def self.calculate(current_average, new_value_to_average, smoothing_factor)
+    new_value_to_average * (1.0 - smoothing_factor) + current_average * smoothing_factor
+  end
+end
+end
+end

data/lib/ruby-progressbar/components.rb

@@ -0,0 +1,5 @@
+require 'ruby-progressbar/components/bar'
+require 'ruby-progressbar/components/percentage'
+require 'ruby-progressbar/components/rate'
+require 'ruby-progressbar/components/time'
+require 'ruby-progressbar/components/title'

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

@@ -0,0 +1,96 @@
+###
+# UPA = Unknown Progress Animation
+#
+class   ProgressBar
+module  Components
+class   Bar
+  DEFAULT_PROGRESS_MARK  = '='.freeze
+  DEFAULT_REMAINDER_MARK = ' '.freeze
+  DEFAULT_UPA_STEPS      = ['=---', '-=--', '--=-', '---='].freeze
+
+  attr_accessor :progress_mark,
+                :remainder_mark,
+                :length,
+                :progress,
+                :upa_steps
+
+  def initialize(options = {})
+    self.upa_steps      = options[:unknown_progress_animation_steps] || DEFAULT_UPA_STEPS
+    self.progress_mark  = options[:progress_mark]  || DEFAULT_PROGRESS_MARK
+    self.remainder_mark = options[:remainder_mark] || DEFAULT_REMAINDER_MARK
+    self.progress       = options[:progress]
+    self.length         = options[:length]
+  end
+
+  def to_s(options = { :format => :standard })
+    if progress.unknown?
+      unknown_string
+    elsif options[:format] == :standard
+      "#{standard_complete_string}#{incomplete_string}"
+    elsif options[:format] == :integrated_percentage
+      "#{integrated_percentage_complete_string}#{incomplete_string}"
+    end
+  end
+
+  private
+
+  def integrated_percentage_complete_string
+    return standard_complete_string if completed_length < 5
+
+    " #{progress.percentage_completed} ".to_s.center(completed_length, progress_mark)
+  end
+
+  def standard_complete_string
+    progress_mark * completed_length
+  end
+
+  def incomplete_string
+    remainder_mark * (length - completed_length)
+  end
+
+  def bar(length)
+    self.length = length
+
+    standard_complete_string
+  end
+
+  def complete_bar(length)
+    self.length = length
+
+    to_s
+  end
+
+  def unknown_string
+    unknown_frame_string = unknown_progress_frame * ((length / upa_steps.size) + 2)
+
+    unknown_frame_string[0, length]
+  end
+
+  def incomplete_space(length)
+    self.length = length
+
+    if progress.unknown?
+      unknown_string
+    else
+      incomplete_string
+    end
+  end
+
+  def bar_with_percentage(length)
+    self.length = length
+
+    integrated_percentage_complete_string
+  end
+
+  def completed_length
+    (length * progress.percentage_completed / 100).floor
+  end
+
+  def unknown_progress_frame
+    current_animation_step = progress.progress % upa_steps.size
+
+    upa_steps[current_animation_step]
+  end
+end
+end
+end

data/lib/ruby-progressbar/components/percentage.rb

@@ -0,0 +1,29 @@
+class   ProgressBar
+module  Components
+class   Percentage
+  attr_accessor :progress
+
+  def initialize(options = {})
+    self.progress = options[:progress]
+  end
+
+  private
+
+  def percentage
+    progress.percentage_completed
+  end
+
+  def justified_percentage
+    progress.percentage_completed.to_s.rjust(3)
+  end
+
+  def percentage_with_precision
+    progress.percentage_completed_with_precision
+  end
+
+  def justified_percentage_with_precision
+    progress.percentage_completed_with_precision.to_s.rjust(6)
+  end
+end
+end
+end

data/lib/ruby-progressbar/components/rate.rb

@@ -0,0 +1,43 @@
+class   ProgressBar
+module  Components
+class   Rate
+  attr_accessor :rate_scale,
+                :started_at,
+                :stopped_at,
+                :timer,
+                :progress
+
+  def initialize(options = {})
+    self.rate_scale = options[:rate_scale] || lambda { |x| x }
+    self.started_at = nil
+    self.stopped_at = nil
+    self.timer      = options[:timer]
+    self.progress   = options[:progress]
+  end
+
+  private
+
+  def rate_of_change(format_string = '%i')
+    return 0 unless elapsed_seconds.positive?
+
+    format_string % scaled_rate
+  end
+
+  def rate_of_change_with_precision
+    rate_of_change('%.2f')
+  end
+
+  def scaled_rate
+    rate_scale.call(base_rate)
+  end
+
+  def base_rate
+    progress.absolute / elapsed_seconds
+  end
+
+  def elapsed_seconds
+    timer.elapsed_whole_seconds.to_f
+  end
+end
+end
+end

data/lib/ruby-progressbar/components/time.rb

@@ -0,0 +1,103 @@
+###
+# OOB = 'Out of Bounds'
+#
+class   ProgressBar
+module  Components
+class   Time
+  TIME_FORMAT            = '%02d:%02d:%02d'.freeze
+  OOB_TIME_FORMATS       = [:unknown, :friendly, nil].freeze
+  OOB_LIMIT_IN_HOURS     = 99
+  OOB_UNKNOWN_TIME_TEXT  = '??:??:??'.freeze
+  OOB_FRIENDLY_TIME_TEXT = '> 4 Days'.freeze
+  NO_TIME_ELAPSED_TEXT   = '--:--:--'.freeze
+  ESTIMATED_LABEL        = ' ETA'.freeze
+  ELAPSED_LABEL          = 'Time'.freeze
+
+  def initialize(options = {})
+    self.out_of_bounds_time_format = options[:out_of_bounds_time_format]
+    self.timer                     = options[:timer]
+    self.progress                  = options[:progress]
+  end
+
+  def estimated_with_label
+    "#{ESTIMATED_LABEL}: #{estimated}"
+  end
+
+  def elapsed_with_label
+    "#{ELAPSED_LABEL}: #{elapsed}"
+  end
+
+  protected
+
+  def estimated_with_no_oob
+    self.out_of_bounds_time_format = nil
+
+    estimated_with_elapsed_fallback
+  end
+
+  def estimated_with_unknown_oob
+    self.out_of_bounds_time_format = :unknown
+
+    estimated_with_elapsed_fallback
+  end
+
+  def estimated_with_friendly_oob
+    self.out_of_bounds_time_format = :friendly
+
+    estimated_with_elapsed_fallback
+  end
+
+  attr_reader   :out_of_bounds_time_format
+  attr_accessor :timer,
+                :progress
+
+  def out_of_bounds_time_format=(format)
+    unless OOB_TIME_FORMATS.include? format
+      fail 'Invalid Out Of Bounds time format.  Valid formats are ' +
+        OOB_TIME_FORMATS.inspect
+    end
+
+    @out_of_bounds_time_format = format
+  end
+
+  private
+
+  def estimated
+    return OOB_UNKNOWN_TIME_TEXT if progress.unknown? || progress.none? || timer.stopped?
+
+    hours, minutes, seconds = timer.divide_seconds(estimated_seconds_remaining)
+
+    if hours > OOB_LIMIT_IN_HOURS && out_of_bounds_time_format
+      out_of_bounds_time
+    else
+      TIME_FORMAT % [hours, minutes, seconds]
+    end
+  end
+
+  def elapsed
+    return NO_TIME_ELAPSED_TEXT unless timer.started?
+
+    hours, minutes, seconds = timer.divide_seconds(timer.elapsed_whole_seconds)
+
+    TIME_FORMAT % [hours, minutes, seconds]
+  end
+
+  def estimated_with_elapsed_fallback
+    progress.finished? ? elapsed_with_label : estimated_with_label
+  end
+
+  def estimated_seconds_remaining
+    (timer.elapsed_seconds * (progress.total / progress.running_average - 1)).round
+  end
+
+  def out_of_bounds_time
+    case out_of_bounds_time_format
+    when :unknown
+      OOB_UNKNOWN_TIME_TEXT
+    when :friendly
+      OOB_FRIENDLY_TIME_TEXT
+    end
+  end
+end
+end
+end

data/lib/ruby-progressbar/components/title.rb

@@ -0,0 +1,13 @@
+class   ProgressBar
+module  Components
+class   Title
+  DEFAULT_TITLE = 'Progress'.freeze
+
+  attr_accessor :title
+
+  def initialize(options = {})
+    self.title = options[:title] || DEFAULT_TITLE
+  end
+end
+end
+end

data/lib/ruby-progressbar/errors/invalid_progress_error.rb

@@ -0,0 +1,4 @@
+class   ProgressBar
+class   InvalidProgressError < RuntimeError
+end
+end

data/lib/ruby-progressbar/format.rb

@@ -0,0 +1,3 @@
+require 'ruby-progressbar/format/molecule'
+require 'ruby-progressbar/format/formatter'
+require 'ruby-progressbar/format/string'

data/lib/ruby-progressbar/format/formatter.rb

@@ -0,0 +1,27 @@
+class   ProgressBar
+module  Format
+class   Formatter
+  def self.process(format_string, max_length, bar)
+    processed_string = format_string.dup
+
+    format_string.non_bar_molecules.each do |molecule|
+      processed_string.gsub!(molecule.full_key, molecule.lookup_value(bar, nil))
+    end
+
+    processed_string.gsub!(/%%/, '%')
+
+    bar_length         = max_length -
+                         processed_string.displayable_length +
+                         format_string.bar_molecule_placeholder_length
+    bar_length         = bar_length.negative? ? 0 : bar_length
+
+    format_string.bar_molecules.each do |molecule|
+      processed_string.gsub!(molecule.full_key,
+                             molecule.lookup_value(bar, bar_length))
+    end
+
+    processed_string
+  end
+end
+end
+end