spree-state_machine 2.0.0.beta1

Sign up to get free protection for your applications and to get access to all the features.
Files changed (140) hide show
  1. checksums.yaml +7 -0
  2. data/.gitignore +8 -0
  3. data/.travis.yml +12 -0
  4. data/.yardopts +5 -0
  5. data/CHANGELOG.md +502 -0
  6. data/Gemfile +3 -0
  7. data/LICENSE +20 -0
  8. data/README.md +1246 -0
  9. data/Rakefile +20 -0
  10. data/examples/AutoShop_state.png +0 -0
  11. data/examples/Car_state.png +0 -0
  12. data/examples/Gemfile +5 -0
  13. data/examples/Gemfile.lock +14 -0
  14. data/examples/TrafficLight_state.png +0 -0
  15. data/examples/Vehicle_state.png +0 -0
  16. data/examples/auto_shop.rb +13 -0
  17. data/examples/car.rb +21 -0
  18. data/examples/doc/AutoShop.html +2856 -0
  19. data/examples/doc/AutoShop_state.png +0 -0
  20. data/examples/doc/Car.html +919 -0
  21. data/examples/doc/Car_state.png +0 -0
  22. data/examples/doc/TrafficLight.html +2230 -0
  23. data/examples/doc/TrafficLight_state.png +0 -0
  24. data/examples/doc/Vehicle.html +7921 -0
  25. data/examples/doc/Vehicle_state.png +0 -0
  26. data/examples/doc/_index.html +136 -0
  27. data/examples/doc/class_list.html +47 -0
  28. data/examples/doc/css/common.css +1 -0
  29. data/examples/doc/css/full_list.css +55 -0
  30. data/examples/doc/css/style.css +322 -0
  31. data/examples/doc/file_list.html +46 -0
  32. data/examples/doc/frames.html +13 -0
  33. data/examples/doc/index.html +136 -0
  34. data/examples/doc/js/app.js +205 -0
  35. data/examples/doc/js/full_list.js +173 -0
  36. data/examples/doc/js/jquery.js +16 -0
  37. data/examples/doc/method_list.html +734 -0
  38. data/examples/doc/top-level-namespace.html +105 -0
  39. data/examples/merb-rest/controller.rb +51 -0
  40. data/examples/merb-rest/model.rb +28 -0
  41. data/examples/merb-rest/view_edit.html.erb +24 -0
  42. data/examples/merb-rest/view_index.html.erb +23 -0
  43. data/examples/merb-rest/view_new.html.erb +13 -0
  44. data/examples/merb-rest/view_show.html.erb +17 -0
  45. data/examples/rails-rest/controller.rb +43 -0
  46. data/examples/rails-rest/migration.rb +7 -0
  47. data/examples/rails-rest/model.rb +23 -0
  48. data/examples/rails-rest/view__form.html.erb +34 -0
  49. data/examples/rails-rest/view_edit.html.erb +6 -0
  50. data/examples/rails-rest/view_index.html.erb +25 -0
  51. data/examples/rails-rest/view_new.html.erb +5 -0
  52. data/examples/rails-rest/view_show.html.erb +19 -0
  53. data/examples/traffic_light.rb +9 -0
  54. data/examples/vehicle.rb +33 -0
  55. data/lib/state_machine/assertions.rb +36 -0
  56. data/lib/state_machine/branch.rb +225 -0
  57. data/lib/state_machine/callback.rb +236 -0
  58. data/lib/state_machine/core.rb +7 -0
  59. data/lib/state_machine/core_ext/class/state_machine.rb +5 -0
  60. data/lib/state_machine/core_ext.rb +2 -0
  61. data/lib/state_machine/error.rb +13 -0
  62. data/lib/state_machine/eval_helpers.rb +87 -0
  63. data/lib/state_machine/event.rb +257 -0
  64. data/lib/state_machine/event_collection.rb +141 -0
  65. data/lib/state_machine/extensions.rb +149 -0
  66. data/lib/state_machine/graph.rb +92 -0
  67. data/lib/state_machine/helper_module.rb +17 -0
  68. data/lib/state_machine/initializers/rails.rb +25 -0
  69. data/lib/state_machine/initializers.rb +4 -0
  70. data/lib/state_machine/integrations/active_model/locale.rb +11 -0
  71. data/lib/state_machine/integrations/active_model/observer.rb +33 -0
  72. data/lib/state_machine/integrations/active_model/observer_update.rb +42 -0
  73. data/lib/state_machine/integrations/active_model/versions.rb +31 -0
  74. data/lib/state_machine/integrations/active_model.rb +585 -0
  75. data/lib/state_machine/integrations/active_record/locale.rb +20 -0
  76. data/lib/state_machine/integrations/active_record/versions.rb +123 -0
  77. data/lib/state_machine/integrations/active_record.rb +525 -0
  78. data/lib/state_machine/integrations/base.rb +100 -0
  79. data/lib/state_machine/integrations.rb +121 -0
  80. data/lib/state_machine/machine.rb +2287 -0
  81. data/lib/state_machine/machine_collection.rb +74 -0
  82. data/lib/state_machine/macro_methods.rb +522 -0
  83. data/lib/state_machine/matcher.rb +123 -0
  84. data/lib/state_machine/matcher_helpers.rb +54 -0
  85. data/lib/state_machine/node_collection.rb +222 -0
  86. data/lib/state_machine/path.rb +120 -0
  87. data/lib/state_machine/path_collection.rb +90 -0
  88. data/lib/state_machine/state.rb +297 -0
  89. data/lib/state_machine/state_collection.rb +112 -0
  90. data/lib/state_machine/state_context.rb +138 -0
  91. data/lib/state_machine/transition.rb +470 -0
  92. data/lib/state_machine/transition_collection.rb +245 -0
  93. data/lib/state_machine/version.rb +3 -0
  94. data/lib/state_machine/yard/handlers/base.rb +32 -0
  95. data/lib/state_machine/yard/handlers/event.rb +25 -0
  96. data/lib/state_machine/yard/handlers/machine.rb +344 -0
  97. data/lib/state_machine/yard/handlers/state.rb +25 -0
  98. data/lib/state_machine/yard/handlers/transition.rb +47 -0
  99. data/lib/state_machine/yard/handlers.rb +12 -0
  100. data/lib/state_machine/yard/templates/default/class/html/setup.rb +30 -0
  101. data/lib/state_machine/yard/templates/default/class/html/state_machines.erb +12 -0
  102. data/lib/state_machine/yard/templates.rb +3 -0
  103. data/lib/state_machine/yard.rb +8 -0
  104. data/lib/state_machine.rb +8 -0
  105. data/lib/yard-state_machine.rb +2 -0
  106. data/state_machine.gemspec +22 -0
  107. data/test/files/en.yml +17 -0
  108. data/test/files/switch.rb +15 -0
  109. data/test/functional/state_machine_test.rb +1066 -0
  110. data/test/test_helper.rb +7 -0
  111. data/test/unit/assertions_test.rb +40 -0
  112. data/test/unit/branch_test.rb +969 -0
  113. data/test/unit/callback_test.rb +704 -0
  114. data/test/unit/error_test.rb +43 -0
  115. data/test/unit/eval_helpers_test.rb +270 -0
  116. data/test/unit/event_collection_test.rb +398 -0
  117. data/test/unit/event_test.rb +1196 -0
  118. data/test/unit/graph_test.rb +98 -0
  119. data/test/unit/helper_module_test.rb +17 -0
  120. data/test/unit/integrations/active_model_test.rb +1245 -0
  121. data/test/unit/integrations/active_record_test.rb +2551 -0
  122. data/test/unit/integrations/base_test.rb +104 -0
  123. data/test/unit/integrations_test.rb +71 -0
  124. data/test/unit/invalid_event_test.rb +20 -0
  125. data/test/unit/invalid_parallel_transition_test.rb +18 -0
  126. data/test/unit/invalid_transition_test.rb +115 -0
  127. data/test/unit/machine_collection_test.rb +603 -0
  128. data/test/unit/machine_test.rb +3395 -0
  129. data/test/unit/matcher_helpers_test.rb +37 -0
  130. data/test/unit/matcher_test.rb +155 -0
  131. data/test/unit/node_collection_test.rb +362 -0
  132. data/test/unit/path_collection_test.rb +266 -0
  133. data/test/unit/path_test.rb +485 -0
  134. data/test/unit/state_collection_test.rb +352 -0
  135. data/test/unit/state_context_test.rb +441 -0
  136. data/test/unit/state_machine_test.rb +31 -0
  137. data/test/unit/state_test.rb +1101 -0
  138. data/test/unit/transition_collection_test.rb +2168 -0
  139. data/test/unit/transition_test.rb +1558 -0
  140. metadata +264 -0
