Class: ConvenientService::Service::Plugins::RescuesResultUnhandledExceptions::Commands::FormatMessage Private

Inherits:
ConvenientService::Support::Command show all
Defined in:
lib/convenient_service/service/plugins/rescues_result_unhandled_exceptions/commands/format_message.rb

Overview

This class is part of a private API. You should avoid using this class if possible, as it may be removed or be changed in the future.

Since:

  • 1.0.0

Instance Attribute Summary collapse

Instance Method Summary collapse

Methods inherited from ConvenientService::Support::Command

[], call

Constructor Details

#initialize(message:) ⇒ void

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.

Parameters:

  • message (String, nil)

Since:

  • 1.0.0



24
25
26
 
# File 'lib/convenient_service/service/plugins/rescues_result_unhandled_exceptions/commands/format_message.rb', line 24

def initialize(message:)
  @message = message
end

Instance Attribute Details

#message ⇒ Object (readonly)

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.

Since:

  • 1.0.0



18
19
20
 
# File 'lib/convenient_service/service/plugins/rescues_result_unhandled_exceptions/commands/format_message.rb', line 18

def message
  @message
end

Instance Method Details

#call ⇒ String

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.

Note:

Message formatting is inspired by RSpec. It has almost the same output (at least for RSpec 3).

Note:

Underscores are used to highlight spaces in docs, they are NOT included in the resulting message, check FormatException for a full example.

Examples:

Message.

__exception message

Multiline message.

__exception message first line
__exception message second line
__exception message third line

Returns:

  • (String)

See Also:

Since:

  • 1.0.0



45
46
47
 
# File 'lib/convenient_service/service/plugins/rescues_result_unhandled_exceptions/commands/format_message.rb', line 45

def call
  message.to_s.chomp.split("\n").map { |line| line.prepend(Constants::MESSAGE_LINE_PREFIX) }.join("\n")
end