Module: Statesman::Machine
- Defined in:
- lib/statesman/machine.rb
Overview
The main module, that should be ‘extend`ed in to state machine classes.
Defined Under Namespace
Modules: ClassMethods
Class Method Summary collapse
- .included(base) ⇒ Object
-
.retry_conflicts(max_retries = 1) ⇒ Object
Retry any transitions that fail due to a TransitionConflictError.
Instance Method Summary collapse
- #allowed_transitions(metadata = {}) ⇒ Object
- #can_transition_to?(new_state, metadata = {}) ⇒ Boolean
- #current_state(force_reload: false) ⇒ Object
- #execute(phase, initial_state, new_state, transition) ⇒ Object
- #execute_on_failure(phase, initial_state, new_state, exception) ⇒ Object
- #history ⇒ Object
- #in_state?(*states) ⇒ Boolean
- #initialize(object, options = { transition_class: Statesman::Adapters::MemoryTransition, }) ⇒ Object
- #last_transition(force_reload: false) ⇒ Object
- #transition_to(new_state, metadata = {}) ⇒ Object
- #transition_to!(new_state, metadata = {}) ⇒ Object
Class Method Details
.included(base) ⇒ Object
12 13 14 15 |
# File 'lib/statesman/machine.rb', line 12 def self.included(base) base.extend(ClassMethods) base.send(:attr_reader, :object) end |
.retry_conflicts(max_retries = 1) ⇒ Object
Retry any transitions that fail due to a TransitionConflictError
18 19 20 21 22 23 24 25 26 27 |
# File 'lib/statesman/machine.rb', line 18 def self.retry_conflicts(max_retries = 1) retry_attempt = 0 begin yield rescue TransitionConflictError retry_attempt += 1 retry_attempt <= max_retries ? retry : raise end end |
Instance Method Details
#allowed_transitions(metadata = {}) ⇒ Object
202 203 204 205 206 |
# File 'lib/statesman/machine.rb', line 202 def allowed_transitions( = {}) successors_for(current_state).select do |state| can_transition_to?(state, ) end end |
#can_transition_to?(new_state, metadata = {}) ⇒ Boolean
212 213 214 215 216 217 218 219 |
# File 'lib/statesman/machine.rb', line 212 def can_transition_to?(new_state, = {}) validate_transition(from: current_state, to: new_state, metadata: ) true rescue TransitionFailedError, GuardFailedError false end |
#current_state(force_reload: false) ⇒ Object
193 194 195 196 |
# File 'lib/statesman/machine.rb', line 193 def current_state(force_reload: false) last_action = last_transition(force_reload: force_reload) last_action ? last_action.to_state : self.class.initial_state end |
#execute(phase, initial_state, new_state, transition) ⇒ Object
249 250 251 252 |
# File 'lib/statesman/machine.rb', line 249 def execute(phase, initial_state, new_state, transition) callbacks = callbacks_for(phase, from: initial_state, to: new_state) callbacks.each { |cb| cb.call(@object, transition) } end |
#execute_on_failure(phase, initial_state, new_state, exception) ⇒ Object
244 245 246 247 |
# File 'lib/statesman/machine.rb', line 244 def execute_on_failure(phase, initial_state, new_state, exception) callbacks = callbacks_for(phase, from: initial_state, to: new_state) callbacks.each { |cb| cb.call(@object, exception) } end |
#history ⇒ Object
221 222 223 |
# File 'lib/statesman/machine.rb', line 221 def history @storage_adapter.history end |
#in_state?(*states) ⇒ Boolean
198 199 200 |
# File 'lib/statesman/machine.rb', line 198 def in_state?(*states) states.flatten.any? { |state| current_state == state.to_s } end |
#initialize(object, options = { transition_class: Statesman::Adapters::MemoryTransition, }) ⇒ Object
181 182 183 184 185 186 187 188 189 190 191 |
# File 'lib/statesman/machine.rb', line 181 def initialize(object, = { transition_class: Statesman::Adapters::MemoryTransition, }) @object = object @transition_class = [:transition_class] @storage_adapter = adapter_class(@transition_class).new( @transition_class, object, self, ) send(:after_initialize) if respond_to? :after_initialize end |
#last_transition(force_reload: false) ⇒ Object
208 209 210 |
# File 'lib/statesman/machine.rb', line 208 def last_transition(force_reload: false) @storage_adapter.last(force_reload: force_reload) end |
#transition_to(new_state, metadata = {}) ⇒ Object
254 255 256 257 258 |
# File 'lib/statesman/machine.rb', line 254 def transition_to(new_state, = {}) transition_to!(new_state, ) rescue TransitionFailedError, GuardFailedError false end |
#transition_to!(new_state, metadata = {}) ⇒ Object
225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 |
# File 'lib/statesman/machine.rb', line 225 def transition_to!(new_state, = {}) initial_state = current_state new_state = new_state.to_s validate_transition(from: initial_state, to: new_state, metadata: ) @storage_adapter.create(initial_state, new_state, ) true rescue TransitionFailedError => e execute_on_failure(:after_transition_failure, initial_state, new_state, e) raise rescue GuardFailedError => e execute_on_failure(:after_guard_failure, initial_state, new_state, e) raise end |