Class: ActiveInteractor::Context::Base

Inherits:

OpenStruct

• Object
• OpenStruct
• ActiveInteractor::Context::Base

Extended by:

Attributes::ClassMethods

Includes:

Attributes, Errors, Status, ActiveModel::Attributes, ActiveModel::Validations

Defined in:

lib/active_interactor/context/base.rb

Overview

The base context class all context objects should inherit from.

Author:

• Aaron Allen hello@aaronmallen.me

Since:

• 0.1.0

Class Method Summary

• .attribute(name, type = Type::Value.new, **options) ⇒ Object
• .attribute_method?(attribute) ⇒ Object
• .attribute_missing(match, *args, &block) ⇒ Object
• .attribute_names ⇒ Object
• .attributes(*attributes) ⇒ Array<Symbol> extended from Attributes::ClassMethods

  Get or set attributes on a context class.

• .clear_validators!(attribute) ⇒ Object
• .method_missing(method, *args, &block) ⇒ Object
• .respond_to?(method, include_private_methods = false) ⇒ Object
• .respond_to_without_attributes?(method, include_private_methods = false) ⇒ Object
• .validate(*args, &block) ⇒ Object
• .validates(*attributes) ⇒ Object
• .validates!(*attributes) ⇒ Object
• .validates_absence_of(*attr_names) ⇒ Object
• .validates_acceptance_of(*attr_names) ⇒ Object
• .validates_confirmation_of(*attr_names) ⇒ Object
• .validates_each(*attr_names, &block) ⇒ Object
• .validates_exclusion_of(*attr_names) ⇒ Object
• .validates_format_of(*attr_names) ⇒ Object
• .validates_inclusion_of(*attr_names) ⇒ Object
• .validates_length_of(*attr_names) ⇒ Object
• .validates_numericality_of(*attr_names) ⇒ Object
• .validates_presence_of(*attr_names) ⇒ Object
• .validates_size_of(*attr_names) ⇒ Object
• .validates_with(*args, &block) ⇒ Object
• .validators ⇒ Object
• .validators_on(*attributes) ⇒ Object

Instance Method Summary

• #[](name) ⇒ Object included from Attributes

  Returns the value of an attribute.

• #[]=(name, value) ⇒ Object included from Attributes

  Sets value of a Hash attribute in context.attributes.

• #attribute?(attr_name) ⇒ Boolean (also: #has_attribute?) included from Attributes

  Check if the context instance has an attribute.

• #attribute_missing(match, *args, &block) ⇒ Object
• #attribute_names ⇒ Object
• #attributes ⇒ Hash{Symbol => *} included from Attributes

  Get values defined on the instance of context whose keys are defined on the context class' .attributes.

• #called!(interactor) ⇒ Array<Class> included from Status

  Add an instance of interactor to the list of interactors called on the context.

• #errors ⇒ Object
• #fail!(errors = nil) ⇒ Object included from Status

  Fail the context instance.

• #failure? ⇒ Boolean (also: #fail?) included from Status

  Whether the context instance has failed.

• #failure_errors ⇒ ActiveModel::Errors included from Errors private

  Generic errors generated outside of validation.

• #initialize(context = {}) ⇒ Base included from Attributes

  Initialize a new instance of Base.

• #invalid?(context = nil) ⇒ Object
• #merge!(context) ⇒ self included from Attributes

  Merge an instance of context into the calling context instance.

• #method_missing(method, *args, &block) ⇒ Object
• #resolve ⇒ self included from Status

  Resolve an instance of context.

• #respond_to?(method, include_private_methods = false) ⇒ Object
• #respond_to_without_attributes?(method, include_private_methods = false) ⇒ Object
• #rollback! ⇒ Boolean included from Status

  Rollback an instance of context.

• #success? ⇒ Boolean (also: #successful?) included from Status

  Whether the context instance is successful.

• #valid?(context = nil) ⇒ Object
• #validate(context = nil) ⇒ Object
• #validate!(context = nil) ⇒ Object
• #validates_absence_of(*attr_names) ⇒ Object
• #validates_acceptance_of(*attr_names) ⇒ Object
• #validates_confirmation_of(*attr_names) ⇒ Object
• #validates_exclusion_of(*attr_names) ⇒ Object
• #validates_format_of(*attr_names) ⇒ Object
• #validates_inclusion_of(*attr_names) ⇒ Object
• #validates_length_of(*attr_names) ⇒ Object
• #validates_numericality_of(*attr_names) ⇒ Object
• #validates_presence_of(*attr_names) ⇒ Object
• #validates_size_of(*attr_names) ⇒ Object
• #validates_with(*args, &block) ⇒ Object

