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

Instance Method Summary collapse

Class Method Details

.included(base) ⇒ Object 



11
12
13
14
 
# File 'lib/statesman/machine.rb', line 11

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



17
18
19
20
21
22
23
24
25
26
 
# File 'lib/statesman/machine.rb', line 17

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 ⇒ Object 



183
184
185
186
187
 
# File 'lib/statesman/machine.rb', line 183

def allowed_transitions
  successors_for(current_state).select do |state|
    can_transition_to?(state)
  end
end

#available_events ⇒ Object 



251
252
253
254
255
 
# File 'lib/statesman/machine.rb', line 251

def available_events
  self.class.events.select do |_, transitions|
    transitions.key?(current_state)
  end.map(&:first)
end

#can_transition_to?(new_state, metadata = nil) ⇒ Boolean

Returns:

  • (Boolean) 


193
194
195
196
197
198
199
200
 
# File 'lib/statesman/machine.rb', line 193

def can_transition_to?(new_state, metadata = nil)
  validate_transition(from: current_state,
                      to: new_state,
                      metadata: metadata)
  true
rescue TransitionFailedError, GuardFailedError
  false
end

#current_state ⇒ Object 



178
179
180
181
 
# File 'lib/statesman/machine.rb', line 178

def current_state
  last_action = last_transition
  last_action ? last_action.to_state : self.class.initial_state
end

#execute(phase, initial_state, new_state, transition) ⇒ Object 



234
235
236
237
 
# File 'lib/statesman/machine.rb', line 234

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

#history ⇒ Object 



202
203
204
 
# File 'lib/statesman/machine.rb', line 202

def history
  @storage_adapter.history
end

#initialize(object, options = { transition_class: Statesman::Adapters::MemoryTransition }) ⇒ Object 



167
168
169
170
171
172
173
174
175
176
 
# File 'lib/statesman/machine.rb', line 167

def initialize(object,
                  options = {
                    transition_class: Statesman::Adapters::MemoryTransition
                  })
  @object = object
  @transition_class = options[:transition_class]
  @storage_adapter = adapter_class(@transition_class)
                      .new(@transition_class, object, self)
  send(:after_initialize) if respond_to? :after_initialize
end

#last_transition ⇒ Object 



189
190
191
 
# File 'lib/statesman/machine.rb', line 189

def last_transition
  @storage_adapter.last
end

#transition_to(new_state, metadata = nil) ⇒ Object 



239
240
241
242
243
 
# File 'lib/statesman/machine.rb', line 239

def transition_to(new_state, metadata = nil)
  self.transition_to!(new_state, metadata)
rescue TransitionFailedError, GuardFailedError
  false
end

#transition_to!(new_state, metadata = nil) ⇒ Object 



206
207
208
209
210
211
212
213
214
215
216
217
 
# File 'lib/statesman/machine.rb', line 206

def transition_to!(new_state, metadata = nil)
  initial_state = current_state
  new_state = new_state.to_s

  validate_transition(from: initial_state,
                      to: new_state,
                      metadata: metadata)

  @storage_adapter.create(initial_state, new_state, metadata)

  true
end

#trigger(event_name, metadata = nil) ⇒ Object 



245
246
247
248
249
 
# File 'lib/statesman/machine.rb', line 245

def trigger(event_name, metadata = nil)
  self.trigger!(event_name, metadata)
rescue TransitionFailedError, GuardFailedError
  false
end

#trigger!(event_name, metadata = nil) ⇒ Object 



219
220
221
222
223
224
225
226
227
228
229
230
231
232
 
# File 'lib/statesman/machine.rb', line 219

def trigger!(event_name, metadata = nil)
  transitions = self.class.events.fetch(event_name) do
    raise Statesman::TransitionFailedError,
          "Event #{event_name} not found"
  end

  new_state = transitions.fetch(current_state) do
    raise Statesman::TransitionFailedError,
          "State #{current_state} not found for Event #{event_name}"
  end

  transition_to!(new_state.first, metadata)
  true
end