Class: Machines::Logger

Inherits:

Object

• Object
• Machines::Logger

Defined in:

lib/machines/logger.rb

Instance Method Summary

• #flush ⇒ Object
• #initialize(to, options = {}) ⇒ Logger constructor

  A new instance of Logger.

• #log(message, options = {}) ⇒ Object

  Logs a message.

Constructor Details

#initialize(to, options = {}) ⇒ Logger

Returns a new instance of Logger.

# File 'lib/machines/logger.rb', line 13

def initialize to, options = {}
  @to = to
  @truncate = options[:truncate]
end

Instance Method Details

#flush ⇒ Object

# File 'lib/machines/logger.rb', line 29

def flush
  @to.flush
end

#log(message, options = {}) ⇒ Object

Logs a message

Parameters:

• message (String) —

  Message to display

• options (Hash) (defaults to: {})

Options Hash (options):

• :progress (String) —

  Prepends number of commands completed

• :color (String) —

  Color the text (overrides :success)

• :newline (Bool) —

  Set to false to print on same line and return to start of it (:color not supported)

# File 'lib/machines/logger.rb', line 24

def log message, options = {}
  message = format_message(message, options)
  @to.print message
end