ruby-progressbar 1.8.3 → 1.9.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 5c76e440b5648ce692f5dc9876121e7cc96dd3af
-  data.tar.gz: 1c0125425bb7c1e183ec2afd8d064da4238c63cf
+  metadata.gz: 3cd1a27db6b9c29f0440221647c623b5ab71fd7a
+  data.tar.gz: 8f91086c51905f925c41a3c44f97645fab0d3ad5
 SHA512:
-  metadata.gz: c65ec7e1f2c8ff352fc80f5f655b38aadc16daf9fdadfc3bc62b025e55a6b134fe6efc23e516882cfd1e442eadf1e326f3087a9aade4f856991bee0859cf823d
-  data.tar.gz: 41d93639c3949b40010226755058d976ea1280e771b97bd6ea4e0338257fc40dcf8b541d80f47345d9e74633c7f1d5ba680e3a2ae2fe39dbd5d93911f96cba40
+  metadata.gz: 9dd5f1c042df2a20a336b5cf28b68123ad19ea6e017bd3c0beff5b2c0bad54f48b5f7b8e526b3e4a134a78409d2eb5751b81c689cf55782a70c38d0a5c083e2c
+  data.tar.gz: da8ad7b38d1ab514a6dd3a0eb13cfe9303654a73e25069ea4c5b492180f4ccb39a08c3ddd5012ebc2c1657c7b7e78b07405908a5a9d69a1c8a4bc1d67f850b74

data.tar.gz.sig

@@ -1 +1,2 @@
-C�>��"6�5u��P��F��!��4����:�j�z���eıo�jd�.1�00-�'������g��s	\��M|_T�&�f�Dr���u<\4��:��g�=U�eu��x�>���)\17S�l�ߛ� ��<�I��sRc���8j�Gc|&��&�X�I��w`�~��%�zC�N�ȩ����Y��|A*�ť
+;��9�_�JD]�r�74�7Bz3���v��X�V�*�>�4�r��tK�v�T�Տ�waI��3��&��
+8D)eFY"�@nC�gjc�E��B����Ov;����q@�a�8��E:�+�'W����ݛO�^!tO�p�P�rLo�"?i�
T����Qʆ�W�@g�S�ɤ�X\V�������&l���L��bp�7���:��1u�c�-�̆� w`>�!$�������#1Sx��C�

data/README.md

@@ -2,7 +2,7 @@ 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!
 
@@ -10,12 +10,6 @@ Don't miss out on what all the kids are talking about!  If you want everyone to
 
 <br><br><br>
 
-`progressbar` has been merged into `ruby-progressbar`!!
---------------------------------
-As of 1.8.2 onwards, `ruby-progressbar` and `progressbar` will remain in
-lock-step on version numbers. *Huge* thanks to @peleteiro for giving me access
-to the `progressbar` rubygem.
-
 Full Reference
 --------------------------------
 
@@ -31,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)
 
@@ -40,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/ruby-progressbar.rb

@@ -9,6 +9,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,6 +39,7 @@ 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?
 
@@ -45,13 +48,16 @@ class   Length
   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/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.3'.freeze
+  VERSION = '1.9.0'.freeze
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: ruby-progressbar
 version: !ruby/object:Gem::Version
-  version: 1.8.3
+  version: 1.9.0
 platform: ruby
 authors:
 - thekompanee
@@ -32,7 +32,7 @@ cert_chain:
   PHO6SmWDz7oWa8pdUSTTn9dNIVaxsYYuqr1HyaHdhjItQLl/4S4wZu1yqMBEwyGO
   HGJ2WkoCJ6ABU8wsO70PQd9pl1M3stScQLd3vWgPeuioBQ==
   -----END CERTIFICATE-----
-date: 2017-09-13 00:00:00.000000000 Z
+date: 2017-09-27 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rspec
@@ -40,14 +40,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.2'
+        version: '3.6'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.2'
+        version: '3.6'
 - !ruby/object:Gem::Dependency
   name: rspectacular
   requirement: !ruby/object:Gem::Requirement
@@ -119,7 +119,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,8 +133,11 @@ 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

metadata.gz.sig

@@ -1,2 +1 @@
-B�%A6�L@��:_z}3Y;l��q��5j"��:��_�;Xj`IP�pn�/Fx�Ƨs����Z.�pJ"���Z9b�΄
-���`j�1��r�;BT����e`~�GmY�^6��@��n�ca�1WN�p��p5�<�׿�*��m'��w8=��K��4�7��p��
+��Fr4>��,�߼a�_��ȣy���JbC|+b��o���x� Pr6�U%)3�ˏ�@��	X��L4�n��.yR���ܖɒ;�����+c3����b��0NƬI)��:��$��U�)!T�sB�Fy��0�

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