Module: Cuprum::Operation::Mixin

Parent Namespace

Cuprum::Operation

Defined In

lib/cuprum/operation.rb

Table Of Contents

• Overview
  • Examples
• Instance Attributes
  • result
• Instance Methods
  • call
  • called?
  • error
  • failure?
  • reset!
  • status
  • success?
  • to_cuprum_result
  • value

Overview

Module-based implementation of the Operation methods.

Use this to convert an already-defined command into an operation.

Examples

class CustomOperation < CustomCommand
  include Cuprum::Operation::Mixin
end

Back To Top

Instance Attributes

#result => Cuprum::Result (readonly)

Returns

• (Cuprum::Result) — The result from the most recent call of the operation.

Back To Top

Instance Methods

#call(*arguments, **keywords, &block) => Cuprum::Operation

Calls the command implementation and stores the result.

Parameters

• arguments (Array) — Arguments to be passed to the implementation.
• keywords (Hash) — Keywords to be passed to the implementation.

Yields

• If a block argument is given, it will be passed to the implementation.

Returns

• (Cuprum::Operation) — the called operation.

See Also

• Cuprum::Command#call

#called? => Boolean

Returns

• (Boolean) — true if the operation has been called and has a reference to the most recent result; otherwise false.

#error => Object

Returns

• (Object) — the error (if any) from the most recent result, or nil if the operation has not been called.

#failure? => Boolean

Returns

• (Boolean) — true if the most recent result had an error, or false if the most recent result had no error or if the operation has not been called.

#reset! => Object

Clears the reference to the most recent call of the operation, if any. This allows the result and any referenced data to be garbage collected. Use this method to clear any instance variables or state internal to the operation (an operation should never have external state apart from the last result).

If the operation cannot be run more than once, this method should raise an error.

#status => Symbol, nil

Returns

• (Symbol, nil) — the status of the most recent result, or nil if the operation has not been called.

#success? => Boolean

Returns

• (Boolean) — true if the most recent result had no error, or false if the most recent result had an error or if the operation has not been called.

#to_cuprum_result => Cuprum::Result

Returns

• (Cuprum::Result) — the most recent result if the operation was previously called; otherwise, returns a failing result with a Cuprum::Errors::OperationNotCalled error.

#value => Object

Returns

• (Object) — the value of the most recent result, or nil if the operation has not been called.

Back To Top

---

Back to Documentation | Reference | Cuprum | Cuprum::Operation