progress 3.5.2 → 3.6.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 968512bbd9522d70ff093587d4ec2f75a82b8cfe3af204bbec0ccf461474ffa4
-  data.tar.gz: df95743ec5de95729873bc5afa3ffd7e507bd4f515b0918287cf69d1a3b70c07
+  metadata.gz: cdce3b680bc7e08cda708708d4058f6cddd399469463d57adfeb576ce7436bd7
+  data.tar.gz: 699601431481e0159b0f48102a879e3bb8e47f473bedd25478002cbc55856225
 SHA512:
-  metadata.gz: 7767fac01705f63d745a64aa352aa9ce4afa998d33874967ddf397c912629f3b0a2b288bdab80c97123ff90be7432e43053301a643da47e2ab88d17359d16ad0
-  data.tar.gz: 8c1b6a5e2be195328dc59c15b5d9acdd3ed9bd93d76ca4c60301d9a33857174b45a8e78aa0c9b2e5a688fad0577f133a821fffac818bd00e71184d463495b8b7
+  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
@@ -14,7 +16,7 @@ Layout/DotPosition:
 Layout/EndAlignment:
   EnforcedStyleAlignWith: variable
 
-Layout/IndentFirstHashElement:
+Layout/FirstHashElementIndentation:
   EnforcedStyle: consistent
 
 Layout/SpaceBeforeBlockBraces:
@@ -24,7 +26,7 @@ Layout/SpaceBeforeBlockBraces:
 Layout/SpaceInsideHashLiteralBraces:
   EnforcedStyle: no_space
 
-Lint/UnneededRequireStatement:
+Lint/RedundantRequireStatement:
   Enabled: false
 
 Metrics/AbcSize:
@@ -47,14 +49,14 @@ Metrics/ModuleLength:
   Max: 200
 
 Metrics/PerceivedComplexity:
-  Max: 10
+  Max: 11
+
+Style/AccessorGrouping:
+  Enabled: false
 
 Style/Alias:
   EnforcedStyle: prefer_alias_method
 
-Style/BracesAroundHashParameters:
-  Enabled: false
-
 Style/DoubleNegation:
   Enabled: false
 
@@ -64,12 +66,27 @@ Style/EmptyCaseCondition:
 Style/Encoding:
   Enabled: false
 
+Style/FormatStringToken:
+  Enabled: false
+
+Style/HashEachMethods:
+  Enabled: true
+
+Style/HashTransformKeys:
+  Enabled: false
+
+Style/HashTransformValues:
+  Enabled: false
+
 Style/IfUnlessModifier:
   Enabled: false
 
 Style/NumericPredicate:
   Enabled: false
 
+Style/OptionalBooleanParameter:
+  Enabled: false
+
 Style/ParallelAssignment:
   Enabled: false
 

data/.travis.yml

@@ -1,5 +1,4 @@
-sudo: false
-dist: trusty
+dist: xenial
 language: ruby
 before_install:
   - gem install bundler || gem install bundler --version '< 2'
@@ -9,16 +8,19 @@ rvm:
   - '2.1.10'
   - '2.2.10'
   - '2.3.8'
-  - '2.4.6'
-  - '2.5.5'
-  - '2.6.3'
-  - 'jruby-9.1.9.0'
+  - '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.6'
+    - env: RUBOCOP=1
+      rvm: '2.4.10'
       script: bundle exec rubocop
-    - env: CHECK_RUBIES=✓
-      rvm: '2.4.6'
+    - env: CHECK_RUBIES=1
+      rvm: '2.4.10'
       script: bundle exec travis_check_rubies

data/CHANGELOG.markdown

@@ -2,6 +2,10 @@
 
 ## 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)

data/LICENSE.txt

@@ -1,4 +1,4 @@
-Copyright (c) 2008-2019 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

@@ -163,4 +163,4 @@ end
 
 ## Copyright
 
