Class: Commander::UI::ProgressBar

Inherits:
Object
  • Object
show all
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
  )

bar = Commander::UI::ProgressBar.new uris.length, options
threads = []
uris.each do |uri|
  threads << Thread.new do
    begin
      res = open uri
      bar.increment :uri => uri
    rescue Exception => e
      bar.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

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

312
313
314
315
316
317
318
319
320
321
# File 'lib/commander/user_interaction.rb', line 312

def initialize total, options = {}
  @total_steps, @step, @start_time = total, 0, Time.now
  @title = options.fetch :title, 'Progress'
  @width = options.fetch :width, 25
  @progress_str = options.fetch :progress_str, '='
  @incomplete_str = options.fetch :incomplete_str, '.'
  @complete_message = options.fetch :complete_message, 'Process complete'
  @format = options.fetch :format, ':title |:progress_bar| :percent_complete% complete '
  @tokens = options.fetch :tokens, {}
end

Instance Method Details

#completed?Boolean

Whether or not the operation has completed.

Returns:

  • (Boolean)

399
400
401
# File 'lib/commander/user_interaction.rb', line 399

def completed?
  @step == @total_steps
end

#erase_lineObject

Erase previous terminal line.


416
417
418
419
# File 'lib/commander/user_interaction.rb', line 416

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.

Returns:

  • (Boolean)

392
393
394
# File 'lib/commander/user_interaction.rb', line 392

def finished?
  @step == @total_steps + 1
end

#generate_tokensObject

Generates tokens for this step.


361
362
363
364
365
366
367
368
369
370
371
372
373
# File 'lib/commander/user_interaction.rb', line 361

def generate_tokens
  {
    :title => @title,
    :percent_complete => percent_complete,
    :progress_bar => progress_bar, 
    :step => @step,
    :steps_remaining => steps_remaining,
    :total_steps => @total_steps, 
    :time_elapsed => "%0.2fs" % time_elapsed,
    :time_remaining => "%0.2fs" % time_remaining,
  }.
  merge! @tokens
end

#increment(tokens = {}) ⇒ Object

Increment progress. Optionally pass tokens which can be displayed in the output format.


407
408
409
410
411
# File 'lib/commander/user_interaction.rb', line 407

def increment tokens = {}
  @step += 1
  @tokens.merge! tokens if tokens.is_a? Hash
  show
end

#percent_completeObject

Completion percentage.


326
327
328
# File 'lib/commander/user_interaction.rb', line 326

def percent_complete
  @step * 100 / @total_steps
end

#progress_barObject

Formatted progress bar.


354
355
356
# File 'lib/commander/user_interaction.rb', line 354

def progress_bar
  (@progress_str * (@width * percent_complete / 100)).ljust @width, @incomplete_str
end

#showObject

Output the progress bar.


378
379
380
381
382
383
384
385
386
387
# File 'lib/commander/user_interaction.rb', line 378

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_remainingObject

Number of steps left.


347
348
349
# File 'lib/commander/user_interaction.rb', line 347

def steps_remaining
  @total_steps - @step
end

#time_elapsedObject

Time that has elapsed since the operation started.


333
334
335
# File 'lib/commander/user_interaction.rb', line 333

def time_elapsed
  Time.now - @start_time
end

#time_remainingObject

Estimated time remaining.


340
341
342
# File 'lib/commander/user_interaction.rb', line 340

def time_remaining
  (time_elapsed / @step) * steps_remaining
end