ruby-progressbar 1.10.1 → 1.13.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 37022e1989dd1fd4e4dc54cf71175a0b6b582cf11489e96b5962f3019df68b49
-  data.tar.gz: 5cfd49785da0897226c6d3d6b679629cae0b926c1907322646a9515c7ab93140
+  metadata.gz: a326fec3040bac0fc963d989df67f252d45243a7983184b88f0ccdfda4d0f35c
+  data.tar.gz: 7aaaae56892722f0fc22a440f21f5f13e54f9171fb64b6630386d67ac0515f14
 SHA512:
-  metadata.gz: ac7fe3dffbad63b6e893a44e88ed5b3ba1353c518c521036e512a20cbd82ad2ee928d0739c66664438f47ed6e3030d47ed8085b225241cc51ce6ee31af2c9e6f
-  data.tar.gz: 3fc79b1ea373cd512c256ee1ab70669224d523dc4f1c09124078d3a04dbf15bf010582b91c9f79bc504a0dac6c020405e5cb40cb9ec0c3c1042d3f23e500fa07
+  metadata.gz: 0f8d6034719ec5276dee6bb1f11bb14ad4696dcd8dbf6fa88b26eebf6e8e4f658ee2d686f406aa9c25a71b2f0d8ce8dcd22c4b58af5c8cd6cd42f39f88301916
+  data.tar.gz: 14978170664e0308259fad1e4dd9ea11adacf3f48a03c8faf532d3a0691aed7a9fd7a397f7dcc7bea389d0f2716b36e1a77a54c4560593012008ba6811dafb3b

data/LICENSE.txt

@@ -1,4 +1,4 @@
-Copyright (c) 2010-2016 The Kompanee, Ltd
+Copyright (c) 2010-2019 The Kompanee, Ltd
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

data/README.md

@@ -1,38 +1,131 @@
 Ruby/ProgressBar
