Конфигурация

Конфигурируйте сервисы через метод configuration, обычно расположенный в базовом классе.

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

Для исключений

app/services/application_service/base.rb

module ApplicationService
  class Base < Servactory::Base
    configuration do
      input_exception_class ApplicationService::Exceptions::Input
      internal_exception_class ApplicationService::Exceptions::Internal
      output_exception_class ApplicationService::Exceptions::Output

      failure_class ApplicationService::Exceptions::Failure
    end
  end
end

app/services/application_service/exceptions.rb

module ApplicationService
  module Exceptions
    class Input < Servactory::Exceptions::Input; end
    class Output < Servactory::Exceptions::Output; end
    class Internal < Servactory::Exceptions::Internal; end

    class Failure < Servactory::Exceptions::Failure; end
  end
end

Для результата Начиная с 2.5.0

app/services/application_service/base.rb

module ApplicationService
  class Base < Servactory::Base
    configuration do
      # ...

      result_class ApplicationService::Result
    end
  end
end

app/services/application_service/result.rb

module ApplicationService
  class Result < Servactory::Result; end
end

Режим коллекции

app/services/application_service/base.rb

module ApplicationService
  class Base < Servactory::Base
    configuration do
      collection_mode_class_names([ActiveRecord::Relation])
    end
  end
end

Режим хеша

app/services/application_service/base.rb

module ApplicationService
  class Base < Servactory::Base
    configuration do
      hash_mode_class_names([CustomHash])
    end
  end
end

Хелперы для input

Основывайте пользовательские хелперы для input на опциях must и prepare.

Пример с must

app/services/application_service/base.rb

module ApplicationService
  class Base < Servactory::Base
    configuration do
      input_option_helpers(
        [
          Servactory::Maintenance::Attributes::OptionHelper.new(
            name: :must_be_6_characters,
            equivalent: {
              must: {
                be_6_characters: {
                  is: ->(value:, input:) { value.all? { |id| id.size == 6 } },
                  message: lambda do |input:, **|
                    "Wrong IDs in `#{input.name}`"
                  end
                }
              }
            }
          )
        ]
      )
    end
  end
end

Пример с prepare

app/services/application_service/base.rb

module ApplicationService
  class Base < Servactory::Base
    configuration do
      input_option_helpers(
        [
          Servactory::Maintenance::Attributes::OptionHelper.new(
            name: :to_money,
            equivalent: {
              prepare: ->(value:) { Money.from_cents(value, :USD) }
            }
          )
        ]
      )
    end
  end
end

Хелперы для internal

Основывайте пользовательские хелперы для internal на опции must.

Пример с must

app/services/application_service/base.rb

module ApplicationService
  class Base < Servactory::Base
    configuration do
      internal_option_helpers(
        [
          Servactory::Maintenance::Attributes::OptionHelper.new(
            name: :must_be_6_characters,
            equivalent: {
              must: {
                be_6_characters: {
                  is: ->(value:, internal:) { value.all? { |id| id.size == 6 } },
                  message: lambda do |internal:, **|
                    "Wrong IDs in `#{internal.name}`"
                  end
                }
              }
            }
          )
        ]
      )
    end
  end
end

Хелперы для output

Основывайте пользовательские хелперы для output на опции must.

Пример с must

app/services/application_service/base.rb

module ApplicationService
  class Base < Servactory::Base
    configuration do
      output_option_helpers(
        [
          Servactory::Maintenance::Attributes::OptionHelper.new(
            name: :must_be_6_characters,
            equivalent: {
              must: {
                be_6_characters: {
                  is: ->(value:, output:) { value.all? { |id| id.size == 6 } },
                  message: lambda do |output:, **|
                    "Wrong IDs in `#{output.name}`"
                  end
                }
              }
            }
          )
        ]
      )
    end
  end
end

Алиасы для make

Добавляйте альтернативы для make через конфигурацию action_aliases.

app/services/application_service/base.rb

module ApplicationService
  class Base < Servactory::Base
    configuration do
      action_aliases %i[execute]
    end
  end
end

Кастомизация для make

Реализуйте сокращения для make через конфигурацию action_shortcuts.

Значения заменяют make и служат префиксом метода инстанса.

Простой режим

В простом режиме значения передаются в виде массива символов.

app/services/application_service/base.rb

module ApplicationService
  class Base < Servactory::Base
    configuration do
      action_shortcuts(
        %i[assign perform]
      )
    end
  end
end

Пример использования

class CMSService::API::Posts::Create < CMSService::API::Base
  # ...
  
  assign :model

  perform :request

  private

  def assign_model
    # Построение модели для API запроса
  end

  def perform_request
    # Выполнение API запроса
  end
  
  # ...
end

Расширенный режим Начиная с 2.14.0

В расширенном режиме значения передаются в виде хеша.

app/services/application_service/base.rb

module ApplicationService
  class Base < Servactory::Base
    configuration do
      action_shortcuts(
        %i[assign],
        {
          restrict: {             # замена для make
            prefix: :create,      # префикс имени метода
            suffix: :restriction  # суффикс имени метода
          }
        }
      )
    end
  end
end

Пример использования

class PaymentsService::Restrictions::Create < ApplicationService::Base
  input :payment, type: Payment

  # Восклицательный знак будет перемещен в конец имени метода
  restrict :payment!

  private

  def create_payment_restriction!
    inputs.payment.restrictions.create!(
      reason: "Suspicion of fraud"
    )
  end
end

Методы предикаты Начиная с 2.5.0

Методы предикаты для всех атрибутов включены по умолчанию. Отключайте их при необходимости.

app/services/application_service/base.rb

module ApplicationService
  class Base < Servactory::Base
    configuration do
      predicate_methods_enabled false
    end
  end
end

Корневой ключ для I18n Начиная с 2.6.0

Переопределяйте корневой ключ по умолчанию для переводов (servactory).

app/services/application_service/base.rb

module ApplicationService
  class Base < Servactory::Base
    configuration do
      i18n_root_key :my_app
    end
  end
end

Это изменяет поиск переводов с servactory.* на my_app.*.

Смотрите также Интернационализация (I18n).