Class: StateMachine::Event

Inherits:
Object
  • Object
show all
Includes:
Assertions, MatcherHelpers
Defined in:
lib/state_machine/event.rb

Overview

An event defines an action that transitions an attribute from one state to another. The state that an attribute is transitioned to depends on the branches configured for the event.

Instance Attribute Summary collapse

Instance Method Summary collapse

Methods included from MatcherHelpers

#all, #same

Methods included from Assertions

#assert_exclusive_keys, #assert_valid_keys

Constructor Details

#initialize(machine, name, options = {}) ⇒ Event

Creates a new event within the context of the given machine

Configuration options:

  • :human_name - The human-readable version of this event’s name



51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
 
# File 'lib/state_machine/event.rb', line 51

def initialize(machine, name, options = {}) #:nodoc:
  assert_valid_keys(options, :human_name)
  
  @machine = machine
  @name = name
  @qualified_name = machine.namespace ? :"#{name}_#{machine.namespace}" : name
  @human_name = options[:human_name] || @name.to_s.tr('_', ' ')
  @branches = []
  @known_states = []
  
  # Output a warning if another event has a conflicting qualified name
  if conflict = machine.owner_class.state_machines.detect {|name, other_machine| other_machine != @machine && other_machine.events[qualified_name, :qualified_name]}
    name, other_machine = conflict
    warn "Event #{qualified_name.inspect} for #{machine.name.inspect} is already defined in #{other_machine.name.inspect}"
  else
    add_actions
  end
end

Instance Attribute Details

#branches ⇒ Object (readonly)

The list of branches that determine what state this event transitions objects to when fired



41
42
43
 
# File 'lib/state_machine/event.rb', line 41

def branches
  @branches
end

#human_name(klass = @machine.owner_class) ⇒ Object

Transforms the event name into a more human-readable format, such as “turn on” instead of “turn_on”



80
81
82
 
# File 'lib/state_machine/event.rb', line 80

def human_name(klass = @machine.owner_class)
  @human_name.is_a?(Proc) ? @human_name.call(self, klass) : @human_name
end

#known_states ⇒ Object (readonly)

A list of all of the states known to this event using the configured branches/transitions as the source



45
46
47
 
# File 'lib/state_machine/event.rb', line 45

def known_states
  @known_states
end

#machine ⇒ Object

The state machine for which this event is defined



28
29
30
 
# File 'lib/state_machine/event.rb', line 28

def machine
  @machine
end

#name ⇒ Object (readonly)

The name of the event



31
32
33
 
# File 'lib/state_machine/event.rb', line 31

def name
  @name
end

#qualified_name ⇒ Object (readonly)

The fully-qualified name of the event, scoped by the machine’s namespace



34
35
36
 
# File 'lib/state_machine/event.rb', line 34

def qualified_name
  @qualified_name
end

Instance Method Details

#can_fire?(object, requirements = {}) ⇒ Boolean

Determines whether any transitions can be performed for this event based on the current state of the given object.

If the event can’t be fired, then this will return false, otherwise true.

Returns:

  • (Boolean) 


193
194
195
 
# File 'lib/state_machine/event.rb', line 193

def can_fire?(object, requirements = {})
  !transition_for(object, requirements).nil?
end

#draw(graph) ⇒ Object

Draws a representation of this event on the given graph. This will create 1 or more edges on the graph for each branch (i.e. transition) configured.

A collection of the generated edges will be returned.



256
257
258
259
 
# File 'lib/state_machine/event.rb', line 256

def draw(graph)
  valid_states = machine.states.by_priority.map {|state| state.name}
  branches.collect {|branch| branch.draw(graph, name, valid_states)}.flatten
end

#fire(object, *args) ⇒ Object

Attempts to perform the next available transition on the given object. If no transitions can be made, then this will return false, otherwise true.

Any additional arguments are passed to the StateMachine::Transition#perform instance method.



231
232
233
234
235
236
237
238
239
240
 
# File 'lib/state_machine/event.rb', line 231

def fire(object, *args)
  machine.reset(object)
  
  if transition = transition_for(object)
    transition.perform(*args)
  else
    on_failure(object)
    false
  end
end

#initialize_copy(orig) ⇒ Object

Creates a copy of this event in addition to the list of associated branches to prevent conflicts across events within a class hierarchy.



72
73
74
75
76
 
# File 'lib/state_machine/event.rb', line 72

def initialize_copy(orig) #:nodoc:
  super
  @branches = @branches.dup
  @known_states = @known_states.dup
end

#inspect ⇒ Object

Generates a nicely formatted description of this event’s contents.

For example,

event = StateMachine::Event.new(machine, :park)
event.transition all - :idling => :parked, :idling => same
event   # => #<StateMachine::Event name=:park transitions=[all - :idling => :parked, :idling => same]>



268
269
270
271
272
273
274
275
276
 
# File 'lib/state_machine/event.rb', line 268

def inspect
  transitions = branches.map do |branch|
    branch.state_requirements.map do |state_requirement|
      "#{state_requirement[:from].description} => #{state_requirement[:to].description}"
    end * ', '
  end
  
  "#<#{self.class} name=#{name.inspect} transitions=[#{transitions * ', '}]>"
end

#on_failure(object) ⇒ Object

