Class: StateMachines::Transition

Inherits:
Object
  • Object
show all
Defined in:
lib/state_machines/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

Class Method 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



40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
# File 'lib/state_machines/transition.rb', line 40

def initialize(object, machine, event, from_name, to_name, read_state = true) #:nodoc:
  @object = object
  @machine = machine
  @args = []
  @transient = false
  @resume_block = nil

  @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

#argsObject

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



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

def args
  @args
end

#fromObject (readonly)

The original state value before the transition



18
19
20
# File 'lib/state_machines/transition.rb', line 18

def from
  @from
end

#machineObject (readonly)

The state machine for which this transition is defined



15
16
17
# File 'lib/state_machines/transition.rb', line 15

def machine
  @machine
end

#objectObject (readonly)

The object being transitioned



12
13
14
# File 'lib/state_machines/transition.rb', line 12

def object
  @object
end

#resultObject (readonly)

The result of invoking the action associated with the machine



28
29
30
# File 'lib/state_machines/transition.rb', line 28

def result
  @result
end

#toObject (readonly)

The new state value after the transition



21
22
23
# File 'lib/state_machines/transition.rb', line 21

def to
  @to
end

#transient=(value) ⇒ Object (writeonly)

Whether the transition is only existing temporarily for the object



31
32
33
# File 'lib/state_machines/transition.rb', line 31

def transient=(value)
  @transient = value
end

Class Method Details

.pause_supported?Boolean

Determines whether the current ruby implementation supports pausing and resuming transitions

Returns:

  • (Boolean)


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

def self.pause_supported?
  %w(ruby maglev).include?(RUBY_ENGINE)
end

Instance Method Details

#==(other) ⇒ Object

Determines equality of transitions by testing whether the object, states, and event involved in the transition are equal



266
267
268
269
270
271
272
273
# File 'lib/state_machines/transition.rb', line 266

def ==(other)
  other.instance_of?(self.class) &&
  other.object == object &&
  other.machine == machine &&
  other.from_name == from_name &&
  other.to_name == to_name &&
  other.event == event
end

#actionObject

The action that will be run when this transition is performed



62
63
64
# File 'lib/state_machines/transition.rb', line 62

def action
  machine.action
end

#attributeObject

The attribute which this transition’s machine is defined for



57
58
59
# File 'lib/state_machines/transition.rb', line 57

def attribute
  machine.attribute
end

#attributesObject

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 = StateMachines::Transition.new(Vehicle.new, machine, :ignite, :parked, :idling)
transition.attributes   # => {:object => #<Vehicle:0xb7d60ea4>, :attribute => :state, :event => :ignite, :from => 'parked', :to => 'idling'}


138
139
140
# File 'lib/state_machines/transition.rb', line 138

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

#eventObject

The event that triggered the transition



67
68
69
# File 'lib/state_machines/transition.rb', line 67

def event
  @event.name
end

#from_nameObject

The state name before the transition



82
83
84
# File 'lib/state_machines/transition.rb', line 82

def from_name
  @from_state.name
end

#human_eventObject

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



77
78
79
# File 'lib/state_machines/transition.rb', line 77

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

#human_from_nameObject

The human-readable state name before the transition



92
93
94
# File 'lib/state_machines/transition.rb', line 92

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

#human_to_nameObject

The new human-readable state name after the transition



107
108
109
# File 'lib/state_machines/transition.rb', line 107

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

#inspectObject

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

For example,

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


281
282
283
# File 'lib/state_machines/transition.rb', line 281

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)
StateMachines::Transition.new(Vehicle.new, machine, :park, :parked, :parked).loopback?   # => true
StateMachines::Transition.new(Vehicle.new, machine, :park, :idling, :parked).loopback?   # => false

Returns:

  • (Boolean)


119
120
121
# File 'lib/state_machines/transition.rb', line 119

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 = StateMachines::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


160
161
162
163
164
165
166
# File 'lib/state_machines/transition.rb', line 160

def perform(*args)
  run_action = [true, false].include?(args.last) ? args.pop : true
  self.args = args

  # Run the transition
  !!TransitionCollection.new([self], {use_transactions: machine.use_transactions, actions: run_action}).perform
end

#persistObject

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 = StateMachines::Transition.new(vehicle, Vehicle.state_machine, :ignite, :parked, :idling)
transition.persist

vehicle.state   # => 'idling'


221
222
223
224
225
226
# File 'lib/state_machines/transition.rb', line 221

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

#qualified_eventObject

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



72
73
74
# File 'lib/state_machines/transition.rb', line 72

def qualified_event
  @event.qualified_name
end

#qualified_from_nameObject

The fully-qualified state name before the transition



87
88
89
# File 'lib/state_machines/transition.rb', line 87

def qualified_from_name
  @from_state.qualified_name
end

#qualified_to_nameObject

The new fully-qualified state name after the transition



102
103
104
# File 'lib/state_machines/transition.rb', line 102

def qualified_to_name
  @to_state.qualified_name
end

#resetObject

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



259
260
261
262
# File 'lib/state_machines/transition.rb', line 259

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

#rollbackObject

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 = StateMachines::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"


252
253
254
255
# File 'lib/state_machines/transition.rb', line 252

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:

  • before - Whether to run before callbacks.

  • 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.



188
189
190
191
192
193
194
195
196
197
198
199
200
# File 'lib/state_machines/transition.rb', line 188

def run_callbacks(options = {}, &block)
  options = {before: true, after: true}.merge(options)
  @success = false

  halted = pausable { before(options[:after], &block) } if options[:before]

  # 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_nameObject

The new state name after the transition



97
98
99
# File 'lib/state_machines/transition.rb', line 97

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)


126
127
128
# File 'lib/state_machines/transition.rb', line 126

def transient?
  @transient
end

#within_transactionObject

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.



171
172
173
174
175
# File 'lib/state_machines/transition.rb', line 171

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