module AASM def self.included(base) #:nodoc: base.extend AASM::ClassMethods # do not overwrite existing state machines, which could have been created by # inheritance, see class method inherited AASM::StateMachine[base] ||= AASM::StateMachine.new AASM::Persistence.load_persistence(base) super end module ClassMethods # make sure inheritance (aka subclassing) works with AASM def inherited(base) AASM::StateMachine[base] = AASM::StateMachine[self].clone super end # this is the entry point for all state and event definitions def aasm(options={}, &block) @aasm ||= AASM::Base.new(self, options) @aasm.instance_eval(&block) if block # new DSL @aasm end # TODO remove this method in v4.0.0 def aasm_initial_state(set_state=nil) if set_state warn ".aasm_initial_state(:name) is deprecated and will be removed in version 4.0.0; please use .aasm.initial_state = :name instead!" AASM::StateMachine[self].initial_state = set_state else warn ".aasm_initial_state is deprecated and will be removed in version 4.0.0; please use .aasm.initial_state instead!" AASM::StateMachine[self].initial_state end end # TODO remove this method in v4.0.0 def aasm_from_states_for_state(state, options={}) warn ".aasm_from_states_for_state is deprecated and will be removed in version 4.0.0; please use .aasm.from_states_for_state instead!" aasm.from_states_for_state(state, options) end # TODO remove this method in v4.0.0 def aasm_initial_state=(state) warn ".aasm_initial_state= is deprecated and will be removed in version 4.0.0" AASM::StateMachine[self].initial_state = state end # TODO remove this method in v4.0.0 def aasm_state(name, options={}) warn ".aasm_state is deprecated and will be removed in version 4.0.0; please use .aasm.state instead!" aasm.state(name, options) end # TODO remove this method in v4.0.0 def aasm_event(name, options = {}, &block) warn ".aasm_event is deprecated and will be removed in version 4.0.0; please use .aasm.event instead!" aasm.event(name, options, &block) end # TODO remove this method in v4.0.0 def aasm_states warn ".aasm_states is deprecated and will be removed in version 4.0.0; please use .aasm.states instead!" aasm.states end # TODO remove this method in v4.0.0 def aasm_events warn ".aasm_events is deprecated and will be removed in version 4.0.0; please use .aasm.events instead!" aasm.events end # TODO remove this method in v4.0.0 def aasm_states_for_select warn ".aasm_states_for_select is deprecated and will be removed in version 4.0.0; please use .aasm.states_for_select instead!" aasm.states_for_select end # aasm.event(:event_name).human? def aasm_human_event_name(event) # event_name? AASM::Localizer.new.human_event_name(self, event) end end # ClassMethods def aasm @aasm ||= AASM::InstanceBase.new(self) end # may be overwritten by persistence mixins def aasm_read_state # all the following lines behave like @current_state ||= aasm.enter_initial_state current = aasm.instance_variable_get("@current_state") return current if current aasm.instance_variable_set("@current_state", aasm.enter_initial_state) end # may be overwritten by persistence mixins def aasm_write_state(new_state) true end # may be overwritten by persistence mixins def aasm_write_state_without_persistence(new_state) true end # TODO remove this method in v4.0.0 def aasm_current_state warn "#aasm_current_state is deprecated and will be removed in version 4.0.0; please use #aasm.current_state instead!" aasm.current_state end # TODO remove this method in v4.0.0 def aasm_enter_initial_state warn "#aasm_enter_initial_state is deprecated and will be removed in version 4.0.0; please use #aasm.enter_initial_state instead!" aasm.enter_initial_state end # TODO remove this method in v4.0.0 def aasm_events_for_current_state warn "#aasm_events_for_current_state is deprecated and will be removed in version 4.0.0; please use #aasm.events(aasm.current_state) instead!" aasm.events(aasm.current_state) end # TODO remove this method in v4.0.0 def aasm_permissible_events_for_current_state warn "#aasm_permissible_events_for_current_state is deprecated and will be removed in version 4.0.0; please use #aasm.permissible_events instead!" aasm.permissible_events end # TODO remove this method in v4.0.0 def aasm_events_for_state(state_name) warn "#aasm_events_for_state(state_name) is deprecated and will be removed in version 4.0.0; please use #aasm.events(state_name) instead!" aasm.events(state_name) end # TODO remove this method in v4.0.0 def aasm_human_state warn "#aasm_human_state is deprecated and will be removed in version 4.0.0; please use #aasm.human_state instead!" aasm.human_state end private def aasm_fire_event(event_name, options, *args, &block) event = self.class.aasm.events[event_name] begin old_state = aasm.state_object_for_name(aasm.current_state) old_state.fire_callbacks(:exit, self) # new event before callback event.fire_callbacks(:before, self) if new_state_name = event.fire(self, *args) fired(event, old_state, new_state_name, options, &block) else failed(event_name, old_state) end rescue StandardError => e event.fire_callbacks(:error, self, e) || raise(e) end end def fired(event, old_state, new_state_name, options) persist = options[:persist] new_state = aasm.state_object_for_name(new_state_name) # new before_ callbacks old_state.fire_callbacks(:before_exit, self) new_state.fire_callbacks(:before_enter, self) new_state.fire_callbacks(:enter, self) persist_successful = true if persist persist_successful = aasm.set_current_state_with_persistence(new_state_name) if persist_successful yield if block_given? event.fire_callbacks(:success, self) end else aasm.current_state = new_state_name yield if block_given? end if persist_successful old_state.fire_callbacks(:after_exit, self) new_state.fire_callbacks(:after_enter, self) event.fire_callbacks(:after, self) self.aasm_event_fired(event.name, old_state.name, aasm.current_state) if self.respond_to?(:aasm_event_fired) else self.aasm_event_failed(event.name, old_state.name) if self.respond_to?(:aasm_event_failed) end persist_successful end def failed(event_name, old_state) if self.respond_to?(:aasm_event_failed) self.aasm_event_failed(event_name, old_state.name) end if AASM::StateMachine[self.class].config.whiny_transitions raise AASM::InvalidTransition, "Event '#{event_name}' cannot transition from '#{aasm.current_state}'" else false end end end