Class: Commander::UI::ProgressBar
- Defined in:
- lib/commander/user_interaction.rb
Overview
Progress Bar
Terminal progress bar utility. In its most basic form requires that the developer specifies when the bar should be incremented. Note that a hash of tokens may be passed to #increment, (or returned when using Object#progress).
uris = %w(
http://vision-media.ca
http://yahoo.com
http://google.com
)
= Commander::UI::ProgressBar.new uris.length,
threads = []
uris.each do |uri|
threads << Thread.new do
begin
res = open uri
.increment :uri => uri
rescue Exception => e
.increment :uri => "#{uri} failed"
end
end
end
threads.each { |t| t.join }
The Object method #progress is also available:
progress uris, :width => 10 do |uri|
res = open uri
{ :uri => uri } # Can now use :uri within :format option
end
Instance Method Summary collapse
-
#completed? ⇒ Boolean
Whether or not the operation has completed.
-
#erase_line ⇒ Object
Erase previous terminal line.
-
#finished? ⇒ Boolean
Whether or not the operation is complete, and we have finished.
-
#generate_tokens ⇒ Object
Generates tokens for this step.
-
#increment(tokens = {}) ⇒ Object
Increment progress.
-
#initialize(total, options = {}) ⇒ ProgressBar
constructor
Creates a new progress bar.
-
#percent_complete ⇒ Object
Completion percentage.
-
#progress_bar ⇒ Object
Formatted progress bar.
-
#show ⇒ Object
Output the progress bar.
-
#steps_remaining ⇒ Object
Number of steps left.
-
#time_elapsed ⇒ Object
Time that has elapsed since the operation started.
-
#time_remaining ⇒ Object
Estimated time remaining.
Constructor Details
#initialize(total, options = {}) ⇒ ProgressBar
Creates a new progress bar.
Options
:title Title, defaults to "Progress"
:width Width of :progress_bar
:progress_str Progress string, defaults to "="
:incomplete_str Incomplete bar string, defaults to '.'
:format Defaults to ":title |:progress_bar| :percent_complete% complete "
:tokens Additional tokens replaced within the format string
:complete_message Defaults to "Process complete"
Tokens
:title
:percent_complete
:progress_bar
:step
:steps_remaining
:total_steps
:time_elapsed
:time_remaining
314 315 316 317 318 319 320 321 322 323 |
# File 'lib/commander/user_interaction.rb', line 314 def initialize total, = {} @total_steps, @step, @start_time = total, 0, Time.now @title = .fetch :title, 'Progress' @width = .fetch :width, 25 @progress_str = .fetch :progress_str, '=' @incomplete_str = .fetch :incomplete_str, '.' @complete_message = .fetch :complete_message, 'Process complete' @format = .fetch :format, ':title |:progress_bar| :percent_complete% complete ' @tokens = .fetch :tokens, {} end |
Instance Method Details
#completed? ⇒ Boolean
Whether or not the operation has completed.
405 406 407 |
# File 'lib/commander/user_interaction.rb', line 405 def completed? @step == @total_steps end |
#erase_line ⇒ Object
Erase previous terminal line.
422 423 424 425 |
# File 'lib/commander/user_interaction.rb', line 422 def erase_line # highline does not expose the output stream $terminal.instance_variable_get('@output').print "\r\e[K" end |
#finished? ⇒ Boolean
Whether or not the operation is complete, and we have finished.
398 399 400 |
# File 'lib/commander/user_interaction.rb', line 398 def finished? @step == @total_steps + 1 end |
#generate_tokens ⇒ Object
Generates tokens for this step.
367 368 369 370 371 372 373 374 375 376 377 378 379 |
# File 'lib/commander/user_interaction.rb', line 367 def generate_tokens { :title => @title, :percent_complete => percent_complete, :progress_bar => , :step => @step, :steps_remaining => steps_remaining, :total_steps => @total_steps, :time_elapsed => "%0.2fs" % time_elapsed, :time_remaining => @step > 0 ? "%0.2fs" % time_remaining : '', }. merge! @tokens end |
#increment(tokens = {}) ⇒ Object
Increment progress. Optionally pass tokens which can be displayed in the output format.
413 414 415 416 417 |
# File 'lib/commander/user_interaction.rb', line 413 def increment tokens = {} @step += 1 @tokens.merge! tokens if tokens.is_a? Hash show end |
#percent_complete ⇒ Object
Completion percentage.
328 329 330 331 332 333 334 |
# File 'lib/commander/user_interaction.rb', line 328 def percent_complete if @total_steps.zero? 100 else @step * 100 / @total_steps end end |
#progress_bar ⇒ Object
Formatted progress bar.
360 361 362 |
# File 'lib/commander/user_interaction.rb', line 360 def (@progress_str * (@width * percent_complete / 100)).ljust @width, @incomplete_str end |
#show ⇒ Object
Output the progress bar.
384 385 386 387 388 389 390 391 392 393 |
# File 'lib/commander/user_interaction.rb', line 384 def show unless finished? erase_line if completed? $terminal.say UI.replace_tokens(@complete_message, generate_tokens) if @complete_message.is_a? String else $terminal.say UI.replace_tokens(@format, generate_tokens) << ' ' end end end |
#steps_remaining ⇒ Object
Number of steps left.
353 354 355 |
# File 'lib/commander/user_interaction.rb', line 353 def steps_remaining @total_steps - @step end |
#time_elapsed ⇒ Object
Time that has elapsed since the operation started.
339 340 341 |
# File 'lib/commander/user_interaction.rb', line 339 def time_elapsed Time.now - @start_time end |
#time_remaining ⇒ Object
Estimated time remaining.
346 347 348 |
# File 'lib/commander/user_interaction.rb', line 346 def time_remaining (time_elapsed / @step) * steps_remaining end |