Class: Progress::Bar

Inherits:
Object
  • Object
show all
Defined in:
lib/progress-bar.rb

Instance Method Summary collapse

Constructor Details

#initialize(max, depth, num_reports, desc) ⇒ Bar

Creates a new instance. Max is the total number of iterations of the loop. The depth represents how many other loops are above this one, this information is used to find the place to print the progress report.



9
10
11
12
13
14
15
16
17
18
 
# File 'lib/progress-bar.rb', line 9

def initialize(max,depth, num_reports, desc)
  @max = max
  @max = 1 if @max < 1
  @current = 0
  @time = Time.now
  @last_report = -1
  @num_reports = num_reports
  @depth = depth
  @desc = desc
end

Instance Method Details

#report ⇒ Object

Prints de progress report. It backs up as many lines as the meters depth. Prints the progress as a line of dots, a percentage, time spent, and time left. And then goes moves the cursor back to its original line. Everything is printed to stderr.



44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
 
# File 'lib/progress-bar.rb', line 44

def report

  percent = @current.to_f/ @max.to_f
  percent = 0.001 if percent < 0.001
  if @desc != ""
    indicator = @desc + ": "
  else
    indicator = "Progress "
  end
  indicator += "["
  10.times{|i|
    if i < percent * 10 then
      indicator += "."
    else
      indicator += " "
    end
  }
  indicator += "]   done #{(percent * 100).to_i}% "

  eta =  (Time.now - @time)/percent * (1-percent)
  eta = eta.to_i
  eta = [eta/3600, eta/60 % 60, eta % 60].map{|t| t.to_s.rjust(2, '0')}.join(':')

  used = (Time.now - @time).to_i
  used = [used/3600, used/60 % 60, used % 60].map{|t| t.to_s.rjust(2, '0')}.join(':')

  indicator += " (Time left #{eta} seconds) (Started #{used} seconds ago)"

  STDERR.print("\033[#{@depth + 1}F\033[2K" + indicator + "\n\033[#{@depth + 2}E")
end

#tick(step = nil) ⇒ Object

Used to register a new completed loop iteration.



22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
 
# File 'lib/progress-bar.rb', line 22

def tick(step = nil)

  if step.nil?
    @current += 1
  else
    @current = step
  end

  percent = @current.to_f/ @max.to_f
  if percent - @last_report > 1.to_f/@num_reports.to_f 
    report
    @last_report=percent
  end

  nil
end