Class: Interactor::Context

Inherits:
Object
  • Object
show all
Defined in:
lib/interactor/context.rb

Overview

Public: The object for tracking state of an Interactor’s invocation. The context is used to initialize the interactor with the information required for invocation. The interactor manipulates the context to produce the result of invocation.

The context is the mechanism by which success and failure are determined and the context is responsible for tracking individual interactor invocations for the purpose of rollback.

The context may be manipulated using arbitrary getter and setter methods.

Examples

context = Interactor::Context.new
# => #<Interactor::Context>
context.foo = "bar"
# => "bar"
context
# => #<Interactor::Context foo="bar">
context.hello = "world"
# => "world"
context
# => #<Interactor::Context foo="bar" hello="world">
context.foo = "baz"
# => "baz"
context
# => #<Interactor::Context foo="baz" hello="world">

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Instance Attribute Details

#error ⇒ Object

Returns the value of attribute error.



61
62
63
 
# File 'lib/interactor/context.rb', line 61

def error
  @error
end

#error_cause ⇒ Object

Returns the value of attribute error_cause.



61
62
63
 
# File 'lib/interactor/context.rb', line 61

def error_cause
  @error_cause
end

Class Method Details

.build(context = {}) ⇒ Object

Internal: Initialize an Interactor::Context or preserve an existing one. If the argument given is an Interactor::Context, the argument is returned. Otherwise, a new Interactor::Context is initialized from the provided hash.

The “build” method is used during interactor initialization.

context - A Hash whose key/value pairs are used in initializing a new

Interactor::Context object. If an existing Interactor::Context
is given, it is simply returned. (default: {})

Examples

context = Interactor::Context.build(foo: "bar")
# => #<Interactor::Context foo="bar">
context.object_id
# => 2170969340
context = Interactor::Context.build(context)
# => #<Interactor::Context foo="bar">
context.object_id
# => 2170969340

Returns the Interactor::Context.



55
56
57
58
59
 
# File 'lib/interactor/context.rb', line 55

def self.build(context = {})
  new.tap do |instance|
    instance.assign_attributes(context.to_h)
  end
end

Instance Method Details

#assign_attributes(params) ⇒ Object 



134
135
136
137
138
 
# File 'lib/interactor/context.rb', line 134

def assign_attributes(params)
  params.each do |attribute, value|
    self.send("#{attribute}=", value) if respond_to?(attribute)
  end
end

#fail!(params = {}) ⇒ Object

Public: Fail the Interactor::Context. Failing a context raises an error that may be rescued by the calling interactor. The context is also flagged as having failed.

Optionally the caller may provide a hash of key/value pairs to be merged into the context before failure.

context - A Hash whose key/value pairs are merged into the existing

Interactor::Context instance. (default: {})

Examples

context = Interactor::Context.new
# => #<Interactor::Context>
context.fail!
# => Interactor::Failure: #<Interactor::Context>
context.fail! rescue false
# => false
context.fail!(foo: "baz")
# => Interactor::Failure: #<Interactor::Context foo="baz">

Raises Interactor::Failure initialized with the Interactor::Context.

Raises:



128
129
130
131
132
 
# File 'lib/interactor/context.rb', line 128

def fail!(params = {})
  assign_attributes(params)
  @failure = true
  raise Failure, self
end

#failure? ⇒ Boolean

Public: Whether the Interactor::Context has failed. By default, a new context is successful and only changes when explicitly failed.

The “failure?” method is the inverse of the “success?” method.

Examples

context = Interactor::Context.new
# => #<Interactor::Context>
context.failure?
# => false
context.fail!
# => Interactor::Failure: #<Interactor::Context>
context.failure?
# => true

Returns false by default or true if failed.

Returns:

  • (Boolean) 


102
103
104
 
# File 'lib/interactor/context.rb', line 102

def failure?
  @failure || false
end

#success? ⇒ Boolean

Public: Whether the Interactor::Context is successful. By default, a new context is successful and only changes when explicitly failed.

The “success?” method is the inverse of the “failure?” method.

Examples

context = Interactor::Context.new
# => #<Interactor::Context>
context.success?
# => true
context.fail!
# => Interactor::Failure: #<Interactor::Context>
context.success?
# => false

Returns true by default or false if failed.

Returns:

  • (Boolean) 


81
82
83
 
# File 'lib/interactor/context.rb', line 81

def success?
  !failure?
end

#to_h ⇒ Object 



140
141
142
 
# File 'lib/interactor/context.rb', line 140

def to_h
  { error: error }
end