progress 3.3.2 → 3.6.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 64ca0726e8a2eb5bfd62828a9f9aeec7b0fc49b5
-  data.tar.gz: e7b15fed0cb040c622fc381a4922fd697c071ad5
+SHA256:
+  metadata.gz: cdce3b680bc7e08cda708708d4058f6cddd399469463d57adfeb576ce7436bd7
+  data.tar.gz: 699601431481e0159b0f48102a879e3bb8e47f473bedd25478002cbc55856225
 SHA512:
-  metadata.gz: cda7bef90d61b0eed3af7397af5d2dc8a00fb8f2bf52539feef2edd9a5efc1d99ea9ea85d71465b8145f3fffad87cbe2ae43cc51ae3975f9475c681e110e647e
-  data.tar.gz: c20fd466c9d7a061035d4450a9c046d472f58c2bf43e49509c11717e9380bb28e04703aa8abcd810c1aeb8a2120ce6aabcd7083d9478a113c01329633c534c8e
+  metadata.gz: 84757caa1fa6d3e7e6f4a1e78d086d3494ae991021178fdbd454b05ed81b16b3ef6439719e9e3b6c37549c9fb9bc3f6420232b2fcb5f68f684d5655c1245bd4b
+  data.tar.gz: e1f40e3b1a84f4f8cea4e29ba798f136ed72e5b7a2e978dde51c86fd0c28cbcf4c695557b8920649948d0b6c6d5299eccde2c6b83e59fbfb7d51600b76d88651

data/.rubocop.yml

@@ -1,6 +1,8 @@
 AllCops:
   Exclude:
     - '*.gemspec'
+  NewCops: enable
+  TargetRubyVersion: 2.4
 
 Layout/AccessModifierIndentation:
   EnforcedStyle: outdent
@@ -11,17 +13,21 @@ Layout/CaseIndentation:
 Layout/DotPosition:
   EnforcedStyle: trailing
 
-Layout/IndentHash:
+Layout/EndAlignment:
+  EnforcedStyleAlignWith: variable
+
+Layout/FirstHashElementIndentation:
   EnforcedStyle: consistent
 
 Layout/SpaceBeforeBlockBraces:
   EnforcedStyle: no_space
+  EnforcedStyleForEmptyBraces: no_space
 
 Layout/SpaceInsideHashLiteralBraces:
   EnforcedStyle: no_space
 
-Lint/EndAlignment:
-  EnforcedStyleAlignWith: variable
+Lint/RedundantRequireStatement:
+  Enabled: false
 
 Metrics/AbcSize:
   Max: 30
@@ -43,17 +49,14 @@ Metrics/ModuleLength:
   Max: 200
 
 Metrics/PerceivedComplexity:
-  Max: 10
+  Max: 11
 
-Performance/RedundantBlockCall:
+Style/AccessorGrouping:
   Enabled: false
 
 Style/Alias:
   EnforcedStyle: prefer_alias_method
 
-Style/BracesAroundHashParameters:
-  Enabled: false
-
 Style/DoubleNegation:
   Enabled: false
 
@@ -63,23 +66,41 @@ Style/EmptyCaseCondition:
 Style/Encoding:
   Enabled: false
 
-Style/HashSyntax:
-  EnforcedStyle: hash_rockets
+Style/FormatStringToken:
+  Enabled: false
+
+Style/HashEachMethods:
+  Enabled: true
+
+Style/HashTransformKeys:
+  Enabled: false
+
+Style/HashTransformValues:
+  Enabled: false
 
 Style/IfUnlessModifier:
-  MaxLineLength: 40
+  Enabled: false
 
 Style/NumericPredicate:
   Enabled: false
 
+Style/OptionalBooleanParameter:
+  Enabled: false
+
 Style/ParallelAssignment:
   Enabled: false
 
+Style/SafeNavigation:
+  Enabled: false
+
 Style/Semicolon:
   AllowAsExpressionSeparator: true
 
 Style/TrailingCommaInArguments:
   EnforcedStyleForMultiline: no_comma
 
-Style/TrailingCommaInLiteral:
+Style/TrailingCommaInArrayLiteral:
+  EnforcedStyleForMultiline: comma
+
+Style/TrailingCommaInHashLiteral:
   EnforcedStyleForMultiline: comma

