Module: Guard::RSpectacle::Formatter

Defined in:
lib/guard/rspectacle/formatter.rb

Overview

The Guard::RSpectacle formatter collects console and system notification methods and enhances them with some color information.

Class Method Summary collapse

Class Method Details

.debug(message, options = { }) ⇒ Object

Print a debug message to the console.

Parameters:

  • message (String) —

    the message to print

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

    the output options

Options Hash (options):

  • :reset (Boolean) —

    reset the UI



27
28
29
 
# File 'lib/guard/rspectacle/formatter.rb', line 27

def debug(message, options = { })
  ::Guard::UI.debug(message, options)
end

.error(message, options = { }) ⇒ Object

Print a red error message to the console.

Parameters:

  • message (String) —

    the message to print

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

    the output options

Options Hash (options):

  • :reset (Boolean) —

    reset the UI



37
38
39
 
# File 'lib/guard/rspectacle/formatter.rb', line 37

def error(message, options = { })
  ::Guard::UI.error(color(message, ';31'), options)
end

.info(message, options = { }) ⇒ Object

Print an info message to the console.

Parameters:

  • message (String) —

    the message to print

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

    the output options

Options Hash (options):

  • :reset (Boolean) —

    reset the UI



17
18
19
 
# File 'lib/guard/rspectacle/formatter.rb', line 17

def info(message, options = { })
  ::Guard::UI.info(message, options)
end

.notify(message, options = { }) ⇒ Object

Outputs a system notification.

Parameters:

  • message (String) —

    the message to print

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

    the output options

Options Hash (options):

  • :image (Symbol, String) —

    the image to use, either :failed, :pending or :success, or an image path

  • :title (String) —

    the title of the system notification



58
59
60
 
# File 'lib/guard/rspectacle/formatter.rb', line 58

def notify(message, options = { })
  ::Guard::Notifier.notify(message, options)
end

.success(message, options = { }) ⇒ Object

Print a green success message to the console.

Parameters:

  • message (String) —

    the message to print

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

    the output options

Options Hash (options):

  • :reset (Boolean) —

    reset the UI



47
48
49
 
# File 'lib/guard/rspectacle/formatter.rb', line 47

def success(message, options = { })
  ::Guard::UI.info(color(message, ';32'), options)
end