Class: LibGems::StreamUI::VerboseProgressReporter

Inherits:
Object
  • Object
show all
Includes:
DefaultUserInteraction
Defined in:
lib/libgems/user_interaction.rb

Overview

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

Instance Attribute Summary collapse

Instance Method Summary collapse

Methods included from DefaultUserInteraction

ui, #ui, ui=, #ui=, use_ui, #use_ui

Constructor Details

#initialize(out_stream, size, initial_message, terminal_message = 'complete') ⇒ VerboseProgressReporter

Returns a new instance of VerboseProgressReporter.



389
390
391
392
393
394
395
396
397
 
# File 'lib/libgems/user_interaction.rb', line 389

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 Attribute Details

#count ⇒ Object (readonly)

Returns the value of attribute count.



387
388
389
 
# File 'lib/libgems/user_interaction.rb', line 387

def count
  @count
end

Instance Method Details

#done ⇒ Object

Prints out the terminal message.



410
411
412
 
# File 'lib/libgems/user_interaction.rb', line 410

def done
  @out.puts @terminal_message
end

#updated(message) ⇒ Object

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



402
403
404
405
 
# File 'lib/libgems/user_interaction.rb', line 402

def updated(message)
  @count += 1
  @out.puts "#{@count}/#{@total}: #{message}"
end