Module: Statesman::Machine::ClassMethods
- Defined in:
- lib/statesman/machine.rb
Instance Attribute Summary collapse
-
#initial_state ⇒ Object
readonly
Returns the value of attribute initial_state.
Instance Method Summary collapse
- #after_transition(options = { after_commit: false }, &block) ⇒ Object
- #before_transition(options = {}, &block) ⇒ Object
- #callbacks ⇒ Object
- #guard_transition(options = {}, &block) ⇒ Object
- #state(name, options = { initial: false }) ⇒ Object
- #states ⇒ Object
- #successors ⇒ Object
- #transition(from: nil, to: nil) ⇒ Object
- #validate_callback_condition(options = { from: nil, to: nil }) ⇒ Object
-
#validate_from_and_to_state(from, to) ⇒ Object
Check that the transition is valid when ‘from’ and ‘to’ are given.
-
#validate_not_from_terminal_state(from) ⇒ Object
Check that the ‘from’ state is not terminal.
-
#validate_not_to_initial_state(to) ⇒ Object
Check that the ‘to’ state is not initial.
Instance Attribute Details
#initial_state ⇒ Object (readonly)
Returns the value of attribute initial_state.
28 29 30 |
# File 'lib/statesman/machine.rb', line 28 def initial_state @initial_state end |
Instance Method Details
#after_transition(options = { after_commit: false }, &block) ⇒ Object
79 80 81 82 83 84 |
# File 'lib/statesman/machine.rb', line 79 def after_transition( = { after_commit: false }, &block) callback_type = [:after_commit] ? :after_commit : :after add_callback(callback_type: callback_type, callback_class: Callback, from: [:from], to: [:to], &block) end |
#before_transition(options = {}, &block) ⇒ Object
69 70 71 72 |
# File 'lib/statesman/machine.rb', line 69 def before_transition( = {}, &block) add_callback(callback_type: :before, callback_class: Callback, from: [:from], to: [:to], &block) end |
#callbacks ⇒ Object
47 48 49 50 51 52 53 54 |
# File 'lib/statesman/machine.rb', line 47 def callbacks @callbacks ||= { before: [], after: [], after_commit: [], guards: [], } end |
#guard_transition(options = {}, &block) ⇒ Object
74 75 76 77 |
# File 'lib/statesman/machine.rb', line 74 def guard_transition( = {}, &block) add_callback(callback_type: :guards, callback_class: Guard, from: [:from], to: [:to], &block) end |
#state(name, options = { initial: false }) ⇒ Object
34 35 36 37 38 39 40 41 |
# File 'lib/statesman/machine.rb', line 34 def state(name, = { initial: false }) name = name.to_s if [:initial] validate_initial_state(name) @initial_state = name end states << name end |
#states ⇒ Object
30 31 32 |
# File 'lib/statesman/machine.rb', line 30 def states @states ||= [] end |
#successors ⇒ Object
43 44 45 |
# File 'lib/statesman/machine.rb', line 43 def successors @successors ||= {} end |
#transition(from: nil, to: nil) ⇒ Object
56 57 58 59 60 61 62 63 64 65 66 67 |
# File 'lib/statesman/machine.rb', line 56 def transition(from: nil, to: nil) from = to_s_or_nil(from) to = array_to_s_or_nil(to) raise InvalidStateError, "No to states provided." if to.empty? successors[from] ||= [] ([from] + to).each { |state| validate_state(state) } successors[from] += to end |
#validate_callback_condition(options = { from: nil, to: nil }) ⇒ Object
86 87 88 89 90 91 92 93 94 95 96 97 98 99 |
# File 'lib/statesman/machine.rb', line 86 def validate_callback_condition( = { from: nil, to: nil }) from = to_s_or_nil([:from]) to = array_to_s_or_nil([:to]) ([from] + to).compact.each { |state| validate_state(state) } return if from.nil? && to.empty? validate_not_from_terminal_state(from) to.each { |state| validate_not_to_initial_state(state) } return if from.nil? || to.empty? to.each { |state| validate_from_and_to_state(from, state) } end |
#validate_from_and_to_state(from, to) ⇒ Object
Check that the transition is valid when ‘from’ and ‘to’ are given
118 119 120 121 122 123 |
# File 'lib/statesman/machine.rb', line 118 def validate_from_and_to_state(from, to) unless successors.fetch(from, []).include?(to) raise InvalidTransitionError, "Cannot transition from '#{from}' to '#{to}'" end end |
#validate_not_from_terminal_state(from) ⇒ Object
Check that the ‘from’ state is not terminal
102 103 104 105 106 107 |
# File 'lib/statesman/machine.rb', line 102 def validate_not_from_terminal_state(from) unless from.nil? || successors.key?(from) raise InvalidTransitionError, "Cannot transition away from terminal state '#{from}'" end end |
#validate_not_to_initial_state(to) ⇒ Object
Check that the ‘to’ state is not initial
110 111 112 113 114 115 |
# File 'lib/statesman/machine.rb', line 110 def validate_not_to_initial_state(to) unless to.nil? || successors.values.flatten.include?(to) raise InvalidTransitionError, "Cannot transition to initial state '#{to}'" end end |