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
 
# 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('_', ' ')
  reset
  
  # Output a warning if another event has a conflicting qualified name
  if conflict = machine.owner_class.state_machines.detect {|other_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”



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

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.

Note that this will not take the object context into account. Although a transition may be possible based on the state machine definition, object-specific behaviors (like validations) may prevent it from firing.

Returns:

  • (Boolean) 


125
126
127
 
# File 'lib/state_machine/event.rb', line 125

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

#context(&block) ⇒ Object

Evaluates the given block within the context of this event. This simply provides a DSL-like syntax for defining transitions.



85
86
87
 
# File 'lib/state_machine/event.rb', line 85

def context(&block)
  instance_eval(&block)
end

#draw(graph, options = {}) ⇒ 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.

Configuration options:

  • :human_name - Whether to use the event’s human name for the node’s label that gets drawn on the graph



204
205
206
207
208
209
210
211
 
# File 'lib/state_machine/event.rb', line 204

def draw(graph, options = {})
  valid_states = machine.states.by_priority.map {|state| state.name}
  branches.each do |branch|
    branch.draw(graph, options[:human_name] ? human_name : name, valid_states)
  end
  
  true
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.



168
169
170
171
172
173
174
175
176
177
 
# File 'lib/state_machine/event.rb', line 168

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.



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

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]>



220
221
222
223
224
225
226
227
228
 
# File 'lib/state_machine/event.rb', line 220

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.



181
182
183
184
185
186
 
# File 'lib/state_machine/event.rb', line 181

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

#reset ⇒ Object

Resets back to the initial state of the event, with no branches / known states associated. This allows you to redefine an event in situations where you either are re-using an existing state machine implementation or are subclassing machines.



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

def reset
  @branches = []
  @known_states = []
end

#transition(options) ⇒ Object

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

Since this transition is being defined within an event context, you do not need to specify the :on option for the transition. For example:

state_machine do
  event :ignite do
    transition :parked => :idling, :idling => same, :if => :seatbelt_on? # Transitions to :idling if seatbelt is on
    transition all => :parked, :unless => :seatbelt_on?                  # Transitions to :parked if seatbelt is off
  end
end

See StateMachine::Machine#transition for a description of the possible configurations for defining transitions.

Raises:

  • (ArgumentError) 


105
106
107
108
109
110
111
112
113
114
115
 
# File 'lib/state_machine/event.rb', line 105

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, :except_to, :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.



139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
 
# File 'lib/state_machine/event.rb', line 139

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 = if match[:to].is_a?(LoopbackMatcher)
        from
      else
        values = requirements.include?(:to) ? [requirements[:to]].flatten : [from] | machine.states.keys(:name)
        match[:to].filter(values).first
      end
      
      return Transition.new(object, machine, name, from, to, !custom_from_state)
    end
  end
  
  # No transition matched
  nil
end