spree-state_machine 2.0.0.beta1
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- checksums.yaml +7 -0
- data/.gitignore +8 -0
- data/.travis.yml +12 -0
- data/.yardopts +5 -0
- data/CHANGELOG.md +502 -0
- data/Gemfile +3 -0
- data/LICENSE +20 -0
- data/README.md +1246 -0
- data/Rakefile +20 -0
- data/examples/AutoShop_state.png +0 -0
- data/examples/Car_state.png +0 -0
- data/examples/Gemfile +5 -0
- data/examples/Gemfile.lock +14 -0
- data/examples/TrafficLight_state.png +0 -0
- data/examples/Vehicle_state.png +0 -0
- data/examples/auto_shop.rb +13 -0
- data/examples/car.rb +21 -0
- data/examples/doc/AutoShop.html +2856 -0
- data/examples/doc/AutoShop_state.png +0 -0
- data/examples/doc/Car.html +919 -0
- data/examples/doc/Car_state.png +0 -0
- data/examples/doc/TrafficLight.html +2230 -0
- data/examples/doc/TrafficLight_state.png +0 -0
- data/examples/doc/Vehicle.html +7921 -0
- data/examples/doc/Vehicle_state.png +0 -0
- data/examples/doc/_index.html +136 -0
- data/examples/doc/class_list.html +47 -0
- data/examples/doc/css/common.css +1 -0
- data/examples/doc/css/full_list.css +55 -0
- data/examples/doc/css/style.css +322 -0
- data/examples/doc/file_list.html +46 -0
- data/examples/doc/frames.html +13 -0
- data/examples/doc/index.html +136 -0
- data/examples/doc/js/app.js +205 -0
- data/examples/doc/js/full_list.js +173 -0
- data/examples/doc/js/jquery.js +16 -0
- data/examples/doc/method_list.html +734 -0
- data/examples/doc/top-level-namespace.html +105 -0
- data/examples/merb-rest/controller.rb +51 -0
- data/examples/merb-rest/model.rb +28 -0
- data/examples/merb-rest/view_edit.html.erb +24 -0
- data/examples/merb-rest/view_index.html.erb +23 -0
- data/examples/merb-rest/view_new.html.erb +13 -0
- data/examples/merb-rest/view_show.html.erb +17 -0
- data/examples/rails-rest/controller.rb +43 -0
- data/examples/rails-rest/migration.rb +7 -0
- data/examples/rails-rest/model.rb +23 -0
- data/examples/rails-rest/view__form.html.erb +34 -0
- data/examples/rails-rest/view_edit.html.erb +6 -0
- data/examples/rails-rest/view_index.html.erb +25 -0
- data/examples/rails-rest/view_new.html.erb +5 -0
- data/examples/rails-rest/view_show.html.erb +19 -0
- data/examples/traffic_light.rb +9 -0
- data/examples/vehicle.rb +33 -0
- data/lib/state_machine/assertions.rb +36 -0
- data/lib/state_machine/branch.rb +225 -0
- data/lib/state_machine/callback.rb +236 -0
- data/lib/state_machine/core.rb +7 -0
- data/lib/state_machine/core_ext/class/state_machine.rb +5 -0
- data/lib/state_machine/core_ext.rb +2 -0
- data/lib/state_machine/error.rb +13 -0
- data/lib/state_machine/eval_helpers.rb +87 -0
- data/lib/state_machine/event.rb +257 -0
- data/lib/state_machine/event_collection.rb +141 -0
- data/lib/state_machine/extensions.rb +149 -0
- data/lib/state_machine/graph.rb +92 -0
- data/lib/state_machine/helper_module.rb +17 -0
- data/lib/state_machine/initializers/rails.rb +25 -0
- data/lib/state_machine/initializers.rb +4 -0
- data/lib/state_machine/integrations/active_model/locale.rb +11 -0
- data/lib/state_machine/integrations/active_model/observer.rb +33 -0
- data/lib/state_machine/integrations/active_model/observer_update.rb +42 -0
- data/lib/state_machine/integrations/active_model/versions.rb +31 -0
- data/lib/state_machine/integrations/active_model.rb +585 -0
- data/lib/state_machine/integrations/active_record/locale.rb +20 -0
- data/lib/state_machine/integrations/active_record/versions.rb +123 -0
- data/lib/state_machine/integrations/active_record.rb +525 -0
- data/lib/state_machine/integrations/base.rb +100 -0
- data/lib/state_machine/integrations.rb +121 -0
- data/lib/state_machine/machine.rb +2287 -0
- data/lib/state_machine/machine_collection.rb +74 -0
- data/lib/state_machine/macro_methods.rb +522 -0
- data/lib/state_machine/matcher.rb +123 -0
- data/lib/state_machine/matcher_helpers.rb +54 -0
- data/lib/state_machine/node_collection.rb +222 -0
- data/lib/state_machine/path.rb +120 -0
- data/lib/state_machine/path_collection.rb +90 -0
- data/lib/state_machine/state.rb +297 -0
- data/lib/state_machine/state_collection.rb +112 -0
- data/lib/state_machine/state_context.rb +138 -0
- data/lib/state_machine/transition.rb +470 -0
- data/lib/state_machine/transition_collection.rb +245 -0
- data/lib/state_machine/version.rb +3 -0
- data/lib/state_machine/yard/handlers/base.rb +32 -0
- data/lib/state_machine/yard/handlers/event.rb +25 -0
- data/lib/state_machine/yard/handlers/machine.rb +344 -0
- data/lib/state_machine/yard/handlers/state.rb +25 -0
- data/lib/state_machine/yard/handlers/transition.rb +47 -0
- data/lib/state_machine/yard/handlers.rb +12 -0
- data/lib/state_machine/yard/templates/default/class/html/setup.rb +30 -0
- data/lib/state_machine/yard/templates/default/class/html/state_machines.erb +12 -0
- data/lib/state_machine/yard/templates.rb +3 -0
- data/lib/state_machine/yard.rb +8 -0
- data/lib/state_machine.rb +8 -0
- data/lib/yard-state_machine.rb +2 -0
- data/state_machine.gemspec +22 -0
- data/test/files/en.yml +17 -0
- data/test/files/switch.rb +15 -0
- data/test/functional/state_machine_test.rb +1066 -0
- data/test/test_helper.rb +7 -0
- data/test/unit/assertions_test.rb +40 -0
- data/test/unit/branch_test.rb +969 -0
- data/test/unit/callback_test.rb +704 -0
- data/test/unit/error_test.rb +43 -0
- data/test/unit/eval_helpers_test.rb +270 -0
- data/test/unit/event_collection_test.rb +398 -0
- data/test/unit/event_test.rb +1196 -0
- data/test/unit/graph_test.rb +98 -0
- data/test/unit/helper_module_test.rb +17 -0
- data/test/unit/integrations/active_model_test.rb +1245 -0
- data/test/unit/integrations/active_record_test.rb +2551 -0
- data/test/unit/integrations/base_test.rb +104 -0
- data/test/unit/integrations_test.rb +71 -0
- data/test/unit/invalid_event_test.rb +20 -0
- data/test/unit/invalid_parallel_transition_test.rb +18 -0
- data/test/unit/invalid_transition_test.rb +115 -0
- data/test/unit/machine_collection_test.rb +603 -0
- data/test/unit/machine_test.rb +3395 -0
- data/test/unit/matcher_helpers_test.rb +37 -0
- data/test/unit/matcher_test.rb +155 -0
- data/test/unit/node_collection_test.rb +362 -0
- data/test/unit/path_collection_test.rb +266 -0
- data/test/unit/path_test.rb +485 -0
- data/test/unit/state_collection_test.rb +352 -0
- data/test/unit/state_context_test.rb +441 -0
- data/test/unit/state_machine_test.rb +31 -0
- data/test/unit/state_test.rb +1101 -0
- data/test/unit/transition_collection_test.rb +2168 -0
- data/test/unit/transition_test.rb +1558 -0
- metadata +264 -0
@@ -0,0 +1,257 @@
|
|
1
|
+
require 'state_machine/transition'
|
2
|
+
require 'state_machine/branch'
|
3
|
+
require 'state_machine/assertions'
|
4
|
+
require 'state_machine/matcher_helpers'
|
5
|
+
require 'state_machine/error'
|
6
|
+
|
7
|
+
module StateMachine
|
8
|
+
# An invalid event was specified
|
9
|
+
class InvalidEvent < Error
|
10
|
+
# The event that was attempted to be run
|
11
|
+
attr_reader :event
|
12
|
+
|
13
|
+
def initialize(object, event_name) #:nodoc:
|
14
|
+
@event = event_name
|
15
|
+
|
16
|
+
super(object, "#{event.inspect} is an unknown state machine event")
|
17
|
+
end
|
18
|
+
end
|
19
|
+
|
20
|
+
# An event defines an action that transitions an attribute from one state to
|
21
|
+
# another. The state that an attribute is transitioned to depends on the
|
22
|
+
# branches configured for the event.
|
23
|
+
class Event
|
24
|
+
include Assertions
|
25
|
+
include MatcherHelpers
|
26
|
+
|
27
|
+
# The state machine for which this event is defined
|
28
|
+
attr_accessor :machine
|
29
|
+
|
30
|
+
# The name of the event
|
31
|
+
attr_reader :name
|
32
|
+
|
33
|
+
# The fully-qualified name of the event, scoped by the machine's namespace
|
34
|
+
attr_reader :qualified_name
|
35
|
+
|
36
|
+
# The human-readable name for the event
|
37
|
+
attr_writer :human_name
|
38
|
+
|
39
|
+
# The list of branches that determine what state this event transitions
|
40
|
+
# objects to when fired
|
41
|
+
attr_reader :branches
|
42
|
+
|
43
|
+
# A list of all of the states known to this event using the configured
|
44
|
+
# branches/transitions as the source
|
45
|
+
attr_reader :known_states
|
46
|
+
|
47
|
+
# Creates a new event within the context of the given machine
|
48
|
+
#
|
49
|
+
# Configuration options:
|
50
|
+
# * <tt>:human_name</tt> - The human-readable version of this event's name
|
51
|
+
def initialize(machine, name, options = {}) #:nodoc:
|
52
|
+
assert_valid_keys(options, :human_name)
|
53
|
+
|
54
|
+
@machine = machine
|
55
|
+
@name = name
|
56
|
+
@qualified_name = machine.namespace ? :"#{name}_#{machine.namespace}" : name
|
57
|
+
@human_name = options[:human_name] || @name.to_s.tr('_', ' ')
|
58
|
+
reset
|
59
|
+
|
60
|
+
# Output a warning if another event has a conflicting qualified name
|
61
|
+
if conflict = machine.owner_class.state_machines.detect {|other_name, other_machine| other_machine != @machine && other_machine.events[qualified_name, :qualified_name]}
|
62
|
+
name, other_machine = conflict
|
63
|
+
warn "Event #{qualified_name.inspect} for #{machine.name.inspect} is already defined in #{other_machine.name.inspect}"
|
64
|
+
else
|
65
|
+
add_actions
|
66
|
+
end
|
67
|
+
end
|
68
|
+
|
69
|
+
# Creates a copy of this event in addition to the list of associated
|
70
|
+
# branches to prevent conflicts across events within a class hierarchy.
|
71
|
+
def initialize_copy(orig) #:nodoc:
|
72
|
+
super
|
73
|
+
@branches = @branches.dup
|
74
|
+
@known_states = @known_states.dup
|
75
|
+
end
|
76
|
+
|
77
|
+
# Transforms the event name into a more human-readable format, such as
|
78
|
+
# "turn on" instead of "turn_on"
|
79
|
+
def human_name(klass = @machine.owner_class)
|
80
|
+
@human_name.is_a?(Proc) ? @human_name.call(self, klass) : @human_name
|
81
|
+
end
|
82
|
+
|
83
|
+
# Evaluates the given block within the context of this event. This simply
|
84
|
+
# provides a DSL-like syntax for defining transitions.
|
85
|
+
def context(&block)
|
86
|
+
instance_eval(&block)
|
87
|
+
end
|
88
|
+
|
89
|
+
# Creates a new transition that determines what to change the current state
|
90
|
+
# to when this event fires.
|
91
|
+
#
|
92
|
+
# Since this transition is being defined within an event context, you do
|
93
|
+
# *not* need to specify the <tt>:on</tt> option for the transition. For
|
94
|
+
# example:
|
95
|
+
#
|
96
|
+
# state_machine do
|
97
|
+
# event :ignite do
|
98
|
+
# transition :parked => :idling, :idling => same, :if => :seatbelt_on? # Transitions to :idling if seatbelt is on
|
99
|
+
# transition all => :parked, :unless => :seatbelt_on? # Transitions to :parked if seatbelt is off
|
100
|
+
# end
|
101
|
+
# end
|
102
|
+
#
|
103
|
+
# See StateMachine::Machine#transition for a description of the possible
|
104
|
+
# configurations for defining transitions.
|
105
|
+
def transition(options)
|
106
|
+
raise ArgumentError, 'Must specify as least one transition requirement' if options.empty?
|
107
|
+
|
108
|
+
# Only a certain subset of explicit options are allowed for transition
|
109
|
+
# requirements
|
110
|
+
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?
|
111
|
+
|
112
|
+
branches << branch = Branch.new(options.merge(:on => name))
|
113
|
+
@known_states |= branch.known_states
|
114
|
+
branch
|
115
|
+
end
|
116
|
+
|
117
|
+
# Determines whether any transitions can be performed for this event based
|
118
|
+
# on the current state of the given object.
|
119
|
+
#
|
120
|
+
# If the event can't be fired, then this will return false, otherwise true.
|
121
|
+
#
|
122
|
+
# *Note* that this will not take the object context into account. Although
|
123
|
+
# a transition may be possible based on the state machine definition,
|
124
|
+
# object-specific behaviors (like validations) may prevent it from firing.
|
125
|
+
def can_fire?(object, requirements = {})
|
126
|
+
!transition_for(object, requirements).nil?
|
127
|
+
end
|
128
|
+
|
129
|
+
# Finds and builds the next transition that can be performed on the given
|
130
|
+
# object. If no transitions can be made, then this will return nil.
|
131
|
+
#
|
132
|
+
# Valid requirement options:
|
133
|
+
# * <tt>:from</tt> - One or more states being transitioned from. If none
|
134
|
+
# are specified, then this will be the object's current state.
|
135
|
+
# * <tt>:to</tt> - One or more states being transitioned to. If none are
|
136
|
+
# specified, then this will match any to state.
|
137
|
+
# * <tt>:guard</tt> - Whether to guard transitions with the if/unless
|
138
|
+
# conditionals defined for each one. Default is true.
|
139
|
+
def transition_for(object, requirements = {})
|
140
|
+
assert_valid_keys(requirements, :from, :to, :guard)
|
141
|
+
requirements[:from] = machine.states.match!(object).name unless custom_from_state = requirements.include?(:from)
|
142
|
+
|
143
|
+
branches.each do |branch|
|
144
|
+
if match = branch.match(object, requirements)
|
145
|
+
# Branch allows for the transition to occur
|
146
|
+
from = requirements[:from]
|
147
|
+
to = if match[:to].is_a?(LoopbackMatcher)
|
148
|
+
from
|
149
|
+
else
|
150
|
+
values = requirements.include?(:to) ? [requirements[:to]].flatten : [from] | machine.states.map {|state| state.name}
|
151
|
+
|
152
|
+
match[:to].filter(values).first
|
153
|
+
end
|
154
|
+
|
155
|
+
return Transition.new(object, machine, name, from, to, !custom_from_state)
|
156
|
+
end
|
157
|
+
end
|
158
|
+
|
159
|
+
# No transition matched
|
160
|
+
nil
|
161
|
+
end
|
162
|
+
|
163
|
+
# Attempts to perform the next available transition on the given object.
|
164
|
+
# If no transitions can be made, then this will return false, otherwise
|
165
|
+
# true.
|
166
|
+
#
|
167
|
+
# Any additional arguments are passed to the StateMachine::Transition#perform
|
168
|
+
# instance method.
|
169
|
+
def fire(object, *args)
|
170
|
+
machine.reset(object)
|
171
|
+
|
172
|
+
if transition = transition_for(object)
|
173
|
+
transition.perform(*args)
|
174
|
+
else
|
175
|
+
on_failure(object)
|
176
|
+
false
|
177
|
+
end
|
178
|
+
end
|
179
|
+
|
180
|
+
# Marks the object as invalid and runs any failure callbacks associated with
|
181
|
+
# this event. This should get called anytime this event fails to transition.
|
182
|
+
def on_failure(object)
|
183
|
+
state = machine.states.match!(object)
|
184
|
+
machine.invalidate(object, :state, :invalid_transition, [[:event, human_name(object.class)], [:state, state.human_name(object.class)]])
|
185
|
+
|
186
|
+
Transition.new(object, machine, name, state.name, state.name).run_callbacks(:before => false)
|
187
|
+
end
|
188
|
+
|
189
|
+
# Resets back to the initial state of the event, with no branches / known
|
190
|
+
# states associated. This allows you to redefine an event in situations
|
191
|
+
# where you either are re-using an existing state machine implementation
|
192
|
+
# or are subclassing machines.
|
193
|
+
def reset
|
194
|
+
@branches = []
|
195
|
+
@known_states = []
|
196
|
+
end
|
197
|
+
|
198
|
+
# Draws a representation of this event on the given graph. This will
|
199
|
+
# create 1 or more edges on the graph for each branch (i.e. transition)
|
200
|
+
# configured.
|
201
|
+
#
|
202
|
+
# Configuration options:
|
203
|
+
# * <tt>:human_name</tt> - Whether to use the event's human name for the
|
204
|
+
# node's label that gets drawn on the graph
|
205
|
+
def draw(graph, options = {})
|
206
|
+
valid_states = machine.states.by_priority.map {|state| state.name}
|
207
|
+
branches.each do |branch|
|
208
|
+
branch.draw(graph, options[:human_name] ? human_name : name, valid_states)
|
209
|
+
end
|
210
|
+
|
211
|
+
true
|
212
|
+
end
|
213
|
+
|
214
|
+
# Generates a nicely formatted description of this event's contents.
|
215
|
+
#
|
216
|
+
# For example,
|
217
|
+
#
|
218
|
+
# event = StateMachine::Event.new(machine, :park)
|
219
|
+
# event.transition all - :idling => :parked, :idling => same
|
220
|
+
# event # => #<StateMachine::Event name=:park transitions=[all - :idling => :parked, :idling => same]>
|
221
|
+
def inspect
|
222
|
+
transitions = branches.map do |branch|
|
223
|
+
branch.state_requirements.map do |state_requirement|
|
224
|
+
"#{state_requirement[:from].description} => #{state_requirement[:to].description}"
|
225
|
+
end * ', '
|
226
|
+
end
|
227
|
+
|
228
|
+
"#<#{self.class} name=#{name.inspect} transitions=[#{transitions * ', '}]>"
|
229
|
+
end
|
230
|
+
|
231
|
+
protected
|
232
|
+
# Add the various instance methods that can transition the object using
|
233
|
+
# the current event
|
234
|
+
def add_actions
|
235
|
+
# Checks whether the event can be fired on the current object
|
236
|
+
machine.define_helper(:instance, "can_#{qualified_name}?") do |machine, object, *args|
|
237
|
+
machine.event(name).can_fire?(object, *args)
|
238
|
+
end
|
239
|
+
|
240
|
+
# Gets the next transition that would be performed if the event were
|
241
|
+
# fired now
|
242
|
+
machine.define_helper(:instance, "#{qualified_name}_transition") do |machine, object, *args|
|
243
|
+
machine.event(name).transition_for(object, *args)
|
244
|
+
end
|
245
|
+
|
246
|
+
# Fires the event
|
247
|
+
machine.define_helper(:instance, qualified_name) do |machine, object, *args|
|
248
|
+
machine.event(name).fire(object, *args)
|
249
|
+
end
|
250
|
+
|
251
|
+
# Fires the event, raising an exception if it fails
|
252
|
+
machine.define_helper(:instance, "#{qualified_name}!") do |machine, object, *args|
|
253
|
+
object.send(qualified_name, *args) || raise(StateMachine::InvalidTransition.new(object, machine, name))
|
254
|
+
end
|
255
|
+
end
|
256
|
+
end
|
257
|
+
end
|
@@ -0,0 +1,141 @@
|
|
1
|
+
require 'state_machine/node_collection'
|
2
|
+
|
3
|
+
module StateMachine
|
4
|
+
# Represents a collection of events in a state machine
|
5
|
+
class EventCollection < NodeCollection
|
6
|
+
def initialize(machine) #:nodoc:
|
7
|
+
super(machine, :index => [:name, :qualified_name])
|
8
|
+
end
|
9
|
+
|
10
|
+
# Gets the list of events that can be fired on the given object.
|
11
|
+
#
|
12
|
+
# Valid requirement options:
|
13
|
+
# * <tt>:from</tt> - One or more states being transitioned from. If none
|
14
|
+
# are specified, then this will be the object's current state.
|
15
|
+
# * <tt>:to</tt> - One or more states being transitioned to. If none are
|
16
|
+
# specified, then this will match any to state.
|
17
|
+
# * <tt>:on</tt> - One or more events that fire the transition. If none
|
18
|
+
# are specified, then this will match any event.
|
19
|
+
# * <tt>:guard</tt> - Whether to guard transitions with the if/unless
|
20
|
+
# conditionals defined for each one. Default is true.
|
21
|
+
#
|
22
|
+
# == Examples
|
23
|
+
#
|
24
|
+
# class Vehicle
|
25
|
+
# state_machine :initial => :parked do
|
26
|
+
# event :park do
|
27
|
+
# transition :idling => :parked
|
28
|
+
# end
|
29
|
+
#
|
30
|
+
# event :ignite do
|
31
|
+
# transition :parked => :idling
|
32
|
+
# end
|
33
|
+
# end
|
34
|
+
# end
|
35
|
+
#
|
36
|
+
# events = Vehicle.state_machine(:state).events
|
37
|
+
#
|
38
|
+
# vehicle = Vehicle.new # => #<Vehicle:0xb7c464b0 @state="parked">
|
39
|
+
# events.valid_for(vehicle) # => [#<StateMachine::Event name=:ignite transitions=[:parked => :idling]>]
|
40
|
+
#
|
41
|
+
# vehicle.state = 'idling'
|
42
|
+
# events.valid_for(vehicle) # => [#<StateMachine::Event name=:park transitions=[:idling => :parked]>]
|
43
|
+
def valid_for(object, requirements = {})
|
44
|
+
match(requirements).select {|event| event.can_fire?(object, requirements)}
|
45
|
+
end
|
46
|
+
|
47
|
+
# Gets the list of transitions that can be run on the given object.
|
48
|
+
#
|
49
|
+
# Valid requirement options:
|
50
|
+
# * <tt>:from</tt> - One or more states being transitioned from. If none
|
51
|
+
# are specified, then this will be the object's current state.
|
52
|
+
# * <tt>:to</tt> - One or more states being transitioned to. If none are
|
53
|
+
# specified, then this will match any to state.
|
54
|
+
# * <tt>:on</tt> - One or more events that fire the transition. If none
|
55
|
+
# are specified, then this will match any event.
|
56
|
+
# * <tt>:guard</tt> - Whether to guard transitions with the if/unless
|
57
|
+
# conditionals defined for each one. Default is true.
|
58
|
+
#
|
59
|
+
# == Examples
|
60
|
+
#
|
61
|
+
# class Vehicle
|
62
|
+
# state_machine :initial => :parked do
|
63
|
+
# event :park do
|
64
|
+
# transition :idling => :parked
|
65
|
+
# end
|
66
|
+
#
|
67
|
+
# event :ignite do
|
68
|
+
# transition :parked => :idling
|
69
|
+
# end
|
70
|
+
# end
|
71
|
+
# end
|
72
|
+
#
|
73
|
+
# events = Vehicle.state_machine.events
|
74
|
+
#
|
75
|
+
# vehicle = Vehicle.new # => #<Vehicle:0xb7c464b0 @state="parked">
|
76
|
+
# events.transitions_for(vehicle) # => [#<StateMachine::Transition attribute=:state event=:ignite from="parked" from_name=:parked to="idling" to_name=:idling>]
|
77
|
+
#
|
78
|
+
# vehicle.state = 'idling'
|
79
|
+
# events.transitions_for(vehicle) # => [#<StateMachine::Transition attribute=:state event=:park from="idling" from_name=:idling to="parked" to_name=:parked>]
|
80
|
+
#
|
81
|
+
# # Search for explicit transitions regardless of the current state
|
82
|
+
# events.transitions_for(vehicle, :from => :parked) # => [#<StateMachine::Transition attribute=:state event=:ignite from="parked" from_name=:parked to="idling" to_name=:idling>]
|
83
|
+
def transitions_for(object, requirements = {})
|
84
|
+
match(requirements).map {|event| event.transition_for(object, requirements)}.compact
|
85
|
+
end
|
86
|
+
|
87
|
+
# Gets the transition that should be performed for the event stored in the
|
88
|
+
# given object's event attribute. This also takes an additional parameter
|
89
|
+
# for automatically invalidating the object if the event or transition are
|
90
|
+
# invalid. By default, this is turned off.
|
91
|
+
#
|
92
|
+
# *Note* that if a transition has already been generated for the event, then
|
93
|
+
# that transition will be used.
|
94
|
+
#
|
95
|
+
# == Examples
|
96
|
+
#
|
97
|
+
# class Vehicle < ActiveRecord::Base
|
98
|
+
# state_machine :initial => :parked do
|
99
|
+
# event :ignite do
|
100
|
+
# transition :parked => :idling
|
101
|
+
# end
|
102
|
+
# end
|
103
|
+
# end
|
104
|
+
#
|
105
|
+
# vehicle = Vehicle.new # => #<Vehicle id: nil, state: "parked">
|
106
|
+
# events = Vehicle.state_machine.events
|
107
|
+
#
|
108
|
+
# vehicle.state_event = nil
|
109
|
+
# events.attribute_transition_for(vehicle) # => nil # Event isn't defined
|
110
|
+
#
|
111
|
+
# vehicle.state_event = 'invalid'
|
112
|
+
# events.attribute_transition_for(vehicle) # => false # Event is invalid
|
113
|
+
#
|
114
|
+
# vehicle.state_event = 'ignite'
|
115
|
+
# events.attribute_transition_for(vehicle) # => #<StateMachine::Transition attribute=:state event=:ignite from="parked" from_name=:parked to="idling" to_name=:idling>
|
116
|
+
def attribute_transition_for(object, invalidate = false)
|
117
|
+
return unless machine.action
|
118
|
+
|
119
|
+
result = machine.read(object, :event_transition) || if event_name = machine.read(object, :event)
|
120
|
+
if event = self[event_name.to_sym, :name]
|
121
|
+
event.transition_for(object) || begin
|
122
|
+
# No valid transition: invalidate
|
123
|
+
machine.invalidate(object, :event, :invalid_event, [[:state, machine.states.match!(object).human_name(object.class)]]) if invalidate
|
124
|
+
false
|
125
|
+
end
|
126
|
+
else
|
127
|
+
# Event is unknown: invalidate
|
128
|
+
machine.invalidate(object, :event, :invalid) if invalidate
|
129
|
+
false
|
130
|
+
end
|
131
|
+
end
|
132
|
+
|
133
|
+
result
|
134
|
+
end
|
135
|
+
|
136
|
+
private
|
137
|
+
def match(requirements) #:nodoc:
|
138
|
+
requirements && requirements[:on] ? [fetch(requirements.delete(:on))] : self
|
139
|
+
end
|
140
|
+
end
|
141
|
+
end
|
@@ -0,0 +1,149 @@
|
|
1
|
+
require 'state_machine/machine_collection'
|
2
|
+
|
3
|
+
module StateMachine
|
4
|
+
module ClassMethods
|
5
|
+
def self.extended(base) #:nodoc:
|
6
|
+
base.class_eval do
|
7
|
+
@state_machines = MachineCollection.new
|
8
|
+
end
|
9
|
+
end
|
10
|
+
|
11
|
+
# Gets the current list of state machines defined for this class. This
|
12
|
+
# class-level attribute acts like an inheritable attribute. The attribute
|
13
|
+
# is available to each subclass, each having a copy of its superclass's
|
14
|
+
# attribute.
|
15
|
+
#
|
16
|
+
# The hash of state machines maps <tt>:attribute</tt> => +machine+, e.g.
|
17
|
+
#
|
18
|
+
# Vehicle.state_machines # => {:state => #<StateMachine::Machine:0xb6f6e4a4 ...>}
|
19
|
+
def state_machines
|
20
|
+
@state_machines ||= superclass.state_machines.dup
|
21
|
+
end
|
22
|
+
end
|
23
|
+
|
24
|
+
module InstanceMethods
|
25
|
+
# Runs one or more events in parallel. All events will run through the
|
26
|
+
# following steps:
|
27
|
+
# * Before callbacks
|
28
|
+
# * Persist state
|
29
|
+
# * Invoke action
|
30
|
+
# * After callbacks
|
31
|
+
#
|
32
|
+
# For example, if two events (for state machines A and B) are run in
|
33
|
+
# parallel, the order in which steps are run is:
|
34
|
+
# * A - Before transition callbacks
|
35
|
+
# * B - Before transition callbacks
|
36
|
+
# * A - Persist new state
|
37
|
+
# * B - Persist new state
|
38
|
+
# * A - Invoke action
|
39
|
+
# * B - Invoke action (only if different than A's action)
|
40
|
+
# * A - After transition callbacks
|
41
|
+
# * B - After transition callbacks
|
42
|
+
#
|
43
|
+
# *Note* that multiple events on the same state machine / attribute cannot
|
44
|
+
# be run in parallel. If this is attempted, an ArgumentError will be
|
45
|
+
# raised.
|
46
|
+
#
|
47
|
+
# == Halting callbacks
|
48
|
+
#
|
49
|
+
# When running multiple events in parallel, special consideration should
|
50
|
+
# be taken with regard to how halting within callbacks affects the flow.
|
51
|
+
#
|
52
|
+
# For *before* callbacks, any <tt>:halt</tt> error that's thrown will
|
53
|
+
# immediately cancel the perform for all transitions. As a result, it's
|
54
|
+
# possible for one event's transition to affect the continuation of
|
55
|
+
# another.
|
56
|
+
#
|
57
|
+
# On the other hand, any <tt>:halt</tt> error that's thrown within an
|
58
|
+
# *after* callback with only affect that event's transition. Other
|
59
|
+
# transitions will continue to run their own callbacks.
|
60
|
+
#
|
61
|
+
# == Example
|
62
|
+
#
|
63
|
+
# class Vehicle
|
64
|
+
# state_machine :initial => :parked do
|
65
|
+
# event :ignite do
|
66
|
+
# transition :parked => :idling
|
67
|
+
# end
|
68
|
+
#
|
69
|
+
# event :park do
|
70
|
+
# transition :idling => :parked
|
71
|
+
# end
|
72
|
+
# end
|
73
|
+
#
|
74
|
+
# state_machine :alarm_state, :namespace => 'alarm', :initial => :on do
|
75
|
+
# event :enable do
|
76
|
+
# transition all => :active
|
77
|
+
# end
|
78
|
+
#
|
79
|
+
# event :disable do
|
80
|
+
# transition all => :off
|
81
|
+
# end
|
82
|
+
# end
|
83
|
+
# end
|
84
|
+
#
|
85
|
+
# vehicle = Vehicle.new # => #<Vehicle:0xb7c02850 @state="parked", @alarm_state="active">
|
86
|
+
# vehicle.state # => "parked"
|
87
|
+
# vehicle.alarm_state # => "active"
|
88
|
+
#
|
89
|
+
# vehicle.fire_events(:ignite, :disable_alarm) # => true
|
90
|
+
# vehicle.state # => "idling"
|
91
|
+
# vehicle.alarm_state # => "off"
|
92
|
+
#
|
93
|
+
# # If any event fails, the entire event chain fails
|
94
|
+
# vehicle.fire_events(:ignite, :enable_alarm) # => false
|
95
|
+
# vehicle.state # => "idling"
|
96
|
+
# vehicle.alarm_state # => "off"
|
97
|
+
#
|
98
|
+
# # Exception raised on invalid event
|
99
|
+
# vehicle.fire_events(:park, :invalid) # => StateMachine::InvalidEvent: :invalid is an unknown event
|
100
|
+
# vehicle.state # => "idling"
|
101
|
+
# vehicle.alarm_state # => "off"
|
102
|
+
def fire_events(*events)
|
103
|
+
self.class.state_machines.fire_events(self, *events)
|
104
|
+
end
|
105
|
+
|
106
|
+
# Run one or more events in parallel. If any event fails to run, then
|
107
|
+
# a StateMachine::InvalidTransition exception will be raised.
|
108
|
+
#
|
109
|
+
# See StateMachine::InstanceMethods#fire_events for more information.
|
110
|
+
#
|
111
|
+
# == Example
|
112
|
+
#
|
113
|
+
# class Vehicle
|
114
|
+
# state_machine :initial => :parked do
|
115
|
+
# event :ignite do
|
116
|
+
# transition :parked => :idling
|
117
|
+
# end
|
118
|
+
#
|
119
|
+
# event :park do
|
120
|
+
# transition :idling => :parked
|
121
|
+
# end
|
122
|
+
# end
|
123
|
+
#
|
124
|
+
# state_machine :alarm_state, :namespace => 'alarm', :initial => :active do
|
125
|
+
# event :enable do
|
126
|
+
# transition all => :active
|
127
|
+
# end
|
128
|
+
#
|
129
|
+
# event :disable do
|
130
|
+
# transition all => :off
|
131
|
+
# end
|
132
|
+
# end
|
133
|
+
# end
|
134
|
+
#
|
135
|
+
# vehicle = Vehicle.new # => #<Vehicle:0xb7c02850 @state="parked", @alarm_state="active">
|
136
|
+
# vehicle.fire_events(:ignite, :disable_alarm) # => true
|
137
|
+
#
|
138
|
+
# vehicle.fire_events!(:ignite, :disable_alarm) # => StateMachine::InvalidTranstion: Cannot run events in parallel: ignite, disable_alarm
|
139
|
+
def fire_events!(*events)
|
140
|
+
run_action = [true, false].include?(events.last) ? events.pop : true
|
141
|
+
fire_events(*(events + [run_action])) || raise(StateMachine::InvalidParallelTransition.new(self, events))
|
142
|
+
end
|
143
|
+
|
144
|
+
protected
|
145
|
+
def initialize_state_machines(options = {}, &block) #:nodoc:
|
146
|
+
self.class.state_machines.initialize_states(self, options, &block)
|
147
|
+
end
|
148
|
+
end
|
149
|
+
end
|
@@ -0,0 +1,92 @@
|
|
1
|
+
begin
|
2
|
+
require 'rubygems'
|
3
|
+
gem 'ruby-graphviz', '>=0.9.17'
|
4
|
+
require 'graphviz'
|
5
|
+
rescue LoadError => ex
|
6
|
+
$stderr.puts "Cannot draw the machine (#{ex.message}). `gem install ruby-graphviz` >= v0.9.17 and try again."
|
7
|
+
raise
|
8
|
+
end
|
9
|
+
|
10
|
+
require 'state_machine/assertions'
|
11
|
+
|
12
|
+
module StateMachine
|
13
|
+
# Provides a set of higher-order features on top of the raw GraphViz graphs
|
14
|
+
class Graph < GraphViz
|
15
|
+
include Assertions
|
16
|
+
|
17
|
+
# The name of the font to draw state names in
|
18
|
+
attr_reader :font
|
19
|
+
|
20
|
+
# The graph's full filename
|
21
|
+
attr_reader :file_path
|
22
|
+
|
23
|
+
# The image format to generate the graph in
|
24
|
+
attr_reader :file_format
|
25
|
+
|
26
|
+
# Creates a new graph with the given name.
|
27
|
+
#
|
28
|
+
# Configuration options:
|
29
|
+
# * <tt>:path</tt> - The path to write the graph file to. Default is the
|
30
|
+
# current directory (".").
|
31
|
+
# * <tt>:format</tt> - The image format to generate the graph in.
|
32
|
+
# Default is "png'.
|
33
|
+
# * <tt>:font</tt> - The name of the font to draw state names in.
|
34
|
+
# Default is "Arial".
|
35
|
+
# * <tt>:orientation</tt> - The direction of the graph ("portrait" or
|
36
|
+
# "landscape"). Default is "portrait".
|
37
|
+
def initialize(name, options = {})
|
38
|
+
options = {:path => '.', :format => 'png', :font => 'Arial', :orientation => 'portrait'}.merge(options)
|
39
|
+
assert_valid_keys(options, :path, :format, :font, :orientation)
|
40
|
+
|
41
|
+
@font = options[:font]
|
42
|
+
@file_path = File.join(options[:path], "#{name}.#{options[:format]}")
|
43
|
+
@file_format = options[:format]
|
44
|
+
|
45
|
+
super('G', :rankdir => options[:orientation] == 'landscape' ? 'LR' : 'TB')
|
46
|
+
end
|
47
|
+
|
48
|
+
# Generates the actual image file based on the nodes / edges added to the
|
49
|
+
# graph. The path to the file is based on the configuration options for
|
50
|
+
# this graph.
|
51
|
+
def output
|
52
|
+
super(@file_format => @file_path)
|
53
|
+
end
|
54
|
+
|
55
|
+
# Adds a new node to the graph. The font for the node will be automatically
|
56
|
+
# set based on the graph configuration. The generated node will be returned.
|
57
|
+
#
|
58
|
+
# For example,
|
59
|
+
#
|
60
|
+
# graph = StateMachine::Graph.new('test')
|
61
|
+
# graph.add_nodes('parked', :label => 'Parked', :width => '1', :height => '1', :shape => 'ellipse')
|
62
|
+
def add_nodes(*args)
|
63
|
+
node = v0_api? ? add_node(*args) : super
|
64
|
+
node.fontname = @font
|
65
|
+
node
|
66
|
+
end
|
67
|
+
|
68
|
+
# Adds a new edge to the graph. The font for the edge will be automatically
|
69
|
+
# set based on the graph configuration. The generated edge will be returned.
|
70
|
+
#
|
71
|
+
# For example,
|
72
|
+
#
|
73
|
+
# graph = StateMachine::Graph.new('test')
|
74
|
+
# graph.add_edges('parked', 'idling', :label => 'ignite')
|
75
|
+
def add_edges(*args)
|
76
|
+
edge = v0_api? ? add_edge(*args) : super
|
77
|
+
edge.fontname = @font
|
78
|
+
edge
|
79
|
+
end
|
80
|
+
|
81
|
+
private
|
82
|
+
# Determines whether the old v0 api is in use
|
83
|
+
def v0_api?
|
84
|
+
version[0] == '0' || version[0] == '1' && version[1] == '0' && version[2] <= '2'
|
85
|
+
end
|
86
|
+
|
87
|
+
# The ruby-graphviz version data
|
88
|
+
def version
|
89
|
+
Constants::RGV_VERSION.split('.')
|
90
|
+
end
|
91
|
+
end
|
92
|
+
end
|
@@ -0,0 +1,17 @@
|
|
1
|
+
module StateMachine
|
2
|
+
# Represents a type of module that defines instance / class methods for a
|
3
|
+
# state machine
|
4
|
+
class HelperModule < Module #:nodoc:
|
5
|
+
def initialize(machine, kind)
|
6
|
+
@machine = machine
|
7
|
+
@kind = kind
|
8
|
+
end
|
9
|
+
|
10
|
+
# Provides a human-readable description of the module
|
11
|
+
def to_s
|
12
|
+
owner_class = @machine.owner_class
|
13
|
+
owner_class_name = owner_class.name && !owner_class.name.empty? ? owner_class.name : owner_class.to_s
|
14
|
+
"#{owner_class_name} #{@machine.name.inspect} #{@kind} helpers"
|
15
|
+
end
|
16
|
+
end
|
17
|
+
end
|
@@ -0,0 +1,25 @@
|
|
1
|
+
if defined?(Rails)
|
2
|
+
# Track all of the applicable locales to load
|
3
|
+
locale_paths = []
|
4
|
+
StateMachine::Integrations.all.each do |integration|
|
5
|
+
locale_paths << integration.locale_path if integration.available? && integration.locale_path
|
6
|
+
end
|
7
|
+
|
8
|
+
if defined?(Rails::Engine)
|
9
|
+
# Rails 3.x
|
10
|
+
class StateMachine::RailsEngine < Rails::Engine
|
11
|
+
rake_tasks do
|
12
|
+
load 'tasks/state_machine.rb'
|
13
|
+
end
|
14
|
+
end
|
15
|
+
|
16
|
+
if Rails::VERSION::MAJOR == 3 && Rails::VERSION::MINOR == 0
|
17
|
+
StateMachine::RailsEngine.paths.config.locales = locale_paths
|
18
|
+
else
|
19
|
+
StateMachine::RailsEngine.paths['config/locales'] = locale_paths
|
20
|
+
end
|
21
|
+
elsif defined?(I18n)
|
22
|
+
# Rails 2.x
|
23
|
+
I18n.load_path.unshift(*locale_paths)
|
24
|
+
end
|
25
|
+
end
|