@@ -0,0 +1,225 @@
1
+ require 'state_machine/matcher'
2
+ require 'state_machine/eval_helpers'
3
+ require 'state_machine/assertions'
4
+
5
+ module StateMachine
6
+ # Represents a set of requirements that must be met in order for a transition
7
+ # or callback to occur. Branches verify that the event, from state, and to
8
+ # state of the transition match, in addition to if/unless conditionals for
9
+ # an object's state.
10
+ class Branch
11
+ include Assertions
12
+ include EvalHelpers
13
+
14
+ # The condition that must be met on an object
15
+ attr_reader :if_condition
16
+
17
+ # The condition that must *not* be met on an object
18
+ attr_reader :unless_condition
19
+
20
+ # The requirement for verifying the event being matched
21
+ attr_reader :event_requirement
22
+
23
+ # One or more requirements for verifying the states being matched. All
24
+ # requirements contain a mapping of {:from => matcher, :to => matcher}.
25
+ attr_reader :state_requirements
26
+
27
+ # A list of all of the states known to this branch. This will pull states
28
+ # from the following options (in the same order):
29
+ # * +from+ / +except_from+
30
+ # * +to+ / +except_to+
31
+ attr_reader :known_states
32
+
33
+ # Creates a new branch
34
+ def initialize(options = {}) #:nodoc:
35
+ # Build conditionals
36
+ @if_condition = options.delete(:if)
37
+ @unless_condition = options.delete(:unless)
38
+
39
+ # Build event requirement
40
+ @event_requirement = build_matcher(options, :on, :except_on)
41
+
42
+ if (options.keys - [:from, :to, :on, :except_from, :except_to, :except_on]).empty?
43
+ # Explicit from/to requirements specified
44
+ @state_requirements = [{:from => build_matcher(options, :from, :except_from), :to => build_matcher(options, :to, :except_to)}]
45
+ else
46
+ # Separate out the event requirement
47
+ options.delete(:on)
48
+ options.delete(:except_on)
49
+
50
+ # Implicit from/to requirements specified
51
+ @state_requirements = options.collect do |from, to|
52
+ from = WhitelistMatcher.new(from) unless from.is_a?(Matcher)
53
+ to = WhitelistMatcher.new(to) unless to.is_a?(Matcher)
54
+ {:from => from, :to => to}
55
+ end
56
+ end
57
+
58
+ # Track known states. The order that requirements are iterated is based
59
+ # on the priority in which tracked states should be added.
60
+ @known_states = []
61
+ @state_requirements.each do |state_requirement|
62
+ [:from, :to].each {|option| @known_states |= state_requirement[option].values}
63
+ end
64
+ end
65
+
66
+ # Determines whether the given object / query matches the requirements
67
+ # configured for this branch. In addition to matching the event, from state,
68
+ # and to state, this will also check whether the configured :if/:unless
69
+ # conditions pass on the given object.
70
+ #
71
+ # == Examples
72
+ #
73
+ # branch = StateMachine::Branch.new(:parked => :idling, :on => :ignite)
74
+ #
75
+ # # Successful
76
+ # branch.matches?(object, :on => :ignite) # => true
77
+ # branch.matches?(object, :from => nil) # => true
78
+ # branch.matches?(object, :from => :parked) # => true
79
+ # branch.matches?(object, :to => :idling) # => true
80
+ # branch.matches?(object, :from => :parked, :to => :idling) # => true
81
+ # branch.matches?(object, :on => :ignite, :from => :parked, :to => :idling) # => true
82
+ #
83
+ # # Unsuccessful
84
+ # branch.matches?(object, :on => :park) # => false
85
+ # branch.matches?(object, :from => :idling) # => false
86
+ # branch.matches?(object, :to => :first_gear) # => false
87
+ # branch.matches?(object, :from => :parked, :to => :first_gear) # => false
88
+ # branch.matches?(object, :on => :park, :from => :parked, :to => :idling) # => false
89
+ def matches?(object, query = {})
90
+ !match(object, query).nil?
91
+ end
92
+
93
+ # Attempts to match the given object / query against the set of requirements
94
+ # configured for this branch. In addition to matching the event, from state,
95
+ # and to state, this will also check whether the configured :if/:unless
96
+ # conditions pass on the given object.
97
+ #
98
+ # If a match is found, then the event/state requirements that the query
99
+ # passed successfully will be returned. Otherwise, nil is returned if there
100
+ # was no match.
101
+ #
102
+ # Query options:
103
+ # * <tt>:from</tt> - One or more states being transitioned from. If none
104
+ # are specified, then this will always match.
105
+ # * <tt>:to</tt> - One or more states being transitioned to. If none are
106
+ # specified, then this will always match.
107
+ # * <tt>:on</tt> - One or more events that fired the transition. If none
108
+ # are specified, then this will always match.
109
+ # * <tt>:guard</tt> - Whether to guard matches with the if/unless
110
+ # conditionals defined for this branch. Default is true.
111
+ #
112
+ # == Examples
113
+ #
114
+ # branch = StateMachine::Branch.new(:parked => :idling, :on => :ignite)
115
+ #
116
+ # branch.match(object, :on => :ignite) # => {:to => ..., :from => ..., :on => ...}
117
+ # branch.match(object, :on => :park) # => nil
118
+ def match(object, query = {})
119
+ assert_valid_keys(query, :from, :to, :on, :guard)
120
+
121
+ if (match = match_query(query)) && matches_conditions?(object, query)
122
+ match
123
+ end
124
+ end
125
+
126
+ # Draws a representation of this branch on the given graph. This will draw
127
+ # an edge between every state this branch matches *from* to either the
128
+ # configured to state or, if none specified, then a loopback to the from
129
+ # state.
130
+ #
131
+ # For example, if the following from states are configured:
132
+ # * +idling+
133
+ # * +first_gear+
134
+ # * +backing_up+
135
+ #
136
+ # ...and the to state is +parked+, then the following edges will be created:
137
+ # * +idling+ -> +parked+
138
+ # * +first_gear+ -> +parked+
139
+ # * +backing_up+ -> +parked+
140
+ #
141
+ # Each edge will be labeled with the name of the event that would cause the
142
+ # transition.
143
+ def draw(graph, event, valid_states)
144
+ state_requirements.each do |state_requirement|
145
+ # From states determined based on the known valid states
146
+ from_states = state_requirement[:from].filter(valid_states)
147
+
148
+ # If a to state is not specified, then it's a loopback and each from
149
+ # state maps back to itself
150
+ if state_requirement[:to].values.empty?
151
+ loopback = true
152
+ else
153
+ to_state = state_requirement[:to].values.first
154
+ to_state = to_state ? to_state.to_s : 'nil'
155
+ loopback = false
156
+ end
157
+
158
+ # Generate an edge between each from and to state
159
+ from_states.each do |from_state|
160
+ from_state = from_state ? from_state.to_s : 'nil'
161
+ graph.add_edges(from_state, loopback ? from_state : to_state, :label => event.to_s)
162
+ end
163
+ end
164
+
165
+ true
166
+ end
167
+
168
+ protected
169
+ # Builds a matcher strategy to use for the given options. If neither a
170
+ # whitelist nor a blacklist option is specified, then an AllMatcher is
171
+ # built.
172
+ def build_matcher(options, whitelist_option, blacklist_option)
173
+ assert_exclusive_keys(options, whitelist_option, blacklist_option)
174
+
175
+ if options.include?(whitelist_option)
176
+ value = options[whitelist_option]
177
+ value.is_a?(Matcher) ? value : WhitelistMatcher.new(options[whitelist_option])
178
+ elsif options.include?(blacklist_option)
179
+ value = options[blacklist_option]
180
+ raise ArgumentError, ":#{blacklist_option} option cannot use matchers; use :#{whitelist_option} instead" if value.is_a?(Matcher)
181
+ BlacklistMatcher.new(value)
182
+ else
183
+ AllMatcher.instance
184
+ end
185
+ end
186
+
187
+ # Verifies that all configured requirements (event and state) match the
188
+ # given query. If a match is found, then a hash containing the
189
+ # event/state requirements that passed will be returned; otherwise, nil.
190
+ def match_query(query)
191
+ query ||= {}
192
+
193
+ if match_event(query) && (state_requirement = match_states(query))
194
+ state_requirement.merge(:on => event_requirement)
195
+ end
196
+ end
197
+
198
+ # Verifies that the event requirement matches the given query
199
+ def match_event(query)
200
+ matches_requirement?(query, :on, event_requirement)
201
+ end
202
+
203
+ # Verifies that the state requirements match the given query. If a
204
+ # matching requirement is found, then it is returned.
205
+ def match_states(query)
206
+ state_requirements.detect do |state_requirement|
207
+ [:from, :to].all? {|option| matches_requirement?(query, option, state_requirement[option])}
208
+ end
209
+ end
210
+
211
+ # Verifies that an option in the given query matches the values required
212
+ # for that option
213
+ def matches_requirement?(query, option, requirement)
214
+ !query.include?(option) || requirement.matches?(query[option], query)
215
+ end
216
+
217
+ # Verifies that the conditionals for this branch evaluate to true for the
218
+ # given object
219
+ def matches_conditions?(object, query)
220
+ query[:guard] == false ||
221
+ Array(if_condition).all? {|condition| evaluate_method(object, condition)} &&
222
+ !Array(unless_condition).any? {|condition| evaluate_method(object, condition)}
223
+ end
224
+ end
225
+ end
@@ -0,0 +1,236 @@
1
+ require 'state_machine/branch'
2
+ require 'state_machine/eval_helpers'
3
+
4
+ module StateMachine
5
+ # Callbacks represent hooks into objects that allow logic to be triggered
6
+ # before, after, or around a specific set of transitions.
7
+ class Callback
8
+ include EvalHelpers
9
+
10
+ class << self
11
+ # Determines whether to automatically bind the callback to the object
12
+ # being transitioned. This only applies to callbacks that are defined as
13
+ # lambda blocks (or Procs). Some integrations, such as DataMapper, handle
14
+ # callbacks by executing them bound to the object involved, while other
15
+ # integrations, such as ActiveRecord, pass the object as an argument to
16
+ # the callback. This can be configured on an application-wide basis by
17
+ # setting this configuration to +true+ or +false+. The default value
18
+ # is +false+.
19
+ #
20
+ # *Note* that the DataMapper and Sequel integrations automatically
21
+ # configure this value on a per-callback basis, so it does not have to
22
+ # be enabled application-wide.
23
+ #
24
+ # == Examples
25
+ #
26
+ # When not bound to the object:
27
+ #
28
+ # class Vehicle
29
+ # state_machine do
30
+ # before_transition do |vehicle|
31
+ # vehicle.set_alarm
32
+ # end
33
+ # end
34
+ #
35
+ # def set_alarm
36
+ # ...
37
+ # end
38
+ # end
39
+ #
40
+ # When bound to the object:
41
+ #
42
+ # StateMachine::Callback.bind_to_object = true
43
+ #
44
+ # class Vehicle
45
+ # state_machine do
46
+ # before_transition do
47
+ # self.set_alarm
48
+ # end
49
+ # end
50
+ #
51
+ # def set_alarm
52
+ # ...
53
+ # end
54
+ # end
55
+ attr_accessor :bind_to_object
56
+
57
+ # The application-wide terminator to use for callbacks when not
58
+ # explicitly defined. Terminators determine whether to cancel a
59
+ # callback chain based on the return value of the callback.
60
+ #
61
+ # See StateMachine::Callback#terminator for more information.
62
+ attr_accessor :terminator
63
+ end
64
+
65
+ # The type of callback chain this callback is for. This can be one of the
66
+ # following:
67
+ # * +before+
68
+ # * +after+
69
+ # * +around+
70
+ # * +failure+
71
+ attr_accessor :type
72
+
73
+ # An optional block for determining whether to cancel the callback chain
74
+ # based on the return value of the callback. By default, the callback
75
+ # chain never cancels based on the return value (i.e. there is no implicit
76
+ # terminator). Certain integrations, such as ActiveRecord and Sequel,
77
+ # change this default value.
78
+ #
79
+ # == Examples
80
+ #
81
+ # Canceling the callback chain without a terminator:
82
+ #
83
+ # class Vehicle
84
+ # state_machine do
85
+ # before_transition do |vehicle|
86
+ # throw :halt
87
+ # end
88
+ # end
89
+ # end
90
+ #
91
+ # Canceling the callback chain with a terminator value of +false+:
92
+ #
93
+ # class Vehicle
94
+ # state_machine do
95
+ # before_transition do |vehicle|
96
+ # false
97
+ # end
98
+ # end
99
+ # end
100
+ attr_reader :terminator
101
+
102
+ # The branch that determines whether or not this callback can be invoked
103
+ # based on the context of the transition. The event, from state, and
104
+ # to state must all match in order for the branch to pass.
105
+ #
106
+ # See StateMachine::Branch for more information.
107
+ attr_reader :branch
108
+
109
+ # Creates a new callback that can get called based on the configured
110
+ # options.
111
+ #
112
+ # In addition to the possible configuration options for branches, the
113
+ # following options can be configured:
114
+ # * <tt>:bind_to_object</tt> - Whether to bind the callback to the object involved.
115
+ # If set to false, the object will be passed as a parameter instead.
116
+ # Default is integration-specific or set to the application default.
117
+ # * <tt>:terminator</tt> - A block/proc that determines what callback
118
+ # results should cause the callback chain to halt (if not using the
119
+ # default <tt>throw :halt</tt> technique).
120
+ #
121
+ # More information about how those options affect the behavior of the
122
+ # callback can be found in their attribute definitions.
123
+ def initialize(type, *args, &block)
124
+ @type = type
125
+ raise ArgumentError, 'Type must be :before, :after, :around, or :failure' unless [:before, :after, :around, :failure].include?(type)
126
+
127
+ options = args.last.is_a?(Hash) ? args.pop : {}
128
+ @methods = args
129
+ @methods.concat(Array(options.delete(:do)))
130
+ @methods << block if block_given?
131
+ raise ArgumentError, 'Method(s) for callback must be specified' unless @methods.any?
132
+
133
+ options = {:bind_to_object => self.class.bind_to_object, :terminator => self.class.terminator}.merge(options)
134
+
135
+ # Proxy lambda blocks so that they're bound to the object
136
+ bind_to_object = options.delete(:bind_to_object)
137
+ @methods.map! do |method|
138
+ bind_to_object && method.is_a?(Proc) ? bound_method(method) : method
139
+ end
140
+
141
+ @terminator = options.delete(:terminator)
142
+ @branch = Branch.new(options)
143
+ end
144
+
145
+ # Gets a list of the states known to this callback by looking at the
146
+ # branch's known states
147
+ def known_states
148
+ branch.known_states
149
+ end
150
+
151
+ # Runs the callback as long as the transition context matches the branch
152
+ # requirements configured for this callback. If a block is provided, it
153
+ # will be called when the last method has run.
154
+ #
155
+ # If a terminator has been configured and it matches the result from the
156
+ # evaluated method, then the callback chain should be halted.
157
+ def call(object, context = {}, *args, &block)
158
+ if @branch.matches?(object, context)
159
+ run_methods(object, context, 0, *args, &block)
160
+ true
161
+ else
162
+ false
163
+ end
164
+ end
165
+
166
+ private
167
+ # Runs all of the methods configured for this callback.
168
+ #
169
+ # When running +around+ callbacks, this will evaluate each method and
170
+ # yield when the last method has yielded. The callback will only halt if
171
+ # one of the methods does not yield.
172
+ #
173
+ # For all other types of callbacks, this will evaluate each method in
174
+ # order. The callback will only halt if the resulting value from the
175
+ # method passes the terminator.
176
+ def run_methods(object, context = {}, index = 0, *args, &block)
177
+ if type == :around
178
+ if current_method = @methods[index]
179
+ yielded = false
180
+ evaluate_method(object, current_method, *args) do
181
+ yielded = true
182
+ run_methods(object, context, index + 1, *args, &block)
183
+ end
184
+
185
+ throw :halt unless yielded
186
+ else
187
+ yield if block_given?
188
+ end
189
+ else
190
+ @methods.each do |method|
191
+ result = evaluate_method(object, method, *args)
192
+ throw :halt if @terminator && @terminator.call(result)
193
+ end
194
+ end
195
+ end
196
+
197
+ # Generates a method that can be bound to the object being transitioned
198
+ # when the callback is invoked
199
+ def bound_method(block)
200
+ type = self.type
201
+ arity = block.arity
202
+ arity += 1 if arity >= 0 # Make sure the object gets passed
203
+ arity += 1 if arity == 1 && type == :around # Make sure the block gets passed
204
+
205
+ method = if RUBY_VERSION >= '1.9'
206
+ lambda do |object, *args|
207
+ object.instance_exec(*args, &block)
208
+ end
209
+ else
210
+ # Generate a thread-safe unbound method that can be used on any object.
211
+ # This is a workaround for not having Ruby 1.9's instance_exec
212
+ unbound_method = Object.class_eval do
213
+ time = Time.now
214
+ method_name = "__bind_#{time.to_i}_#{time.usec}"
215
+ define_method(method_name, &block)
216
+ method = instance_method(method_name)
217
+ remove_method(method_name)
218
+ method
219
+ end
220
+
221
+ # Proxy calls to the method so that the method can be bound *and*
222
+ # the arguments are adjusted
223
+ lambda do |object, *args|
224
+ unbound_method.bind(object).call(*args)
225
+ end
226
+ end
227
+
228
+ # Proxy arity to the original block
229
+ (class << method; self; end).class_eval do
230
+ define_method(:arity) { arity }
231
+ end
232
+
233
+ method
234
+ end
235
+ end
236
+ end
@@ -0,0 +1,7 @@
1
+ # Load all of the core implementation required to use state_machine. This
2
+ # includes:
3
+ # * StateMachine::MacroMethods which adds the state_machine DSL to your class
4
+ # * A set of initializers for setting state_machine defaults based on the current
5
+ # running environment (such as within Rails)
6
+ require 'state_machine/macro_methods'
7
+ require 'state_machine/initializers'
@@ -0,0 +1,5 @@
1
+ require 'state_machine/macro_methods'
2
+
3
+ Class.class_eval do
4
+ include StateMachine::MacroMethods
5
+ end
@@ -0,0 +1,2 @@
1
+ # Loads all of the extensions to be made to Ruby core classes
2
+ require 'state_machine/core_ext/class/state_machine'
@@ -0,0 +1,13 @@
1
+ module StateMachine
2
+ # An error occurred during a state machine invocation
3
+ class Error < StandardError
4
+ # The object that failed
5
+ attr_reader :object
6
+
7
+ def initialize(object, message = nil) #:nodoc:
8
+ @object = object
9
+
10
+ super(message)
11
+ end
12
+ end
13
+ end
@@ -0,0 +1,87 @@
1
+ module StateMachine
2
+ # Provides a set of helper methods for evaluating methods within the context
3
+ # of an object.
4
+ module EvalHelpers
5
+ # Evaluates one of several different types of methods within the context
6
+ # of the given object. Methods can be one of the following types:
7
+ # * Symbol
8
+ # * Method / Proc
9
+ # * String
10
+ #
11
+ # == Examples
12
+ #
13
+ # Below are examples of the various ways that a method can be evaluated
14
+ # on an object:
15
+ #
16
+ # class Person
17
+ # def initialize(name)
18
+ # @name = name
19
+ # end
20
+ #
21
+ # def name
22
+ # @name
23
+ # end
24
+ # end
25
+ #
26
+ # class PersonCallback
27
+ # def self.run(person)
28
+ # person.name
29
+ # end
30
+ # end
31
+ #
32
+ # person = Person.new('John Smith')
33
+ #
34
+ # evaluate_method(person, :name) # => "John Smith"
35
+ # evaluate_method(person, PersonCallback.method(:run)) # => "John Smith"
36
+ # evaluate_method(person, Proc.new {|person| person.name}) # => "John Smith"
37
+ # evaluate_method(person, lambda {|person| person.name}) # => "John Smith"
38
+ # evaluate_method(person, '@name') # => "John Smith"
39
+ #
40
+ # == Additional arguments
41
+ #
42
+ # Additional arguments can be passed to the methods being evaluated. If
43
+ # the method defines additional arguments other than the object context,
44
+ # then all arguments are required.
45
+ #
46
+ # For example,
47
+ #
48
+ # person = Person.new('John Smith')
49
+ #
50
+ # evaluate_method(person, lambda {|person| person.name}, 21) # => "John Smith"
51
+ # evaluate_method(person, lambda {|person, age| "#{person.name} is #{age}"}, 21) # => "John Smith is 21"
52
+ # evaluate_method(person, lambda {|person, age| "#{person.name} is #{age}"}, 21, 'male') # => ArgumentError: wrong number of arguments (3 for 2)
53
+ def evaluate_method(object, method, *args, &block)
54
+ case method
55
+ when Symbol
56
+ klass = (class << object; self; end)
57
+ args = [] if (klass.method_defined?(method) || klass.private_method_defined?(method)) && object.method(method).arity == 0
58
+ object.send(method, *args, &block)
59
+ when Proc, Method
60
+ args.unshift(object)
61
+ arity = method.arity
62
+
63
+ # Procs don't support blocks in < Ruby 1.9, so it's tacked on as an
64
+ # argument for consistency across versions of Ruby
65
+ if block_given? && Proc === method && arity != 0
66
+ if [1, 2].include?(arity)
67
+ # Force the block to be either the only argument or the 2nd one
68
+ # after the object (may mean additional arguments get discarded)
69
+ args = args[0, arity - 1] + [block]
70
+ else
71
+ # Tack the block to the end of the args
72
+ args << block
73
+ end
74
+ else
75
+ # These method types are only called with 0, 1, or n arguments
76
+ args = args[0, arity] if [0, 1].include?(arity)
77
+ end
78
+
79
+ method.is_a?(Proc) ? method.call(*args) : method.call(*args, &block)
80
+ when String
81
+ eval(method, object.instance_eval {binding}, &block)
82
+ else
83
+ raise ArgumentError, 'Methods must be a symbol denoting the method to call, a block to be invoked, or a string to be evaluated'
84
+ end
85
+ end
86
+ end
87
+ end