progressbar 1.8.1 → 1.11.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 961db6323b945f7b6373152fb44363bfd8a6ac51
-  data.tar.gz: 379bef4d424ce616f2f7b98e0de4881474d3c636
+SHA256:
+  metadata.gz: d5bc49bb14e8635e80a71dd8aae8e6e80d42b1eedda7342c4b3ff975487bd119
+  data.tar.gz: af44f894c1ab7d25ae2ce4a4f150bc565e68669aa8f24220cb91e59eb6cb98ae
 SHA512:
-  metadata.gz: 45799ecf9e67670603bb0cbeb959508fbe148a30681d07c5dff599b8fb3ee9aefa06d1ac24f42552977b463760340d83724b0d4193297ffa60dcf49654d10084
-  data.tar.gz: 60430265e9174a0fe0a1484986d956683b8dea789683fb78c7956852bf9c5759b569d6e476ad0c6871084f32ee27ff43fd274a598985722e0d1d870870c6c90d
+  metadata.gz: 231ae03f6609373a4dbe57ab1fe4866b03afadc376b6766e00c60c3fde434acc39a69df57f68496d4927285d69437f5573f1a8be608fd2e997e4f9eaa9ee1890
+  data.tar.gz: 4efaeb90bd8c1d420a39fc73df3c17d1d3745ccf3f0987528eb9f6750b8fe0b06633ae19a3dd9ec634a55883a1f6271710935e7d10744c409fc0c4eb64f414ed

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)
+================================================================================
 
-<img src="https://www.dropbox.com/s/pe9o1yobxtubof8/ruby-progressbar-cage.png?dl=1" align="right" />
+<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>
 
-The **ultimate** text progress bar library for Ruby!  It'll **SMASH YOU OVER THE HEAD** with a **PURE RUSH** of progress bar excitement!
+  <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>
 
-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**!
+  <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>
 
-&nbsp;
+  <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>
 