Dynamic Method Handling

This class handles dynamic methods through the method_missing method

#method_missing(method, *args, &block) ⇒ Object

See Also:

• ActiveModel::AttributeMethods#method_missing

Since:

• 1.0.1

# File 'lib/active_interactor/context/base.rb', line 323

class Base < OpenStruct
  extend ActiveInteractor::Context::Attributes::ClassMethods

  include ActiveModel::Attributes
  include ActiveModel::Validations
  include ActiveInteractor::Context::Attributes
  include ActiveInteractor::Context::Errors
  include ActiveInteractor::Context::Status
end

Class Method Details

.attribute(name, type = Type::Value.new, **options) ⇒ Object

Examples:

Setting default values on the context class

class MyContext < ActiveInteractor::Context::Base
  attribute :first_name, default: -> { 'Aaron' }
end

MyContext.new
#=> <#MyContext first_name='Aaron'>

MyContext.new(first_name: 'Bob')
#=> <#MyContext first_name='Bob'>

See Also:

• ActiveModel::Attributes::ClassMethods#attribute

Since:

• 1.0.1

# File 'lib/active_interactor/context/base.rb', line 323

class Base < OpenStruct
  extend ActiveInteractor::Context::Attributes::ClassMethods

  include ActiveModel::Attributes
  include ActiveModel::Validations
  include ActiveInteractor::Context::Attributes
  include ActiveInteractor::Context::Errors
  include ActiveInteractor::Context::Status
end

.attribute_method?(attribute) ⇒ Object

See Also:

• ActiveModel::Validations::ClassMethods#attribute_method?

Since:

• 0.1.0

# File 'lib/active_interactor/context/base.rb', line 323

class Base < OpenStruct
  extend ActiveInteractor::Context::Attributes::ClassMethods

  include ActiveModel::Attributes
  include ActiveModel::Validations
  include ActiveInteractor::Context::Attributes
  include ActiveInteractor::Context::Errors
  include ActiveInteractor::Context::Status
end

.attribute_missing(match, *args, &block) ⇒ Object

See Also:

• ActiveModel::AttributeMethods#attribute_missing

Since:

• 1.0.1

# File 'lib/active_interactor/context/base.rb', line 323

class Base < OpenStruct
  extend ActiveInteractor::Context::Attributes::ClassMethods

  include ActiveModel::Attributes
  include ActiveModel::Validations
  include ActiveInteractor::Context::Attributes
  include ActiveInteractor::Context::Errors
  include ActiveInteractor::Context::Status
end

.attribute_names ⇒ Object

See Also:

• ActiveModel::Attributes::ClassMethods#attribute_names

Since:

• 1.0.1

# File 'lib/active_interactor/context/base.rb', line 323

class Base < OpenStruct
  extend ActiveInteractor::Context::Attributes::ClassMethods

  include ActiveModel::Attributes
  include ActiveModel::Validations
  include ActiveInteractor::Context::Attributes
  include ActiveInteractor::Context::Errors
  include ActiveInteractor::Context::Status
end

.attributes(*attributes) ⇒ Array<Symbol> Originally defined in module Attributes::ClassMethods

Get or set attributes on a context class

Examples:

Set attributes on a context class

class MyContext < ActiveInteractor::Context::Base
  attributes :first_name, :last_name
end

Get attributes defined on a context class

MyContext.attributes
#=> [:first_name, :last_name]

Set defaults for attributes on a context class

class MyContext < ActiveInteractor::Context::Base
  attributes first_name: { default: -> { 'Aaron' } }, last_name: { default: -> { 'Allen' } }
end

Returns:

• (Array<Symbol>) —

  the defined attributes

Since:

• 0.1.4

.clear_validators!(attribute) ⇒ Object

See Also:

• ActiveModel::Validations::ClassMethods#clear_validators!

Since:

• 0.1.0

# File 'lib/active_interactor/context/base.rb', line 323

