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

Inherits:
ConvenientService::Support::Command show all
Defined in:
lib/convenient_service/service/plugins/rescues_result_unhandled_exceptions/commands/format_backtrace.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(backtrace:, max_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:

  • backtrace (Array, nil)
  • max_size (Integer) (defaults to: Constants::DEFAULT_MAX_BACKTRACE_SIZE)

Since:

  • 1.0.0



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

def initialize(backtrace:, max_size: Constants::DEFAULT_MAX_BACKTRACE_SIZE)
  @backtrace = backtrace.to_a
  @max_size = max_size
end

Instance Attribute Details

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

def backtrace
  @backtrace
end

#max_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_backtrace.rb', line 24

def max_size
  @max_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:

Backtrace with upto 10 lines.


# /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'

Backtrace with more than 10 lines.


# /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'
# ...

Returns:

  • (String)

Since:

  • 1.0.0



73
74
75
76
77
78
79
 
# File 'lib/convenient_service/service/plugins/rescues_result_unhandled_exceptions/commands/format_backtrace.rb', line 73

def call
  message = backtrace.take(max_size).map { |line| Commands::FormatLine.call(line: line) }.join("\n")

  message << "\n# ..." if backtrace.size > max_size

  message
end