data/.travis.yml

@@ -1,23 +1,26 @@
-sudo: false
+dist: xenial
 language: ruby
 before_install:
-  - gem update bundler
+  - gem install bundler || gem install bundler --version '< 2'
 rvm:
-  - '1.8.7-p371'
   - '1.9.3-p551'
   - '2.0.0-p648'
   - '2.1.10'
-  - '2.2.8'
-  - '2.3.5'
-  - '2.4.2'
-  - 'jruby-9.0.5.0'
-  - 'jruby-9.1.9.0'
+  - '2.2.10'
+  - '2.3.8'
+  - '2.4.10'
+  - '2.5.8'
+  - '2.6.6'
+  - '2.7.2'
+  - '3.0.0'
+  - 'jruby-9.1.17.0'
+  - 'jruby-9.2.14.0'
 script: bundle exec rspec
 matrix:
   include:
-    - env: RUBOCOP=✓
-      rvm: '2.4.2'
+    - env: RUBOCOP=1
+      rvm: '2.4.10'
       script: bundle exec rubocop
-    - env: CHECK_RUBIES=✓
-      rvm: '2.4.2'
+    - env: CHECK_RUBIES=1
+      rvm: '2.4.10'
       script: bundle exec travis_check_rubies

data/CHANGELOG.markdown