-Copyright (c) 2008-2019 Ivan Kuchin. See LICENSE.txt for details.
+Copyright (c) 2008-2021 Ivan Kuchin. See LICENSE.txt for details.

data/lib/progress.rb

@@ -52,6 +52,7 @@ class Progress
   attr_reader :current
   attr_reader :title
   attr_accessor :note
+
   def initialize(total, title)
     if !total.is_a?(Numeric) && (title.nil? || title.is_a?(Numeric))
       total, title = title, total

data/lib/progress/class_methods.rb

@@ -1,6 +1,8 @@
 # encoding: UTF-8
 # frozen_string_literal: true
 
+require 'progress/elapsed_time'
+
 class Progress
   # Class methods of Progress
   module ClassMethods
@@ -165,14 +167,14 @@ class Progress
     end
 
     def time_to_print?
-      !@next_time_to_print || @next_time_to_print <= Time.now
+      !@next_time_to_print || @next_time_to_print <= ElapsedTime.now
     end
 
     def print_message(options = {})
       force = options[:force]
       lock force do
         if force || time_to_print?
-          @next_time_to_print = Time.now + 0.3
+          @next_time_to_print = ElapsedTime.now + 0.3
           restart_beeper
           io << message_for_output(options)
         end

data/lib/progress/elapsed_time.rb

@@ -0,0 +1,26 @@
+# frozen_string_literal: true
+
+class Progress
+  # Use Process.clock_gettime if available to get time more fitting to calculate elapsed time
+  module ElapsedTime
+    CLOCK_NAME = %w[
+      CLOCK_UPTIME_RAW
+      CLOCK_UPTIME
+      CLOCK_MONOTONIC_RAW
+      CLOCK_MONOTONIC
+      CLOCK_REALTIME
+    ].find{ |name| Process.const_defined?(name) }
+
+    CLOCK_ID = CLOCK_NAME && Process.const_get(CLOCK_NAME)
+
+  module_function
+
+    def now
+      if CLOCK_ID
+        Process.clock_gettime(CLOCK_ID)
+      else
+        Time.now.to_f
+      end
+    end
+  end
+end

data/lib/progress/eta.rb

@@ -1,10 +1,12 @@
 # frozen_string_literal: true
 
+require 'progress/elapsed_time'
+
 class Progress
   # Estimate time of arrival
   class Eta
     def initialize
-      @started_at = Time.now
+      @started_at = ElapsedTime.now
     end
 
     def left(completed)
@@ -15,7 +17,7 @@ class Progress
     end
 
     def elapsed
-      seconds_to_string(Time.now - @started_at)
+      seconds_to_string(ElapsedTime.now - @started_at)
     end
 
   private
@@ -36,7 +38,7 @@ class Progress
     end
 
     def seconds_left(completed)
-      now = Time.now
+      now = ElapsedTime.now
       return unless completed > 0 && now - @started_at >= 1
 
       current_eta = @started_at + (now - @started_at) / completed

data/lib/progress/kernel.rb

@@ -4,7 +4,7 @@ require 'progress'
 
 # Add Progress method as alias to Progress.start
 module Kernel
-private # rubocop:disable Layout/IndentationWidth
+private
 
   define_method :Progress do |*args, &block|
     Progress.start(*args, &block)

data/progress.gemspec

@@ -2,9 +2,9 @@
 
 Gem::Specification.new do |s|
   s.name        = 'progress'
-  s.version     = '3.5.2'
+  s.version     = '3.6.0'
   s.summary     = %q{Show progress of long running tasks}
-  s.homepage    = "http://github.com/toy/#{s.name}"
+  s.homepage    = "https://github.com/toy/#{s.name}"
   s.authors     = ['Ivan Kuchin']
   s.license     = 'MIT'
 
@@ -23,7 +23,7 @@ Gem::Specification.new do |s|
   s.require_paths = %w[lib]
 
   s.add_development_dependency 'rspec', '~> 3.0'
