Class: ProgressBar

Inherits:
Object
  • Object
show all
Defined in:
lib/progressbar.rb

Overview

Ruby/ProgressBar - a text progress bar library

Copyright © 2001-2005 Satoru Takabayashi <[email protected]>

All rights reserved.
This is free software with ABSOLUTELY NO WARRANTY.

You can redistribute it and/or modify it under the terms of Ruby’s license.

Direct Known Subclasses

ReversedProgressBar

Constant Summary collapse

VERSION = 
"0.9"

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(title, total, out = STDERR) ⇒ ProgressBar

Returns a new instance of ProgressBar.



15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
 
# File 'lib/progressbar.rb', line 15

def initialize (title, total, out = STDERR)
  @title = title
  @total = total
  @out = out
  @terminal_width = 80
  @bar_mark = "o"
  @current = 0
  @previous = 0
  @finished_p = false
  @start_time = Time.now
  @previous_time = @start_time
  @title_width = 14
  @format = "%-#{@title_width}s %3d%% %s %s"
  @format_arguments = [:title, :percentage, :bar, :stat]
  clear
  show
end

Instance Attribute Details

#bar_mark=(value) ⇒ Object (writeonly)

Sets the attribute bar_mark

Parameters:

  • value —

    the value to set the attribute bar_mark to.



36
37
38
 
# File 'lib/progressbar.rb', line 36

def bar_mark=(value)
  @bar_mark = value
end

#current ⇒ Object (readonly)

Returns the value of attribute current.



33
34
35
 
# File 'lib/progressbar.rb', line 33

def current
  @current
end

#start_time ⇒ Object

Returns the value of attribute start_time.



35
36
37
 
# File 'lib/progressbar.rb', line 35

def start_time
  @start_time
end

#title ⇒ Object (readonly)

Returns the value of attribute title.



32
33
34
 
# File 'lib/progressbar.rb', line 32

def title
  @title
end

#total ⇒ Object (readonly)

Returns the value of attribute total.



34
35
36
 
# File 'lib/progressbar.rb', line 34

def total
  @total
end

Instance Method Details

#clear ⇒ Object 



178
179
180
181
182
 
# File 'lib/progressbar.rb', line 178

def clear
  @out.print "\r"
  @out.print(" " * (get_width - 1))
  @out.print "\r"
end

#file_transfer_mode ⇒ Object 



194
195
196
 
# File 'lib/progressbar.rb', line 194

def file_transfer_mode
  @format_arguments = [:title, :percentage, :bar, :stat_for_file_transfer]
end

#finish ⇒ Object 



184
185
186
187
188
 
# File 'lib/progressbar.rb', line 184

def finish
  @current = @total
  @finished_p = true
  show
end

#finished? ⇒ Boolean

Returns:

  • (Boolean) 


190
191
192
 
# File 'lib/progressbar.rb', line 190

def finished?
  @finished_p
end

#format=(format) ⇒ Object 



198
199
200
 
# File 'lib/progressbar.rb', line 198

def format= (format)
  @format = format
end

#format_arguments=(arguments) ⇒ Object 



202
203
204
 
# File 'lib/progressbar.rb', line 202

def format_arguments= (arguments)
  @format_arguments = arguments
end

#halt ⇒ Object 



206
207
208
209
 
# File 'lib/progressbar.rb', line 206

def halt
  @finished_p = true
  show
end

#inc(step = 1) ⇒ Object 



211
212
213
214
215
216
 
# File 'lib/progressbar.rb', line 211

def inc (step = 1)
  @current += step
  @current = @total if @current > @total
  show_if_needed
  @previous = @current
end

#inspect ⇒ Object 



227
228
229
 
# File 'lib/progressbar.rb', line 227

def inspect
  "#<ProgressBar:#{@current}/#{@total}>"
end

#set(count) ⇒ Object 



218
219
220
221
222
223
224
225
 
# File 'lib/progressbar.rb', line 218

def set (count)
  if count < 0 || count > @total
    raise "invalid count: #{count} (total: #{@total})"
  end
  @current = count
  show_if_needed
  @previous = @current
end