Class: StateMachines::PathCollection

Inherits:
Array
  • Object
show all
Defined in:
lib/state_machines/path_collection.rb

Overview

Represents a collection of paths that are generated based on a set of requirements regarding what states to start and end on

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(object, machine, options = {}) ⇒ PathCollection

Creates a new collection of paths with the given requirements.

Configuration options:

  • :from - The initial state to start from

  • :to - The target end state

  • :deep - Whether to enable deep searches for the target state.

  • :guard - Whether to guard transitions with the if/unless conditionals defined for each one



26
27
28
29
30
31
32
33
34
35
36
37
38
 
# File 'lib/state_machines/path_collection.rb', line 26

def initialize(object, machine, options = {})
  options = {deep: false, from: machine.states.match!(object).name}.merge(options)
  options.assert_valid_keys( :from, :to, :deep, :guard)

  @object = object
  @machine = machine
  @from_name = machine.states.fetch(options[:from]).name
  @to_name = options[:to] && machine.states.fetch(options[:to]).name
  @guard = options[:guard]
  @deep = options[:deep]

  initial_paths.each { |path| walk(path) }
end

Instance Attribute Details

#from_name ⇒ Object (readonly)

The initial state to start each path from



13
14
15
 
# File 'lib/state_machines/path_collection.rb', line 13

def from_name
  @from_name
end

#machine ⇒ Object (readonly)

The state machine these path are walking



10
11
12
 
# File 'lib/state_machines/path_collection.rb', line 10

def machine
  @machine
end

#object ⇒ Object (readonly)

The object whose state machine is being walked



7
8
9
 
# File 'lib/state_machines/path_collection.rb', line 7

def object
  @object
end

#to_name ⇒ Object (readonly)

The target state for each path



16
17
18
 
# File 'lib/state_machines/path_collection.rb', line 16

def to_name
  @to_name
end

Instance Method Details

#events ⇒ Object

Lists all of the events that can be fired through the paths in this collection.

For example,

paths.events  # => [:park, :ignite, :shift_up, ...]



66
67
68
 
# File 'lib/state_machines/path_collection.rb', line 66

def events
  flat_map(&:events).uniq
end

#from_states ⇒ Object

Lists all of the states that can be transitioned from through the paths in this collection.

For example,

paths.from_states # => [:parked, :idling, :first_gear, ...]



46
47
48
 
# File 'lib/state_machines/path_collection.rb', line 46

def from_states
  flat_map(&:from_states).uniq
end

#to_states ⇒ Object

Lists all of the states that can be transitioned to through the paths in this collection.

For example,

paths.to_states # => [:idling, :first_gear, :second_gear, ...]



56
57
58
 
# File 'lib/state_machines/path_collection.rb', line 56

def to_states
  flat_map(&:to_states).uniq
end