@@ -0,0 +1,273 @@
+# ChangeLog
+
+## unreleased
+
+## v3.6.0 (2021-04-02)
+
+* Use `Process.clock_gettime` instead of `Time.now` which is faster and should give proper estimates even if sleeping in the middle [#13](https://github.com/toy/progress/issues/13) [@toy](https://github.com/toy)
+
+## v3.5.2 (2019-07-14)
+
+* Remove deprecated `rubyforge_project` attribute from gemspec [rubygems/rubygems#2436](https://github.com/rubygems/rubygems/pull/2436) [@toy](https://github.com/toy)
+
+## v3.5.1 (2019-05-25)
+
+* Enable frozen string literals [@toy](https://github.com/toy)
+
+## v3.5.0 (2018-10-19)
+
+* Add `Progress.without_beeper` for stopping periodical refresh of progress/eta for the duration of the block [@toy](https://github.com/toy)
+
+## v3.4.0 (2017-10-11)
+
+* Remove special handling for CSV in ruby 1.8 [@toy](https://github.com/toy)
+* Set minimum ruby version to 1.9.3 [@toy](https://github.com/toy)
+* Support `Enumerable#each_with_index` which stopped working since [45435b3](https://github.com/toy/progress/commit/45435b31ae0f9ad42255d9105d264f5fe9722c88) ([v3.2.2](#v322-2016-07-27)), not compatible with ruby 1.8 [#9](https://github.com/toy/progress/pull/9) [@amatsuda](https://github.com/amatsuda)
+
+## v3.3.2 (2017-10-09)
+
+* Support `Enumerable#each_with_index` which stopped working since [45435b3](https://github.com/toy/progress/commit/45435b31ae0f9ad42255d9105d264f5fe9722c88) ([v3.2.2](#v322-2016-07-27)), compatible with ruby 1.8 [#10](https://github.com/toy/progress/pull/10) [@amatsuda](https://github.com/amatsuda)
+
+## v3.3.1 (2017-02-22)
+
+* Fix for jruby raising wrong exception when checking if io is seekable [@toy](https://github.com/toy)
+
+## v3.3.0 (2017-01-30)
+
+* Add public setter for `io` and make `io` and `io_tty?` methods public [#8](https://github.com/toy/progress/issues/8) [@toy](https://github.com/toy)
+
+## v3.2.2 (2016-07-27)
+
+* Fix block arguments for `Hash` in ruby < 1.9 [@toy](https://github.com/toy)
+
+## v3.2.1 (2016-07-26)
+
+* Fix `respond_to?` for non existing methods in ruby < 1.9 [@toy](https://github.com/toy)
+
+## v3.2.0 (2016-07-26)
+
+* Provide `respond_to_missing?` instead of `respond_to?` in `WithProgress` [@toy](https://github.com/toy)
+
+## v3.1.1 (2016-01-11)
+
+* Fix `Thread.exclusive` deprecation in Ruby 2.3.0 [#4](https://github.com/toy/progress/pull/4) [@katsuma](https://github.com/katsuma)
+
+## v3.1.0 (2014-12-22)
+
+* Add handling for CSV in ruby 1.8 [@toy](https://github.com/toy)
+* Fix getting total for progress on `Range` [@toy](https://github.com/toy)
+* Use `StringIO` for `String` progress and `pos`/`size` for `IO` progress to not convert to array before progress [@toy](https://github.com/toy)
+* Set `WithProgress` title to `nil` by default [@toy](https://github.com/toy)
+* Fix return value from `with_progress{}` to equal `with_progress.each{}` [@toy](https://github.com/toy)
+* Fix wrong variable name in `WithProgress#respond_to?` [@toy](https://github.com/toy)
+* Fix using wrong constant `TempFile` instead of `Tempfile` [@toy](https://github.com/toy)
+* Remove methods `eta` and `elapsed` created for mocking eta [@toy](https://github.com/toy)
+* Rename `set_terminal_title` to `terminal_title` [@toy](https://github.com/toy)
+
+## v3.0.2 (2014-12-19)
+
+* Restore updating eta when there is no progress [@toy](https://github.com/toy)
+
+## v3.0.1 (2014-08-18)
+
+* Step once when running without block [@toy](https://github.com/toy)
+* Fix working with `in_threads` by removing `WithProgress` inheritance of `Delegator` [@toy](https://github.com/toy)
+
+## v3.0.0 (2013-08-20)
+
+* Befriend with [`in_threads`](https://rubygems.org/gems/in_threads) gem [@toy](https://github.com/toy)
+* Warn and use `to_a` on `IO` and `String` related objects before running progress, for other objects use for length in order: `size`, `length`, `count` [@toy](https://github.com/toy)
+* Make `WithProgress` inherit `Delegator` [@toy](https://github.com/toy)
+* Show elapsed time on finish [@toy](https://github.com/toy)
+* Cleanup/rewrite, extract `Eta` and `Beeper` [@toy](https://github.com/toy)
+* Conditionally require active_record support instead of conditionally creating module [@toy](https://github.com/toy)
+* Don't kill dead thread for eta output without progress [@toy](https://github.com/toy)
+* Don't show eta until at least one second passed [@toy](https://github.com/toy)
+
+## v2.4.0 (2012-01-03)
+
+* Add `Progress.running?` for checking if progress is running [@toy](https://github.com/toy)
+
+## v2.3.0 (2011-12-25)
+
+* Better handle edge cases of eta output without progress [@toy](https://github.com/toy)
+* Call each only once for enumerable that can not be reused [@toy](https://github.com/toy)
+* Allow to set length directly when calling `with_progress` [@toy](https://github.com/toy)
+
+## v2.2.0 (2011-12-05)
+
+* Make `with_progress.with_progress` create new instance instead of changing current, added enumerable and title attribute readers [@toy](https://github.com/toy)
+
+## v2.1.1 (2011-12-04)
+
+* Fix `with_progress.with_progress` with block not calling each [@toy](https://github.com/toy)
+
+## v2.1.0 (2011-11-29)
+
+* Change title when overriding progress with another call to `with_progress` [@toy](https://github.com/toy)
+* Allow to directly specify length when initialising `WithProgress` [@toy](https://github.com/toy)
+
+## v2.0.0 (2011-11-28)
+
+* Show eta every second instead of every three when there is no progress [@toy](https://github.com/toy)
+* Cache calculated length [@toy](https://github.com/toy)
+* Use count method of enumerable if available to determine total for progress [@toy](https://github.com/toy)
+* Call `each` with progress when `with_progress` is called with block [@toy](https://github.com/toy)
+* Stop thread triggering eta update [@toy](https://github.com/toy)
+* Rework `WithProgress` [@toy](https://github.com/toy)
+* Remove `each_with_progress` and `each_with_index_and_progress` [@toy](https://github.com/toy)
+
+## v1.2.1 (2011-10-18)
+
+* Add missing `require 'thread'` [@toy](https://github.com/toy)
+
+## v1.2.0 (2011-10-18)
+
+* Updated eta every 3 seconds if nothing is happening [@toy](https://github.com/toy)
+
+## v1.1.3 (2011-01-15)
+
+* Fix `io` method, so `$stderr` can be silenced using `reopen` [@toy](https://github.com/toy)
+* Remove `require 'rubygems'` [@toy](https://github.com/toy)
+
+## v1.1.2.1 (2010-12-15)
+
+* Internal gem changes [@toy](https://github.com/toy)
+
+## v1.1.2 (2010-12-09)
+
+* Use control character to clear line to end [@toy](https://github.com/toy)
+
+## v1.1.1 (2010-12-07)
+
+* Fix in notes handling [@toy](https://github.com/toy)
+
+## v1.1.0 (2010-12-07)
+
+* Add note for step [@toy](https://github.com/toy)
+
+## v1.0.1 (2010-11-14)
+
+* Fix progress by using `step` with block everywhere [@toy](https://github.com/toy)
+* Separate `step` arguments to numerator and denominator [@toy](https://github.com/toy)
+
+## v1.0.0 (2010-11-14)
+
+* Show progress in terminal title [@toy](https://github.com/toy)
+* Add eta [@toy](https://github.com/toy)
+* Fix `step` by implementing through `set` and fix `set` return value  [@toy](https://github.com/toy)
+
+## v0.4.1 (2010-11-13)
+
+* Fix active record batch extension inclusion [@toy](https://github.com/toy)
+
+## v0.4.0 (2010-11-13)
+
+* Add support for active record batch progress [@toy](https://github.com/toy)
+* Fix `each_with_index_and_progress` requiring title [@toy](https://github.com/toy)
+
+## v0.3.0 (2010-11-13)
+
+* Allow progress without title [@toy](https://github.com/toy)
+
+## v0.2.2 (2010-01-20)
+
+* Fix bug in i18n gem [@toy](https://github.com/toy)
+
+## v0.2.1 (2010-01-16)
+
+* Ensure outputting final 100% of outer progress [@toy](https://github.com/toy)
+
+## v0.2.0 (2009-12-30)
+
+* Limit frequency of progress output [@toy](https://github.com/toy)
+
+## v0.1.2 (2009-12-29)
+
+* Internal gem changes [@toy](https://github.com/toy)
+
+## v0.1.1.3 (2009-09-28)
+
+* Remove debugging character from output [@toy](https://github.com/toy)
+
+## v0.1.1.2 (2009-09-28)
+
+* Fix highlighting [@toy](https://github.com/toy)
+
+## v0.1.1.0 (2009-09-21)
+
+* Allow `Progress(…)` instead `Progress.start(…)` [@toy](https://github.com/toy)
+* Allow `step` to accept block for valid counting of custom progress [@toy](https://github.com/toy)
+* Kill progress on cycle break [@toy](https://github.com/toy)
+
+## v0.1.0.3 (2009-09-21)
+
+* Internal gem changes [@toy](https://github.com/toy)
+
+## v0.1.0.2 (2009-08-19)
+
+* Don't raise error on extra `Progress.stop` [@toy](https://github.com/toy)
+
+## v0.1.0.1 (2009-08-19)
+
+* Fix output by verifying and converting progress to float [@toy](https://github.com/toy)
+
+## v0.1.0.0 (2009-08-19)
+
+* Inner progress increases outer progress, ability to set progress using `set` alongside stepping using `step` [@toy](https://github.com/toy)
+
+## v0.0.9.3 (2009-08-06)
+
+* Use space instead of `'>'` for padding [@toy](https://github.com/toy)
+
+## v0.0.9.2 (2009-07-28)
+
+* Force behaving as with tty by setting `PROGRESS_TTY` environment variable [@toy](https://github.com/toy)
+
+## v0.0.9.1 (2009-07-28)
+
+* Separate handling of staying on same line and colourising output [@toy](https://github.com/toy)
+
+## v0.0.9.0 (2009-07-20)
+
+* Add `Enumerable#with_progress` on which any enumerable method can be called [@toy](https://github.com/toy)
+
+## v0.0.8.1 (2009-05-02)
+
+* Return to line start after printing message instead of before [@toy](https://github.com/toy)
+
+## v0.0.8 (2009-04-27)
+
+* No colours and don't stay on same line when not on tty or explicitly using `:lines => true` option [@toy](https://github.com/toy)
+
+## v0.0.7.1 (2009-04-24)
+
+* Internal gem changes [@toy](https://github.com/toy)
+
+## v0.0.7 (2009-03-24)
+
+* Internal gem changes [@toy](https://github.com/toy)
+
+## v0.0.6 (2009-02-19)
+
+* Output to stderr [@toy](https://github.com/toy)
+
+## v0.0.5 (2008-11-07)
+
+* Return result of enumerable method [@toy](https://github.com/toy)
+
+## v0.0.4 (2008-11-06)
+
+* Allow to change step size [@toy](https://github.com/toy)
+
+## v0.0.3 (2008-11-01)
+
+* Output final newline after finishing progress [@toy](https://github.com/toy)
+
+## v0.0.2 (2008-10-31)
+
+* Allow enclosed progress [@toy](https://github.com/toy)
+
+## v0.0.1 (2008-08-10)
+
+* Initial [@toy](https://github.com/toy)

data/Gemfile

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 source 'https://rubygems.org'
 
 gemspec

data/LICENSE.txt

@@ -1,4 +1,4 @@
-Copyright (c) 2010-2017 Ivan Kuchin
+Copyright (c) 2008-2021 Ivan Kuchin
 
 Permission is hereby granted, free of charge, to any person obtaining
 a copy of this software and associated documentation files (the

data/README.markdown

@@ -1,7 +1,7 @@
 [![Gem Version](https://img.shields.io/gem/v/progress.svg?style=flat)](https://rubygems.org/gems/progress)
 [![Build Status](https://img.shields.io/travis/toy/progress/master.svg?style=flat)](https://travis-ci.org/toy/progress)
-[![Code Climate](https://img.shields.io/codeclimate/github/toy/progress.svg?style=flat)](https://codeclimate.com/github/toy/progress)
-[![Dependency Status](https://img.shields.io/gemnasium/toy/progress.svg?style=flat)](https://gemnasium.com/toy/progress)
+[![Code Climate](https://img.shields.io/codeclimate/maintainability/toy/progress.svg?style=flat)](https://codeclimate.com/github/toy/progress)
+[![Depfu](https://badges.depfu.com/badges/528142fc3202e4bd89680832bfc713d7/overview.svg)](https://depfu.com/github/toy/progress)
 [![Inch CI](https://inch-ci.org/github/toy/progress.svg?branch=master&style=flat)](https://inch-ci.org/github/toy/progress)
 
 # progress
@@ -14,127 +14,153 @@ Show progress during console script run.
 
 ## Usage
 
-    1000.times_with_progress('Counting to 1000') do |i|
-      # do something with i
-    end
+```ruby
+1000.times_with_progress('Counting to 1000') do |i|
+  # do something with i
+end
+```
 
 or without title:
 
-    1000.times_with_progress do |i|
-      # do something with i
-    end
+```ruby
+1000.times_with_progress do |i|
+  # do something with i
+end
+```
 
 With array:
 
-    [1, 2, 3].with_progress('1…2…3').each do |i|
-      # still counting
-    end
+```ruby
+[1, 2, 3].with_progress('1…2…3').each do |i|
+  # still counting
+end
+```
 
 `.each` is optional:
 
-    [1, 2, 3].with_progress('1…2…3') do |i|
-      # =||=
-    end
+```ruby
+[1, 2, 3].with_progress('1…2…3') do |i|
+  # =||=
+end
+```
 
 Nested progress
 
-    (1..10).with_progress('Outer').map do |a|
-      (1..10).with_progress('Middle').map do |b|
-        (1..10).with_progress('Inner').map do |c|
-          # do something with a, b and c
-        end
-      end
+```ruby
+(1..10).with_progress('Outer').map do |a|
+  (1..10).with_progress('Middle').map do |b|
+    (1..10).with_progress('Inner').map do |c|
+      # do something with a, b and c
     end
+  end
+end
+```
 
 You can also show note:
 
-    [1, 2, 3].with_progress do |i|
-      Progress.note = i
-      sleep 5
-    end
+```ruby
+[1, 2, 3].with_progress do |i|
+  Progress.note = i
+  sleep 5
+end
+```
 
 You can use any enumerable method:
 
-    [1, 2, 3].with_progress.map{ |i| 'do stuff' }
-    [1, 2, 3].with_progress.each_cons(3){ |i| 'do stuff' }
-    [1, 2, 3].with_progress.each_slice(2){ |i| 'do stuff' }
-    # …
+```ruby
+[1, 2, 3].with_progress.map{ |i| 'do stuff' }
+[1, 2, 3].with_progress.each_cons(3){ |i| 'do stuff' }
+[1, 2, 3].with_progress.each_slice(2){ |i| 'do stuff' }
+# …
+```
 
 Any enumerable will work:
 
-    (1..100).with_progress('Wait') do |i|
-      # ranges are good
-    end
+```ruby
+(1..100).with_progress('Wait') do |i|
+  # ranges are good
+end
 
-    Dir.new('.').with_progress do |path|
-      # check path
-    end
+Dir.new('.').with_progress do |path|
+  # check path
+end
+```
 
 NOTE: progress gets number of objects using `length`, `size`, `to_a.length` or just `inject` and if used on objects which needs rewind (like opened File), cycle itself will not work.
 
 Use simple blocks:
 
-    symbols = []
-    Progress.start('Input 100 symbols', 100) do
-      while symbols.length < 100
-        input = gets.scan(/\S/)
-        symbols += input
-        Progress.step input.length
-      end
-    end
+```ruby
+symbols = []
+Progress.start('Input 100 symbols', 100) do
+  while symbols.length < 100
+    input = gets.scan(/\S/)
+    symbols += input
+    Progress.step input.length
+  end
+end
+```
 
 or just
 
-    symbols = []
-    Progress('Input 100 symbols', 100) do
-      while symbols.length < 100
-        input = gets.scan(/\S/)
-        symbols += input
-        Progress.step input.length
-      end
-    end
+```ruby
+symbols = []
+Progress('Input 100 symbols', 100) do
+  while symbols.length < 100
+    input = gets.scan(/\S/)
+    symbols += input
+    Progress.step input.length
+  end
+end
+```
 
 NOTE: you will get WRONG progress if you use something like this:
 
-    10.times_with_progress('A') do |time|
-      10.times_with_progress('B') do
-        # code
-      end
-      10.times_with_progress('C') do
-        # code
-      end
-    end
+```ruby
+10.times_with_progress('A') do |time|
+  10.times_with_progress('B') do
+    # code
+  end
+  10.times_with_progress('C') do
+    # code
+  end
+end
+```
 
 But you can use this:
 
-    10.times_with_progress('A') do |time|
-      Progress.step 5 do
-        10.times_with_progress('B') do
-          # code
-        end
-      end
-      Progress.step 5 do
-        10.times_with_progress('C') do
-          # code
-        end
-      end
+```ruby
+10.times_with_progress('A') do |time|
+  Progress.step 5 do
+    10.times_with_progress('B') do
+      # code
+    end
+  end
+  Progress.step 5 do
+    10.times_with_progress('C') do
+      # code
     end
+  end
+end
+```
 
 Or if you know that B runs 9 times faster than C:
 
-    10.times_with_progress('A') do |time|
-      Progress.step 1 do
-        10.times_with_progress('B') do
-          # code
-        end
-      end
-      Progress.step 9 do
-        10.times_with_progress('C') do
-          # code
-        end
-      end
+```ruby
+10.times_with_progress('A') do |time|
+  Progress.step 1 do
+    10.times_with_progress('B') do
+      # code
+    end
+  end
+  Progress.step 9 do
+    10.times_with_progress('C') do
+      # code
     end
+  end
+end
+```
 
 ## Copyright
 
-Copyright (c) 2010-2017 Ivan Kuchin. See LICENSE.txt for details.
+Copyright (c) 2008-2021 Ivan Kuchin. See LICENSE.txt for details.