class Base < OpenStruct
  extend ActiveInteractor::Context::Attributes::ClassMethods

  include ActiveModel::Attributes
  include ActiveModel::Validations
  include ActiveInteractor::Context::Attributes
  include ActiveInteractor::Context::Errors
  include ActiveInteractor::Context::Status
end

.method_missing(method, *args, &block) ⇒ Object

See Also:

• ActiveModel::AttributeMethods#method_missing

Since:

• 1.0.1

# File 'lib/active_interactor/context/base.rb', line 323

class Base < OpenStruct
  extend ActiveInteractor::Context::Attributes::ClassMethods

  include ActiveModel::Attributes
  include ActiveModel::Validations
  include ActiveInteractor::Context::Attributes
  include ActiveInteractor::Context::Errors
  include ActiveInteractor::Context::Status
end

.respond_to?(method, include_private_methods = false) ⇒ Object

See Also:

• ActiveModel::AttributeMethods#respond_to?

Since:

• 1.0.1

# File 'lib/active_interactor/context/base.rb', line 323

class Base < OpenStruct
  extend ActiveInteractor::Context::Attributes::ClassMethods

  include ActiveModel::Attributes
  include ActiveModel::Validations
  include ActiveInteractor::Context::Attributes
  include ActiveInteractor::Context::Errors
  include ActiveInteractor::Context::Status
end

.respond_to_without_attributes?(method, include_private_methods = false) ⇒ Object

See Also:

• ActiveModel::AttributeMethods#respond_to_without_attributes?

Since:

• 1.0.1

# File 'lib/active_interactor/context/base.rb', line 323

class Base < OpenStruct
  extend ActiveInteractor::Context::Attributes::ClassMethods

  include ActiveModel::Attributes
  include ActiveModel::Validations
  include ActiveInteractor::Context::Attributes
  include ActiveInteractor::Context::Errors
  include ActiveInteractor::Context::Status
end

.validate(*args, &block) ⇒ Object

See Also:

• ActiveModel::Validations::ClassMethods#validate

Since:

• 0.1.0

# File 'lib/active_interactor/context/base.rb', line 323

class Base < OpenStruct
  extend ActiveInteractor::Context::Attributes::ClassMethods

  include ActiveModel::Attributes
  include ActiveModel::Validations
  include ActiveInteractor::Context::Attributes
  include ActiveInteractor::Context::Errors
  include ActiveInteractor::Context::Status
end

.validates(*attributes) ⇒ Object

See Also:

• ActiveModel::Validations::ClassMethods#validates

Since:

• 0.1.0

# File 'lib/active_interactor/context/base.rb', line 323

class Base < OpenStruct
  extend ActiveInteractor::Context::Attributes::ClassMethods

  include ActiveModel::Attributes
  include ActiveModel::Validations
  include ActiveInteractor::Context::Attributes
  include ActiveInteractor::Context::Errors
  include ActiveInteractor::Context::Status
end

.validates!(*attributes) ⇒ Object

See Also:

• ActiveModel::Validations::ClassMethods#validates!

Since:

• 0.1.0

# File 'lib/active_interactor/context/base.rb', line 323

class Base < OpenStruct
  extend ActiveInteractor::Context::Attributes::ClassMethods

  include ActiveModel::Attributes
  include ActiveModel::Validations
  include ActiveInteractor::Context::Attributes
  include ActiveInteractor::Context::Errors
  include ActiveInteractor::Context::Status
end

.validates_absence_of(*attr_names) ⇒ Object

See Also:

• ActiveModel::Validations::HelperMethods#validates_absence_of

Since:

• 0.1.0

# File 'lib/active_interactor/context/base.rb', line 323

class Base < OpenStruct
  extend ActiveInteractor::Context::Attributes::ClassMethods

  include ActiveModel::Attributes
  include ActiveModel::Validations
  include ActiveInteractor::Context::Attributes
  include ActiveInteractor::Context::Errors
  include ActiveInteractor::Context::Status
end

.validates_acceptance_of(*attr_names) ⇒ Object

See Also:

• ActiveModel::Validations::HelperMethods#validates_acceptance_of

Since:

• 0.1.0

# File 'lib/active_interactor/context/base.rb', line 323

class Base < OpenStruct
  extend ActiveInteractor::Context::Attributes::ClassMethods

  include ActiveModel::Attributes
  include ActiveModel::Validations
  include ActiveInteractor::Context::Attributes
  include ActiveInteractor::Context::Errors
  include ActiveInteractor::Context::Status
