Class: StateMachine::Transition

Inherits:
Object
  • Object
show all
Defined in:
lib/state_machine/transition.rb

Overview

A transition represents a state change for a specific attribute.

Transitions consist of:

  • An event

  • A starting state

  • An ending state

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(object, machine, event, from_name, to_name, read_state = true) ⇒ Transition

Creates a new, specific transition



38
39
40
41
42
43
44
45
46
47
48
49
50
51
 
# File 'lib/state_machine/transition.rb', line 38

def initialize(object, machine, event, from_name, to_name, read_state = true) #:nodoc:
  @object = object
  @machine = machine
  @args = []
  @transient = false
  
  @event = machine.events.fetch(event)
  @from_state = machine.states.fetch(from_name)
  @from = read_state ? machine.read(object, :state) : @from_state.value
  @to_state = machine.states.fetch(to_name)
  @to = @to_state.value
  
  reset
end

Instance Attribute Details

#args ⇒ Object

The arguments passed in to the event that triggered the transition (does not include the run_action boolean argument if specified)



29
30
31
 
# File 'lib/state_machine/transition.rb', line 29

def args
  @args
end

#from ⇒ Object (readonly)

The original state value before the transition



22
23
24
 
# File 'lib/state_machine/transition.rb', line 22

def from
  @from
end

#machine ⇒ Object (readonly)

The state machine for which this transition is defined



19
20
21
 
# File 'lib/state_machine/transition.rb', line 19

def machine
  @machine
end

#object ⇒ Object (readonly)

The object being transitioned



16
17
18
 
# File 'lib/state_machine/transition.rb', line 16

def object
  @object
end

#result ⇒ Object (readonly)

The result of invoking the action associated with the machine



32
33
34
 
# File 'lib/state_machine/transition.rb', line 32

def result
  @result
end

#to ⇒ Object (readonly)

The new state value after the transition



25
26
27
 
# File 'lib/state_machine/transition.rb', line 25

def to
  @to
end

#transient=(value) ⇒ Object (writeonly)

Whether the transition is only existing temporarily for the object



35
36
37
 
# File 'lib/state_machine/transition.rb', line 35

def transient=(value)
  @transient = value
end

Instance Method Details

#action ⇒ Object

The action that will be run when this transition is performed



59
60
61
 
# File 'lib/state_machine/transition.rb', line 59

def action
  machine.action
end

#attribute ⇒ Object

The attribute which this transition’s machine is defined for



54
55
56
 
# File 'lib/state_machine/transition.rb', line 54

def attribute
  machine.attribute
end

#attributes ⇒ Object

A hash of all the core attributes defined for this transition with their names as keys and values of the attributes as values.

Example

machine = StateMachine.new(Vehicle)
transition = StateMachine::Transition.new(Vehicle.new, machine, :ignite, :parked, :idling)
transition.attributes   # => {:object => #<Vehicle:0xb7d60ea4>, :attribute => :state, :event => :ignite, :from => 'parked', :to => 'idling'}



135
136
137
 
# File 'lib/state_machine/transition.rb', line 135

def attributes
  @attributes ||= {:object => object, :attribute => attribute, :event => event, :from => from, :to => to}
end

#event ⇒ Object

The event that triggered the transition



64
65
66
 
# File 'lib/state_machine/transition.rb', line 64

def event
  @event.name
end

#from_name ⇒ Object

The state name before the transition



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

def from_name
  @from_state.name
end

#human_event ⇒ Object

The human-readable name of the event that triggered the transition



74
75
76
 
# File 'lib/state_machine/transition.rb', line 74

def human_event
  @event.human_name(@object.class)
end

#human_from_name ⇒ Object

The human-readable state name before the transition



89
90
91
 
# File 'lib/state_machine/transition.rb', line 89

def human_from_name
  @from_state.human_name(@object.class)
end

#human_to_name ⇒ Object

The new human-readable state name after the transition



104
105
106
 
# File 'lib/state_machine/transition.rb', line 104

def human_to_name
  @to_state.human_name(@object.class)
end

#inspect ⇒ Object

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

For example,

transition = StateMachine::Transition.new(object, machine, :ignite, :parked, :idling)
transition   # => #<StateMachine::Transition attribute=:state event=:ignite from="parked" from_name=:parked to="idling" to_name=:idling>



266
267
268
 
# File 'lib/state_machine/transition.rb', line 266

def inspect
  "#<#{self.class} #{%w(attribute event from from_name to to_name).map {|attr| "#{attr}=#{send(attr).inspect}"} * ' '}>"
end

#loopback? ⇒ Boolean

Does this transition represent a loopback (i.e. the from and to state are the same)

Example

machine = StateMachine.new(Vehicle)
StateMachine::Transition.new(Vehicle.new, machine, :park, :parked, :parked).loopback?   # => true
StateMachine::Transition.new(Vehicle.new, machine, :park, :idling, :parked).loopback?   # => false

Returns:

  • (Boolean) 


116
117
118
 