Marks the object as invalid and runs any failure callbacks associated with this event. This should get called anytime this event fails to transition.



244
245
246
247
248
249
 
# File 'lib/state_machine/event.rb', line 244

def on_failure(object)
  machine.invalidate(object, :state, :invalid_transition, [[:event, human_name(object.class)]])
  
  state = machine.states.match!(object).name
  Transition.new(object, machine, name, state, state).run_callbacks(:before => false)
end

#transition(options) ⇒ Object

Creates a new transition that determines what to change the current state to when this event fires.

Defining transitions

The options for a new transition uses the Hash syntax to map beginning states to ending states. For example,

transition :parked => :idling, :idling => :first_gear

In this case, when the event is fired, this transition will cause the state to be idling if it’s current state is parked or first_gear if it’s current state is idling.

To help define these implicit transitions, a set of helpers are available for slightly more complex matching:

  • all - Matches every state in the machine

  • all - [:parked, :idling, ...] - Matches every state except those specified

  • any - An alias for all (matches every state in the machine)

  • same - Matches the same state being transitioned from

See StateMachine::MatcherHelpers for more information.

Examples:

transition all => nil                               # Transitions to nil regardless of the current state
transition all => :idling                           # Transitions to :idling regardless of the current state
transition all - [:idling, :first_gear] => :idling  # Transitions every state but :idling and :first_gear to :idling
transition nil => :idling                           # Transitions to :idling from the nil state
transition :parked => :idling                       # Transitions to :idling if :parked
transition [:parked, :stalled] => :idling           # Transitions to :idling if :parked or :stalled

transition :parked => same                          # Loops :parked back to :parked
transition [:parked, :stalled] => same              # Loops either :parked or :stalled back to the same state
transition all - :parked => same                    # Loops every state but :parked back to the same state

# Transitions to :idling if :parked, :first_gear if :idling, or :second_gear if :first_gear
transition :parked => :idling, :idling => :first_gear, :first_gear => :second_gear

Verbose transitions

Transitions can also be defined use an explicit set of deprecated configuration options:

  • :from - A state or array of states that can be transitioned from. If not specified, then the transition can occur for any state.

  • :to - The state that’s being transitioned to. If not specified, then the transition will simply loop back (i.e. the state will not change).

  • :except_from - A state or array of states that cannot be transitioned from.

Examples:

transition :to => nil
transition :to => :idling
transition :except_from => [:idling, :first_gear], :to => :idling
transition :from => nil, :to => :idling
transition :from => [:parked, :stalled], :to => :idling

transition :from => :parked
transition :from => [:parked, :stalled]
transition :except_from => :parked

Notice that the above examples are the verbose equivalent of the examples described initially.

Conditions

In addition to the state requirements for each transition, a condition can also be defined to help determine whether that transition is available. These options will work on both the normal and verbose syntax.

Configuration options:

  • :if - A method, proc or string to call to determine if the transition should occur (e.g. :if => :moving?, or :if => lambda {|vehicle| vehicle.speed > 60}). The condition should return or evaluate to true or false.

  • :unless - A method, proc or string to call to determine if the transition should not occur (e.g. :unless => :stopped?, or :unless => lambda {|vehicle| vehicle.speed <= 60}). The condition should return or evaluate to true or false.

Examples:

transition :parked => :idling, :if => :moving?
transition :parked => :idling, :unless => :stopped?
transition :idling => :first_gear, :first_gear => :second_gear, :if => :seatbelt_on?

transition :from => :parked, :to => :idling, :if => :moving?
transition :from => :parked, :to => :idling, :unless => :stopped?

Order of operations

Transitions are evaluated in the order in which they’re defined. As a result, if more than one transition applies to a given object, then the first transition that matches will be performed.

Raises:

  • (ArgumentError) 


177
178
179
180
181
182
183
184
185
186
187
 
# File 'lib/state_machine/event.rb', line 177

def transition(options)
  raise ArgumentError, 'Must specify as least one transition requirement' if options.empty?
  
  # Only a certain subset of explicit options are allowed for transition
  # requirements
  assert_valid_keys(options, :from, :to, :except_from, :if, :unless) if (options.keys - [:from, :to, :on, :except_from, :except_to, :except_on, :if, :unless]).empty?
  
  branches << branch = Branch.new(options.merge(:on => name))
  @known_states |= branch.known_states
  branch
end

#transition_for(object, requirements = {}) ⇒ Object

Finds and builds the next transition that can be performed on the given object. If no transitions can be made, then this will return nil.

Valid requirement options:

  • :from - One or more states being transitioned from. If none are specified, then this will be the object’s current state.

  • :to - One or more states being transitioned to. If none are specified, then this will match any to state.

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



207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
 
# File 'lib/state_machine/event.rb', line 207

def transition_for(object, requirements = {})
  assert_valid_keys(requirements, :from, :to, :guard)
  requirements[:from] = machine.states.match!(object).name unless custom_from_state = requirements.include?(:from)
  
  branches.each do |branch|
    if match = branch.match(object, requirements)
      # Branch allows for the transition to occur
      from = requirements[:from]
      to = match[:to].values.empty? ? from : match[:to].values.first
      
      return Transition.new(object, machine, name, from, to, !custom_from_state)
    end
  end
  
  # No transition matched
  nil
end