aasm/lib/aasm.rb

143 lines
3.8 KiB
Ruby
Raw Normal View History

require File.join(File.dirname(__FILE__), 'event')
2008-02-21 17:32:04 +00:00
require File.join(File.dirname(__FILE__), 'state')
require File.join(File.dirname(__FILE__), 'state_machine')
require File.join(File.dirname(__FILE__), 'persistence')
2008-01-07 19:11:38 +00:00
module AASM
class InvalidTransition < Exception
end
2008-01-07 19:11:38 +00:00
def self.included(base) #:nodoc:
base.extend AASM::ClassMethods
AASM::Persistence.set_persistence(base)
AASM::StateMachine[base] = AASM::StateMachine.new('')
base.class_eval do
def base.inherited(klass)
AASM::StateMachine[klass] = AASM::StateMachine[self].dup
end
end
2008-01-07 19:11:38 +00:00
end
module ClassMethods
2008-02-21 17:59:28 +00:00
def aasm_initial_state(set_state=nil)
if set_state
AASM::StateMachine[self].initial_state = set_state
2008-02-21 17:59:28 +00:00
else
AASM::StateMachine[self].initial_state
2008-02-21 17:59:28 +00:00
end
2008-01-07 19:11:38 +00:00
end
def aasm_initial_state=(state)
AASM::StateMachine[self].initial_state = state
2008-01-07 19:11:38 +00:00
end
2008-02-21 17:59:28 +00:00
def aasm_state(name, options={})
sm = AASM::StateMachine[self]
2008-05-31 22:33:17 +00:00
sm.create_state(name, options)
sm.initial_state = name unless sm.initial_state
2008-01-07 19:11:38 +00:00
define_method("#{name.to_s}?") do
2008-01-08 14:39:00 +00:00
aasm_current_state == name
2008-01-07 19:11:38 +00:00
end
end
def aasm_event(name, options = {}, &block)
sm = AASM::StateMachine[self]
unless sm.events.has_key?(name)
sm.events[name] = AASM::SupportingClasses::Event.new(name, options, &block)
end
define_method("#{name.to_s}!") do |*args|
aasm_fire_event(name, true, *args)
end
define_method("#{name.to_s}") do |*args|
aasm_fire_event(name, false, *args)
2008-01-07 19:11:38 +00:00
end
end
def aasm_states
AASM::StateMachine[self].states
end
2008-01-08 15:03:18 +00:00
def aasm_events
AASM::StateMachine[self].events
2008-01-07 19:11:38 +00:00
end
def aasm_states_for_select
AASM::StateMachine[self].states.map { |state| state.for_select }
end
2008-01-07 19:11:38 +00:00
end
# Instance methods
2008-01-08 14:39:00 +00:00
def aasm_current_state
return @aasm_current_state if @aasm_current_state
if self.respond_to?(:aasm_read_state) || self.private_methods.include?('aasm_read_state')
@aasm_current_state = aasm_read_state
end
return @aasm_current_state if @aasm_current_state
self.class.aasm_initial_state
2008-01-07 19:11:38 +00:00
end
2008-01-08 14:39:00 +00:00
def aasm_events_for_current_state
aasm_events_for_state(aasm_current_state)
end
def aasm_events_for_state(state)
events = self.class.aasm_events.values.select {|event| event.transitions_from_state?(state) }
events.map {|event| event.name}
end
2008-01-08 14:39:00 +00:00
private
def aasm_current_state_with_persistence=(state)
if self.respond_to?(:aasm_write_state) || self.private_methods.include?('aasm_write_state')
2008-02-21 16:15:40 +00:00
aasm_write_state(state)
2008-01-08 14:39:00 +00:00
end
self.aasm_current_state = state
2008-01-08 14:39:00 +00:00
end
def aasm_current_state=(state)
if self.respond_to?(:aasm_write_state_without_persistence) || self.private_methods.include?('aasm_write_state_without_persistence')
aasm_write_state_without_persistence(state)
end
@aasm_current_state = state
end
def aasm_state_object_for_state(name)
self.class.aasm_states.find {|s| s == name}
end
def aasm_fire_event(name, persist, *args)
aasm_state_object_for_state(aasm_current_state).call_action(:exit, self)
new_state = self.class.aasm_events[name].fire(self, *args)
unless new_state.nil?
aasm_state_object_for_state(new_state).call_action(:enter, self)
if self.respond_to?(:aasm_event_fired)
self.aasm_event_fired(self.aasm_current_state, new_state)
end
if persist
self.aasm_current_state_with_persistence = new_state
self.send(self.class.aasm_events[name].success) if self.class.aasm_events[name].success
else
self.aasm_current_state = new_state
end
true
else
if self.respond_to?(:aasm_event_failed)
self.aasm_event_failed(name)
end
false
end
end
2008-01-07 19:11:38 +00:00
end