ruby-progressbar 1.8.1 → 1.11.0

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

@@ -22,7 +22,7 @@ class   NonTty < Output
     output_string           = formatted_string[last_update_length..-1]
     self.last_update_length = formatted_string.length
 
-    output_string
+    output_string.to_s
   end
 
   def default_format

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

@@ -0,0 +1,33 @@
+require 'ruby-progressbar/output'
+
+class   ProgressBar
+module  Outputs
+class   Null < Output
+  alias refresh_with_format_change with_refresh
+
+  def clear;        end
+  def log(_string); end
+  def refresh(*);   end
+
+  def clear_string
+    ''
+  end
+
+  def bar_update_string
+    ''
+  end
+
+  def default_format
+    ''
+  end
+
+  def resolve_format(_format)
+    ''
+  end
+
+  def eol
+    ''
+  end
+end
+end
+end

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

@@ -35,17 +35,21 @@ class   Progress
   end
 
   def increment
-    warn "WARNING: Your progress bar is currently at #{progress} out of #{total} " \
-         "and cannot be incremented. In v2.0.0 this will become a " \
-         "ProgressBar::InvalidProgressError." if progress == total
+    if progress == total
+      warn "WARNING: Your progress bar is currently at #{progress} out of #{total} " \
+           "and cannot be incremented. In v2.0.0 this will become a " \
+           "ProgressBar::InvalidProgressError."
+    end
 
     self.progress += 1 unless progress == total
   end
 
   def decrement
-    warn "WARNING: Your progress bar is currently at #{progress} out of #{total} " \
-         "and cannot be decremented. In v2.0.0 this will become a " \
-         "ProgressBar::InvalidProgressError." if progress == 0
+    if progress == 0
+      warn "WARNING: Your progress bar is currently at #{progress} out of #{total} " \
+           "and cannot be decremented. In v2.0.0 this will become a " \
+           "ProgressBar::InvalidProgressError."
+    end
 
     self.progress -= 1 unless progress == 0
   end
@@ -55,10 +59,10 @@ class   Progress
   end
 
   def progress=(new_progress)
-    fail ProgressBar::InvalidProgressError,
-         "You can't set the item's current value to be greater than the total." \
-    if total &&
-       new_progress > total
+    if total && new_progress > total
+      fail ProgressBar::InvalidProgressError,
+           "You can't set the item's current value to be greater than the total."
+    end
 
     @progress = new_progress
 
@@ -68,18 +72,17 @@ class   Progress
   end
 
   def total=(new_total)
-    fail ProgressBar::InvalidProgressError,
-         "You can't set the item's total value to less than the current progress." \
-    unless progress.nil?  ||
-           new_total.nil? ||
-           new_total >= progress
+    unless progress.nil? || new_total.nil? || new_total >= progress
+      fail ProgressBar::InvalidProgressError,
+           "You can't set the item's total value to less than the current progress."
+    end
 
     @total = new_total
   end
 
   def percentage_completed
     return 0   if total.nil?
-    return 100 if total.zero?
+    return 100 if total == 0
 
     # progress / total * 100
     #
@@ -97,6 +100,10 @@ class   Progress
     progress.nil? || total.nil?
   end
 
+  def total_with_unknown_indicator
+    total || '??'
+  end
+
   def percentage_completed_with_precision
     return 100.0  if total == 0
     return 0.0    if total.nil?

data/lib/ruby-progressbar/refinements.rb

@@ -0,0 +1 @@
+require 'ruby-progressbar/refinements/enumerator'

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

@@ -0,0 +1,23 @@
+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
+
+    chain.each(&block)
+  end
+end
+end
+end
+end

data/lib/ruby-progressbar/time.rb

@@ -1,10 +1,11 @@
+# rubocop:disable Style/InlineComment
 class   ProgressBar
 class   Time
   TIME_MOCKING_LIBRARY_METHODS = [
-                                   :__simple_stub__now,          # ActiveSupport
-                                   :now_without_mock_time,       # Timecop
-                                   :now_without_delorean,        # Delorean
-                                   :now                          # Actual
+                                   :__simple_stub__now,     # ActiveSupport
+                                   :now_without_mock_time,  # Timecop
+                                   :now_without_delorean,   # Delorean
+                                   :now                     # Unmocked
                                  ].freeze
 
   def initialize(time = ::Time)
@@ -12,7 +13,7 @@ class   Time
   end
 
   def now
-    time.__send__ unmocked_time_method
+    time.__send__(unmocked_time_method)
   end
 
   def unmocked_time_method
