Skip to Content Skip to Search

A progress reporter that prints out messages about the current progress.

Methods
D
N
U
Included Modules

Attributes

[R] count

The number of progress items counted so far.

Class Public methods

new(out_stream, size, initial_message, terminal_message = "complete")

Creates a new progress reporter that will write to out_stream for size items. Shows the given initial_message when progress starts and the terminal_message when it is complete.

# File ruby/lib/rubygems/user_interaction.rb, line 471
def initialize(out_stream, size, initial_message, terminal_message = "complete")
  @out = out_stream
  @total = size
  @count = 0
  @terminal_message = terminal_message

  @out.puts initial_message
end

Instance Public methods

done()

Prints out the terminal message.

# File ruby/lib/rubygems/user_interaction.rb, line 491
def done
  @out.puts @terminal_message
end

updated(message)

Prints out the position relative to the total and the message.

# File ruby/lib/rubygems/user_interaction.rb, line 483
def updated(message)
  @count += 1
  @out.puts "#{@count}/#{@total}: #{message}"
end