-Full Reference
---------------------------------
+  <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!
+
+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>
+
+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://www.dropbox.com/s/86jfka1d6bhv8as/kompanee-text-black.png?dl=1)
+![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-2016 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://namazu.org/~satoru/)
+[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/progressbar.rb

@@ -1,4 +1,5 @@
 # frozen_string_literal: true
+
 require 'ruby-progressbar/output'
 require 'ruby-progressbar/outputs/tty'
 require 'ruby-progressbar/outputs/non_tty'
@@ -10,6 +11,9 @@ 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.
+                                         include?(:using)
 
 class ProgressBar
   def self.create(*args)

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
@@ -37,8 +37,6 @@ class   Base
   end
 
   def start(options = {})
-    clear
-
     timer.start
     update_progress(:start, options)
   end
@@ -125,6 +123,30 @@ class   Base
     Format::Formatter.process(@format, output.length, self)
   end
 
+  # 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,
+      '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,
+      'throttle_rate'                       => output.__send__(:throttle).rate,
+      'started?'                            => started?,
+      'stopped?'                            => stopped?,
+      'finished?'                           => finished?
+    }
+  end
+  # rubocop:enable Metrics/AbcSize, Layout/LineLength
+
   def inspect
     "#<ProgressBar:#{progress}/#{total || 'unknown'}>"
   end

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

@@ -2,10 +2,12 @@ class   ProgressBar
 module  Calculators
 class   Length
   attr_reader   :length_override
-  attr_accessor :current_length
+  attr_accessor :current_length,
+                :output
 
   def initialize(options = {})
     self.length_override = options[:length]
+    self.output          = options[:output]
     self.current_length  = nil
   end
 
@@ -37,21 +39,25 @@ class   Length
 
   # This code was copied and modified from Rake, available under MIT-LICENSE
   # Copyright (c) 2003, 2004 Jim Weirich
+  # rubocop:disable Style/RescueStandardError
   def terminal_width
     return 80 unless unix?
 
     result = dynamic_width
-    result < 20 ? 80 : result
+    (result < 20) ? 80 : result
   rescue
     80
   end
+  # rubocop:enable Style/RescueStandardError
 
   # rubocop:disable Lint/DuplicateMethods
   begin
     require 'io/console'
 
     def dynamic_width
-      if IO.console
+      if output && output.tty? && output.respond_to?(:winsize)
+        dynamic_width_via_output_stream_object
+      elsif IO.console
         dynamic_width_via_io_object
       else
         dynamic_width_via_system_calls
@@ -62,6 +68,12 @@ class   Length
       dynamic_width_via_system_calls
     end
   end
+  # rubocop:enable Lint/DuplicateMethods
+
+  def dynamic_width_via_output_stream_object
+    _rows, columns = output.winsize
+    columns
+  end
 
   def dynamic_width_via_io_object
     _rows, columns = IO.console.winsize

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

@@ -57,7 +57,13 @@ class   Bar
   def complete_bar(length)
     self.length = length
 
-    to_s
+    to_s(:format => :standard)
+  end
+
+  def complete_bar_with_percentage(length)
+    self.length = length
+
+    to_s(:format => :integrated_percentage)
   end
 
   def unknown_string

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

@@ -18,7 +18,7 @@ class   Rate
   private
 
   def rate_of_change(format_string = '%i')
-    return 0 unless elapsed_seconds.positive?
+    return 0 unless elapsed_seconds > 0
 
     format_string % scaled_rate
   end

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
@@ -63,12 +66,14 @@ class   Time
   private
 
   def estimated
-    return OOB_UNKNOWN_TIME_TEXT if progress.unknown? || progress.none? || timer.stopped?
+    memo_estimated_seconds_remaining = estimated_seconds_remaining
 
-    hours, minutes, seconds = timer.divide_seconds(estimated_seconds_remaining)
+    return OOB_UNKNOWN_TIME_TEXT unless memo_estimated_seconds_remaining
+
+    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
@@ -87,16 +92,9 @@ class   Time
   end
 
   def estimated_seconds_remaining
-    (timer.elapsed_seconds * (progress.total / progress.running_average - 1)).round
-  end
+    return if progress.unknown? || 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 / progress.running_average - 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.negative? ? 0 : bar_length
+    bar_length         = (bar_length < 0) ? 0 : bar_length
 
     format_string.bar_molecules.each do |molecule|
       processed_string.gsub!(molecule.full_key,

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

@@ -6,6 +6,7 @@ class   Molecule
     :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],
@@ -16,13 +17,14 @@ class   Molecule
     :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],
+    :R => [:rate,         :rate_of_change_with_precision]
   }.freeze
 
-  BAR_MOLECULES = %w{w B b i}.freeze
+  BAR_MOLECULES = %w{W w B b i}.freeze
 
   attr_accessor :key,
                 :method_name

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/output.rb

@@ -7,12 +7,17 @@ class   Output
   def initialize(options = {})
     self.bar               = options[:bar]
     self.stream            = options[:output] || DEFAULT_OUTPUT_STREAM
-    self.length_calculator = Calculators::Length.new(options)
     self.throttle          = Throttle.new(options)
+    self.length_calculator = Calculators::Length.new(
+                               :length => options[:length],
+                               :output => stream
+                             )
   end
 
   def self.detect(options = {})
-    if (options[:output] || DEFAULT_OUTPUT_STREAM).tty?
+    if options[:output].is_a?(Class) && options[:output] <= ProgressBar::Output
+      options[:output].new(options)
+    elsif (options[:output] || DEFAULT_OUTPUT_STREAM).tty?
       Outputs::Tty.new(options)
     else
       Outputs::NonTty.new(options)
@@ -47,15 +52,17 @@ class   Output
     end
   end
 
-  def print_and_flush
-    stream.print bar_update_string + eol
-    stream.flush
-  end
-
   protected
 
   attr_accessor :length_calculator,
                 :throttle,
                 :bar
+
+  private
+
+  def print_and_flush
+    stream.print bar_update_string + eol
+    stream.flush
+  end
 end
 end