Skip to main content
Version: 1.9

Internal

Internal private attributes can be defined through the internal method.

Usage​

The assignment and use of internal service arguments is done through the internals=/internals methods or their int=/int aliases.

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

  # ...

  def something
    internals.full_name = [inputs.first_name, inputs.middle_name, inputs.last_name].compact.join(" ")
    # or
    # int.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 internal corresponds to the specified type (class). In this case is_a? method is used.

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

  internal :inviter, type: User
  
  output :notification, type: Notification

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

Predicate methods​

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

# ...

internal :full_name, type: String

# ...

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