Exception: ConvenientService::Exception

Inherits:

StandardError

Object
StandardError
ConvenientService::Exception

show all

Defined in:: lib/convenient_service/exception.rb

Overview

Base class for all ‘ConvenientService` exceptions.

Examples:

Can be used as a catch-all solution.


begin
  any_service.result
rescue ConvenientService::Exception => exception
  puts exception.message
end

Direct Known Subclasses

Class Method Summary collapse

.new(message = nil, **kwargs) ⇒ Object

Creates ‘ConvenientService` exception instance.

Class Method Details

.new ⇒ `ConvenientService::Exception` .new(message) ⇒ `ConvenientService::Exception` .new(**kwargs) ⇒ `ConvenientService::Exception`

Note:

‘initialize_with_kwargs` or `initialize_without_arguments` must call `initialize(message)`, otherwise exception instance won’t be properly set up.

Creates ‘ConvenientService` exception instance. In contract to `StandardError.new`, may accept `kwargs`. In such a case the descendant must implement `initialize_with_kwargs` to specify the logic of how to generate a `message`. Without arguments behavior is also changed, it calls `initialize_without_arguments` instead of immediately setting `nil` as `message`.

Overloads:

.new ⇒ ConvenientService::Exception

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.

Calls ‘initialize_without_arguments` under the hood to generate the exception message.
Examples:

Usage.
```
module Exceptions
  class Foo < ::ConvenientService::Exception
    def initialize_without_arguments
      # message = ...
      initialize(message)
    end
  end
end

::ConvenientService.raise Foo.new
```
Returns:
- (ConvenientService::Exception)
.new(message) ⇒ ConvenientService::Exception

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.

Calls ‘initialize(message)` under the hood to set the exception message.
Examples:

Usage.
```
module Exceptions
  class Foo < ::ConvenientService::Exception
  end
end

::ConvenientService.raise Foo.new("some message")
```
Parameters:
- message (String)
Returns:
- (ConvenientService::Exception)
.new(**kwargs) ⇒ ConvenientService::Exception

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.

Calls ‘initialize_with_kwargs(**kwargs)` under the hood to generate the exception message.
Examples:

Usage.
```
module Exceptions
  class Foo < ::ConvenientService::Exception
    def initialize_with_kwargs(**kwargs)
      # message = ...
      initialize(message)
    end
  end
end

::ConvenientService.raise Foo.new(foo: :bar, baz: :qux)
```
Parameters:
- kwargs (Hash{Symbol => Object})
Returns:
- (ConvenientService::Exception)

# File 'lib/convenient_service/exception.rb', line 81

def new(message = nil, **kwargs)
  if message
    super(message)
  elsif kwargs.any?
    allocate.tap { |exception| exception.initialize_with_kwargs(**kwargs) }
  else
    allocate.tap(&:initialize_without_arguments)
  end
end