end

.validates_confirmation_of(*attr_names) ⇒ Object

See Also:

• ActiveModel::Validations::HelperMethods#validates_confirmation_of

Since:

• 0.1.0

# File 'lib/active_interactor/context/base.rb', line 323

class Base < OpenStruct
  extend ActiveInteractor::Context::Attributes::ClassMethods

  include ActiveModel::Attributes
  include ActiveModel::Validations
  include ActiveInteractor::Context::Attributes
  include ActiveInteractor::Context::Errors
  include ActiveInteractor::Context::Status
end

.validates_each(*attr_names, &block) ⇒ Object

See Also:

• ActiveModel::Validations::ClassMethods#validates_each

Since:

• 0.1.0

# File 'lib/active_interactor/context/base.rb', line 323

class Base < OpenStruct
  extend ActiveInteractor::Context::Attributes::ClassMethods

  include ActiveModel::Attributes
  include ActiveModel::Validations
  include ActiveInteractor::Context::Attributes
  include ActiveInteractor::Context::Errors
  include ActiveInteractor::Context::Status
end

.validates_exclusion_of(*attr_names) ⇒ Object

See Also:

• ActiveModel::Validations::HelperMethods#validates_exclusion_of

Since:

• 0.1.0

# File 'lib/active_interactor/context/base.rb', line 323

class Base < OpenStruct
  extend ActiveInteractor::Context::Attributes::ClassMethods

  include ActiveModel::Attributes
  include ActiveModel::Validations
  include ActiveInteractor::Context::Attributes
  include ActiveInteractor::Context::Errors
  include ActiveInteractor::Context::Status
end

.validates_format_of(*attr_names) ⇒ Object

See Also:

• ActiveModel::Validations::HelperMethods#validates_format_of

Since:

• 0.1.0

# File 'lib/active_interactor/context/base.rb', line 323

class Base < OpenStruct
  extend ActiveInteractor::Context::Attributes::ClassMethods

  include ActiveModel::Attributes
  include ActiveModel::Validations
  include ActiveInteractor::Context::Attributes
  include ActiveInteractor::Context::Errors
  include ActiveInteractor::Context::Status
end

.validates_inclusion_of(*attr_names) ⇒ Object

See Also:

• ActiveModel::Validations::HelperMethods#validates_inclusion_of

Since:

• 0.1.0

# File 'lib/active_interactor/context/base.rb', line 323

class Base < OpenStruct
  extend ActiveInteractor::Context::Attributes::ClassMethods

  include ActiveModel::Attributes
  include ActiveModel::Validations
  include ActiveInteractor::Context::Attributes
  include ActiveInteractor::Context::Errors
  include ActiveInteractor::Context::Status
end

.validates_length_of(*attr_names) ⇒ Object

See Also:

• ActiveModel::Validations::HelperMethods#validates_length_of

Since:

• 0.1.0

# File 'lib/active_interactor/context/base.rb', line 323

class Base < OpenStruct
  extend ActiveInteractor::Context::Attributes::ClassMethods

  include ActiveModel::Attributes
  include ActiveModel::Validations
  include ActiveInteractor::Context::Attributes
  include ActiveInteractor::Context::Errors
  include ActiveInteractor::Context::Status
end

.validates_numericality_of(*attr_names) ⇒ Object

See Also:

• ActiveModel::Validations::HelperMethods#validates_numericality_of

Since:

• 0.1.0

# File 'lib/active_interactor/context/base.rb', line 323

class Base < OpenStruct
  extend ActiveInteractor::Context::Attributes::ClassMethods

  include ActiveModel::Attributes
  include ActiveModel::Validations
  include ActiveInteractor::Context::Attributes
  include ActiveInteractor::Context::Errors
  include ActiveInteractor::Context::Status
end

.validates_presence_of(*attr_names) ⇒ Object

See Also:

• ActiveModel::Validations::HelperMethods#validates_presence_of

Since:

• 0.1.0

# File 'lib/active_interactor/context/base.rb', line 323

class Base < OpenStruct
  extend ActiveInteractor::Context::Attributes::ClassMethods

  include ActiveModel::Attributes
  include ActiveModel::Validations
  include ActiveInteractor::Context::Attributes
  include ActiveInteractor::Context::Errors
  include ActiveInteractor::Context::Status
