class Gem::StreamUI::SimpleProgressReporter - rubygems: Ruby Standard Library Documentation

# class Gem::StreamUI::SimpleProgressReporter

A basic dotted progress reporter.

### Attributes

count[R]

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 429
    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

### Public Instance Methods

done() click to toggle source

Prints out the terminal message.

    # File rubygems/user_interaction.rb, line 450
    def done
      @out.puts "\n#{@terminal_message}"
    end

updated(message) click to toggle source

Prints out a dot and ignores `message`.

    # File rubygems/user_interaction.rb, line 441
    def updated(message)
      @count += 1
      @out.print "."
      @out.flush
    end