-  if RUBY_VERSION >= '2.2'
-    s.add_development_dependency 'rubocop', '~> 0.59'
+  if RUBY_VERSION >= '2.4'
+    s.add_development_dependency 'rubocop', '~> 1.0'
   end
 end

data/spec/progress/elapsed_time_spec.rb

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+require 'progress/elapsed_time'
+
+describe Progress::ElapsedTime do
+  let(:timeout){ 0.01 }
+
+  describe '.now' do
+    it 'returns incrementing value' do
+      expect{ sleep timeout }.to change{ described_class.now }.by_at_least(timeout)
+    end
+  end
+end

data/spec/progress_spec.rb

@@ -5,6 +5,7 @@ require 'progress'
 require 'tempfile'
 require 'shellwords'
 require 'csv'
+require 'set'
 
 describe Progress do
   before do
@@ -86,7 +87,7 @@ describe Progress do
 
       describe 'with_progress' do
         it 'returns with block same as when called with each' do
-          expect(enum.with_progress{}).to eq(enum.with_progress.each{})
+          expect(enum.with_progress(&:to_s)).to eq(enum.with_progress.each(&:to_s))
         end
 
         it 'does not break each' do
@@ -180,7 +181,7 @@ describe Progress do
           describe enum.class do
             it 'calls each only once' do
               expect(enum).to receive(:each).once.and_call_original
-              expect(enum.with_progress.each{}).to eq(enum)
+              expect(enum.with_progress.each(&:to_s)).to eq(enum)
             end
 
             include_examples 'yielding', enum
@@ -189,13 +190,13 @@ describe Progress do
 
         [
           100.times,
-          'a'..'z',
+          ('a'..'z').dup,
         ].each do |enum|
           describe enum.class do
             it 'calls each twice' do
-              enum_each = enum.each{}
+              enum_each = enum.each(&:to_s)
               expect(enum).to receive(:each).at_most(:twice).and_call_original
-              expect(enum.with_progress.each{}).to eq(enum_each)
+              expect(enum.with_progress.each(&:to_s)).to eq(enum_each)
             end
 
             include_examples 'yielding', enum
@@ -212,7 +213,7 @@ describe Progress do
 
             with_progress = Progress::WithProgress.new(enum)
             expect(with_progress).not_to receive(:warn)
-            expect(with_progress.each{}).to eq(enum)
+            expect(with_progress.each(&:to_s)).to eq(enum)
           end
 
           it 'yields same lines' do
@@ -233,18 +234,18 @@ describe Progress do
 
               with_progress = enum.with_progress
               expect(with_progress).not_to receive(:warn)
-              expect(with_progress.each{}).to eq(enum)
+              expect(with_progress.each(&:to_s)).to eq(enum)
             end
           end
 
           it 'calls each only once for Tempfile' do
             enum = Tempfile.open('progress')
-            enum_each = enum.each{} # returns underlying File
+            enum_each = enum.each(&:to_s) # returns underlying File
             expect(enum_each).to receive(:each).once.and_call_original
 
             with_progress = enum.with_progress
             expect(with_progress).not_to receive(:warn)
-            expect(with_progress.each{}).to eq(enum_each)
+            expect(with_progress.each(&:to_s)).to eq(enum_each)
           end
 
           it 'calls each only once for IO and shows warning' do
@@ -253,7 +254,7 @@ describe Progress do
 
             with_progress = enum.with_progress
             expect(with_progress).to receive(:warn)
