Module: ConvenientService::Service::Plugins::CanHaveFallbacks::Concern Private

Includes:
ConvenientService::Support::Concern
Defined in:
lib/convenient_service/service/plugins/can_have_fallbacks/concern.rb

Overview

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

Since:

  • 1.0.0

Class Method Summary collapse

Instance Method Summary collapse

Methods included from ConvenientService::Support::Concern

included

Class Method Details

.fallback_error_result ⇒ Object

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.

Returns ConvenientService::Service::Plugins::HasJSendResult::Entities::Result when #fallback_result is overridden.

Examples:

fallback_error_result method MUST always return success with reasonable "null" data.


For example, check the following service:

  class SelectActiveUsers
    include ConvenientService::Standard::Config

    # ...

    def result
      # ...

      success(users: ::User.where(active: true))
    end

    # ...
  end

Since `result` returns relation for `users` when it is successful, its corresponding `fallback_error_result` must also return a relation.

  class SelectActiveUsers
    include ConvenientService::Standard::Config

    # ...

    def fallback_error_result
      # ...

      success(users: ::User.none)
    end

    # ...
  end

This way a significant amount of extra `if` statements can be avoided.

result = SelectActiveUsers.result # or `result = SelectActiveUsers.fallback_error_result`

if result.success?
  result.data[:users].count
end

It is safe to invoke `count` for both `result` and `fallback_error_result` since `result.data[:users]` return same class.

This idea can be applied in a broader sense by utilizing the Null object pattern.

Raises:

See Also:

Since:

  • 1.0.0



111
112
113
 
# File 'lib/convenient_service/service/plugins/can_have_fallbacks/concern.rb', line 111

def fallback_error_result(...)
  new(...).fallback_error_result
end

.fallback_failure_result ⇒ Object

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.

Returns ConvenientService::Service::Plugins::HasJSendResult::Entities::Result when #fallback_result is overridden.

Raises:

Since:

  • 1.0.0



50
51
52
 
# File 'lib/convenient_service/service/plugins/can_have_fallbacks/concern.rb', line 50

def fallback_failure_result(...)
  new(...).fallback_failure_result
end

.fallback_result ⇒ Object

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.

Returns ConvenientService::Service::Plugins::HasJSendResult::Entities::Result when #fallback_result is overridden.

Raises:

Since:

  • 1.0.0



120
121
122
 
# File 'lib/convenient_service/service/plugins/can_have_fallbacks/concern.rb', line 120

def fallback_result(...)
  new(...).fallback_result
end

Instance Method Details

#fallback_error_result ⇒ Object

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.

Returns ConvenientService::Service::Plugins::HasJSendResult::Entities::Result when overridden.

Raises:

Since:

  • 1.0.0



30
31
32
 
# File 'lib/convenient_service/service/plugins/can_have_fallbacks/concern.rb', line 30

def fallback_error_result
  ::ConvenientService.raise Exceptions::FallbackResultIsNotOverridden.new(service: self, status: :error)
end

#fallback_failure_result ⇒ Object

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.

Returns ConvenientService::Service::Plugins::HasJSendResult::Entities::Result when overridden.

Raises:

Since:

  • 1.0.0



21
22
23
 
# File 'lib/convenient_service/service/plugins/can_have_fallbacks/concern.rb', line 21

def fallback_failure_result
  ::ConvenientService.raise Exceptions::FallbackResultIsNotOverridden.new(service: self, status: :failure)
end

#fallback_result ⇒ Object

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.

Returns ConvenientService::Service::Plugins::HasJSendResult::Entities::Result when overridden.

Raises:

Since:

  • 1.0.0



39
40
41
 
# File 'lib/convenient_service/service/plugins/can_have_fallbacks/concern.rb', line 39

def fallback_result
  ::ConvenientService.raise Exceptions::FallbackResultIsNotOverridden.new(service: self, status: nil)
end