ruby-progressbar 1.10.0 → 1.11.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 42ee7acdeadf208ea04bd6a634dbc999b264fe0914f1ffd7782ecbac90e50858
-  data.tar.gz: 0e7ece6126e208f2636f8e4841c6fd26ee1d935c16ff5d84075e65ac70371b98
+  metadata.gz: e84294efeca1c0798ab9989fd765703f2079bb91a0a1a82896007f9c25073427
+  data.tar.gz: f4d325243b1633034ad6d88a5d076cdc182f4a801ec5607bbc38fd3632a42d4d
 SHA512:
-  metadata.gz: 36159642c868a944be95a1e6466366516096f7f875437ce3c304418ead4e97349cd8acac7123c2dc9550d18999f1ea629cc34aa622ae5497cea5cfa7a5563ee2
-  data.tar.gz: fc513c2a18cbd165cc1b69dc47c17d9c8f7844f14d86707c15fbc8ecea8c7ff51a9872d9b1bb61e4d505ce054a993c61dcdc7c260cb97a36edb53de49805496c
+  metadata.gz: ee3000a7ec9be1ae3151dedb7498408959fbaa637d635d17e92bf6ef2c92deaa0f9eff60a33f2cb3b32f79246a3700e7e2c6c2c301f14f90c7260b4582597df9
+  data.tar.gz: 281663e1fe308da2ce0a374e19aa9832113adee0cc15baed87286d1485ad3acd41bf236af7261ede128d7d97954ef425416dfd03a7789156488156a9e3ecdfd6

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

@@ -13,7 +13,7 @@ class   Base
                  :progress,
                  :total
 
-  def initialize(options = {})
+  def initialize(options = {}) # rubocop:disable Metrics/AbcSize
     self.autostart    = options.fetch(:autostart,  true)
     self.autofinish   = options.fetch(:autofinish, true)
     self.finished     = false
@@ -123,7 +123,7 @@ 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),
@@ -145,7 +145,7 @@ class   Base
       'finished?'                           => finished?
     }
   end
-  # rubocop:enable Metrics/AbcSize, Metrics/LineLength
+  # rubocop:enable Metrics/AbcSize, Layout/LineLength
 
   def inspect
     "#<ProgressBar:#{progress}/#{total || 'unknown'}>"

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

@@ -55,7 +55,7 @@ class   Length
     require 'io/console'
 
     def dynamic_width
-      if output && output.tty?
+      if output && output.tty? && output.respond_to?(:winsize)
         dynamic_width_via_output_stream_object
       elsif IO.console
         dynamic_width_via_io_object

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

@@ -12,6 +12,10 @@ class   Time
   NO_TIME_ELAPSED_TEXT   = '--:--:--'.freeze
   ESTIMATED_LABEL        = ' ETA'.freeze
   ELAPSED_LABEL          = 'Time'.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]
@@ -53,8 +57,7 @@ class   Time
 
   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
+      fail StandardError, "Invalid Out Of Bounds time format.  Valid formats are #{OOB_TIME_FORMATS.inspect}"
     end
 
     @out_of_bounds_time_format = format
@@ -70,7 +73,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[out_of_bounds_time_format]
     else
       TIME_FORMAT % [hours, minutes, seconds]
     end
@@ -89,19 +92,10 @@ class   Time
   end
 
   def estimated_seconds_remaining
