class Gem::StreamUI::VerboseProgressReporter - Documentation for Ruby 4.0
Description: class Gem::StreamUI::VerboseProgressReporter: A progress reporter that prints out messages about the current progress.
Keywords: ruby,class,Gem::StreamUI::VerboseProgressReporter

🔍

No recent searches

# class Gem::StreamUI::VerboseProgressReporter

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

### Attributes

count [R]

The number of progress items counted so far.

### Public Class Methods

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

    # File lib/rubygems/user_interaction.rb, line 468
    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

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.

### Public Instance Methods

done ()
Source

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

Prints out the terminal message.

updated (message)
Source

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

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