-            expect(with_progress.each{}).to eq(enum)
+            expect(with_progress.each(&:to_s)).to eq(enum)
           end
 
           [
@@ -279,8 +280,8 @@ describe Progress do
 
               with_progress = enum.with_progress
               expect(with_progress).not_to receive(:warn)
-              expect(with_progress.each{}).
-                to eq(CSV.open('spec/test.csv').each{})
+              expect(with_progress.each(&:to_s)).
+                to eq(CSV.open('spec/test.csv').each(&:to_s))
             end
           else
             it 'calls each only once for CSV and shows warning' do
@@ -289,7 +290,7 @@ describe Progress do
 
               with_progress = enum.with_progress
               expect(with_progress).to receive(:warn)
-              expect(with_progress.each{}).to eq(enum)
+              expect(with_progress.each(&:to_s)).to eq(enum)
             end
           end
 
@@ -334,11 +335,11 @@ describe Progress do
           Progress.step 2, 'simle'
 
           Progress.step 2, 'times' do
-            3.times.with_progress{}
+            3.times.with_progress(&:to_s)
           end
 
           Progress.step 'enum' do
-            3.times.to_a.with_progress{}
+            3.times.to_a.with_progress(&:to_s)
           end
         end
       end
@@ -356,11 +357,11 @@ describe Progress do
       end
 
       def on_line(str)
-        "\r" + str + "\e[K"
+        "\r#{str}\e[K"
       end
 
       def line(str)
-        str + "\n"
+        "#{str}\n"
       end
 
       def on_line_n_title(str)
@@ -390,7 +391,7 @@ describe Progress do
           on_line_n_title("Test: #{hl ' 93.3%'} > #{hl ' 66.7%'}"),
           on_line_n_title('Test: 100.0% > 100.0%'),
           on_line_n_title('Test: 100.0% - enum'),
-          on_line('Test: 100.0% (elapsed: 0s) - enum') + "\n",
+          "#{on_line('Test: 100.0% (elapsed: 0s) - enum')}\n",
           title(''),
         ].flatten.join)
       end
@@ -426,7 +427,7 @@ describe Progress do
       let(:reference_output) do
         stub_progress_io(reference_io = StringIO.new)
         count_a.times.with_progress('Test') do
-          count_b.times.with_progress{}
+          count_b.times.with_progress(&:to_s)
         end
         reference_io.string
       end
@@ -468,7 +469,7 @@ describe Progress do
 
       it 'outputs same when called using with_progress on list' do
         count_a.times.to_a.with_progress('Test') do
-          count_b.times.to_a.with_progress{}
+          count_b.times.to_a.with_progress(&:to_s)
         end
         expect(io.string).to eq(reference_output)
       end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: progress
 version: !ruby/object:Gem::Version
-  version: 3.5.2
+  version: 3.6.0
 platform: ruby
 authors:
 - Ivan Kuchin
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2019-07-14 00:00:00.000000000 Z
+date: 2021-04-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rspec
@@ -30,16 +30,16 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.59'
+        version: '1.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.59'
-description: 
-email: 
+        version: '1.0'
+description:
+email:
 executables: []
 extensions: []
 extra_rdoc_files: []
@@ -55,23 +55,25 @@ files:
 - lib/progress/active_record.rb
 - lib/progress/beeper.rb
 - lib/progress/class_methods.rb
+- lib/progress/elapsed_time.rb
 - lib/progress/enumerable.rb
 - lib/progress/eta.rb
 - lib/progress/integer.rb
 - lib/progress/kernel.rb
 - lib/progress/with_progress.rb
 - progress.gemspec
+- spec/progress/elapsed_time_spec.rb
 - spec/progress_spec.rb
 - spec/test.csv
-homepage: http://github.com/toy/progress
+homepage: https://github.com/toy/progress
 licenses:
 - MIT
 metadata:
   bug_tracker_uri: https://github.com/toy/progress/issues
   changelog_uri: https://github.com/toy/progress/blob/master/CHANGELOG.markdown
-  documentation_uri: https://www.rubydoc.info/gems/progress/3.5.2
+  documentation_uri: https://www.rubydoc.info/gems/progress/3.6.0
   source_code_uri: https://github.com/toy/progress
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -86,10 +88,11 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.3
-signing_key: 
+rubygems_version: 3.1.5
+signing_key:
 specification_version: 4
 summary: Show progress of long running tasks
 test_files:
+- spec/progress/elapsed_time_spec.rb
 - spec/progress_spec.rb
 - spec/test.csv