Skip to main content
Version: 1.8

Output

All attributes the service must return in Result should be described through the output method.

Usage​

The assignment and use of service output arguments is done through the outputs=/outputs methods or their out=/out aliases.

class UsersService::Create < ApplicationService::Base
  input :first_name, type: String
  input :middle_name, type: String
  input :last_name, type: String

  output :full_name, type: String

  # ...

  def something
    outputs.full_name = [inputs.first_name, inputs.middle_name, inputs.last_name].compact.join(" ")
    # or
    # out.full_name = [inp.first_name, inp.middle_name, inp.last_name].compact.join(" ")
  end
end

Options​

Option type​

This option is validation. It will check that the value set to output corresponds to the specified type (class). In this case is_a? method is used.

class NotificationService::Create < ApplicationService::Base
  input :user, type: User

  output :notification, type: Notification

  make :create_notification!
  
  private
  
  def create_notification!
    outputs.notification = Notification.create!(user: inputs.user)
  end
end

Predicate methods​

Every output has a method with a question mark. The data processing logic can be found here.

# ...

output :full_name, type: String

# ...

def something
  return unless outputs.full_name? # instead of `outputs.full_name.present?`

  # ...
end