progress 3.4.0 → 3.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: ed83a839d83aa17fc079ed2a5d16c5fa2b9c4d07
-  data.tar.gz: 419b4c459474fd7b8f73c325006bc9d33a30c25d
+SHA256:
+  metadata.gz: 88486a9fc4ddbe22b0ba6c4d398c71827a2dca05ac9fee01a4a715a72e8a1ddc
+  data.tar.gz: ff8bd4245c78217409212fb60bdc0b3e205604290ffd2005371e0c38cf7c7eee
 SHA512:
-  metadata.gz: c98e8c3477ca6a71b7de133afec93bf1fcfeaa53924f7dca5369b1b808f2aca9b5ce14faf19a889677245b21d8deeea9d9d0f29e9770f3eac9f2d211a0a9c944
-  data.tar.gz: 9ea259515c34274950bbc5916035ded346837f5f36d7af6cdbf4fa31ce589b186c07d6ab0d0aa4b98121dea43ddb42948ce65243cf9af1249362a08011a1274e
+  metadata.gz: a52da0e1033be9ca9069c62c92aa7936c95d4f45df94cbacfb6de439d96fd441a2c59a72750b9728136f11c08ad4e8ade9b51549ee17a3f3da47e915a25cb3a7
+  data.tar.gz: 1a413c2310ae732d1a3bfbe53e86b1a55dbb6677920e6d2cd3307ec59e67a028de5cafa83e53fb728b76ccdbd9b8bbddc2dcf4b5660887837d1fbc5ac77f26e7

data/.rubocop.yml

@@ -11,17 +11,21 @@ Layout/CaseIndentation:
 Layout/DotPosition:
   EnforcedStyle: trailing
 
+Layout/EndAlignment:
+  EnforcedStyleAlignWith: variable
+
 Layout/IndentHash:
   EnforcedStyle: consistent
 
 Layout/SpaceBeforeBlockBraces:
   EnforcedStyle: no_space
+  EnforcedStyleForEmptyBraces: no_space
 
 Layout/SpaceInsideHashLiteralBraces:
   EnforcedStyle: no_space
 
-Lint/EndAlignment:
-  EnforcedStyleAlignWith: variable
+Lint/UnneededRequireStatement:
+  Enabled: false
 
 Metrics/AbcSize:
   Max: 30
@@ -61,7 +65,7 @@ Style/Encoding:
   Enabled: false
 
 Style/IfUnlessModifier:
-  MaxLineLength: 40
+  Enabled: false
 
 Style/NumericPredicate:
   Enabled: false
@@ -75,5 +79,8 @@ Style/Semicolon:
 Style/TrailingCommaInArguments:
   EnforcedStyleForMultiline: no_comma
 
-Style/TrailingCommaInLiteral:
+Style/TrailingCommaInArrayLiteral:
+  EnforcedStyleForMultiline: comma
+
+Style/TrailingCommaInHashLiteral:
   EnforcedStyleForMultiline: comma

data/.travis.yml

@@ -6,17 +6,18 @@ rvm:
   - '1.9.3-p551'
   - '2.0.0-p648'
   - '2.1.10'
-  - '2.2.8'
-  - '2.3.5'
-  - '2.4.2'
+  - '2.2.10'
+  - '2.3.8'
+  - '2.4.5'
+  - '2.5.3'
   - 'jruby-9.0.5.0'
   - 'jruby-9.1.9.0'
 script: bundle exec rspec
 matrix:
   include:
     - env: RUBOCOP=✓
-      rvm: '2.4.2'
+      rvm: '2.4.5'
       script: bundle exec rubocop
     - env: CHECK_RUBIES=✓
-      rvm: '2.4.2'
+      rvm: '2.4.5'
       script: bundle exec travis_check_rubies

data/CHANGELOG.markdown

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

data/LICENSE.txt

@@ -1,4 +1,4 @@
-Copyright (c) 2008-2017 Ivan Kuchin
+Copyright (c) 2008-2018 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
@@ -137,4 +137,4 @@ Or if you know that B runs 9 times faster than C:
 
 ## Copyright
 
-Copyright (c) 2008-2017 Ivan Kuchin. See LICENSE.txt for details.
+Copyright (c) 2008-2018 Ivan Kuchin. See LICENSE.txt for details.

data/lib/progress/class_methods.rb

@@ -12,6 +12,7 @@ class Progress
       init(total, title)
       print_message force: true
       return unless block_given?
+
       begin
         yield
       ensure
@@ -44,6 +45,7 @@ class Progress
     # stop progress
     def stop
       return unless running?
+
       if @levels.length == 1
         print_message force: true, finish: true
         stop_beeper
@@ -59,6 +61,7 @@ class Progress
     # set note
     def note=(note)
       return unless running?
+
       @levels.last.note = note
     end
 
@@ -82,7 +85,7 @@ class Progress
       @highlight = true && value
     end
 
-    # show progerss in terminal title
+    # show progress in terminal title
     def terminal_title?
       @terminal_title.nil? ? io_tty? : @terminal_title
     end
@@ -102,6 +105,15 @@ class Progress
       io.tty? || ENV['PROGRESS_TTY']
     end
 