@@ -28,3 +29,4 @@ class   Time
   attr_accessor :time
 end
 end
+# rubocop:enable Style/InlineComment

data/lib/ruby-progressbar/timer.rb

@@ -6,7 +6,7 @@ class   Timer
                 :stopped_at
 
   def initialize(options = {})
-    self.time = options[:time] || Time.new
+    self.time = options[:time] || ::ProgressBar::Time.new
   end
 
   def start

data/lib/ruby-progressbar/version.rb

@@ -1,3 +1,3 @@
 class ProgressBar
-  VERSION = '1.8.1'.freeze
+  VERSION = '1.11.0'.freeze
 end

metadata

@@ -1,38 +1,40 @@
 --- !ruby/object:Gem::Specification
 name: ruby-progressbar
 version: !ruby/object:Gem::Version
-  version: 1.8.1
+  version: 1.11.0
 platform: ruby
 authors:
 - thekompanee
 - jfelchner
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain:
 - |
   -----BEGIN CERTIFICATE-----
-  MIIDrjCCApagAwIBAgIBATANBgkqhkiG9w0BAQUFADBOMRowGAYDVQQDDBFhY2Nv
-  dW50c19ydWJ5Z2VtczEbMBkGCgmSJomT8ixkARkWC3RoZWtvbXBhbmVlMRMwEQYK
-  CZImiZPyLGQBGRYDY29tMB4XDTE2MDQyNDAyNTEyM1oXDTE3MDQyNDAyNTEyM1ow
-  TjEaMBgGA1UEAwwRYWNjb3VudHNfcnVieWdlbXMxGzAZBgoJkiaJk/IsZAEZFgt0
-  aGVrb21wYW5lZTETMBEGCgmSJomT8ixkARkWA2NvbTCCASIwDQYJKoZIhvcNAQEB
-  BQADggEPADCCAQoCggEBANklzdaVeHtut6LTe/hrl6Krz2Z60InEbNb+TMG43tww
-  jBpWZrdU/SBkR3EYbTAQv/yGTuMHoVKGK2kDlFvdofW2hX0d14qPyYJUNYt+7VWE
-  3UhPSxw1i6MxeU1QwfkIyaN8A5lj0225+rwI/mbplv+lSXPlJEroCQ9EfniZD4jL
-  URlrHWl/UejcQ32C1IzBwth3+nacrO1197v5nSdozFzQwm4groaggXn9F/WpThu+
-  MhcE4bfttwEjAfU3zAThyzOFoVPpACP+SwOuyPJSl02+9BiwzeAnFJDfge7+rsd5
-  64W/VzBIklEKUZMmxZwr5DwpSXLrknBDtHLABG9Nr3cCAwEAAaOBljCBkzAJBgNV
-  HRMEAjAAMAsGA1UdDwQEAwIEsDAdBgNVHQ4EFgQUP7v0f/qfa0LMrhkzHRI3l10X
-  LYIwLAYDVR0RBCUwI4EhYWNjb3VudHMrcnVieWdlbXNAdGhla29tcGFuZWUuY29t
-  MCwGA1UdEgQlMCOBIWFjY291bnRzK3J1YnlnZW1zQHRoZWtvbXBhbmVlLmNvbTAN
-  BgkqhkiG9w0BAQUFAAOCAQEASqdfJKMun1twosHfvdDH7Vgrb5VqX28qJ6MgnhjF
-  p+3HYTjYo/KMQqu78TegUFO5xQ4oumU0FTXADW0ryXZvUGV74M0zwqpFqeo8onII
-  lsVsWdMCLZS21M0uCQmcV+OQMNxL8jV3c0D3x9Srr9yO4oamW3seIdb+b9RfhmV2
-  ryr+NH8U/4xgzdJ4hWV4qk93nwigp4lwJ4u93XJ7Cdyw7itvaEPnn8HpCfzsiLcw
-  QwSfDGz6+zsImi5N3UT71+mk7YcviQSgvMRl3VkAv8MZ6wcJ5SQRpf9w0OeFH6Ln
-  nNbCoHiYeXX/lz/M6AIbxDIZZTwxcyvF7bdrQ2fbH5MsfQ==
+  MIIEGDCCAoCgAwIBAgIBAjANBgkqhkiG9w0BAQsFADAyMTAwLgYDVQQDDCdhY2Nv
+  dW50c19ydWJ5Z2Vtcy9EQz10aGVrb21wYW5lZS9EQz1jb20wHhcNMjAxMjI2MjIz
+  MTE2WhcNMjExMjI2MjIzMTE2WjAyMTAwLgYDVQQDDCdhY2NvdW50c19ydWJ5Z2Vt
+  cy9EQz10aGVrb21wYW5lZS9EQz1jb20wggGiMA0GCSqGSIb3DQEBAQUAA4IBjwAw
+  ggGKAoIBgQCqhYn5ODEoLvuBIF2M1GzoaZU28+ntP5QApvDE0Te04n0JbBC1cNYH
+  mr71neeSx7tlZ9w9kJ/8GNcY5bm7pNJqhyhfc+uG9M7FttcxM8AYXogjcdUDP234
+  +TdmZIz20JxtWBgAZK2I3ktlgLFLC3Pxq63yzhJ75Xok07Wh+ypwjGzDNofPhz+y
+  XR+UeUTp2UGe7kDVoqu/AwwPVhk1qUIRFLfC8SLDTD0CuNW3/AnkwQrKSm8vkiIn
+  q9GCnOq0+jQly0b6a1Gi3ZDYEEswnTzziw2gotUZnQkF5bcOcxK1CB/Okk2jtG7i
+  ztMEU785tERbOSszZrz9rBS/+GnMxlD0pxy50zFfHX3jY1hwnwGjE8Gg+0iYr/tm
+  eysjhcbZfKrMynoqAioCSwstIwtYYYYpYzCPZzwaIBaBqQmUTkuMeiGbAdOdFOrR
+  lOgl5jxCYbNOOTaXbm0nGBFaTucB88+JLbsNAuoNGUf/ybDcZ1zKRkMr2vtb+OtL
+  GoP81fN6l88CAwEAAaM5MDcwCQYDVR0TBAIwADALBgNVHQ8EBAMCBLAwHQYDVR0O
+  BBYEFC+HleDjPYe35DNu6n/aeK2oB4ugMA0GCSqGSIb3DQEBCwUAA4IBgQCbuxKj
+  ZyvFu5mUDEWCf1dT5mqFSyFznVCjQAQygDnz6JkCQlIG93IDtVLEmHrx7hm3dOYt
+  HgPlsSgkoYIgsLYsR9ZIKjA2O5m3QUbo9uOtF4iRi0Obni8fVv7VZVebRfA7ypCo
+  n625lDRIzc/zGVcI37bzIlDXC0aK3oaBVFmN1Uj5LNMW62hTDdMBx4HcUKI45R3g
+  clUG96OBIyrYky3j6zpy6EpBaEdRWR68Yn4Tdba7xE9WzP3DCInjX3KPx+f0PPVK
+  HzsXX6TlwXk2P9DwOTZRjz7vAmvTgZGWjlfq3dgQJBgjB+UKQVHxKEGUC/comr7c
+  vPnXgn+nF38pK/hp/O9/lTpNplKrUvOB9+6nkwbxCPTQQO8In3pC6ixUzr/6wx9R
+  URbz4/Czf5LMUmzqDni0GvBkXElaXzaIRoPM/T7b1LrRsZO3DwGFAasSrR27+ZgU
+  Sv+7zM1SqVOK2Vhp99UBBVIZTHSJWh4sCU7dJrUJTqvwwS3ayTiUlIi5TdQ=
   -----END CERTIFICATE-----