# File 'lib/state_machine/transition.rb', line 116

def loopback?
  from_name == to_name
end

#perform(*args) ⇒ Object

Runs the actual transition and any before/after callbacks associated with the transition. The action associated with the transition/machine can be skipped by passing in false.

Examples

class Vehicle
  state_machine :action => :save do
    ...
  end
end

vehicle = Vehicle.new
transition = StateMachine::Transition.new(vehicle, machine, :ignite, :parked, :idling)
transition.perform                  # => Runs the +save+ action after setting the state attribute
transition.perform(false)           # => Only sets the state attribute
transition.perform(Time.now)        # => Passes in additional arguments and runs the +save+ action
transition.perform(Time.now, false) # => Passes in additional arguments and only sets the state attribute



157
158
159
160
161
162
163
 
# File 'lib/state_machine/transition.rb', line 157

def perform(*args)
  run_action = [true, false].include?(args.last) ? args.pop : true
  self.args = args
  
  # Run the transition
  !!TransitionCollection.new([self], :actions => run_action).perform
end

#persist ⇒ Object

Transitions the current value of the state to that specified by the transition. Once the state is persisted, it cannot be persisted again until this transition is reset.

Example

class Vehicle
  state_machine do
    event :ignite do
      transition :parked => :idling
    end
  end
end

vehicle = Vehicle.new
transition = StateMachine::Transition.new(vehicle, Vehicle.state_machine, :ignite, :parked, :idling)
transition.persist

vehicle.state   # => 'idling'



217
218
219
220
221
222
 
# File 'lib/state_machine/transition.rb', line 217

def persist
  unless @persisted
    machine.write(object, :state, to)
    @persisted = true
  end
end

#qualified_event ⇒ Object

The fully-qualified name of the event that triggered the transition



69
70
71
 
# File 'lib/state_machine/transition.rb', line 69

def qualified_event
  @event.qualified_name
end

#qualified_from_name ⇒ Object

The fully-qualified state name before the transition



84
85
86
 
# File 'lib/state_machine/transition.rb', line 84

def qualified_from_name
  @from_state.qualified_name
end

#qualified_to_name ⇒ Object

The new fully-qualified state name after the transition



99
100
101
 
# File 'lib/state_machine/transition.rb', line 99

def qualified_to_name
  @to_state.qualified_name
end

#reset ⇒ Object

Resets any tracking of which callbacks have already been run and whether the state has already been persisted



255
256
257
258
 
# File 'lib/state_machine/transition.rb', line 255

def reset
  @before_run = @persisted = @after_run = false
  @paused_block = nil
end

#rollback ⇒ Object

Rolls back changes made to the object’s state via this transition. This will revert the state back to the from value.

Example

class Vehicle
  state_machine :initial => :parked do
    event :ignite do
      transition :parked => :idling
    end
  end
end

vehicle = Vehicle.new     # => #<Vehicle:0xb7b7f568 @state="parked">
transition = StateMachine::Transition.new(vehicle, Vehicle.state_machine, :ignite, :parked, :idling)

# Persist the new state
vehicle.state             # => "parked"
transition.persist
vehicle.state             # => "idling"

# Roll back to the original state
transition.rollback
vehicle.state             # => "parked"



248
249
250
251
 
# File 'lib/state_machine/transition.rb', line 248

def rollback
  reset
  machine.write(object, :state, from)
end

#run_callbacks(options = {}, &block) ⇒ Object

Runs the before / after callbacks for this transition. If a block is provided, then it will be executed between the before and after callbacks.

Configuration options:

  • after - Whether to run after callbacks. If false, then any around callbacks will be paused until called again with after enabled. Default is true.

This will return true if all before callbacks gets executed. After callbacks will not have an effect on the result.



184
185
186
187
188
189
190
191
192
193
194
195
196
 
# File 'lib/state_machine/transition.rb', line 184

def run_callbacks(options = {}, &block)
  options = {:after => true}.merge(options)
  @success = false
  
  halted = pausable { before(options[:after], &block) }
  
  # After callbacks are only run if:
  # * An around callback didn't halt after yielding
  # * They're enabled or the run didn't succeed
  after if !(@before_run && halted) && (options[:after] || !@success)
  
  @before_run
end

#to_name ⇒ Object

The new state name after the transition



94
95
96
 
# File 'lib/state_machine/transition.rb', line 94

def to_name
  @to_state.name
end

#transient? ⇒ Boolean

Is this transition existing for a short period only? If this is set, it indicates that the transition (or the event backing it) should not be written to the object if it fails.

Returns:

  • (Boolean) 


123
124
125
 
# File 'lib/state_machine/transition.rb', line 123

def transient?
  @transient
end

#within_transaction ⇒ Object

Runs a block within a transaction for the object being transitioned. By default, transactions are a no-op unless otherwise defined by the machine’s integration.



168
169
170
171
172
 
# File 'lib/state_machine/transition.rb', line 168

def within_transaction
  machine.within_transaction(object) do
    yield
  end
end