+    # don't refresh progress (eta) periodically for the duration of the block
+    def without_beeper
+      old_state = @without_beeper
+      @without_beeper = true
+      yield
+    ensure
+      @without_beeper = old_state
+    end
+
   private
 
     attr_reader :eta
@@ -139,7 +151,7 @@ class Progress
 
     def start_beeper
       @beeper = Beeper.new(10) do
-        print_message
+        print_message unless @without_beeper
       end
     end
 
@@ -188,7 +200,7 @@ class Progress
 
     def build_message(options)
       current = 0
-      message = @levels.reverse.map do |level|
+      reverse_parts = @levels.reverse.map do |level|
         current = level.to_f(current)
 
         part = current.zero? ? '......' : format('%5.1f%%', current * 100.0)
@@ -198,7 +210,8 @@ class Progress
         end
 
         level.title ? "#{level.title}: #{part}" : part
-      end.reverse * ' > '
+      end
+      message = reverse_parts.reverse * ' > '
 
       if options[:finish]
         message << " (elapsed: #{eta.elapsed})"

data/lib/progress/eta.rb

@@ -8,6 +8,7 @@ class Progress
     def left(completed)
       seconds = seconds_left(completed)
       return unless seconds && seconds > 0
+
       seconds_to_string(seconds)
     end
 
@@ -19,6 +20,7 @@ class Progress
 
     def seconds_to_string(seconds)
       return unless seconds
+
       case seconds
       when 0...60
         format '%.0fs', seconds
@@ -34,6 +36,7 @@ class Progress
     def seconds_left(completed)
       now = Time.now
       return unless completed > 0 && now - @started_at >= 1
+
       current_eta = @started_at + (now - @started_at) / completed
       @left = if @left
         @left + (current_eta - @left) * (1 + completed) * 0.5

data/lib/progress/kernel.rb

@@ -2,8 +2,9 @@ require 'progress'
 
 # Add Progress method as alias to Progress.start
 module Kernel
+private
+
   define_method :Progress do |*args, &block|
     Progress.start(*args, &block)
   end
-  private :Progress
 end

data/lib/progress/with_progress.rb

@@ -131,6 +131,7 @@ class Progress
       false
     rescue Errno::EPIPE
       raise unless defined?(JRUBY_VERSION)
+
       false
     end
 

data/progress.gemspec

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

data/spec/progress_spec.rb

@@ -340,32 +340,32 @@ describe Progress do
         end
       end
 
-      def title(s)
-        "\e]0;#{s}\a"
+      def title(str)
+        "\e]0;#{str}\a"
       end
 
-      def hl(s)
-        "\e[1m#{s}\e[0m"
+      def hl(str)
+        "\e[1m#{str}\e[0m"
       end
 
-      def unhl(s)
-        s.gsub(/\e\[\dm/, '')
+      def unhl(str)
+        str.gsub(/\e\[\dm/, '')
       end
 
-      def on_line(s)
-        "\r" + s + "\e[K"
+      def on_line(str)
+        "\r" + str + "\e[K"
       end
 
-      def line(s)
-        s + "\n"
+      def line(str)
+        str + "\n"
       end
 
-      def on_line_n_title(s)
-        [on_line(s), title(unhl(s))]
+      def on_line_n_title(str)
+        [on_line(str), title(unhl(str))]
       end
 
-      def line_n_title(s)
-        [line(s), title(unhl(s))]
+      def line_n_title(str)
+        [line(str), title(unhl(str))]
       end
 
       it 'produces valid output when staying on line' do
@@ -522,5 +522,50 @@ describe Progress do
         it{ is_expected.to be_truthy }
       end
     end
+
+    describe '.without_beeper' do
+      before do
+        allow(Progress).to receive(:start_beeper).and_call_original
+        allow(Progress::Beeper).to receive(:new) do |*, &block|
+          @block = block
+          double(restart: nil, stop: nil)
+        end
+        expect(Progress).to receive(:print_message).exactly(print_times).times
+      end
+
+      context 'when not used' do
+        let(:print_times){ 3 }
+
+        it 'allows beeper to print progress' do
+          Progress.start do
+            @block.call
+          end
+        end
+      end
+
+      context 'when used around progress block' do
+        let(:print_times){ 2 }
+
+        it 'stops beeper from printing progress' do
+          Progress.without_beeper do
+            Progress.start do
+              @block.call
+            end
+          end
+        end
+      end
+
+      context 'when used inside progress block' do
+        let(:print_times){ 2 }
+
+        it 'stops beeper from printing progress' do
+          Progress.start do
+            Progress.without_beeper do
+              @block.call
+            end
+          end
+        end
+      end
+    end
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: progress
 version: !ruby/object:Gem::Version
-  version: 3.4.0
+  version: 3.5.0
 platform: ruby
 authors:
 - Ivan Kuchin
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-10-11 00:00:00.000000000 Z
+date: 2018-10-19 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rspec
@@ -30,14 +30,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.27'
+        version: '0.59'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.27'
+        version: '0.59'
 description: 
 email: 
 executables: []
@@ -83,7 +83,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: progress
-rubygems_version: 2.6.13
+rubygems_version: 2.7.7
 signing_key: 
 specification_version: 4
 summary: Show progress of long running tasks