In Files

  • rubygems/user_interaction.rb



Included Modules

Class/Module Index [+]



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



The number of progress items counted so far.

Public Class Methods

new(out_stream, size, initial_message, terminal_message = 'complete') click to toggle source

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 rubygems/user_interaction.rb, line 495
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

Public Instance Methods

done() click to toggle source

Prints out the terminal message.

               # File rubygems/user_interaction.rb, line 516
def done
  @out.puts @terminal_message
updated(message) click to toggle source

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

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

Commenting is here to help enhance the documentation. For example, code samples, or clarification of the documentation.

If you have questions about Ruby or the documentation, please post to one of the Ruby mailing lists. You will get better, faster, help that way.

If you wish to post a correction of the docs, please do so, but also file bug report so that it can be corrected for the next release. Thank you.

If you want to help improve the Ruby documentation, please visit