-    return if progress.unknown? || progress.none? || timer.stopped?
+    return if progress.unknown? || progress.none? || timer.stopped? || timer.reset?
 
     (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/format/string.rb

@@ -1,8 +1,8 @@
 class   ProgressBar
 module  Format
 class   String < ::String
-  MOLECULE_PATTERN = /%[a-zA-Z]/
-  ANSI_SGR_PATTERN = /\e\[[\d;]+m/
+  MOLECULE_PATTERN = /%[a-zA-Z]/.freeze
+  ANSI_SGR_PATTERN = /\e\[[\d;]+m/.freeze
 
   def displayable_length
     gsub(ANSI_SGR_PATTERN, '').length
@@ -29,7 +29,7 @@ class   String < ::String
                       end
 
                       molecules
-                    end
+                   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/refinements/enumerator.rb

@@ -13,7 +13,7 @@ refine ::Enumerator do
       end
     end
 
-    return chain unless block_given?
+    return chain unless block
 
     chain.each(&block)
   end

data/lib/ruby-progressbar/time.rb

@@ -2,10 +2,10 @@
 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)
@@ -13,7 +13,7 @@ class   Time
   end
 
   def now
-    time.__send__ unmocked_time_method
+    time.__send__(unmocked_time_method)
   end
 
   def unmocked_time_method

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.10.0'.freeze
+  VERSION = '1.11.0'.freeze
 end

data/lib/ruby-progressbar.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'ruby-progressbar/output'
 require 'ruby-progressbar/outputs/tty'
 require 'ruby-progressbar/outputs/non_tty'
@@ -9,7 +11,9 @@ require 'ruby-progressbar/calculators/running_average'
 require 'ruby-progressbar/components'
 require 'ruby-progressbar/format'
 require 'ruby-progressbar/base'
-require 'ruby-progressbar/refinements' unless RUBY_VERSION.start_with?('1.')
+require 'ruby-progressbar/refinements' if Module.
+                                         private_instance_methods.
+                                         include?(:using)
 
 class ProgressBar
   def self.create(*args)

metadata

@@ -1,19 +1,19 @@
 --- !ruby/object:Gem::Specification
 name: ruby-progressbar
 version: !ruby/object:Gem::Version
-  version: 1.10.0
+  version: 1.11.0
 platform: ruby
 authors:
 - thekompanee
 - jfelchner
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain:
 - |
   -----BEGIN CERTIFICATE-----
-  MIIEdjCCAt6gAwIBAgIBATANBgkqhkiG9w0BAQsFADAyMTAwLgYDVQQDDCdhY2Nv
-  dW50c19ydWJ5Z2Vtcy9EQz10aGVrb21wYW5lZS9EQz1jb20wHhcNMTgwODAzMjEz
-  NDA1WhcNMTkwODAzMjEzNDA1WjAyMTAwLgYDVQQDDCdhY2NvdW50c19ydWJ5Z2Vt
+  MIIEGDCCAoCgAwIBAgIBAjANBgkqhkiG9w0BAQsFADAyMTAwLgYDVQQDDCdhY2Nv
+  dW50c19ydWJ5Z2Vtcy9EQz10aGVrb21wYW5lZS9EQz1jb20wHhcNMjAxMjI2MjIz
+  MTE2WhcNMjExMjI2MjIzMTE2WjAyMTAwLgYDVQQDDCdhY2NvdW50c19ydWJ5Z2Vt
   cy9EQz10aGVrb21wYW5lZS9EQz1jb20wggGiMA0GCSqGSIb3DQEBAQUAA4IBjwAw
   ggGKAoIBgQCqhYn5ODEoLvuBIF2M1GzoaZU28+ntP5QApvDE0Te04n0JbBC1cNYH
   mr71neeSx7tlZ9w9kJ/8GNcY5bm7pNJqhyhfc+uG9M7FttcxM8AYXogjcdUDP234
@@ -23,20 +23,18 @@ cert_chain:
   ztMEU785tERbOSszZrz9rBS/+GnMxlD0pxy50zFfHX3jY1hwnwGjE8Gg+0iYr/tm
   eysjhcbZfKrMynoqAioCSwstIwtYYYYpYzCPZzwaIBaBqQmUTkuMeiGbAdOdFOrR
   lOgl5jxCYbNOOTaXbm0nGBFaTucB88+JLbsNAuoNGUf/ybDcZ1zKRkMr2vtb+OtL
-  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
+  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: 2018-08-03 00:00:00.000000000 Z
+date: 2020-12-31 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rspec
@@ -80,20 +78,6 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '2.3'
-- !ruby/object:Gem::Dependency
-  name: warning_filter
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: 0.0.6
-  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
@@ -150,14 +134,13 @@ homepage: https://github.com/jfelchner/ruby-progressbar
 licenses:
 - MIT
 metadata:
-  allowed_push_host: https://rubygems.org
   bug_tracker_uri: https://github.com/jfelchner/ruby-progressbar/issues
-  changelog_uri: https://github.com/jfelchner/ruby-progressbar/CHANGELOG.md
-  documentation_uri: https://github.com/jfelchner/ruby-progressbar/tree/releases/v1.10.0
+  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: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -172,9 +155,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.7.7
-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: []