end

.validates_size_of(*attr_names) ⇒ Object

See Also:

• ActiveModel::Validations::HelperMethods#validates_size_of

Since:

• 0.1.0

# File 'lib/active_interactor/context/base.rb', line 323

class Base < OpenStruct
  extend ActiveInteractor::Context::Attributes::ClassMethods

  include ActiveModel::Attributes
  include ActiveModel::Validations
  include ActiveInteractor::Context::Attributes
  include ActiveInteractor::Context::Errors
  include ActiveInteractor::Context::Status
end

.validates_with(*args, &block) ⇒ Object

See Also:

• ActiveModel::Validations::ClassMethods#validates_with

Since:

• 0.1.0

# File 'lib/active_interactor/context/base.rb', line 323

class Base < OpenStruct
  extend ActiveInteractor::Context::Attributes::ClassMethods

  include ActiveModel::Attributes
  include ActiveModel::Validations
  include ActiveInteractor::Context::Attributes
  include ActiveInteractor::Context::Errors
  include ActiveInteractor::Context::Status
end

.validators ⇒ Object

See Also:

• ActiveModel::Validations::ClassMethods#validators

Since:

• 0.1.0

# File 'lib/active_interactor/context/base.rb', line 323

class Base < OpenStruct
  extend ActiveInteractor::Context::Attributes::ClassMethods

  include ActiveModel::Attributes
  include ActiveModel::Validations
  include ActiveInteractor::Context::Attributes
  include ActiveInteractor::Context::Errors
  include ActiveInteractor::Context::Status
end

.validators_on(*attributes) ⇒ Object

See Also:

• ActiveModel::Validations::ClassMethods#validators_on

Since:

• 0.1.0

# File 'lib/active_interactor/context/base.rb', line 323

class Base < OpenStruct
  extend ActiveInteractor::Context::Attributes::ClassMethods

  include ActiveModel::Attributes
  include ActiveModel::Validations
  include ActiveInteractor::Context::Attributes
  include ActiveInteractor::Context::Errors
  include ActiveInteractor::Context::Status
end

Instance Method Details

#[](name) ⇒ Object Originally defined in module Attributes

Returns the value of an attribute

Parameters:

• name (String, Symbol) —

  the key of the value to be returned

Since:

• 1.0.5

#[]=(name, value) ⇒ Object Originally defined in module Attributes

Sets value of a Hash attribute in context.attributes

Parameters:

• name (String, Symbol) —

  the key name of the attribute

• value (*) —

  the value to be given attribute name

Since:

• 1.1.0

#attribute?(attr_name) ⇒ Boolean Also known as: has_attribute? Originally defined in module Attributes

Check if the context instance has an attribute

Parameters:

• attr_name (Symbol, String) —

  the name of the attribute to check

Returns:

• (Boolean) —

  whether or not the context instance has the attribute

Since:

• 1.0.1

#attribute_missing(match, *args, &block) ⇒ Object

See Also:

• ActiveModel::AttributeMethods#attribute_missing

Since:

• 1.0.1

# File 'lib/active_interactor/context/base.rb', line 323

class Base < OpenStruct
  extend ActiveInteractor::Context::Attributes::ClassMethods

  include ActiveModel::Attributes
  include ActiveModel::Validations
  include ActiveInteractor::Context::Attributes
  include ActiveInteractor::Context::Errors
  include ActiveInteractor::Context::Status
end

#attribute_names ⇒ Object

See Also:

• ActiveModel::Attributes::ClassMethods#attribute_names

Since:

• 1.0.1

# File 'lib/active_interactor/context/base.rb', line 323

class Base < OpenStruct
  extend ActiveInteractor::Context::Attributes::ClassMethods

  include ActiveModel::Attributes
  include ActiveModel::Validations
  include ActiveInteractor::Context::Attributes
  include ActiveInteractor::Context::Errors
  include ActiveInteractor::Context::Status
end

#attributes ⇒ Hash{Symbol => *} Originally defined in module Attributes

Get values defined on the instance of context whose keys are defined on the context class' .attributes

Examples:

Get attributes defined on an instance of context

class MyContext < ActiveInteractor::Context::Base
  attributes :first_name, :last_name
end

