dunedain289-aasm 2.1
Sign up to get free protection for your applications and to get access to all the features.
- data/CHANGELOG +33 -0
- data/MIT-LICENSE +20 -0
- data/README.rdoc +91 -0
- data/Rakefile +94 -0
- data/TODO +9 -0
- data/doc/jamis.rb +591 -0
- data/lib/aasm.rb +173 -0
- data/lib/event.rb +65 -0
- data/lib/persistence.rb +16 -0
- data/lib/persistence/active_record_persistence.rb +246 -0
- data/lib/state.rb +33 -0
- data/lib/state_machine.rb +35 -0
- data/lib/state_transition.rb +36 -0
- metadata +74 -0
data/lib/aasm.rb
ADDED
@@ -0,0 +1,173 @@
|
|
1
|
+
require File.join(File.dirname(__FILE__), 'event')
|
2
|
+
require File.join(File.dirname(__FILE__), 'state')
|
3
|
+
require File.join(File.dirname(__FILE__), 'state_machine')
|
4
|
+
require File.join(File.dirname(__FILE__), 'persistence')
|
5
|
+
|
6
|
+
module AASM
|
7
|
+
def self.Version
|
8
|
+
'2.0.5'
|
9
|
+
end
|
10
|
+
|
11
|
+
class InvalidTransition < RuntimeError
|
12
|
+
end
|
13
|
+
|
14
|
+
class UndefinedState < RuntimeError
|
15
|
+
end
|
16
|
+
|
17
|
+
def self.included(base) #:nodoc:
|
18
|
+
# TODO - need to ensure that a machine is being created because
|
19
|
+
# AASM was either included or arrived at via inheritance. It
|
20
|
+
# cannot be both.
|
21
|
+
base.extend AASM::ClassMethods
|
22
|
+
AASM::Persistence.set_persistence(base)
|
23
|
+
AASM::StateMachine[base] = AASM::StateMachine.new('')
|
24
|
+
end
|
25
|
+
|
26
|
+
module ClassMethods
|
27
|
+
def inherited(klass)
|
28
|
+
AASM::StateMachine[klass] = AASM::StateMachine[self].clone
|
29
|
+
super
|
30
|
+
end
|
31
|
+
|
32
|
+
def aasm_initial_state(set_state=nil)
|
33
|
+
if set_state
|
34
|
+
AASM::StateMachine[self].initial_state = set_state
|
35
|
+
else
|
36
|
+
AASM::StateMachine[self].initial_state
|
37
|
+
end
|
38
|
+
end
|
39
|
+
|
40
|
+
def aasm_initial_state=(state)
|
41
|
+
AASM::StateMachine[self].initial_state = state
|
42
|
+
end
|
43
|
+
|
44
|
+
def aasm_state(name, options={})
|
45
|
+
sm = AASM::StateMachine[self]
|
46
|
+
sm.create_state(name, options)
|
47
|
+
sm.initial_state = name unless sm.initial_state
|
48
|
+
|
49
|
+
define_method("#{name.to_s}?") do
|
50
|
+
aasm_current_state == name
|
51
|
+
end
|
52
|
+
end
|
53
|
+
|
54
|
+
def aasm_event(name, options = {}, &block)
|
55
|
+
sm = AASM::StateMachine[self]
|
56
|
+
|
57
|
+
unless sm.events.has_key?(name)
|
58
|
+
sm.events[name] = AASM::SupportingClasses::Event.new(name, options, &block)
|
59
|
+
end
|
60
|
+
|
61
|
+
define_method("#{name.to_s}!") do |*args|
|
62
|
+
aasm_fire_event(name, true, *args)
|
63
|
+
end
|
64
|
+
|
65
|
+
define_method("#{name.to_s}") do |*args|
|
66
|
+
aasm_fire_event(name, false, *args)
|
67
|
+
end
|
68
|
+
end
|
69
|
+
|
70
|
+
def aasm_states
|
71
|
+
AASM::StateMachine[self].states
|
72
|
+
end
|
73
|
+
|
74
|
+
def aasm_events
|
75
|
+
AASM::StateMachine[self].events
|
76
|
+
end
|
77
|
+
|
78
|
+
def aasm_states_for_select
|
79
|
+
AASM::StateMachine[self].states.map { |state| state.for_select }
|
80
|
+
end
|
81
|
+
|
82
|
+
end
|
83
|
+
|
84
|
+
# Instance methods
|
85
|
+
def aasm_current_state
|
86
|
+
return @aasm_current_state if @aasm_current_state
|
87
|
+
|
88
|
+
if self.respond_to?(:aasm_read_state) || self.private_methods.include?('aasm_read_state')
|
89
|
+
@aasm_current_state = aasm_read_state
|
90
|
+
end
|
91
|
+
return @aasm_current_state if @aasm_current_state
|
92
|
+
self.class.aasm_initial_state
|
93
|
+
end
|
94
|
+
|
95
|
+
def aasm_events_for_current_state
|
96
|
+
aasm_events_for_state(aasm_current_state)
|
97
|
+
end
|
98
|
+
|
99
|
+
def aasm_events_for_state(state)
|
100
|
+
events = self.class.aasm_events.values.select {|event| event.transitions_from_state?(state) }
|
101
|
+
events.map {|event| event.name}
|
102
|
+
end
|
103
|
+
|
104
|
+
private
|
105
|
+
def set_aasm_current_state_with_persistence(state)
|
106
|
+
save_success = true
|
107
|
+
if self.respond_to?(:aasm_write_state) || self.private_methods.include?('aasm_write_state')
|
108
|
+
save_success = aasm_write_state(state)
|
109
|
+
end
|
110
|
+
self.aasm_current_state = state if save_success
|
111
|
+
|
112
|
+
save_success
|
113
|
+
end
|
114
|
+
|
115
|
+
def aasm_current_state=(state)
|
116
|
+
if self.respond_to?(:aasm_write_state_without_persistence) || self.private_methods.include?('aasm_write_state_without_persistence')
|
117
|
+
aasm_write_state_without_persistence(state)
|
118
|
+
end
|
119
|
+
@aasm_current_state = state
|
120
|
+
end
|
121
|
+
|
122
|
+
def aasm_state_object_for_state(name)
|
123
|
+
obj = self.class.aasm_states.find {|s| s == name}
|
124
|
+
raise AASM::UndefinedState, "State :#{name} doesn't exist" if obj.nil?
|
125
|
+
obj
|
126
|
+
end
|
127
|
+
|
128
|
+
def aasm_fire_event(name, persist, *args)
|
129
|
+
old_state = aasm_state_object_for_state(aasm_current_state)
|
130
|
+
event = self.class.aasm_events[name]
|
131
|
+
|
132
|
+
old_state.call_action(:exit, self)
|
133
|
+
|
134
|
+
new_state_name = event.fire(self, *args)
|
135
|
+
|
136
|
+
unless new_state_name.nil?
|
137
|
+
new_state = aasm_state_object_for_state(new_state_name)
|
138
|
+
|
139
|
+
# new before_ callbacks
|
140
|
+
old_state.call_action(:before_exit, self)
|
141
|
+
new_state.call_action(:before_enter, self)
|
142
|
+
event.call_action(:before, self)
|
143
|
+
|
144
|
+
new_state.call_action(:enter, self)
|
145
|
+
|
146
|
+
persist_successful = true
|
147
|
+
if persist
|
148
|
+
persist_successful = set_aasm_current_state_with_persistence(new_state_name)
|
149
|
+
event.execute_success_callback(self) if persist_successful
|
150
|
+
else
|
151
|
+
self.aasm_current_state = new_state_name
|
152
|
+
end
|
153
|
+
|
154
|
+
if persist_successful
|
155
|
+
old_state.call_action(:after_exit, self)
|
156
|
+
new_state.call_action(:after_enter, self)
|
157
|
+
event.call_action(:after, self)
|
158
|
+
|
159
|
+
self.aasm_event_fired(self.aasm_current_state, new_state_name) if self.respond_to?(:aasm_event_fired)
|
160
|
+
else
|
161
|
+
self.aasm_event_failed(name) if self.respond_to?(:aasm_event_failed)
|
162
|
+
end
|
163
|
+
|
164
|
+
persist_successful
|
165
|
+
else
|
166
|
+
if self.respond_to?(:aasm_event_failed)
|
167
|
+
self.aasm_event_failed(name)
|
168
|
+
end
|
169
|
+
|
170
|
+
false
|
171
|
+
end
|
172
|
+
end
|
173
|
+
end
|
data/lib/event.rb
ADDED
@@ -0,0 +1,65 @@
|
|
1
|
+
require File.join(File.dirname(__FILE__), 'state_transition')
|
2
|
+
|
3
|
+
module AASM
|
4
|
+
module SupportingClasses
|
5
|
+
class Event
|
6
|
+
attr_reader :name, :success
|
7
|
+
|
8
|
+
def initialize(name, options = {}, &block)
|
9
|
+
@name = name
|
10
|
+
@success = options[:success]
|
11
|
+
@transitions = []
|
12
|
+
@options = options
|
13
|
+
instance_eval(&block) if block
|
14
|
+
end
|
15
|
+
|
16
|
+
def fire(obj, to_state=nil, *args)
|
17
|
+
transitions = @transitions.select { |t| t.from == obj.aasm_current_state }
|
18
|
+
raise AASM::InvalidTransition, "Event '#{name}' cannot transition from '#{obj.aasm_current_state}'" if transitions.size == 0
|
19
|
+
|
20
|
+
next_state = nil
|
21
|
+
transitions.each do |transition|
|
22
|
+
next if to_state and !Array(transition.to).include?(to_state)
|
23
|
+
if transition.perform(obj)
|
24
|
+
next_state = to_state || Array(transition.to).first
|
25
|
+
transition.execute(obj, *args)
|
26
|
+
break
|
27
|
+
end
|
28
|
+
end
|
29
|
+
next_state
|
30
|
+
end
|
31
|
+
|
32
|
+
def transitions_from_state?(state)
|
33
|
+
@transitions.any? { |t| t.from == state }
|
34
|
+
end
|
35
|
+
|
36
|
+
def execute_success_callback(obj)
|
37
|
+
case success
|
38
|
+
when String, Symbol
|
39
|
+
obj.send(success)
|
40
|
+
when Array
|
41
|
+
success.each { |meth| obj.send(meth) }
|
42
|
+
when Proc
|
43
|
+
success.call(obj)
|
44
|
+
end
|
45
|
+
end
|
46
|
+
|
47
|
+
def call_action(action, record)
|
48
|
+
action = @options[action]
|
49
|
+
case action
|
50
|
+
when Symbol, String
|
51
|
+
record.send(action)
|
52
|
+
when Proc
|
53
|
+
action.call(record)
|
54
|
+
end
|
55
|
+
end
|
56
|
+
|
57
|
+
private
|
58
|
+
def transitions(trans_opts)
|
59
|
+
Array(trans_opts[:from]).each do |s|
|
60
|
+
@transitions << SupportingClasses::StateTransition.new(trans_opts.merge({:from => s.to_sym}))
|
61
|
+
end
|
62
|
+
end
|
63
|
+
end
|
64
|
+
end
|
65
|
+
end
|
data/lib/persistence.rb
ADDED
@@ -0,0 +1,16 @@
|
|
1
|
+
module AASM
|
2
|
+
module Persistence
|
3
|
+
|
4
|
+
# Checks to see this class or any of it's superclasses inherit from
|
5
|
+
# ActiveRecord::Base and if so includes ActiveRecordPersistence
|
6
|
+
def self.set_persistence(base)
|
7
|
+
# Use a fancier auto-loading thingy, perhaps. When there are more persistence engines.
|
8
|
+
hierarchy = base.ancestors.map {|klass| klass.to_s}
|
9
|
+
|
10
|
+
if hierarchy.include?("ActiveRecord::Base")
|
11
|
+
require File.join(File.dirname(__FILE__), 'persistence', 'active_record_persistence')
|
12
|
+
base.send(:include, AASM::Persistence::ActiveRecordPersistence)
|
13
|
+
end
|
14
|
+
end
|
15
|
+
end
|
16
|
+
end
|
@@ -0,0 +1,246 @@
|
|
1
|
+
module AASM
|
2
|
+
module Persistence
|
3
|
+
module ActiveRecordPersistence
|
4
|
+
# This method:
|
5
|
+
#
|
6
|
+
# * extends the model with ClassMethods
|
7
|
+
# * includes InstanceMethods
|
8
|
+
#
|
9
|
+
# Unless the corresponding methods are already defined, it includes
|
10
|
+
# * ReadState
|
11
|
+
# * WriteState
|
12
|
+
# * WriteStateWithoutPersistence
|
13
|
+
#
|
14
|
+
# Adds
|
15
|
+
#
|
16
|
+
# before_validation_on_create :aasm_ensure_initial_state
|
17
|
+
#
|
18
|
+
# As a result, it doesn't matter when you define your methods - the following 2 are equivalent
|
19
|
+
#
|
20
|
+
# class Foo < ActiveRecord::Base
|
21
|
+
# def aasm_write_state(state)
|
22
|
+
# "bar"
|
23
|
+
# end
|
24
|
+
# include AASM
|
25
|
+
# end
|
26
|
+
#
|
27
|
+
# class Foo < ActiveRecord::Base
|
28
|
+
# include AASM
|
29
|
+
# def aasm_write_state(state)
|
30
|
+
# "bar"
|
31
|
+
# end
|
32
|
+
# end
|
33
|
+
#
|
34
|
+
def self.included(base)
|
35
|
+
base.extend AASM::Persistence::ActiveRecordPersistence::ClassMethods
|
36
|
+
base.send(:include, AASM::Persistence::ActiveRecordPersistence::InstanceMethods)
|
37
|
+
base.send(:include, AASM::Persistence::ActiveRecordPersistence::ReadState) unless base.method_defined?(:aasm_read_state)
|
38
|
+
base.send(:include, AASM::Persistence::ActiveRecordPersistence::WriteState) unless base.method_defined?(:aasm_write_state)
|
39
|
+
base.send(:include, AASM::Persistence::ActiveRecordPersistence::WriteStateWithoutPersistence) unless base.method_defined?(:aasm_write_state_without_persistence)
|
40
|
+
|
41
|
+
if base.respond_to?(:named_scope)
|
42
|
+
base.extend(AASM::Persistence::ActiveRecordPersistence::NamedScopeMethods)
|
43
|
+
|
44
|
+
base.class_eval do
|
45
|
+
class << self
|
46
|
+
alias_method :aasm_state_without_named_scope, :aasm_state
|
47
|
+
alias_method :aasm_state, :aasm_state_with_named_scope
|
48
|
+
end
|
49
|
+
end
|
50
|
+
end
|
51
|
+
|
52
|
+
base.before_validation_on_create :aasm_ensure_initial_state
|
53
|
+
end
|
54
|
+
|
55
|
+
module ClassMethods
|
56
|
+
# Maps to the aasm_column in the database. Deafults to "aasm_state". You can write:
|
57
|
+
#
|
58
|
+
# create_table :foos do |t|
|
59
|
+
# t.string :name
|
60
|
+
# t.string :aasm_state
|
61
|
+
# end
|
62
|
+
#
|
63
|
+
# class Foo < ActiveRecord::Base
|
64
|
+
# include AASM
|
65
|
+
# end
|
66
|
+
#
|
67
|
+
# OR:
|
68
|
+
#
|
69
|
+
# create_table :foos do |t|
|
70
|
+
# t.string :name
|
71
|
+
# t.string :status
|
72
|
+
# end
|
73
|
+
#
|
74
|
+
# class Foo < ActiveRecord::Base
|
75
|
+
# include AASM
|
76
|
+
# aasm_column :status
|
77
|
+
# end
|
78
|
+
#
|
79
|
+
# This method is both a getter and a setter
|
80
|
+
def aasm_column(column_name=nil)
|
81
|
+
if column_name
|
82
|
+
AASM::StateMachine[self].config.column = column_name.to_sym
|
83
|
+
# @aasm_column = column_name.to_sym
|
84
|
+
else
|
85
|
+
AASM::StateMachine[self].config.column ||= :aasm_state
|
86
|
+
# @aasm_column ||= :aasm_state
|
87
|
+
end
|
88
|
+
# @aasm_column
|
89
|
+
AASM::StateMachine[self].config.column
|
90
|
+
end
|
91
|
+
|
92
|
+
def find_in_state(number, state, *args)
|
93
|
+
with_state_scope state do
|
94
|
+
find(number, *args)
|
95
|
+
end
|
96
|
+
end
|
97
|
+
|
98
|
+
def count_in_state(state, *args)
|
99
|
+
with_state_scope state do
|
100
|
+
count(*args)
|
101
|
+
end
|
102
|
+
end
|
103
|
+
|
104
|
+
def calculate_in_state(state, *args)
|
105
|
+
with_state_scope state do
|
106
|
+
calculate(*args)
|
107
|
+
end
|
108
|
+
end
|
109
|
+
|
110
|
+
protected
|
111
|
+
def with_state_scope(state)
|
112
|
+
with_scope :find => {:conditions => ["#{table_name}.#{aasm_column} = ?", state.to_s]} do
|
113
|
+
yield if block_given?
|
114
|
+
end
|
115
|
+
end
|
116
|
+
end
|
117
|
+
|
118
|
+
module InstanceMethods
|
119
|
+
|
120
|
+
# Returns the current aasm_state of the object. Respects reload and
|
121
|
+
# any changes made to the aasm_state field directly
|
122
|
+
#
|
123
|
+
# Internally just calls <tt>aasm_read_state</tt>
|
124
|
+
#
|
125
|
+
# foo = Foo.find(1)
|
126
|
+
# foo.aasm_current_state # => :pending
|
127
|
+
# foo.aasm_state = "opened"
|
128
|
+
# foo.aasm_current_state # => :opened
|
129
|
+
# foo.close # => calls aasm_write_state_without_persistence
|
130
|
+
# foo.aasm_current_state # => :closed
|
131
|
+
# foo.reload
|
132
|
+
# foo.aasm_current_state # => :pending
|
133
|
+
#
|
134
|
+
def aasm_current_state
|
135
|
+
@current_state = aasm_read_state
|
136
|
+
end
|
137
|
+
|
138
|
+
private
|
139
|
+
|
140
|
+
# Ensures that if the aasm_state column is nil and the record is new
|
141
|
+
# that the initial state gets populated before validation on create
|
142
|
+
#
|
143
|
+
# foo = Foo.new
|
144
|
+
# foo.aasm_state # => nil
|
145
|
+
# foo.valid?
|
146
|
+
# foo.aasm_state # => "open" (where :open is the initial state)
|
147
|
+
#
|
148
|
+
#
|
149
|
+
# foo = Foo.find(:first)
|
150
|
+
# foo.aasm_state # => 1
|
151
|
+
# foo.aasm_state = nil
|
152
|
+
# foo.valid?
|
153
|
+
# foo.aasm_state # => nil
|
154
|
+
#
|
155
|
+
def aasm_ensure_initial_state
|
156
|
+
send("#{self.class.aasm_column}=", self.aasm_current_state.to_s)
|
157
|
+
end
|
158
|
+
|
159
|
+
end
|
160
|
+
|
161
|
+
module WriteStateWithoutPersistence
|
162
|
+
# Writes <tt>state</tt> to the state column, but does not persist it to the database
|
163
|
+
#
|
164
|
+
# foo = Foo.find(1)
|
165
|
+
# foo.aasm_current_state # => :opened
|
166
|
+
# foo.close
|
167
|
+
# foo.aasm_current_state # => :closed
|
168
|
+
# Foo.find(1).aasm_current_state # => :opened
|
169
|
+
# foo.save
|
170
|
+
# foo.aasm_current_state # => :closed
|
171
|
+
# Foo.find(1).aasm_current_state # => :closed
|
172
|
+
#
|
173
|
+
# NOTE: intended to be called from an event
|
174
|
+
def aasm_write_state_without_persistence(state)
|
175
|
+
write_attribute(self.class.aasm_column, state.to_s)
|
176
|
+
end
|
177
|
+
end
|
178
|
+
|
179
|
+
module WriteState
|
180
|
+
# Writes <tt>state</tt> to the state column and persists it to the database
|
181
|
+
# using update_attribute (which bypasses validation)
|
182
|
+
#
|
183
|
+
# foo = Foo.find(1)
|
184
|
+
# foo.aasm_current_state # => :opened
|
185
|
+
# foo.close!
|
186
|
+
# foo.aasm_current_state # => :closed
|
187
|
+
# Foo.find(1).aasm_current_state # => :closed
|
188
|
+
#
|
189
|
+
# NOTE: intended to be called from an event
|
190
|
+
def aasm_write_state(state)
|
191
|
+
old_value = read_attribute(self.class.aasm_column)
|
192
|
+
write_attribute(self.class.aasm_column, state.to_s)
|
193
|
+
|
194
|
+
unless self.save
|
195
|
+
write_attribute(self.class.aasm_column, old_value)
|
196
|
+
return false
|
197
|
+
end
|
198
|
+
|
199
|
+
true
|
200
|
+
end
|
201
|
+
end
|
202
|
+
|
203
|
+
module ReadState
|
204
|
+
|
205
|
+
# Returns the value of the aasm_column - called from <tt>aasm_current_state</tt>
|
206
|
+
#
|
207
|
+
# If it's a new record, and the aasm state column is blank it returns the initial state:
|
208
|
+
#
|
209
|
+
# class Foo < ActiveRecord::Base
|
210
|
+
# include AASM
|
211
|
+
# aasm_column :status
|
212
|
+
# aasm_state :opened
|
213
|
+
# aasm_state :closed
|
214
|
+
# end
|
215
|
+
#
|
216
|
+
# foo = Foo.new
|
217
|
+
# foo.current_state # => :opened
|
218
|
+
# foo.close
|
219
|
+
# foo.current_state # => :closed
|
220
|
+
#
|
221
|
+
# foo = Foo.find(1)
|
222
|
+
# foo.current_state # => :opened
|
223
|
+
# foo.aasm_state = nil
|
224
|
+
# foo.current_state # => nil
|
225
|
+
#
|
226
|
+
# NOTE: intended to be called from an event
|
227
|
+
#
|
228
|
+
# This allows for nil aasm states - be sure to add validation to your model
|
229
|
+
def aasm_read_state
|
230
|
+
if new_record?
|
231
|
+
send(self.class.aasm_column).blank? ? self.class.aasm_initial_state : send(self.class.aasm_column).to_sym
|
232
|
+
else
|
233
|
+
send(self.class.aasm_column).nil? ? nil : send(self.class.aasm_column).to_sym
|
234
|
+
end
|
235
|
+
end
|
236
|
+
end
|
237
|
+
|
238
|
+
module NamedScopeMethods
|
239
|
+
def aasm_state_with_named_scope name, options = {}
|
240
|
+
aasm_state_without_named_scope name, options
|
241
|
+
self.named_scope name, :conditions => {self.aasm_column => name.to_s} unless self.respond_to?(name)
|
242
|
+
end
|
243
|
+
end
|
244
|
+
end
|
245
|
+
end
|
246
|
+
end
|