-date: 2016-05-13 00:00:00.000000000 Z
+date: 2020-12-31 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rspec
@@ -40,14 +42,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.2'
+        version: '3.7'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.2'
+        version: '3.7'
 - !ruby/object:Gem::Dependency
   name: rspectacular
   requirement: !ruby/object:Gem::Requirement
@@ -68,47 +70,33 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '2.0'
+        version: '2.3'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '2.0'
-- !ruby/object:Gem::Dependency
-  name: warning_filter
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: 0.0.2
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: 0.0.2
+        version: '2.3'
 - !ruby/object:Gem::Dependency
   name: timecop
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 0.6.1
+        version: 0.6.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 0.6.1
-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.
-email: support@thekompanee.com
+        version: 0.6.0
+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.'
+email:
+- support@thekompanee.com
 executables: []
 extensions: []
 extra_rdoc_files: []
@@ -119,7 +107,6 @@ files:
 - lib/ruby-progressbar.rb
 - lib/ruby-progressbar/base.rb
 - lib/ruby-progressbar/calculators/length.rb
-- lib/ruby-progressbar/calculators/length_spec.rb
 - lib/ruby-progressbar/calculators/running_average.rb
 - lib/ruby-progressbar/components.rb
 - lib/ruby-progressbar/components/bar.rb
