Class: ActiveInteractor::Interactor::Perform::Options

Inherits:

Object

• Object
• ActiveInteractor::Interactor::Perform::Options

Includes:

Configurable

Defined in:

lib/active_interactor/interactor/perform.rb

Overview

Interactor #perform options

Author:

• Aaron Allen hello@aaronmallen.me

Since:

• 1.0.0

Instance Attribute Summary

• #skip_each_perform_callbacks ⇒ Boolean

  if true an organizer will be instructed to skip each_perform callbacks.

• #skip_perform_callbacks ⇒ Boolean

  if true an interactor will be instructed to skip perform callbacks.

• #skip_rollback ⇒ Boolean

  if true an interactor will be instructed to skip #rollback on context failure.

• #skip_rollback_callbacks ⇒ Boolean

  if true an interactor will be instructed to skip rollback callbacks on context failure.

• #validate ⇒ Boolean

  if false an interactor will not run validations.

• #validate_on_called ⇒ Boolean

  if false an interactor will not run validations with the validation context :called.

• #validate_on_calling ⇒ Boolean

  if false an interactor will not run validations with the validation context :calling.

Instance Method Summary

• #initialize(options = {}) ⇒ Options constructor

  Initialize a new instance of Options.

Constructor Details

#initialize(options = {}) ⇒ Options

Initialize a new instance of ActiveInteractor::Interactor::Perform::Options

Parameters:

• options (Hash{Symbol=>*}) (defaults to: {}) —

  the attributes to assign to ActiveInteractor::Interactor::Perform::Options

Options Hash (options):

• :skip_each_perform_callbacks (Boolean) — default: false —

  the #skip_each_perform_callbacks attribute

• :skip_perform_callbacks (Boolean) — default: false —

  the #skip_perform_callbacks attribute

• :skip_rollback (Boolean) — default: false —

  the #skip_rollback attribute

• :skip_rollback_callbacks (Boolean) — default: false —

  the #skip_rollback_callbacks attribute

• :validate (Boolean) — default: true —

  the #validate attribute

• :validate_on_calling (Boolean) — default: true —

  the #validate_on_calling attribute

• :validate_on_called (Boolean) — default: true —

  the #validate_on_called attribute

Since:

• 1.0.0

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

class Options
  include ActiveInteractor::Configurable
  defaults skip_each_perform_callbacks: false, skip_perform_callbacks: false, skip_rollback: false,
           skip_rollback_callbacks: false, validate: true, validate_on_calling: true, validate_on_called: true
end

Instance Attribute Details

#skip_each_perform_callbacks ⇒ Boolean

if true an organizer will be instructed to skip each_perform callbacks.

Returns:

• (Boolean) —

  whether or not to skip each_perform callbacks

Since:

• 1.0.0

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

class Options
  include ActiveInteractor::Configurable
  defaults skip_each_perform_callbacks: false, skip_perform_callbacks: false, skip_rollback: false,
           skip_rollback_callbacks: false, validate: true, validate_on_calling: true, validate_on_called: true
end

#skip_perform_callbacks ⇒ Boolean

if true an interactor will be instructed to skip perform callbacks.

Returns:

• (Boolean) —

  whether or not to skip perform callbacks.

Since:

• 1.0.0

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

class Options
  include ActiveInteractor::Configurable
  defaults skip_each_perform_callbacks: false, skip_perform_callbacks: false, skip_rollback: false,
           skip_rollback_callbacks: false, validate: true, validate_on_calling: true, validate_on_called: true
end

#skip_rollback ⇒ Boolean

if true an interactor will be instructed to skip #rollback on context failure.

Returns:

• (Boolean) —

  whether or not to skip #rollback

Since:

• 1.0.0

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

class Options
  include ActiveInteractor::Configurable
  defaults skip_each_perform_callbacks: false, skip_perform_callbacks: false, skip_rollback: false,
           skip_rollback_callbacks: false, validate: true, validate_on_calling: true, validate_on_called: true
end

#skip_rollback_callbacks ⇒ Boolean

if true an interactor will be instructed to skip rollback callbacks on context failure.

Returns:

• (Boolean) —

  whether or not to skip rollback callbacks.

Since:

• 1.0.0

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

class Options
  include ActiveInteractor::Configurable
  defaults skip_each_perform_callbacks: false, skip_perform_callbacks: false, skip_rollback: false,
           skip_rollback_callbacks: false, validate: true, validate_on_calling: true, validate_on_called: true
end

#validate ⇒ Boolean

if false an interactor will not run validations.

Returns:

• (Boolean) —

  whether or to run validations.

Since:

• 1.0.0

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

class Options
  include ActiveInteractor::Configurable
  defaults skip_each_perform_callbacks: false, skip_perform_callbacks: false, skip_rollback: false,
           skip_rollback_callbacks: false, validate: true, validate_on_calling: true, validate_on_called: true
end

#validate_on_called ⇒ Boolean

if false an interactor will not run validations with the validation context :called.

Returns:

• (Boolean) —

  whether or to run validation with the validation context :called.

Since:

• 1.0.0

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

class Options
  include ActiveInteractor::Configurable
  defaults skip_each_perform_callbacks: false, skip_perform_callbacks: false, skip_rollback: false,
           skip_rollback_callbacks: false, validate: true, validate_on_calling: true, validate_on_called: true
end

#validate_on_calling ⇒ Boolean

if false an interactor will not run validations with the validation context :calling.

Returns:

• (Boolean) —

  whether or to run validations with the validation context :calling

Since:

• 1.0.0

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

class Options
  include ActiveInteractor::Configurable
  defaults skip_each_perform_callbacks: false, skip_perform_callbacks: false, skip_rollback: false,
           skip_rollback_callbacks: false, validate: true, validate_on_calling: true, validate_on_called: true
end