Module: Guard::Jasmine::Formatter

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

Overview

The Guard::Jasmine 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/jasmine/formatter.rb', line 27

def debug(message, options = {})
  Compat::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/jasmine/formatter.rb', line 37

def error(message, options = {})
  Compat::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/jasmine/formatter.rb', line 17

def info(message, options = {})
  Compat::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



86
87
88
 
# File 'lib/guard/jasmine/formatter.rb', line 86

def notify(message, options = {})
  Compat::UI.notify(message, options)
end

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

Print a red spec failed message to the console.

Parameters:

  • message (String) —

    the message to print

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

    the output options



66
67
68
 
# File 'lib/guard/jasmine/formatter.rb', line 66

def spec_failed(message, options = {})
  Compat::UI.info(color(message, ';31'), options)
end

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

Print a yellow pending 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



57
58
59
 
# File 'lib/guard/jasmine/formatter.rb', line 57

def spec_pending(message, options = {})
  Compat::UI.info(color(message, ';33'), 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/jasmine/formatter.rb', line 47

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

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

Print a red spec failed message to the console.

Parameters:

  • message (String) —

    the message to print

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

    the output options



75
76
77
 
# File 'lib/guard/jasmine/formatter.rb', line 75

def suite_name(message, options = {})
  Compat::UI.info(color(message, ';33'), options)
end