Module: ActiveInteraction::Runnable Abstract

Extended by:
ActiveSupport::Concern
Includes:
ActiveModel::Validations
Included in:
Base
Defined in:
lib/active_interaction/concerns/runnable.rb

Overview

This module is abstract.

Include and override #execute to implement a custom Runnable class.

Note:

Must be included after ‘ActiveModel::Validations`.

Runs code and provides the result.

Since:

  • 1.0.0

Defined Under Namespace

Modules: ClassMethods

Instance Method Summary collapse

Instance Method Details

#errors ⇒ Errors

Returns:

Since:

  • 1.0.0



22
23
24
 
# File 'lib/active_interaction/concerns/runnable.rb', line 22

def errors
  @_interaction_errors
end

#execute ⇒ Object

This method is abstract.

Raises:

  • (NotImplementedError)

Since:

  • 1.0.0



29
30
31
 
# File 'lib/active_interaction/concerns/runnable.rb', line 29

def execute
  raise NotImplementedError
end

#result ⇒ Object?

Returns:

  • (Object) —

    If there are no validation errors.

  • (nil) —

    If there are validation errors.

Since:

  • 1.0.0



35
36
37
 
# File 'lib/active_interaction/concerns/runnable.rb', line 35

def result
  @_interaction_result
end

#result=(result) ⇒ Object?

Parameters:

  • result (Object)

Returns:

  • (Object) —

    If there are no validation errors.

  • (nil) —

    If there are validation errors.

Since:

  • 1.0.0



42
43
44
45
 
# File 'lib/active_interaction/concerns/runnable.rb', line 42

def result=(result)
  @_interaction_result = result
  @_interaction_valid = errors.empty?
end

#valid? ⇒ Boolean

Returns:

  • (Boolean)

Since:

  • 1.0.0



48
49
50
51
52
53
54
 
# File 'lib/active_interaction/concerns/runnable.rb', line 48

def valid?(*)
  if instance_variable_defined?(:@_interaction_valid)
    return @_interaction_valid
  end

  super
end