context = MyContext.new(first_name: 'Aaron', last_name: 'Allen', occupation: 'Ruby Nerd')
#=> <#MyContext first_name='Aaron' last_name='Allen' occupation='Ruby Nerd')

context.attributes
#=> { first_name: 'Aaron', last_name: 'Allen' }

context.occupation
#=> 'Ruby Nerd'

Returns:

• (Hash{Symbol => *}) —

  the defined attributes and values

Since:

• 0.1.4

#called!(interactor) ⇒ Array<Class> Originally defined in module Status

Add an instance of interactor to the list of interactors called on the context. This list is used when #rollback! is called on a context instance.

Parameters:

• interactor (Class) —

  an interactor instance

Returns:

• (Array<Class>) —

  the list of called interactors

Since:

• 0.1.0

#errors ⇒ Object

See Also:

• ActiveModel::Validations#errors

Since:

• 0.1.0

# File 'lib/active_interactor/context/base.rb', line 323

class Base < OpenStruct
  extend ActiveInteractor::Context::Attributes::ClassMethods

  include ActiveModel::Attributes
  include ActiveModel::Validations
  include ActiveInteractor::Context::Attributes
  include ActiveInteractor::Context::Errors
  include ActiveInteractor::Context::Status
end

#fail!(errors = nil) ⇒ Object Originally defined in module Status

Fail the context instance. Failing an instance raises an error that may be rescued by the calling interactor. The instance is also flagged as having failed.

Examples:

Fail an interactor context

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

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

Parameters:

• errors (ActiveModel::Errors, String) (defaults to: nil) —

  error messages for the failure

Raises:

• (Error::ContextFailure)

See Also:

• ActiveModel::Errors

Since:

• 0.1.0

#failure? ⇒ Boolean Also known as: fail? Originally defined in module Status

Note:

The #failure? method is the inverse of the #success? method

Whether the context instance has failed. By default, a new instance is successful and only changes when explicitly failed.

Examples:

Check if a context has failed

result = MyInteractor.perform
result.failure?
#=> false

Returns:

• (Boolean) —

  false by default or true if failed.

Since:

• 0.1.0

#failure_errors ⇒ ActiveModel::Errors Originally defined in module Errors

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.

Generic errors generated outside of validation.

Returns:

• (ActiveModel::Errors) —

  an instance of ActiveModel::Errors

Since:

• 1.0.3

#initialize(context = {}) ⇒ Base Originally defined in module Attributes

Initialize a new instance of Base

Parameters:

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

  attributes to assign to the context

Returns:

• (Base) —

  a new instance of Base

Since:

• 0.1.4

#invalid?(context = nil) ⇒ Object

See Also:

• ActiveModel::Validations#invalid?

Since:

• 0.1.0

# File 'lib/active_interactor/context/base.rb', line 323

class Base < OpenStruct
  extend ActiveInteractor::Context::Attributes::ClassMethods

  include ActiveModel::Attributes
  include ActiveModel::Validations
  include ActiveInteractor::Context::Attributes
  include ActiveInteractor::Context::Errors
  include ActiveInteractor::Context::Status
end

#merge!(context) ⇒ self Originally defined in module Attributes

Merge an instance of context into the calling context instance

Examples:

context = MyContext.new(first_name: 'Aaron', last_name: 'Allen')
other_context = MyContext.new(last_name: 'Awesome')
context.merge!(other_context)
#=> <#MyContext first_name='Aaron' last_name='Awesome'>

Parameters:

• context (Class) —

  a context instance to be merged

Returns:

• (self) —

  the context instance

Since:

• 1.0.0

#resolve ⇒ self Originally defined in module Status

Resolve an instance of context. Called when an interactor is finished with it's context.

Returns:

• (self) —

  the instance of context

Since:

• 1.0.3

#respond_to?(method, include_private_methods = false) ⇒ Object

See Also:

• ActiveModel::AttributeMethods#respond_to?

Since:

• 1.0.1

# File 'lib/active_interactor/context/base.rb', line 323

class Base < OpenStruct
  extend ActiveInteractor::Context::Attributes::ClassMethods

  include ActiveModel::Attributes
  include ActiveModel::Validations
  include ActiveInteractor::Context::Attributes
  include ActiveInteractor::Context::Errors
  include ActiveInteractor::Context::Status
end

