progressbar 1.8.2 → 1.9.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 678eaa389d64f29d8b48c5e8086549021feaecd2
-  data.tar.gz: afdb30e1a504db901364de5e5852fb59ded7b6b6
+  metadata.gz: 7f2b3dd564ea79b42aff1b69292c39069069efd5
+  data.tar.gz: 6875bf6216a6d834b2caed6477af1a2eefe8ede9
 SHA512:
-  metadata.gz: ae05fc8f39070630e8df1b3c1a0ff5137a3f7363a2e492441512409e2150aa115f611ec1957a3b3558994bd26a4e7d4b104ed19fe4343f3d0b47cf2714d76f49
-  data.tar.gz: 46e580fa131be5aa76694f56bf3b3664ae20c8ec1c47323a648696f679aea312f54a777ee4c47db2acd9662dc15491a335438bda86204bc50d099fa4771bc7c9
+  metadata.gz: e388c8a1576d42b3a884bdd8784d27c2149a64cd9ece8fa841b8d63387776ff583e55f868765261819e10b182ea7bc8c3d90b2c60b06d23695e36f2522ced68a
+  data.tar.gz: 72e8985dbde3bb6890712e6a80864f408d78f27026b1c6d0368fcc125c8a65d8cd0385f02150b00221d1d3e3a1d7a77cd140824348bfa42e2890f56d3657994e

data/README.md

@@ -2,13 +2,13 @@ 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" />
+<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**!
 
-&nbsp;
+<br><br><br>
 
 Full Reference
 --------------------------------