-================================
-[![Gem Version](https://img.shields.io/gem/v/ruby-progressbar.svg)](https://rubygems.org/gems/ruby-progressbar) ![Rubygems Rank Overall](https://img.shields.io/gem/rt/ruby-progressbar.svg) ![Rubygems Rank Daily](https://img.shields.io/gem/rd/ruby-progressbar.svg) ![Rubygems Downloads](https://img.shields.io/gem/dv/ruby-progressbar/stable.svg) [![Build Status](https://img.shields.io/travis/jfelchner/ruby-progressbar/master.svg)](http://travis-ci.org/jfelchner/ruby-progressbar) [![Code Climate](https://codeclimate.com/github/jfelchner/ruby-progressbar.svg)](https://codeclimate.com/github/jfelchner/ruby-progressbar) [![Code Climate](https://codeclimate.com/github/jfelchner/ruby-progressbar/coverage.svg)](https://codeclimate.com/github/jfelchner/ruby-progressbar)
+================================================================================
+
+<div align="center">
+  <a href="https://rubygems.org/gems/ruby-progressbar" alt="RubyGems Version">
+    <img src="https://img.shields.io/gem/v/ruby-progressbar.svg?style=flat-square&label=current-version" alt="RubyGems Version" />
+  </a>
+
+  <a href="https://rubygems.org/gems/ruby-progressbar" alt="RubyGems Rank Overall">
+    <img src="https://img.shields.io/gem/rt/ruby-progressbar.svg?style=flat-square&label=total-rank" alt="RubyGems Rank Overall" />
+  </a>
+
+  <a href="https://rubygems.org/gems/ruby-progressbar" alt="RubyGems Rank Daily">
+    <img src="https://img.shields.io/gem/rd/ruby-progressbar.svg?style=flat-square&label=daily-rank" alt="RubyGems Rank Daily" />
+  </a>
+
+  <a href="https://rubygems.org/gems/ruby-progressbar" alt="RubyGems Downloads">
+    <img src="https://img.shields.io/gem/dt/ruby-progressbar.svg?style=flat-square&label=total-downloads" alt="RubyGems Downloads" />
+  </a>
+
+  <a href="https://github.com/jfelchner/ruby-progressbar/actions?query=workflow%3ABuild" alt="Build Status">
+    <img src="https://img.shields.io/github/workflow/status/jfelchner/ruby-progressbar/Build?label=CI&style=flat-square&logo=github" alt="Build Status" />
+  </a>
+
+  <a href="#" alt="Maintainability">
+    <img src="https://img.shields.io/codeclimate/maintainability/jfelchner/ruby-progressbar?style=flat-square&label=grade" alt="Maintainability" />
+  </a>
+</div>
+
+<br>
 
 <img src="https://kompanee-public-assets.s3.amazonaws.com/readmes/ruby-progressbar-cage.png" align="right" />
 
-The **ultimate** text progress bar library for Ruby!  It'll **SMASH YOU OVER THE HEAD** with a **PURE RUSH** of progress bar excitement!
+The **ultimate** text progress bar library for Ruby!  It'll **SMASH YOU OVER THE
+HEAD** with a **PURE RUSH** of progress bar excitement!
 
-Don't miss out on what all the kids are talking about!  If you want everyone to know that your gem or app can survive _in the cage_ then YOU WANT **RUBY-PROGRESSBAR**!
+Don't miss out on what all the kids are talking about!  If you want everyone to
+know that your gem or app can survive _in the cage_ then YOU WANT
+**RUBY-PROGRESSBAR**!
 
-<br><br><br>
+<br>
 
-Full Reference
---------------------------------
+It's Better Than The Other 186,312 Progress Bar Libraries Because
+--------------------------------------------------------------------------------
+
+* It has [stood the test of time][history] (2008-today)
+
+* Full test suite
+
+* [_**ZERO**_ dependencies][gemspec]
+
+* Used by [tons of other open source projects][dependencies] (which means we
+  find out about bugs quickly)
+
+* It's pretty [freakin' sweet](https://www.youtube.com/watch?v=On3IoVhf_GM)
+
+* And most importantly... our awesome [contributors][contributors]
+
+Basic Usage
+--------------------------------------------------------------------------------
 
-There's gotten to be too much awesome to pack into one page.  Visit the [wiki](https://github.com/jfelchner/ruby-progressbar/wiki) for the full documentation.
+### Creation
 
-Here's a [quick link](https://github.com/jfelchner/ruby-progressbar/wiki/Basic-Usage) to the 'Basic Usage' section.
+It's simple to get started:
+
+```ruby
+progressbar = ProgressBar.create
+```
+
+Creates a basic progress bar beginning at `0`, a maximum capacity of `100` and
+tells it to start.
+
+```text
+Progress: |                                                                       |
+```
+
+### Marking Progress
+
+Every call to `#increment` will advance the bar by `1`. Therefore:
+
+```ruby
+50.times { progressbar.increment }
+```
+
+Would output an advancing line which would end up here:
+
+```text
+Progress: |===================================                                    |
+```
+
+### Animation
+
+![Basic Usage Marking Progress](http://kompanee-public-assets.s3.amazonaws.com/readmes/ruby-progressbar-basic-usage-marking-progress-2.gif)
+
+Full Reference
+--------------------------------------------------------------------------------
+
+There's gotten to be too much awesome to pack into one page.  Visit the
+[wiki][wiki] for the full documentation.
 
 Issues
---------------------------------
+--------------------------------------------------------------------------------
 
-If you have problems, please create a [Github issue](https://github.com/jfelchner/ruby-progressbar/issues).
+If you have problems, please create a [Github issue][issues].
 
 Credits
---------------------------------
+--------------------------------------------------------------------------------
 
-![The Kompanee](https://kompanee-public-assets.s3.amazonaws.com/readmes/kompanee-horizontal-black.png)
+![The Kompanee][kompanee-logo]
 
-ruby-progressbar is maintained by [The Kompanee, Ltd.](http://www.thekompanee.com)
+ruby-progressbar is maintained by [The Kompanee, Ltd.][kompanee-site]
 
 The names and logos for The Kompanee are trademarks of The Kompanee, Ltd.
 
 License
---------------------------------
+--------------------------------------------------------------------------------
+
+ruby-progressbar 1.0 is Copyright &copy; 2011-2021 The Kompanee. It is free
+software, and may be redistributed under the terms specified in the LICENSE
+file.
+ruby-progressbar 0.9.0 is Copyright &copy; 2008 [Satoru Takabayashi][satoru]
 
-ruby-progressbar 1.0 is Copyright &copy; 2011-2018 The Kompanee. It is free software, and may be redistributed under the terms specified in the LICENSE file.
-ruby-progressbar 0.9.0 is Copyright &copy; 2008 [Satoru Takabayashi](http://0xcc.net)
+[contributors]:  https://github.com/jfelchner/ruby-progressbar/graphs/contributors
+[dependencies]:  https://github.com/jfelchner/ruby-progressbar/network/dependents
+[gemspec]:       https://github.com/jfelchner/ruby-progressbar/blob/master/ruby-progressbar.gemspec
+[history]:       https://github.com/jfelchner/ruby-progressbar/wiki/History
+[issues]:        https://github.com/jfelchner/ruby-progressbar/issues
+[kompanee-logo]: https://kompanee-public-assets.s3.amazonaws.com/readmes/kompanee-horizontal-black.png
+[kompanee-site]: http://www.thekompanee.com
+[satoru]:        http://0xcc.net
+[wiki]:          https://github.com/jfelchner/ruby-progressbar/wiki

data/lib/ruby-progressbar/base.rb

@@ -1,9 +1,38 @@
 require 'forwardable'
 
+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'
+require 'ruby-progressbar/format/formatter'
+require 'ruby-progressbar/format/string'
+require 'ruby-progressbar/outputs/non_tty'
+require 'ruby-progressbar/outputs/tty'
+require 'ruby-progressbar/progress'
+require 'ruby-progressbar/projector'
+require 'ruby-progressbar/timer'
+
 class   ProgressBar
 class   Base
   extend Forwardable
 
+  # rubocop:disable Layout/HeredocIndentation
+  SMOOTHING_DEPRECATION_WARNING = <<-HEREDOC.tr("\n", ' ')
+WARNING: Passing the 'smoothing' option is deprecated  and will be removed
+in version 2.0. Please pass { projector: { type: 'smoothing', strength: 0.x }}.
+For more information on why this change is happening,  visit
+https://github.com/jfelchner/ruby-progressbar/wiki/Upgrading
+  HEREDOC
+
+  RUNNING_AVERAGE_RATE_DEPRECATION_WARNING = <<-HEREDOC.tr("\n", ' ')
+WARNING: Passing the 'running_average_rate' option is deprecated  and will be removed
+in version 2.0. Please pass { projector: { type: 'smoothing', strength: 0.x }}.
+For more information on why this change is happening,  visit
+https://github.com/jfelchner/ruby-progressbar/wiki/Upgrading
+  HEREDOC
+  # rubocop:enable Layout/HeredocIndentation
+
   def_delegators :output,
                  :clear,
                  :log,
@@ -13,22 +42,41 @@ class   Base
                  :progress,
                  :total
 
-  def initialize(options = {})
+  def initialize(options = {}) # rubocop:disable Metrics/AbcSize
+    options[:projector] ||= {}
+
     self.autostart    = options.fetch(:autostart,  true)
     self.autofinish   = options.fetch(:autofinish, true)
     self.finished     = false
 
     self.timer        = Timer.new(options)
+    projector_opts    = if options[:projector].any?
+                          options[:projector]
+                        elsif options[:smoothing]
+                          warn SMOOTHING_DEPRECATION_WARNING
+
+                          { :strength => options[:smoothing] }
+                        elsif options[:running_average_rate]
+                          warn RUNNING_AVERAGE_RATE_DEPRECATION_WARNING
+
+                          { :strength => options[:smoothing] }
+                        else
+                          {}
+                        end
+    self.projector    = Projector.
+                          from_type(options[:projector][:type]).
+                          new(projector_opts)
     self.progressable = Progress.new(options)
 
-    options           = options.merge(:timer    => timer,
-                                      :progress => progressable)
+    options = options.merge(:progress  => progressable,
+                            :projector => projector,
+                            :timer     => timer)
 
-    self.title_comp   = Components::Title.new(options)
-    self.bar          = Components::Bar.new(options)
-    self.percentage   = Components::Percentage.new(options)
-    self.rate         = Components::Rate.new(options)
-    self.time         = Components::Time.new(options)
+    self.title_component      = Components::Title.new(options)
+    self.bar_component        = Components::Bar.new(options)
+    self.percentage_component = Components::Percentage.new(options)
+    self.rate_component       = Components::Rate.new(options)
+    self.time_component       = Components::Time.new(options)
 
     self.output       = Output.detect(options.merge(:bar => self))
     @format           = Format::String.new(output.resolve_format(options[:format]))
@@ -67,6 +115,7 @@ class   Base
     output.with_refresh do
       self.finished = false
       progressable.reset
+      projector.reset
       timer.reset
     end
   end
@@ -102,19 +151,19 @@ class   Base
   end
 
   def progress_mark=(mark)
-    output.refresh_with_format_change { bar.progress_mark = mark }
+    output.refresh_with_format_change { bar_component.progress_mark = mark }
   end
 
   def remainder_mark=(mark)
-    output.refresh_with_format_change { bar.remainder_mark = mark }
+    output.refresh_with_format_change { bar_component.remainder_mark = mark }
   end
 
   def title
-    title_comp.title
+    title_component.title
   end
 
   def title=(title)
-    output.refresh_with_format_change { title_comp.title = title }
+    output.refresh_with_format_change { title_component.title = title }
   end
 
   def to_s(new_format = nil)
@@ -123,29 +172,29 @@ class   Base
     Format::Formatter.process(@format, output.length, self)
   end
 
-  # rubocop:disable Metrics/AbcSize, Metrics/LineLength
+  # rubocop:disable Metrics/AbcSize, Layout/LineLength
   def to_h
     {
       'output_stream'                       => output.__send__(:stream),
       'length'                              => output.length,
-      'title'                               => title_comp.title,
-      'progress_mark'                       => bar.progress_mark,
-      'remainder_mark'                      => bar.remainder_mark,
+      'title'                               => title_component.title,
+      'progress_mark'                       => bar_component.progress_mark,
+      'remainder_mark'                      => bar_component.remainder_mark,
       'progress'                            => progressable.progress,
       'total'                               => progressable.total,
       'percentage'                          => progressable.percentage_completed_with_precision.to_f,
-      'elapsed_time_in_seconds'             => time.__send__(:timer).elapsed_seconds,
-      'estimated_time_remaining_in_seconds' => time.__send__(:estimated_seconds_remaining),
-      'base_rate_of_change'                 => rate.__send__(:base_rate),
-      'scaled_rate_of_change'               => rate.__send__(:scaled_rate),
-      'unknown_progress_animation_steps'    => bar.upa_steps,
+      'elapsed_time_in_seconds'             => time_component.__send__(:timer).elapsed_seconds,
+      'estimated_time_remaining_in_seconds' => time_component.__send__(:estimated_seconds_remaining),
+      'base_rate_of_change'                 => rate_component.__send__(:base_rate),
+      'scaled_rate_of_change'               => rate_component.__send__(:scaled_rate),
+      'unknown_progress_animation_steps'    => bar_component.upa_steps,
       'throttle_rate'                       => output.__send__(:throttle).rate,
       'started?'                            => started?,
       'stopped?'                            => stopped?,
       'finished?'                           => finished?
     }
   end
-  # rubocop:enable Metrics/AbcSize, Metrics/LineLength
+  # rubocop:enable Metrics/AbcSize, Layout/LineLength
 
   def inspect
     "#<ProgressBar:#{progress}/#{total || 'unknown'}>"
@@ -162,13 +211,14 @@ class   Base
   protected
 
   attr_accessor :output,
+                :projector,
                 :timer,
                 :progressable,
-                :title_comp,
-                :bar,
-                :percentage,
-                :rate,
-                :time,
+                :title_component,
+                :bar_component,
+                :percentage_component,
+                :rate_component,
+                :time_component,
                 :autostart,
                 :autofinish,
                 :finished
@@ -176,6 +226,7 @@ class   Base
   def update_progress(*args)
     output.with_refresh do
       progressable.__send__(*args)
+      projector.__send__(*args)
       timer.stop if finished?
     end
   end

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

@@ -50,7 +50,6 @@ class   Length
   end
   # rubocop:enable Style/RescueStandardError
 
-  # rubocop:disable Lint/DuplicateMethods
   begin
     require 'io/console'
 
@@ -68,7 +67,6 @@ class   Length
       dynamic_width_via_system_calls
     end
   end
-  # rubocop:enable Lint/DuplicateMethods
 
   def dynamic_width_via_output_stream_object
     _rows, columns = output.winsize

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

@@ -32,22 +32,6 @@ class   Bar
     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
 
@@ -66,12 +50,6 @@ class   Bar
     to_s(:format => :integrated_percentage)
   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
 
@@ -88,6 +66,28 @@ class   Bar
     integrated_percentage_complete_string
   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 unknown_string
+    unknown_frame_string = unknown_progress_frame * ((length / upa_steps.size) + 2)
+
+    unknown_frame_string[0, length]
+  end
+
   def completed_length
     (length * progress.percentage_completed / 100).floor
   end

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

@@ -7,10 +7,8 @@ class   Percentage
     self.progress = options[:progress]
   end
 
-  private
-
   def percentage
-    progress.percentage_completed
+    progress.percentage_completed.to_s
   end
 
   def justified_percentage

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

@@ -2,23 +2,17 @@ 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 > 0
+    return '0' if elapsed_seconds <= 0
 
     format_string % scaled_rate
   end
@@ -27,6 +21,8 @@ class   Rate
     rate_of_change('%.2f')
   end
 
+  private
+
   def scaled_rate
     rate_scale.call(base_rate)
   end

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

@@ -12,57 +12,58 @@ class   Time
   NO_TIME_ELAPSED_TEXT   = '--:--:--'.freeze
   ESTIMATED_LABEL        = ' ETA'.freeze
   ELAPSED_LABEL          = 'Time'.freeze
+  WALL_CLOCK_FORMAT      = '%H:%M:%S'.freeze
+  OOB_TEXT_TO_FORMAT     = {
+    :unknown  => OOB_UNKNOWN_TIME_TEXT,
+    :friendly => OOB_FRIENDLY_TIME_TEXT
+  }.freeze
 
   def initialize(options = {})
-    self.out_of_bounds_time_format = options[:out_of_bounds_time_format]
-    self.timer                     = options[:timer]
-    self.progress                  = options[:progress]
+    self.timer     = options[:timer]
+    self.progress  = options[:progress]
+    self.projector = options[:projector]
   end
 
-  def estimated_with_label
-    "#{ESTIMATED_LABEL}: #{estimated}"
+  def estimated_with_label(out_of_bounds_time_format = nil)
+    "#{ESTIMATED_LABEL}: #{estimated(out_of_bounds_time_format)}"
   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
+    estimated_with_elapsed_fallback(nil)
   end
 
   def estimated_with_unknown_oob
-    self.out_of_bounds_time_format = :unknown
-
-    estimated_with_elapsed_fallback
+    estimated_with_elapsed_fallback(:unknown)
   end
 
   def estimated_with_friendly_oob
-    self.out_of_bounds_time_format = :friendly
-
-    estimated_with_elapsed_fallback
+    estimated_with_elapsed_fallback(:friendly)
   end
 
-  attr_reader   :out_of_bounds_time_format
-  attr_accessor :timer,
-                :progress
+  def estimated_wall_clock
+    return timer.stopped_at.strftime(WALL_CLOCK_FORMAT) if progress.finished?
+    return NO_TIME_ELAPSED_TEXT unless timer.started?
 
-  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
+    memo_estimated_seconds_remaining = estimated_seconds_remaining
+    return NO_TIME_ELAPSED_TEXT unless memo_estimated_seconds_remaining
 
-    @out_of_bounds_time_format = format
+    (timer.now + memo_estimated_seconds_remaining).
+      strftime(WALL_CLOCK_FORMAT)
   end
 
+  protected
+
+  attr_accessor :timer,
+                :progress,
+                :projector
+
   private
 
-  def estimated
+  def estimated(out_of_bounds_time_format)
     memo_estimated_seconds_remaining = estimated_seconds_remaining
 
     return OOB_UNKNOWN_TIME_TEXT unless memo_estimated_seconds_remaining
@@ -70,7 +71,7 @@ class   Time
     hours, minutes, seconds = timer.divide_seconds(memo_estimated_seconds_remaining)
 
     if hours > OOB_LIMIT_IN_HOURS && out_of_bounds_time_format
-      out_of_bounds_time
+      OOB_TEXT_TO_FORMAT.fetch(out_of_bounds_time_format)
     else
       TIME_FORMAT % [hours, minutes, seconds]
     end
@@ -84,23 +85,16 @@ class   Time
     TIME_FORMAT % [hours, minutes, seconds]
   end
 
-  def estimated_with_elapsed_fallback
-    progress.finished? ? elapsed_with_label : estimated_with_label
+  def estimated_with_elapsed_fallback(out_of_bounds_time_format)
+    return elapsed_with_label if progress.finished?
+
+    estimated_with_label(out_of_bounds_time_format)
   end
 
   def estimated_seconds_remaining
-    return if progress.unknown? || progress.none? || timer.stopped?
-
-    (timer.elapsed_seconds * (progress.total / progress.running_average - 1)).round
-  end
+    return if progress.unknown? || projector.none? || progress.none? || timer.stopped? || timer.reset?
 
-  def out_of_bounds_time
-    case out_of_bounds_time_format
-    when :unknown
-      OOB_UNKNOWN_TIME_TEXT
-    when :friendly
-      OOB_FRIENDLY_TIME_TEXT
-    end
+    (timer.elapsed_seconds * ((progress.total / projector.projection) - 1)).round
   end
 end
 end

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

@@ -13,7 +13,7 @@ class   Formatter
     bar_length         = max_length -
                          processed_string.displayable_length +
                          format_string.bar_molecule_placeholder_length
-    bar_length         = (bar_length < 0) ? 0 : bar_length
+    bar_length         = 0 if bar_length < 0
 
     format_string.bar_molecules.each do |molecule|
       processed_string.gsub!(molecule.full_key,

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

@@ -2,26 +2,27 @@ class   ProgressBar
 module  Format
 class   Molecule
   MOLECULES = {
-    :t => [:title_comp,   :title],
-    :T => [:title_comp,   :title],
-    :c => [:progressable, :progress],
-    :C => [:progressable, :total],
-    :u => [:progressable, :total_with_unknown_indicator],
-    :p => [:percentage,   :percentage],
-    :P => [:percentage,   :percentage_with_precision],
-    :j => [:percentage,   :justified_percentage],
-    :J => [:percentage,   :justified_percentage_with_precision],
-    :a => [:time,         :elapsed_with_label],
-    :e => [:time,         :estimated_with_unknown_oob],
-    :E => [:time,         :estimated_with_friendly_oob],
-    :f => [:time,         :estimated_with_no_oob],
-    :B => [:bar,          :complete_bar],
-    :b => [:bar,          :bar],
-    :W => [:bar,          :complete_bar_with_percentage],
-    :w => [:bar,          :bar_with_percentage],
-    :i => [:bar,          :incomplete_space],
-    :r => [:rate,         :rate_of_change],
-    :R => [:rate,         :rate_of_change_with_precision]
+    :t => [:title_component,      :title],
+    :T => [:title_component,      :title],
+    :c => [:progressable,         :progress],
+    :C => [:progressable,         :total],
+    :u => [:progressable,         :total_with_unknown_indicator],
+    :p => [:percentage_component, :percentage],
+    :P => [:percentage_component, :percentage_with_precision],
+    :j => [:percentage_component, :justified_percentage],
+    :J => [:percentage_component, :justified_percentage_with_precision],
+    :a => [:time_component,       :elapsed_with_label],
+    :e => [:time_component,       :estimated_with_unknown_oob],
+    :E => [:time_component,       :estimated_with_friendly_oob],
+    :f => [:time_component,       :estimated_with_no_oob],
+    :l => [:time_component,       :estimated_wall_clock],
+    :B => [:bar_component,        :complete_bar],
+    :b => [:bar_component,        :bar],
+    :W => [:bar_component,        :complete_bar_with_percentage],
+    :w => [:bar_component,        :bar_with_percentage],
+    :i => [:bar_component,        :incomplete_space],
+    :r => [:rate_component,       :rate_of_change],
+    :R => [:rate_component,       :rate_of_change_with_precision]
   }.freeze
 
   BAR_MOLECULES = %w{W w B b i}.freeze

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

@@ -1,3 +1,5 @@
+require 'ruby-progressbar/format/molecule'
+
 class   ProgressBar
 module  Format
 class   String < ::String
@@ -29,7 +31,7 @@ class   String < ::String
                       end
 
                       molecules
-                    end
+                   end
   end
 end
 end

data/lib/ruby-progressbar/output.rb

@@ -1,3 +1,6 @@
+require 'ruby-progressbar/calculators/length'
+require 'ruby-progressbar/throttle'
+
 class   ProgressBar
 class   Output
   DEFAULT_OUTPUT_STREAM = $stdout

data/lib/ruby-progressbar/outputs/tty.rb

@@ -17,7 +17,7 @@ class   Tty < Output
   end
 
   def default_format
-    DEFAULT_FORMAT_STRING
+    ENV['RUBY_PROGRESS_BAR_FORMAT'] || DEFAULT_FORMAT_STRING
   end
 
   def resolve_format(other_format)

data/lib/ruby-progressbar/progress.rb

@@ -4,25 +4,19 @@ class   ProgressBar
 class   Progress
   DEFAULT_TOTAL              = 100
   DEFAULT_BEGINNING_POSITION = 0
-  DEFAULT_SMOOTHING          = 0.1
 
   attr_reader               :total,
                             :progress
-
-  attr_accessor             :starting_position,
-                            :running_average,
-                            :smoothing
+  attr_accessor             :starting_position
 
   def initialize(options = {})
-    self.total     = options.fetch(:total, DEFAULT_TOTAL)
-    self.smoothing = options[:smoothing] || DEFAULT_SMOOTHING
+    self.total = options.fetch(:total, DEFAULT_TOTAL)
 
-    start :at => DEFAULT_BEGINNING_POSITION
+    start(:at => DEFAULT_BEGINNING_POSITION)
   end
 
   def start(options = {})
-    self.running_average   = 0
-    self.progress          = \
+    self.progress = \
       self.starting_position = options[:at] || progress
   end
 
@@ -55,7 +49,7 @@ class   Progress
   end
 
   def reset
-    start :at => starting_position
+    start(:at => starting_position)
   end
 
   def progress=(new_progress)
@@ -65,10 +59,6 @@ class   Progress
     end
 
     @progress = new_progress
-
-    self.running_average = Calculators::RunningAverage.calculate(running_average,
-                                                                 absolute,
-                                                                 smoothing)
   end
 
   def total=(new_total)
@@ -93,7 +83,7 @@ class   Progress
   end
 
   def none?
-    running_average.zero? || progress.zero?
+    progress.zero?
   end
 
   def unknown?

data/lib/ruby-progressbar/projector.rb

@@ -0,0 +1,14 @@
+require 'ruby-progressbar/projectors/smoothed_average'
+
+class   ProgressBar
+class   Projector
+  DEFAULT_PROJECTOR     = ProgressBar::Projectors::SmoothedAverage
+  NAME_TO_PROJECTOR_MAP = {
+    'smoothed' => ProgressBar::Projectors::SmoothedAverage
+  }.freeze
+
+  def self.from_type(name)
+    NAME_TO_PROJECTOR_MAP.fetch(name, DEFAULT_PROJECTOR)
+  end
+end
+end

data/lib/ruby-progressbar/projectors/smoothed_average.rb

@@ -0,0 +1,71 @@
+class   ProgressBar
+module  Projectors
+class   SmoothedAverage
+  DEFAULT_STRENGTH           = 0.1
+  DEFAULT_BEGINNING_POSITION = 0
+
+  attr_accessor :samples,
+                :strength
+  attr_reader   :projection
+
+  def initialize(options = {})
+    self.samples    = []
+    self.projection = 0.0
+    self.strength   = options[:strength] || DEFAULT_STRENGTH
+
+    start(:at => DEFAULT_BEGINNING_POSITION)
+  end
+
+  def start(options = {})
+    self.projection = 0.0
+    self.progress   = samples[0] = (options[:at] || progress)
+  end
+
+  def decrement
+    self.progress -= 1
+  end
+
+  def increment
+    self.progress += 1
+  end
+
+  def progress
+    samples[1]
+  end
+
+  def total=(_new_total); end
+
+  def reset
+    start(:at => samples[0])
+  end
+
+  def progress=(new_progress)
+    samples[1] = new_progress
+    self.projection = \
+      self.class.calculate(
+        @projection,
+        absolute,
+        strength
+      )
+  end
+
+  def none?
+    projection.zero?
+  end
+
+  def self.calculate(current_projection, new_value, rate)
+    (new_value * (1.0 - rate)) + (current_projection * rate)
+  end
+
+  protected
+
+  attr_writer :projection
+
+  private
+
+  def absolute
+    samples[1] - samples[0]
+  end
+end
+end
+end

data/lib/ruby-progressbar/refinements/progress_enumerator.rb

@@ -0,0 +1,28 @@
+class  ProgressBar
+module Refinements
+module Enumerator
+  ARITY_ERROR_MESSAGE = 'Only two arguments allowed to be passed to ' \
+                        'with_progressbar (item, progress_bar)'.freeze
+
+  refine ::Enumerator do
+    def with_progressbar(options = {}, &block)
+      progress_bar = ProgressBar.create(options.merge(:starting_at => 0, :total => size))
+
+      each do |item|
+        progress_bar.increment
+
+        next unless block
+
+        yielded_args = []
+        yielded_args << item         if block.arity > 0
+        yielded_args << progress_bar if block.arity > 1
+
+        fail ::ArgumentError, ARITY_ERROR_MESSAGE if block.arity > 2
+
+        yield(*yielded_args)
+      end
+    end
+  end
+end
+end
+end

data/lib/ruby-progressbar/refinements.rb

@@ -1 +1 @@
-require 'ruby-progressbar/refinements/enumerator'
+require 'ruby-progressbar/refinements/progress_enumerator'

data/lib/ruby-progressbar/time.rb

@@ -17,11 +17,9 @@ class   Time
   end
 
   def unmocked_time_method
-    @unmocked_time_method ||= begin
-                                TIME_MOCKING_LIBRARY_METHODS.find do |method|
-                                  time.respond_to? method
-                                end
-                              end
+    @unmocked_time_method ||= TIME_MOCKING_LIBRARY_METHODS.find do |method|
+      time.respond_to? method
+    end
   end
 
   protected

data/lib/ruby-progressbar/timer.rb

@@ -28,6 +28,10 @@ class   Timer
     start
   end
 
+  def now
+    time.now
+  end
+
   def started?
     started_at
   end
@@ -51,6 +55,8 @@ class   Timer
   end
 
   def elapsed_seconds
+    return 0 unless started?
+
     ((stopped_at || time.now) - started_at)
   end
 

data/lib/ruby-progressbar/version.rb

@@ -1,3 +1,3 @@
 class ProgressBar
-  VERSION = '1.10.1'.freeze
+  VERSION = '1.13.0'.freeze
 end

data/lib/ruby-progressbar.rb

@@ -1,15 +1,5 @@
 # frozen_string_literal: true
 
-require 'ruby-progressbar/output'
-require 'ruby-progressbar/outputs/tty'
-require 'ruby-progressbar/outputs/non_tty'
-require 'ruby-progressbar/timer'
-require 'ruby-progressbar/progress'
-require 'ruby-progressbar/throttle'
-require 'ruby-progressbar/calculators/length'
-require 'ruby-progressbar/calculators/running_average'
-require 'ruby-progressbar/components'
-require 'ruby-progressbar/format'
 require 'ruby-progressbar/base'
 require 'ruby-progressbar/refinements' if Module.
                                          private_instance_methods.

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: ruby-progressbar
 version: !ruby/object:Gem::Version
-  version: 1.10.1
+  version: 1.13.0
 platform: ruby
 authors:
 - thekompanee
@@ -12,8 +12,8 @@ cert_chain:
 - |
   -----BEGIN CERTIFICATE-----
   MIIEdjCCAt6gAwIBAgIBATANBgkqhkiG9w0BAQsFADAyMTAwLgYDVQQDDCdhY2Nv
-  dW50c19ydWJ5Z2Vtcy9EQz10aGVrb21wYW5lZS9EQz1jb20wHhcNMTgwODAzMjEz
-  NDA1WhcNMTkwODAzMjEzNDA1WjAyMTAwLgYDVQQDDCdhY2NvdW50c19ydWJ5Z2Vt
+  dW50c19ydWJ5Z2Vtcy9EQz10aGVrb21wYW5lZS9EQz1jb20wHhcNMjMwMjI2MTcx
+  MDI1WhcNMjYwMjI1MTcxMDI1WjAyMTAwLgYDVQQDDCdhY2NvdW50c19ydWJ5Z2Vt
   cy9EQz10aGVrb21wYW5lZS9EQz1jb20wggGiMA0GCSqGSIb3DQEBAQUAA4IBjwAw
   ggGKAoIBgQCqhYn5ODEoLvuBIF2M1GzoaZU28+ntP5QApvDE0Te04n0JbBC1cNYH
   mr71neeSx7tlZ9w9kJ/8GNcY5bm7pNJqhyhfc+uG9M7FttcxM8AYXogjcdUDP234
@@ -26,17 +26,17 @@ cert_chain:
   GoP81fN6l88CAwEAAaOBljCBkzAJBgNVHRMEAjAAMAsGA1UdDwQEAwIEsDAdBgNV
   HQ4EFgQUL4eV4OM9h7fkM27qf9p4ragHi6AwLAYDVR0RBCUwI4EhYWNjb3VudHMr
   cnVieWdlbXNAdGhla29tcGFuZWUuY29tMCwGA1UdEgQlMCOBIWFjY291bnRzK3J1
-  YnlnZW1zQHRoZWtvbXBhbmVlLmNvbTANBgkqhkiG9w0BAQsFAAOCAYEANh9Y8ccw
-  o3/+ZNjNhewsxip/oj8NZHRBLfrSXNT8nIxlB/CrHXHJ5UvJmsH45MYnU8Blsm04
-  T6PNtZIh8sPWF0ByU/gJhs23C2CGgeDrijZWL/VcOK8ErhLd92lrtXiCei4mexo5
-  flFW1vLZVTJRiXzVSmuBLkrhQE7BqSHvUTz2vkyf4f/G9jnqp+8Tf0IRZiPGFi82
-  2qI/IOGmCb8Oqybt4lcHymLZBYPmj1hb/HVxEWTmQ9Y6ePHSonoK+QZf6Vi+wKga
-  JxeLxFp0fQc+Mfjx+bFdJgOhcXMjLnDtAaQoDkQfRvQmCTKkXUhNRoTiWtxojkjX
-  8mN+AQ66SKTSztEZRZWizqWmTUtkSG+IKlL5E9fUkLYsKV3xgiuwgh+3vSdz398u
-  KuaMSG4L1U+uHNl3upTjh6wZjzKptsxE0eHSeTlt74ei2EZ4XpDQgMAdxnG19eUY
-  Ew38fD/eb7KjFt6HWjaE88pp12uYoAUV0xTysHhml+rk1/rn/h3T1Exa
+  YnlnZW1zQHRoZWtvbXBhbmVlLmNvbTANBgkqhkiG9w0BAQsFAAOCAYEAD/tBN1cM
+  8Qu6u+rPM3SEtlEK/ZdVY0IowXtXMskkderNBJ4HY+xBfIWyAXLTr3Fy6xscVZ95
+  raFCiWHqvR577u3/BsVZ5BoQ0g25oY2bwoamQSdx71ygs25Q+UFbg6lHq6olszj0
+  HqKXUy/iPFb+OzGq7NOtKOD5pHl3ew8H7U5tfh0kx6B5TdL9BZLurjskW0n2G+kY
+  NSGCTGYU8wY4Bsk/AmfoFT/ATwmrf68CTD+IBY5yvt2DGvcyuSrX1RQP8Vk//0EP
+  J2ezTNGIBeQFcyyo09gMfy1yxv9XAvwmy6pAx7/m/F2XzTiXuzmJ7zJ6J0OaHUG4
+  svJgf3o9Eor2okQND60Qdpdl4qdSy3KaNqvQQbTRB96e/+K8ksz4rras5jPaAs0p
+  DV37k4cni6c/jUm2CqepsJ/dbzeWdkhcuO6hwEQV0jvFky5C6d5hHcrbJwxl1sTL
+  V+pWW6L9MSZzKkjWVJXD43B3tWBjIDthQVTzS4j90PUkUXgBXjS7Jxj/
   -----END CERTIFICATE-----
-date: 2019-05-27 00:00:00.000000000 Z
+date: 2023-03-04 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rspec
@@ -81,33 +81,19 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '2.3'
 - !ruby/object:Gem::Dependency
-  name: warning_filter
+  name: timecop
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.0.6
+        version: '0.9'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.0.6
-- !ruby/object:Gem::Dependency
-  name: timecop
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - '='
-      - !ruby/object:Gem::Version
-        version: 0.6.0
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - '='
-      - !ruby/object:Gem::Version
-        version: 0.6.0
+        version: '0.9'
 description: 'Ruby/ProgressBar is an extremely flexible text progress bar library
   for Ruby. The output can be customized with a flexible formatting system including:
   percentage, bars of various formats, elapsed time and estimated time remaining.'
@@ -123,15 +109,12 @@ files:
 - lib/ruby-progressbar.rb
 - lib/ruby-progressbar/base.rb
 - lib/ruby-progressbar/calculators/length.rb
-- lib/ruby-progressbar/calculators/running_average.rb
-- lib/ruby-progressbar/components.rb
 - lib/ruby-progressbar/components/bar.rb
 - lib/ruby-progressbar/components/percentage.rb
 - lib/ruby-progressbar/components/rate.rb
 - lib/ruby-progressbar/components/time.rb
 - lib/ruby-progressbar/components/title.rb
 - lib/ruby-progressbar/errors/invalid_progress_error.rb
-- lib/ruby-progressbar/format.rb
 - lib/ruby-progressbar/format/formatter.rb
 - lib/ruby-progressbar/format/molecule.rb
 - lib/ruby-progressbar/format/string.rb
@@ -140,8 +123,10 @@ files:
 - lib/ruby-progressbar/outputs/null.rb
 - lib/ruby-progressbar/outputs/tty.rb
 - lib/ruby-progressbar/progress.rb
+- lib/ruby-progressbar/projector.rb
+- lib/ruby-progressbar/projectors/smoothed_average.rb
 - lib/ruby-progressbar/refinements.rb
-- lib/ruby-progressbar/refinements/enumerator.rb
+- lib/ruby-progressbar/refinements/progress_enumerator.rb
 - lib/ruby-progressbar/throttle.rb
 - lib/ruby-progressbar/time.rb
 - lib/ruby-progressbar/timer.rb
@@ -152,7 +137,7 @@ licenses:
 metadata:
   bug_tracker_uri: https://github.com/jfelchner/ruby-progressbar/issues
   changelog_uri: https://github.com/jfelchner/ruby-progressbar/blob/master/CHANGELOG.md
-  documentation_uri: https://github.com/jfelchner/ruby-progressbar/tree/releases/v1.10.1
+  documentation_uri: https://github.com/jfelchner/ruby-progressbar/tree/releases/v1.13.0
   homepage_uri: https://github.com/jfelchner/ruby-progressbar
   source_code_uri: https://github.com/jfelchner/ruby-progressbar
   wiki_uri: https://github.com/jfelchner/ruby-progressbar/wiki
@@ -171,7 +156,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.3
+rubygems_version: 3.1.6
 signing_key: 
 specification_version: 4
 summary: Ruby/ProgressBar is a flexible text progress bar library for Ruby.

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

@@ -1,9 +0,0 @@
-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

@@ -1,5 +0,0 @@
-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/format.rb

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

data/lib/ruby-progressbar/refinements/enumerator.rb

@@ -1,23 +0,0 @@
-class  ProgressBar
-module Refinements
-module Enumerator
-refine ::Enumerator do
-  def with_progressbar(options = {}, &block)
-    chain = ::Enumerator.new do |yielder|
-      progress_bar = ProgressBar.create(options.merge(:starting_at => 0, :total => size))
-
-      each do |*args|
-        yielder.yield(*args).tap do
-          progress_bar.increment
-        end
-      end
-    end
-
-    return chain unless block_given?
-
-    chain.each(&block)
-  end
-end
-end
-end
-end