#respond_to_without_attributes?(method, include_private_methods = false) ⇒ Object

See Also:

• ActiveModel::AttributeMethods#respond_to_without_attributes?

Since:

• 1.0.1

# File 'lib/active_interactor/context/base.rb', line 323

class Base < OpenStruct
  extend ActiveInteractor::Context::Attributes::ClassMethods

  include ActiveModel::Attributes
  include ActiveModel::Validations
  include ActiveInteractor::Context::Attributes
  include ActiveInteractor::Context::Errors
  include ActiveInteractor::Context::Status
end

#rollback! ⇒ Boolean Originally defined in module Status

Rollback an instance of context. Any interactors the instance has been passed via the #called! method are asked to roll themselves back by invoking their #rollback methods. The instance is also flagged as rolled back.

Returns:

• (Boolean) —

  true if rolled back successfully or false if already rolled back

Since:

• 0.1.0

#success? ⇒ Boolean Also known as: successful? Originally defined in module Status

Note:

The #success? method is the inverse of the #failure? method

Whether the context instance is successful. By default, a new instance is successful and only changes when explicitly failed.

Examples:

Check if a context has failed

result = MyInteractor.perform
result.success?
#=> true

Returns:

• (Boolean) —

  true by default or false if failed

Since:

• 0.1.0

#valid?(context = nil) ⇒ Object

See Also:

• ActiveModel::Validations#valid?

Since:

• 0.1.0

# File 'lib/active_interactor/context/base.rb', line 323

class Base < OpenStruct
  extend ActiveInteractor::Context::Attributes::ClassMethods

  include ActiveModel::Attributes
  include ActiveModel::Validations
  include ActiveInteractor::Context::Attributes
  include ActiveInteractor::Context::Errors
  include ActiveInteractor::Context::Status
end

#validate(context = nil) ⇒ Object

See Also:

• ActiveModel::Validations#validate

Since:

• 0.1.0

# File 'lib/active_interactor/context/base.rb', line 323

class Base < OpenStruct
  extend ActiveInteractor::Context::Attributes::ClassMethods

  include ActiveModel::Attributes
  include ActiveModel::Validations
  include ActiveInteractor::Context::Attributes
  include ActiveInteractor::Context::Errors
  include ActiveInteractor::Context::Status
end

#validate!(context = nil) ⇒ Object

See Also:

• ActiveModel::Validations#validate!

Since:

• 0.1.0

# File 'lib/active_interactor/context/base.rb', line 323

class Base < OpenStruct
  extend ActiveInteractor::Context::Attributes::ClassMethods

  include ActiveModel::Attributes
  include ActiveModel::Validations
  include ActiveInteractor::Context::Attributes
  include ActiveInteractor::Context::Errors
  include ActiveInteractor::Context::Status
end

#validates_absence_of(*attr_names) ⇒ Object

See Also:

• ActiveModel::Validations::HelperMethods#validates_absence_of

Since:

• 0.1.0

# File 'lib/active_interactor/context/base.rb', line 323

class Base < OpenStruct
  extend ActiveInteractor::Context::Attributes::ClassMethods

  include ActiveModel::Attributes
  include ActiveModel::Validations
  include ActiveInteractor::Context::Attributes
  include ActiveInteractor::Context::Errors
  include ActiveInteractor::Context::Status
end

#validates_acceptance_of(*attr_names) ⇒ Object

See Also:

• ActiveModel::Validations::HelperMethods#validates_acceptance_of

Since:

• 0.1.0

# File 'lib/active_interactor/context/base.rb', line 323

class Base < OpenStruct
  extend ActiveInteractor::Context::Attributes::ClassMethods

  include ActiveModel::Attributes
  include ActiveModel::Validations
  include ActiveInteractor::Context::Attributes
  include ActiveInteractor::Context::Errors
  include ActiveInteractor::Context::Status
end

#validates_confirmation_of(*attr_names) ⇒ Object

See Also:

• ActiveModel::Validations::HelperMethods#validates_confirmation_of

Since:

• 0.1.0

# File 'lib/active_interactor/context/base.rb', line 323

class Base < OpenStruct
  extend ActiveInteractor::Context::Attributes::ClassMethods

  include ActiveModel::Attributes
  include ActiveModel::Validations
  include ActiveInteractor::Context::Attributes
  include ActiveInteractor::Context::Errors
  include ActiveInteractor::Context::Status
