Входящие атрибуты

Все атрибуты, которые должен ожидать сервис при вызове необходимо добавить с использованием метода input. Если сервис будет получать атрибуты, которые не были добавлены через метод input, то он будет возвращать ошибку.

Использование

Использование входящих в сервис атрибутов осуществляется через метод inputs.

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

  internal :full_name, type: String

  output :user, type: User

  make :assign_full_name
  make :create!

  def assign_full_name
    internals.full_name = [
      inputs.first_name,
      inputs.middle_name,
      inputs.last_name
    ].join(" ")
  end

  def create!
    outputs.user = User.create!(full_name: internals.full_name)
  end
end

Опции

Подробнее про опции вы можете узнать в разделе использования опций.

Хелперы

Servactory имеет набор готовых хелперов, а также позволяет добавлять пользовательские хелперы под цели проекта.

Под "хелпером" подразумевается некоторое сокращенное написание, которое при использовании раскрывается в конкретную опцию.

Хелпер optional

Этот хелпер эквивалентен опции required: false.

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

  input :middle_name,
        :optional,
        type: String

  input :last_name,
        type: String

  # ...
end

Пользовательские

Пользовательские хелперы можно добавить используя метод input_option_helpers в configuration.

Такие хелперы могут быть основаны на существующих опциях.

Пример конфигурации

Пример с must

class PaymentsService::Create < ApplicationService::Base
  input :invoice_numbers,
        :must_be_6_characters,
        type: Array,
        consists_of: String

  # ...
end

Пример с prepare

class PaymentsService::Create < ApplicationService::Base
  input :amount_cents,
        :to_money,
        as: :amount,
        type: Integer

  # ...
end

Методы

Метод only

По необходимости можно отфильтровать inputs при помощи метода only. Это будет возвращать Hash с указанными атрибутами.

outputs.full_name =
  inputs.only(:first_name, :middle_name, :last_name)
    .values
    .compact
    .join(" ")

Метод except

По необходимости можно отфильтровать inputs при помощи метода except. Это будет возвращать Hash без указанных атрибутов.

outputs.full_name =
  inputs.except(:gender)
    .values
    .compact
    .join(" ")

Методы предикаты

К любому атрибуту input можно обратиться как к методу предикату.

input :first_name, type: String

# ...

def something
  return unless inputs.user? # вместо `inputs.user.present?`
  
  # ...
end