@@ -25,7 +25,7 @@ If you have problems, please create a [Github issue](https://github.com/jfelchne
 Credits
 --------------------------------
 
-![The Kompanee](https://www.dropbox.com/s/86jfka1d6bhv8as/kompanee-text-black.png?dl=1)
+![The Kompanee](https://kompanee-public-assets.s3.amazonaws.com/readmes/kompanee-horizontal-black.png)
 
 ruby-progressbar is maintained by [The Kompanee, Ltd.](http://www.thekompanee.com)
 
@@ -34,5 +34,5 @@ The names and logos for The Kompanee are trademarks of The Kompanee, Ltd.
 License
 --------------------------------
 
-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/)
+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)

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,7 @@ 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.')
 
 class ProgressBar
   def self.create(*args)

data/lib/ruby-progressbar/base.rb

@@ -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, Metrics/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, Metrics/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 Lint/RescueWithoutErrorClass
   def terminal_width
     return 80 unless unix?
 
     result = dynamic_width
-    result < 20 ? 80 : result
+    (result < 20) ? 80 : result
   rescue
     80
   end
+  # rubocop:enable Lint/RescueWithoutErrorClass
 
   # rubocop:disable Lint/DuplicateMethods
   begin
     require 'io/console'
 
     def dynamic_width
-      if IO.console
+      if output && output.tty?
+        dynamic_width_via_output_stream_object
+      elsif IO.console
         dynamic_width_via_io_object
       else
         dynamic_width_via_system_calls
@@ -63,6 +69,11 @@ class   Length
     end
   end
 
+  def dynamic_width_via_output_stream_object
+    _rows, columns = output.winsize
+    columns
+  end
+
   def dynamic_width_via_io_object
     _rows, columns = IO.console.winsize
     columns

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

@@ -63,9 +63,11 @@ 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
@@ -87,6 +89,8 @@ class   Time
   end
 
   def estimated_seconds_remaining
+    return if progress.unknown? || progress.none? || timer.stopped?
+
     (timer.elapsed_seconds * (progress.total / progress.running_average - 1)).round
   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         = (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],
@@ -19,7 +20,7 @@ class   Molecule
     :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

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

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

@@ -100,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,25 @@
+class  ProgressBar
+module Refinements
+module Enumerator
+refine ::Enumerator do
+  # rubocop:disable Metrics/BlockNesting
+  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
+  # rubocop:enable Metrics/BlockNesting
+end
+end
+end
+end

data/lib/ruby-progressbar/version.rb

@@ -1,3 +1,3 @@
 class ProgressBar
-  VERSION = '1.8.2'.freeze
+  VERSION = '1.9.0'.freeze
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: progressbar
 version: !ruby/object:Gem::Version
-  version: 1.8.2
+  version: 1.9.0
 platform: ruby
 authors:
 - thekompanee
@@ -13,26 +13,26 @@ cert_chain:
   -----BEGIN CERTIFICATE-----
   MIIDrjCCApagAwIBAgIBATANBgkqhkiG9w0BAQUFADBOMRowGAYDVQQDDBFhY2Nv
   dW50c19ydWJ5Z2VtczEbMBkGCgmSJomT8ixkARkWC3RoZWtvbXBhbmVlMRMwEQYK
-  CZImiZPyLGQBGRYDY29tMB4XDTE2MDQyNDAyNTEyM1oXDTE3MDQyNDAyNTEyM1ow
+  CZImiZPyLGQBGRYDY29tMB4XDTE3MDgwMjIyNTgyMVoXDTE4MDgwMjIyNTgyMVow
   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
+  BQADggEPADCCAQoCggEBAKunijEc/LhVt5JaoGNSvpxTGFH0B6nXlKczqYZwSq1v
+  t+N9yjAqbbaWf/gEABZC4OyTKj8CMV+XifPjd1pZgyzTjnNA9H11V0L6iT6ecjTa
+  psR7JOeDNBvvbQLIu1Bcq/YymX4XfUwGiUyP5ik9LUBCzkr9uSA4VrHdXEbU3vTf
+  CO9LSE+IWMSGIsaKe1GO/JgZ8rBPeRU2UtLiKVdbZsN54r9g2ALWKeHbwe8I+/X2
+  09Z5+O8umT6DyQ/ZQwJu1ose4S6xqKuZi3hrVLaZuqzrKXdFNa26YZvNesD69TkD
+  SUyGUo0nCfFRdpasF5b7FPqQrFHpM98GWHTIGfLi+3ECAwEAAaOBljCBkzAJBgNV
+  HRMEAjAAMAsGA1UdDwQEAwIEsDAdBgNVHQ4EFgQUq9CqCtrqfHhfx7IQAJK/ZxuP
+  lqUwLAYDVR0RBCUwI4EhYWNjb3VudHMrcnVieWdlbXNAdGhla29tcGFuZWUuY29t
   MCwGA1UdEgQlMCOBIWFjY291bnRzK3J1YnlnZW1zQHRoZWtvbXBhbmVlLmNvbTAN
-  BgkqhkiG9w0BAQUFAAOCAQEASqdfJKMun1twosHfvdDH7Vgrb5VqX28qJ6MgnhjF
-  p+3HYTjYo/KMQqu78TegUFO5xQ4oumU0FTXADW0ryXZvUGV74M0zwqpFqeo8onII
-  lsVsWdMCLZS21M0uCQmcV+OQMNxL8jV3c0D3x9Srr9yO4oamW3seIdb+b9RfhmV2
-  ryr+NH8U/4xgzdJ4hWV4qk93nwigp4lwJ4u93XJ7Cdyw7itvaEPnn8HpCfzsiLcw
-  QwSfDGz6+zsImi5N3UT71+mk7YcviQSgvMRl3VkAv8MZ6wcJ5SQRpf9w0OeFH6Ln
-  nNbCoHiYeXX/lz/M6AIbxDIZZTwxcyvF7bdrQ2fbH5MsfQ==
+  BgkqhkiG9w0BAQUFAAOCAQEAqjylrSicZbZBInAWZScw/c2oNz2kdnxh76IA/DbA
+  +TCjytQRyKgbynEoBrYf/c6Mc1gPrjPINNubj3GICajOPmYjJZcyn0uBOthBKjOx
+  23BI9sL4wNDvqJVkPuX9kd2YZP6S5UocoMVIrGouD8xzUFDAkghBJAI0rJyeW9ew
+  8GYAA2UPxYOZS25L5NEbRvQyZTifbqxoUiCAET/gbrnodvTTXDhZ8JV45/Fr3K97
+  PHO6SmWDz7oWa8pdUSTTn9dNIVaxsYYuqr1HyaHdhjItQLl/4S4wZu1yqMBEwyGO
+  HGJ2WkoCJ6ABU8wsO70PQd9pl1M3stScQLd3vWgPeuioBQ==
   -----END CERTIFICATE-----
-date: 2016-12-10 00:00:00.000000000 Z
+date: 2017-09-27 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rspec
@@ -82,14 +82,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.0.2
+        version: 0.0.6
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.0.2
+        version: 0.0.6
 - !ruby/object:Gem::Dependency
   name: timecop
   requirement: !ruby/object:Gem::Requirement
@@ -104,11 +104,11 @@ dependencies:
     - - '='
       - !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
+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 +119,6 @@ files:
 - lib/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,37 +133,20 @@ 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: {}
+metadata:
+  allowed_push_host: https://rubygems.org
 post_install_message: 
 rdoc_options: []
 require_paths:
@@ -181,29 +163,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.5.1
+rubygems_version: 2.6.8
 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
+test_files: []