end

#validates_exclusion_of(*attr_names) ⇒ Object

See Also:

• ActiveModel::Validations::HelperMethods#validates_exclusion_of

Since:

• 0.1.0

# File 'lib/active_interactor/context/base.rb', line 323

class Base < OpenStruct
  extend ActiveInteractor::Context::Attributes::ClassMethods

  include ActiveModel::Attributes
  include ActiveModel::Validations
  include ActiveInteractor::Context::Attributes
  include ActiveInteractor::Context::Errors
  include ActiveInteractor::Context::Status
end

#validates_format_of(*attr_names) ⇒ Object

See Also:

• ActiveModel::Validations::HelperMethods#validates_format_of

Since:

• 0.1.0

# File 'lib/active_interactor/context/base.rb', line 323

class Base < OpenStruct
  extend ActiveInteractor::Context::Attributes::ClassMethods

  include ActiveModel::Attributes
  include ActiveModel::Validations
  include ActiveInteractor::Context::Attributes
  include ActiveInteractor::Context::Errors
  include ActiveInteractor::Context::Status
end

#validates_inclusion_of(*attr_names) ⇒ Object

See Also:

• ActiveModel::Validations::HelperMethods#validates_inclusion_of

Since:

• 0.1.0

# File 'lib/active_interactor/context/base.rb', line 323

class Base < OpenStruct
  extend ActiveInteractor::Context::Attributes::ClassMethods

  include ActiveModel::Attributes
  include ActiveModel::Validations
  include ActiveInteractor::Context::Attributes
  include ActiveInteractor::Context::Errors
  include ActiveInteractor::Context::Status
end

#validates_length_of(*attr_names) ⇒ Object

See Also:

• ActiveModel::Validations::HelperMethods#validates_length_of

Since:

• 0.1.0

# File 'lib/active_interactor/context/base.rb', line 323

class Base < OpenStruct
  extend ActiveInteractor::Context::Attributes::ClassMethods

  include ActiveModel::Attributes
  include ActiveModel::Validations
  include ActiveInteractor::Context::Attributes
  include ActiveInteractor::Context::Errors
  include ActiveInteractor::Context::Status
end

#validates_numericality_of(*attr_names) ⇒ Object

See Also:

• ActiveModel::Validations::HelperMethods#validates_numericality_of

Since:

• 0.1.0

# File 'lib/active_interactor/context/base.rb', line 323

class Base < OpenStruct
  extend ActiveInteractor::Context::Attributes::ClassMethods

  include ActiveModel::Attributes
  include ActiveModel::Validations
  include ActiveInteractor::Context::Attributes
  include ActiveInteractor::Context::Errors
  include ActiveInteractor::Context::Status
end

#validates_presence_of(*attr_names) ⇒ Object

See Also:

• ActiveModel::Validations::HelperMethods#validates_presence_of

Since:

• 0.1.0

# File 'lib/active_interactor/context/base.rb', line 323

class Base < OpenStruct
  extend ActiveInteractor::Context::Attributes::ClassMethods

  include ActiveModel::Attributes
  include ActiveModel::Validations
  include ActiveInteractor::Context::Attributes
  include ActiveInteractor::Context::Errors
  include ActiveInteractor::Context::Status
end

#validates_size_of(*attr_names) ⇒ Object

See Also:

• ActiveModel::Validations::HelperMethods#validates_size_of

Since:

• 0.1.0

# File 'lib/active_interactor/context/base.rb', line 323

class Base < OpenStruct
  extend ActiveInteractor::Context::Attributes::ClassMethods

  include ActiveModel::Attributes
  include ActiveModel::Validations
  include ActiveInteractor::Context::Attributes
  include ActiveInteractor::Context::Errors
  include ActiveInteractor::Context::Status
end

#validates_with(*args, &block) ⇒ Object

See Also:

• ActiveModel::Validations#validates_with

Since:

• 0.1.0

# File 'lib/active_interactor/context/base.rb', line 323

class Base < OpenStruct
  extend ActiveInteractor::Context::Attributes::ClassMethods

  include ActiveModel::Attributes
  include ActiveModel::Validations
  include ActiveInteractor::Context::Attributes
  include ActiveInteractor::Context::Errors
  include ActiveInteractor::Context::Status
end