Методы

Вызов методов сервиса происходит только при помощи метода make.

Примеры

Минимальный

make :something

def something
  # ...
end

Несколько методов

make :assign_api_model
make :perform_api_request
make :process_result

def assign_api_model
  self.api_model = APIModel.new
end

def perform_api_request
  self.response = APIClient.resource.create(api_model)
end

def process_result
  ARModel.create!(response)
end

Опции

Опция if

Перед вызовом метода будет проверено условие, описанное в if.

make :something,
     if: ->(**) { Settings.something.enabled }

def something
  # ...
end

Опция unless

Противоположность опции if.

make :something,
     unless: ->(**) { Settings.something.disabled }

def something
  # ...
end

Опция position

Все методы имеют позицию. Если какой-то метод нужно вызвать не в тот момент, в который он был добавлен через make, то можно воспользоваться опцией position. Может быть полезно при наследовании сервисов.

class SomeApiService::Base < ApplicationService::Base
  make :api_request!,
       position: 2

  # ...
end

class SomeApiService::Posts::Create < SomeApiService::Base
  input :post_name, type: String

  # ...
  
  make :validate!,
       position: 1

  private

  def validate!
    # ...
  end

  # ...
end

Группа из нескольких методов

Собрать в одну группу выполнение несколько методов можно при помощи метода stage.

к сведению

Использование опции position для make будет сортировать только внутри stage.

stage do
  make :create_user!
  make :create_blog_for_user!
  make :create_post_for_user_blog!
end

Опция only_if

Перед вызовом методов внутри stage будет проверено условие, описанное в only_if.

stage do
  only_if ->(context:) { Settings.features.preview.enabled }
  
  make :create_user!
  make :create_blog_for_user!
  make :create_post_for_user_blog!
end

Опция wrap_in

Группу методов, находящийхся в stage можно обернуть во что-то. Например, это может быть ActiveRecord::Base.transaction от Rails.

stage do
  wrap_in ->(methods:) { ActiveRecord::Base.transaction { methods.call } }
  
  make :create_user!
  make :create_blog_for_user!
  make :create_post_for_user_blog!
end

Опция rollback

Если в одном из методов в группе или в wrap_in возникло исключение, то это можно обработать при помощи метода rollback.

stage do
  wrap_in ->(methods:) { ActiveRecord::Base.transaction { methods.call } }
  rollback :clear_data_and_fail!
  
  make :create_user!
  make :create_blog_for_user!
  make :create_post_for_user_blog!
end

# ...

def clear_data_and_fail!(e)
  # ...

  fail!(message: "Failed to create data: #{e.message}")
end

Сокращение для методов

Через конфигурацию method_shortcuts можно добавить часто используемые слова, которые используются в виде префиксов в именах методов. Имена самих методов короче не станут, но это позволит сократить строки с применением метода make и улучшить читаемость кода сервиса, сделав его выразительнее.

configuration do
  method_shortcuts %i[assign perform]
end

assign :api_model
perform :api_request
make :process_result

def assign_api_model
  self.api_model = APIModel.new
end

def perform_api_request
  self.response = APIClient.resource.create(api_model)
end

def process_result
  ARModel.create!(response)
end