Class: Flows::Flow::Router Abstract

Inherits:

Object

• Object
• Flows::Flow::Router

Defined in:

lib/flows/flow/router.rb,
lib/flows/flow/router/custom.rb,
lib/flows/flow/router/errors.rb,
lib/flows/flow/router/simple.rb

Overview

This class is abstract.

Node router: defines rules to calculate next Node to execute inside a particular Flows::Flow.

Router receives Result Object, execution context and execution metadata. Basing on this information a router must decide what to execute next or decide to stop execution of a flow.

If router returns :end - it stops an execution process.

Since:

• 0.4.0

Direct Known Subclasses

Custom, Simple

Defined Under Namespace

Classes: Custom, Error, NoRouteError, Simple

Instance Method Summary

• #call(result) ⇒ Symbol abstract

  Name of the next node or a special symbol :end.

• #destinations ⇒ Array<Symbol> abstract

  Names of all the possible destination nodes.

Instance Method Details

#call(result) ⇒ Symbol

This method is abstract.

Returns name of the next node or a special symbol :end.

Parameters:

• result (Flows::Result) —

  Result Object, output of a Node execution.

Returns:

• (Symbol) —

  name of the next node or a special symbol :end.

Raises:

• (NoRouteError) —

  if cannot determine a route.

# File 'lib/flows/flow/router.rb', line 22

class Router
end

#destinations ⇒ Array<Symbol>

This method is abstract.

Returns names of all the possible destination nodes.

Returns:

• (Array<Symbol>) —

  names of all the possible destination nodes

# File 'lib/flows/flow/router.rb', line 22

class Router
end