Module: ActiveInteractor::Interactor::Perform::ClassMethods

Included in:

Base

Defined in:

lib/active_interactor/interactor/perform.rb

Overview

Interactor perform class methods. Because ClassMethods is a module classes should extend ClassMethods rather than inherit from it.

Author:

• Aaron Allen hello@aaronmallen.me

Since:

• 1.0.0

Instance Method Summary

• #perform(context = {}, options = {}) ⇒ Class

  Initialize a new interactor instance and call its #perform method.

• #perform!(context = {}, options = {}) ⇒ Class

  Initialize a new interactor instance and call its #perform method without rescuing Error::ContextFailure.

Instance Method Details

#perform(context = {}, options = {}) ⇒ Class

Initialize a new interactor instance and call its #perform method. This is the default api to interact with all interactors.

Examples:

class MyInteractor < ActiveInteractor::Base
  def perform
    puts "I performed"
  end
end

MyInteractor.perform
"I performed"
#=> <#MyInteractor::Context>

Parameters:

• context (Hash, Class) (defaults to: {}) —

  attributes to assign to the interactor instance's context instance

• options (Hash, Perform::Options) (defaults to: {}) —

  options to use for the #perform. See Options

Returns:

• (Class) —

  an instance of the interactor class' context instance

Since:

• 0.1.0

# File 'lib/active_interactor/interactor/perform.rb', line 38

def perform(context = {}, options = {})
  new(context).with_options(options).execute_perform
end

#perform!(context = {}, options = {}) ⇒ Class

Initialize a new interactor instance and call its #perform method without rescuing Error::ContextFailure.

Examples:

Calling .perform! without failure

class MyInteractor < ActiveInteractor::Base
  def perform
    puts "I performed"
  end
end

MyInteractor.perform!
"I performed"
#=> <#MyInteractor::Context>

Calling .perform! with failure

class MyInteractor < ActiveInteractor::Base
  def perform
    context.fail!
  end
end

MyInteractor.perform!
ActiveInteractor::Error::ContextFailure "<#MyInteractor::Context>"

Parameters:

• context (Hash, Class) (defaults to: {}) —

  attributes to assign to the interactor instance's context instance

• options (Hash, Perform::Options) (defaults to: {}) —

  options to use for the #perform. See Options

Returns:

• (Class) —

  an instance of the interactor class' context instance

Raises:

• (Error::ContextFailure) —

  if the context instance fails.

Since:

• 0.1.0

# File 'lib/active_interactor/interactor/perform.rb', line 75

def perform!(context = {}, options = {})
  new(context).with_options(options).execute_perform!
end