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

Inherits:
ConvenientService::Support::Command show all
Defined in:
lib/convenient_service/service/plugins/rescues_result_unhandled_exceptions/commands/format_exception.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(exception:, args:, kwargs:, block:, max_backtrace_size: Constants::DEFAULT_MAX_BACKTRACE_SIZE) ⇒ 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:

  • exception (StandardError)
  • args (Array<Object>)
  • kwargs (Hash{Symbol => Object})
  • block (Proc, nil)
  • max_backtrace_size (Integer) (defaults to: Constants::DEFAULT_MAX_BACKTRACE_SIZE)

Since:

  • 1.0.0



52
53
54
55
56
57
58
 
# File 'lib/convenient_service/service/plugins/rescues_result_unhandled_exceptions/commands/format_exception.rb', line 52

def initialize(exception:, args:, kwargs:, block:, max_backtrace_size: Constants::DEFAULT_MAX_BACKTRACE_SIZE)
  @exception = exception
  @args = args
  @kwargs = kwargs
  @block = block
  @max_backtrace_size = max_backtrace_size
end

Instance Attribute Details

#args ⇒ 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



30
31
32
 
# File 'lib/convenient_service/service/plugins/rescues_result_unhandled_exceptions/commands/format_exception.rb', line 30

def args
  @args
end

#block ⇒ 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



42
43
44
 
# File 'lib/convenient_service/service/plugins/rescues_result_unhandled_exceptions/commands/format_exception.rb', line 42

def block
  @block
end

#exception ⇒ 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_exception.rb', line 18

def exception
  @exception
end

#kwargs ⇒ 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



36
37
38
 
# File 'lib/convenient_service/service/plugins/rescues_result_unhandled_exceptions/commands/format_exception.rb', line 36

def kwargs
  @kwargs
end

#max_backtrace_size ⇒ 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



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

def max_backtrace_size
  @max_backtrace_size
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:

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

Examples:

Simple exception.


StandardError:
  exception message
# /gem/lib/convenient_service/factories/services.rb:120:in `result'
# /gem/lib/convenient_service/core/entities/config/entities/method_middlewares/entities/caller/commands/define_method_callers.rb:116:in `call'
# /gem/lib/convenient_service/core/entities/config/entities/method_middlewares/entities/caller/commands/define_method_callers.rb:116:in `block in result'
# /gem/lib/convenient_service/dependencies/extractions/ruby_middleware/middleware/runner.rb:67:in `block (2 levels) in build_call_chain'
# /gem/lib/convenient_service/core/entities/config/entities/method_middlewares/entities/chain.rb:35:in `next'
# /gem/lib/convenient_service/common/plugins/caches_return_value/middleware.rb:17:in `block in next'
# /gem/lib/convenient_service/support/cache.rb:110:in `fetch'
# /gem/lib/convenient_service/common/plugins/caches_return_value/middleware.rb:17:in `next'
# /gem/lib/convenient_service/core/entities/config/entities/method_middlewares/entities/middleware.rb:73:in `call'
# /gem/lib/convenient_service/core/entities/config/entities/method_middlewares/entities/chain.rb:35:in `next'

Exception with multiline message.


StandardError:
  exception message first line
  exception message second line
  exception message third line
# /gem/lib/convenient_service/factories/services.rb:120:in `result'
# /gem/lib/convenient_service/core/entities/config/entities/method_middlewares/entities/caller/commands/define_method_callers.rb:116:in `call'
# /gem/lib/convenient_service/core/entities/config/entities/method_middlewares/entities/caller/commands/define_method_callers.rb:116:in `block in result'
# /gem/lib/convenient_service/dependencies/extractions/ruby_middleware/middleware/runner.rb:67:in `block (2 levels) in build_call_chain'
# /gem/lib/convenient_service/core/entities/config/entities/method_middlewares/entities/chain.rb:35:in `next'
# /gem/lib/convenient_service/common/plugins/caches_return_value/middleware.rb:17:in `block in next'
# /gem/lib/convenient_service/support/cache.rb:110:in `fetch'
# /gem/lib/convenient_service/common/plugins/caches_return_value/middleware.rb:17:in `next'
# /gem/lib/convenient_service/core/entities/config/entities/method_middlewares/entities/middleware.rb:73:in `call'
# /gem/lib/convenient_service/core/entities/config/entities/method_middlewares/entities/chain.rb:35:in `next'

Exception with backtrace with more than 10 lines.


StandardError:
  exception message
# /gem/lib/convenient_service/factories/services.rb:120:in `result'
# /gem/lib/convenient_service/core/entities/config/entities/method_middlewares/entities/caller/commands/define_method_callers.rb:116:in `call'
# /gem/lib/convenient_service/core/entities/config/entities/method_middlewares/entities/caller/commands/define_method_callers.rb:116:in `block in result'
# /gem/lib/convenient_service/dependencies/extractions/ruby_middleware/middleware/runner.rb:67:in `block (2 levels) in build_call_chain'
# /gem/lib/convenient_service/core/entities/config/entities/method_middlewares/entities/chain.rb:35:in `next'
# /gem/lib/convenient_service/common/plugins/caches_return_value/middleware.rb:17:in `block in next'
# /gem/lib/convenient_service/support/cache.rb:110:in `fetch'
# /gem/lib/convenient_service/common/plugins/caches_return_value/middleware.rb:17:in `next'
# /gem/lib/convenient_service/core/entities/config/entities/method_middlewares/entities/middleware.rb:73:in `call'
# /gem/lib/convenient_service/core/entities/config/entities/method_middlewares/entities/chain.rb:35:in `next'
# ...

Exception with cause.


StandardError:
  exception message
# /gem/lib/convenient_service/factories/service/class.rb:43:in `rescue in result'
# /gem/lib/convenient_service/factories/service/class.rb:40:in `result'
# /gem/lib/convenient_service/core/entities/config/entities/method_middlewares/entities/caller/commands/define_method_callers.rb:116:in `call'
# /gem/lib/convenient_service/core/entities/config/entities/method_middlewares/entities/caller/commands/define_method_callers.rb:116:in `block in result'
# /gem/lib/convenient_service/dependencies/extractions/ruby_middleware/middleware/runner.rb:67:in `block (2 levels) in build_call_chain'
# /gem/lib/convenient_service/core/entities/config/entities/method_middlewares/entities/chain.rb:35:in `next'
# /gem/lib/convenient_service/common/plugins/caches_return_value/middleware.rb:17:in `block in next'
# /gem/lib/convenient_service/support/cache.rb:110:in `fetch'
# /gem/lib/convenient_service/common/plugins/caches_return_value/middleware.rb:17:in `next'
# /gem/lib/convenient_service/core/entities/config/entities/method_middlewares/entities/middleware.rb:73:in `call'
------------------
--- Caused by: ---
StandardError:
  cause message
# /gem/lib/convenient_service/factories/service/class.rb:41:in `result'

Returns:

  • (String)

Since:

  • 1.0.0



138
139
140
141
142
143
144
145
 
# File 'lib/convenient_service/service/plugins/rescues_result_unhandled_exceptions/commands/format_exception.rb', line 138

def call
  <<~MESSAGE.rstrip
    #{formatted_exception_class}
    #{formatted_exception_message}
    #{formatted_exception_backtrace}
    #{formatted_exception_cause}
  MESSAGE
end