progress 3.3.2 → 3.6.0

data/lib/progress.rb

@@ -1,4 +1,5 @@
 # encoding: UTF-8
+# frozen_string_literal: true
 
 require 'singleton'
 require 'thread'
@@ -51,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/active_record.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'progress'
 
 module ActiveRecord

data/lib/progress/beeper.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 class Progress
   # Repeatedly run block of code after time interval
   class Beeper

data/lib/progress/class_methods.rb

@@ -1,4 +1,7 @@
 # encoding: UTF-8
+# frozen_string_literal: true
+
+require 'progress/elapsed_time'
 
 class Progress
   # Class methods of Progress
@@ -10,8 +13,9 @@ class Progress
     # start progress indication
     def start(total = nil, title = nil)
       init(total, title)
-      print_message :force => true
+      print_message force: true
       return unless block_given?
+
       begin
         yield
       ensure
@@ -44,8 +48,9 @@ class Progress
     # stop progress
     def stop
       return unless running?
+
       if @levels.length == 1
-        print_message :force => true, :finish => true
+        print_message force: true, finish: true
         stop_beeper
       end
       @levels.pop
@@ -59,6 +64,7 @@ class Progress
     # set note
     def note=(note)
       return unless running?
+
       @levels.last.note = note
     end
 
@@ -82,7 +88,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 +108,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 +154,7 @@ class Progress
 
     def start_beeper
       @beeper = Beeper.new(10) do
-        print_message
+        print_message unless @without_beeper
       end
     end
 
@@ -152,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
@@ -169,7 +184,7 @@ class Progress
     def message_for_output(options)
       message = build_message(options)
 
-      out = ''
+      out = ''.dup
       out << "\r" if stay_on_line?
       out << message
       out << "\e[K" if stay_on_line?
@@ -188,7 +203,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 +213,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/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/enumerable.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'enumerator'
 require 'progress/with_progress'
 

data/lib/progress/eta.rb

@@ -1,24 +1,30 @@
+# 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)
       seconds = seconds_left(completed)
       return unless seconds && seconds > 0
+
       seconds_to_string(seconds)
     end
 
     def elapsed
-      seconds_to_string(Time.now - @started_at)
+      seconds_to_string(ElapsedTime.now - @started_at)
     end
 
   private
 
     def seconds_to_string(seconds)
       return unless seconds
+
       case seconds
       when 0...60
         format '%.0fs', seconds
@@ -32,8 +38,9 @@ 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
       @left = if @left
         @left + (current_eta - @left) * (1 + completed) * 0.5

data/lib/progress/integer.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'progress'
 
 # Add times_with_progress method to Integer

data/lib/progress/kernel.rb

@@ -1,9 +1,12 @@
+# frozen_string_literal: true
+
 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

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'progress'
 require 'stringio'
 
@@ -64,8 +66,6 @@ class Progress
         run_for_string(method, *args, &block)
       when io?
         run_for_io(method, *args, &block)
-      when defined?(CSV::Reader) && @enum.is_a?(CSV::Reader)
-        run_for_ruby18_csv(method, *args, &block)
       else
         run_with_length(@enum, enum_length(@enum), method, *args, &block)
       end
@@ -88,13 +88,6 @@ class Progress
       end
     end
 
-    def run_for_ruby18_csv(method, *args, &block)
-      warn "Progress: #{@enum.class} doesn't expose IO, collecting elements"
-      with_substitute(@enum.to_a) do |lines|
-        run_with_length(lines, lines.length, method, *args, &block)
-      end
-    end
-
     def run_without_block(enum, method, *args)
       Progress.start(@title) do
         Progress.step do
@@ -103,22 +96,22 @@ class Progress
       end
     end
 
-    def run_with_length(enum, length, method, *args, &block)
+    def run_with_length(enum, length, method, *args)
       Progress.start(@title, length) do
         enum.send(method, *args) do |*block_args|
           Progress.step do
-            block.call(*block_args)
+            yield(*block_args)
           end
         end
       end
     end
 
-    def run_with_pos(io, method, *args, &block)
+    def run_with_pos(io, method, *args)
       size = io.respond_to?(:size) ? io.size : io.stat.size
       Progress.start(@title, size) do
         io.send(method, *args) do |*block_args|
           Progress.set(io.pos) do
-            block.call(*block_args)
+            yield(*block_args)
           end
         end
       end
@@ -140,6 +133,7 @@ class Progress
       false
     rescue Errno::EPIPE
       raise unless defined?(JRUBY_VERSION)
+
       false
     end
 

data/progress.gemspec

@@ -2,13 +2,20 @@
 
 Gem::Specification.new do |s|
   s.name        = 'progress'
-  s.version     = '3.3.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'
 
-  s.rubyforge_project = s.name
+  s.required_ruby_version = '>= 1.9.3'
+
+  s.metadata = {
+    'bug_tracker_uri'   => "https://github.com/toy/#{s.name}/issues",
+    'changelog_uri'     => "https://github.com/toy/#{s.name}/blob/master/CHANGELOG.markdown",
+    'documentation_uri' => "https://www.rubydoc.info/gems/#{s.name}/#{s.version}",
+    'source_code_uri'   => "https://github.com/toy/#{s.name}",
+  }
 
   s.files         = `git ls-files`.split("\n")
   s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
@@ -16,7 +23,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.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

@@ -1,8 +1,11 @@
+# frozen_string_literal: true
+
 require 'rspec'
 require 'progress'
 require 'tempfile'
 require 'shellwords'
 require 'csv'
+require 'set'
 
 describe Progress do
   before do
@@ -13,7 +16,7 @@ describe Progress do
     allow(Progress).to receive(:start_beeper)
     allow(Progress).to receive(:time_to_print?).and_return(true)
 
-    eta = instance_double(Progress::Eta, :left => nil, :elapsed => '0s')
+    eta = instance_double(Progress::Eta, left: nil, elapsed: '0s')
     allow(Progress).to receive(:eta).and_return(eta)
   end
 
@@ -84,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
@@ -178,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
@@ -187,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
@@ -202,7 +205,7 @@ describe Progress do
 
         describe String do
           it 'calls each only once on StringIO' do
-            enum = "a\nb\nc"
+            enum = "a\nb\nc".dup
             expect(enum).not_to receive(:each)
             io = StringIO.new(enum)
             expect(StringIO).to receive(:new).with(enum).and_return(io)
@@ -210,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
@@ -231,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
@@ -251,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
 
           [
@@ -277,7 +280,8 @@ describe Progress do
 
               with_progress = enum.with_progress
               expect(with_progress).not_to receive(:warn)
-              expect(with_progress.each{}).to eq(nil)
+              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
@@ -286,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
 
@@ -331,41 +335,41 @@ 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
 
-      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
@@ -387,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
@@ -423,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
@@ -465,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
@@ -522,5 +526,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