Class: Progressor

Inherits:
Object
  • Object
show all
Extended by:
Formatting
Defined in:
lib/progressor.rb,
lib/progressor/error.rb,
lib/progressor/version.rb,
lib/progressor/formatting.rb,
lib/progressor/limited_sequence.rb,
lib/progressor/unlimited_sequence.rb

Overview

Used to measure the running time of parts of a long-running task and output an estimation based on the average of the last 1-100 measurements.

Example usage:

progressor = Progressor.new(total_count: Product.count)

Product.find_each do |product|
  if product.not_something_we_want_to_process?
    progressor.skip(1)
    next
  end

  progressor.run do |progress|
    puts "[#{progress}] Product #{product.id}"
    product.calculate_interesting_stats
  end
end

Example output:

...
[0038/1000, 004%, t/i: 0.5s, ETA: 8m:00s] Product 38
[0039/1000, 004%, t/i: 0.5s, ETA: 7m:58s] Product 39
[0040/1000, 004%, t/i: 0.5s, ETA: 7m:57s] Product 40
...

Defined Under Namespace

Modules: Formatting, Iteration Classes: Error, LimitedSequence, UnlimitedSequence

Constant Summary collapse

VERSION = 
'0.1.3'

Class Method Summary collapse

Instance Method Summary collapse

Methods included from Formatting

format_float, format_int, format_time

Constructor Details

#initialize(total_count: nil, min_samples: 1, max_samples: 100, formatter: nil) ⇒ Progressor

Set up a new Progressor instance. Optional parameters:

  • total_count: If given, the tool will be able to provide an ETA.

  • min_samples: The number of samples to collect before attempting to calculate a time per iteration. Default: 1

  • max_samples: The maximum number of measurements to collect and average. Default: 100.

  • formatter: A callable that accepts a progress object and returns a custom formatted string.



71
72
73
74
75
76
77
78
79
80
81
82
83
 
# File 'lib/progressor.rb', line 71

def initialize(total_count: nil, min_samples: 1, max_samples: 100, formatter: nil)
  params = {
    min_samples: min_samples,
    max_samples: max_samples,
    formatter:   formatter,
  }

  if total_count
    @sequence = LimitedSequence.new(total_count: total_count, **params)
  else
    @sequence = UnlimitedSequence.new(**params)
  end
end

Class Method Details

.puts(message, &block) ⇒ Object

Utility method to print a message with the time it took to run the contents of the block.

Progressor.puts("Working on a thing") { thing_work }

Output:

Working on a thing...
Working on a thing DONE: 2.1s



50
51
52
53
54
55
56
 
# File 'lib/progressor.rb', line 50

def self.puts(message, &block)
  Kernel.puts "#{message}..."
  result = nil
  measurement = Benchmark.measure { result = block.call }
  Kernel.puts "#{message} DONE: #{format_time(measurement.real)}"
  result
end

Instance Method Details

#elapsed_time ⇒ Object

Returns the time since the sequence was started, formatted like all the other durations. Useful for a final message to compare initial estimation to actual elapsed time.



108
109
110
 
# File 'lib/progressor.rb', line 108

def elapsed_time
  @sequence.elapsed_time
end

#run ⇒ Object

Run the given block of code, yielding a sequence object that holds progress information.

Example usage:

progressor.run { |progress| puts progress; long_running_task() }



92
93
94
95
 
# File 'lib/progressor.rb', line 92

def run
  measurement = Benchmark.measure { yield @sequence }
  @sequence.push(measurement.real)
end

#skip(n) ⇒ Object

Skips the given number of loops (will likely be 1), updating the estimations appropriately.



100
101
102
 
# File 'lib/progressor.rb', line 100

def skip(n)
  @sequence.skip(n)
end