progressbar 1.13.0rc1 → 1.13.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 600c4958d5a0334a7b8c57e026f018d2fbbb16e5dd03b9abc1a989a36b008466
-  data.tar.gz: 895e70eb9b8cc7ca96d86f06e8cc8f6dd36171faa2ea61cd868541b748fdb975
+  metadata.gz: f418592d256e13252084abad3577d8000cdaacfdf2714c930cef99bb02690dcb
+  data.tar.gz: 05fe75f498f6dc53fc26ee79c5cb229359e7f4fc158e3aed861ae84b02700a4a
 SHA512:
-  metadata.gz: cd5be8205221bd7701b32a2174465bab687195e3b764d19c1ccfa1f6a748162eaed3f2259b21f06f8d4a1070c899ef6cfc262f02e6cd7409990b7ac4295fcfe3
-  data.tar.gz: e470d4c737a328d6aad8dbb58796408256b63c4d5efd21ef2e730141cd3ce817b6a4c0d14dec4db2165b6f73d02dcf6ee221f54432a7abd226864dd4416fcd75
+  metadata.gz: c56aeb64b49c3e7bc9fffcc5e79c23bd2d5a96048a39b89398506397f317a891796eedd64f8924afb0a671d37b7df0bd3528d95a58218089c4e4d1ad464e9920
+  data.tar.gz: b20205abe7ce6979211102f81b7157ccbd3eec58f2ed9076626dcce4eba4aa1c6763708dca35bb046b5923e3f2803f44e2955113a8a1380ac0fab03a85ae6717

data/lib/ruby-progressbar/base.rb

@@ -10,12 +10,29 @@ 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,
@@ -26,15 +43,34 @@ class   Base
                  :total
 
   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(:progress => progressable,
-                            :timer    => timer)
+    options = options.merge(:progress  => progressable,
+                            :projector => projector,
+                            :timer     => timer)
 
     self.title_component      = Components::Title.new(options)
     self.bar_component        = Components::Bar.new(options)
@@ -79,6 +115,7 @@ class   Base
     output.with_refresh do
       self.finished = false
       progressable.reset
+      projector.reset
       timer.reset
     end
   end
@@ -174,6 +211,7 @@ class   Base
   protected
 
   attr_accessor :output,
+                :projector,
                 :timer,
                 :progressable,
                 :title_component,
@@ -188,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/components/time.rb

@@ -19,8 +19,9 @@ class   Time
   }.freeze
 
   def initialize(options = {})
-    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(out_of_bounds_time_format = nil)
@@ -57,7 +58,8 @@ class   Time
   protected
 
   attr_accessor :timer,
-                :progress
+                :progress,
+                :projector
 
   private
 
@@ -90,9 +92,9 @@ class   Time
   end
 
   def estimated_seconds_remaining
-    return if progress.unknown? || progress.none? || timer.stopped? || timer.reset?
+    return if progress.unknown? || projector.none? || progress.none? || timer.stopped? || timer.reset?
 
-    (timer.elapsed_seconds * ((progress.total / progress.running_average) - 1)).round
+    (timer.elapsed_seconds * ((progress.total / projector.projection) - 1)).round
   end
 end
 end

data/lib/ruby-progressbar/progress.rb

@@ -1,40 +1,22 @@
 require 'ruby-progressbar/errors/invalid_progress_error'
-require 'ruby-progressbar/calculators/smoothed_average'
 
 class   ProgressBar
 class   Progress
-  DEFAULT_TOTAL                      = 100
-  DEFAULT_BEGINNING_POSITION         = 0
-  DEFAULT_RUNNING_AVERAGE_RATE       = 0.1
-  DEFAULT_RUNNING_AVERAGE_CALCULATOR = ProgressBar::Calculators::SmoothedAverage
-
-  RUNNING_AVERAGE_CALCULATOR_MAP     = {
-    'smoothing' => ProgressBar::Calculators::SmoothedAverage
-  }.freeze
+  DEFAULT_TOTAL              = 100
+  DEFAULT_BEGINNING_POSITION = 0
 
   attr_reader               :total,
                             :progress
-
-  attr_accessor             :starting_position,
-                            :running_average,
-                            :running_average_calculator,
-                            :running_average_rate
+  attr_accessor             :starting_position
 
   def initialize(options = {})
-    self.total                      = options.fetch(:total, DEFAULT_TOTAL)
-    self.running_average_rate       = options[:smoothing] ||
-                                      options[:running_average_rate] ||
-                                      DEFAULT_RUNNING_AVERAGE_RATE
-    self.running_average_calculator = RUNNING_AVERAGE_CALCULATOR_MAP.
-                                        fetch(options[:running_average_calculator],
-                                              DEFAULT_RUNNING_AVERAGE_CALCULATOR)
-
-    start :at => DEFAULT_BEGINNING_POSITION
+    self.total = options.fetch(:total, DEFAULT_TOTAL)
+
+    start(:at => DEFAULT_BEGINNING_POSITION)
   end
 
   def start(options = {})
-    self.running_average   = 0
-    self.progress          = \
+    self.progress = \
       self.starting_position = options[:at] || progress
   end
 
@@ -67,7 +49,7 @@ class   Progress
   end
 
   def reset
-    start :at => starting_position
+    start(:at => starting_position)
   end
 
   def progress=(new_progress)
@@ -77,10 +59,6 @@ class   Progress
     end
 
     @progress = new_progress
-
-    self.running_average = running_average_calculator.calculate(running_average,
-                                                                absolute,
-                                                                running_average_rate)
   end
 
   def total=(new_total)
@@ -105,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/version.rb

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

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: progressbar
 version: !ruby/object:Gem::Version
-  version: 1.13.0rc1
+  version: 1.13.0
 platform: ruby
 authors:
 - thekompanee
@@ -36,7 +36,7 @@ cert_chain:
   DV37k4cni6c/jUm2CqepsJ/dbzeWdkhcuO6hwEQV0jvFky5C6d5hHcrbJwxl1sTL
   V+pWW6L9MSZzKkjWVJXD43B3tWBjIDthQVTzS4j90PUkUXgBXjS7Jxj/
   -----END CERTIFICATE-----
-date: 2023-03-01 00:00:00.000000000 Z
+date: 2023-03-04 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rspec
@@ -109,7 +109,6 @@ files:
 - lib/progressbar.rb
 - lib/ruby-progressbar/base.rb
 - lib/ruby-progressbar/calculators/length.rb
-- lib/ruby-progressbar/calculators/smoothed_average.rb
 - lib/ruby-progressbar/components/bar.rb
 - lib/ruby-progressbar/components/percentage.rb
 - lib/ruby-progressbar/components/rate.rb
@@ -124,6 +123,8 @@ 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/progress_enumerator.rb
 - lib/ruby-progressbar/throttle.rb
@@ -136,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.13.0rc1
+  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
@@ -151,9 +152,9 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ">"
+  - - ">="
     - !ruby/object:Gem::Version
-      version: 1.3.1
+      version: '0'
 requirements: []
 rubygems_version: 3.1.6
 signing_key: 

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

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