@@ -134,38 +121,26 @@ files:
 - lib/ruby-progressbar/format/string.rb
 - lib/ruby-progressbar/output.rb
 - lib/ruby-progressbar/outputs/non_tty.rb
+- lib/ruby-progressbar/outputs/null.rb
 - lib/ruby-progressbar/outputs/tty.rb
 - lib/ruby-progressbar/progress.rb
+- lib/ruby-progressbar/refinements.rb
+- lib/ruby-progressbar/refinements/enumerator.rb
 - lib/ruby-progressbar/throttle.rb
 - lib/ruby-progressbar/time.rb
 - lib/ruby-progressbar/timer.rb
 - lib/ruby-progressbar/version.rb
-- spec/fixtures/benchmark.rb
-- spec/ruby-progressbar/base_spec.rb
-- spec/ruby-progressbar/calculators/length_calculator_spec.rb
-- spec/ruby-progressbar/calculators/running_average_spec.rb
-- spec/ruby-progressbar/components/bar_spec.rb
-- spec/ruby-progressbar/components/percentage_spec.rb
-- spec/ruby-progressbar/components/rate_spec.rb
-- spec/ruby-progressbar/components/throttle_spec.rb
-- spec/ruby-progressbar/components/time_spec.rb
-- spec/ruby-progressbar/components/title_spec.rb
-- spec/ruby-progressbar/format/formatter_spec.rb
-- spec/ruby-progressbar/format/molecule_spec.rb
-- spec/ruby-progressbar/format/string_spec.rb
-- spec/ruby-progressbar/output_spec.rb
-- spec/ruby-progressbar/outputs/non_tty_spec.rb
-- spec/ruby-progressbar/outputs/tty_spec.rb
-- spec/ruby-progressbar/progress_spec.rb
-- spec/ruby-progressbar/time_spec.rb
-- spec/ruby-progressbar/timer_spec.rb
-- spec/spec_helper.rb
-- spec/support/time.rb
 homepage: https://github.com/jfelchner/ruby-progressbar
 licenses:
 - MIT
-metadata: {}
-post_install_message: 
+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.11.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
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -180,31 +155,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.4.5.1
-signing_key: 
+rubygems_version: 3.2.3
+signing_key:
 specification_version: 4
 summary: Ruby/ProgressBar is a flexible text progress bar library for Ruby.
-test_files:
-- spec/fixtures/benchmark.rb
-- spec/ruby-progressbar/base_spec.rb
-- spec/ruby-progressbar/calculators/length_calculator_spec.rb
-- spec/ruby-progressbar/calculators/running_average_spec.rb
-- spec/ruby-progressbar/components/bar_spec.rb
-- spec/ruby-progressbar/components/percentage_spec.rb
-- spec/ruby-progressbar/components/rate_spec.rb
-- spec/ruby-progressbar/components/throttle_spec.rb
-- spec/ruby-progressbar/components/time_spec.rb
-- spec/ruby-progressbar/components/title_spec.rb
-- spec/ruby-progressbar/format/formatter_spec.rb
-- spec/ruby-progressbar/format/molecule_spec.rb
-- spec/ruby-progressbar/format/string_spec.rb
-- spec/ruby-progressbar/output_spec.rb
-- spec/ruby-progressbar/outputs/non_tty_spec.rb
-- spec/ruby-progressbar/outputs/tty_spec.rb
-- spec/ruby-progressbar/progress_spec.rb
-- spec/ruby-progressbar/time_spec.rb
-- spec/ruby-progressbar/timer_spec.rb
-- spec/spec_helper.rb
-- spec/support/time.rb
-has_rdoc: 
+test_files: []

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

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

data/spec/fixtures/benchmark.rb

@@ -1,28 +0,0 @@
-# bundle exec ruby-prof --printer=graph_html
-#                       --file=../results.html
-#                       --require 'ruby-progressbar'
-#                       --sort=total ./spec/fixtures/benchmark.rb
-
-total  = 100_000
-# output = File.open('/Users/jfelchner/Downloads/benchmark.txt', 'w+')
-output = $stdout
-
-# Progressbar gem
-# bar = ProgressBar.new('Progress', total)
-#
-# total.times do |i|
-#   bar.inc
-# end
-#
-# bar.finish
-
-# Ruby/ProgressBar
-bar = ProgressBar.create(:output => output,
-                         :length => 80,
-                         :start  => 0,
-                         :total  => total)
-
-total.times do |_i|
-  # bar.log i
-  bar.increment
-end