branston 0.3.6 → 0.4.0

Sign up to get free protection for your applications and to get access to all the features.
Files changed (141) hide show
  1. data/lib/branston/app/controllers/scenarios_controller.rb +6 -5
  2. data/lib/branston/app/controllers/stories_controller.rb +101 -89
  3. data/lib/branston/app/models/story.rb +30 -1
  4. data/lib/branston/app/models/user.rb +4 -0
  5. data/lib/branston/app/views/iterations/index.html.erb +1 -1
  6. data/lib/branston/app/views/layouts/_header.html.erb +1 -2
  7. data/lib/branston/app/views/scenarios/_scenario.html.erb +6 -3
  8. data/lib/branston/app/views/scenarios/_scenarios.html.erb +4 -2
  9. data/lib/branston/app/views/stories/_form.html.erb +15 -4
  10. data/lib/branston/app/views/stories/_story.html.erb +26 -6
  11. data/lib/branston/app/views/stories/edit.html.erb +3 -3
  12. data/lib/branston/app/views/stories/index.html.erb +22 -3
  13. data/lib/branston/app/views/stories/new.html.erb +2 -2
  14. data/lib/branston/app/views/stories/show.html.erb +3 -3
  15. data/lib/branston/config/routes.rb +7 -4
  16. data/lib/branston/coverage/app-controllers-application_controller_rb.html +1 -1
  17. data/lib/branston/coverage/app-controllers-iterations_controller_rb.html +1 -1
  18. data/lib/branston/coverage/app-controllers-outcomes_controller_rb.html +1 -1
  19. data/lib/branston/coverage/app-controllers-preconditions_controller_rb.html +1 -1
  20. data/lib/branston/coverage/app-controllers-releases_controller_rb.html +1 -1
  21. data/lib/branston/coverage/app-controllers-scenarios_controller_rb.html +18 -12
  22. data/lib/branston/coverage/app-controllers-sessions_controller_rb.html +1 -1
  23. data/lib/branston/coverage/app-controllers-stories_controller_rb.html +193 -121
  24. data/lib/branston/coverage/app-controllers-user_roles_controller_rb.html +1 -1
  25. data/lib/branston/coverage/app-controllers-users_controller_rb.html +1 -1
  26. data/lib/branston/coverage/app-helpers-application_helper_rb.html +1 -1
  27. data/lib/branston/coverage/app-helpers-iterations_helper_rb.html +1 -1
  28. data/lib/branston/coverage/app-helpers-outcomes_helper_rb.html +1 -1
  29. data/lib/branston/coverage/app-helpers-preconditions_helper_rb.html +1 -1
  30. data/lib/branston/coverage/app-helpers-releases_helper_rb.html +1 -1
  31. data/lib/branston/coverage/app-helpers-sessions_helper_rb.html +1 -1
  32. data/lib/branston/coverage/app-helpers-stories_helper_rb.html +1 -1
  33. data/lib/branston/coverage/app-helpers-user_roles_helper_rb.html +1 -1
  34. data/lib/branston/coverage/app-models-iteration_rb.html +1 -1
  35. data/lib/branston/coverage/app-models-outcome_rb.html +1 -1
  36. data/lib/branston/coverage/app-models-participation_rb.html +1 -1
  37. data/lib/branston/coverage/app-models-precondition_rb.html +1 -1
  38. data/lib/branston/coverage/app-models-release_rb.html +1 -1
  39. data/lib/branston/coverage/app-models-scenario_rb.html +1 -1
  40. data/lib/branston/coverage/app-models-story_rb.html +192 -18
  41. data/lib/branston/coverage/app-models-user_rb.html +33 -9
  42. data/lib/branston/coverage/app-models-user_role_rb.html +1 -1
  43. data/lib/branston/coverage/index.html +13 -13
  44. data/lib/branston/coverage/lib-client_rb.html +1 -1
  45. data/lib/branston/coverage/lib-faker_extras_rb.html +1 -1
  46. data/lib/branston/coverage/lib-story_generator_rb.html +1 -1
  47. data/lib/branston/db/development.sqlite3 +0 -0
  48. data/lib/branston/db/migrate/20091223100903_add_status_to_story.rb +11 -0
  49. data/lib/branston/db/pristine.sqlite3 +0 -0
  50. data/lib/branston/db/schema.rb +5 -3
  51. data/lib/branston/db/test.sqlite3 +0 -0
  52. data/lib/branston/lib/branston.rb +4 -2
  53. data/lib/branston/log/development.log +4970 -0
  54. data/lib/branston/log/test.log +88225 -0
  55. data/lib/branston/test/blueprints.rb +10 -7
  56. data/lib/branston/test/functional/scenarios_controller_test.rb +22 -15
  57. data/lib/branston/test/functional/stories_controller_test.rb +51 -30
  58. data/lib/branston/test/unit/story_test.rb +47 -7
  59. data/lib/branston/test/unit/user_test.rb +4 -0
  60. data/lib/branston/tmp/performance/BrowsingTest#test_homepage_process_time_flat.txt +3 -2
  61. data/lib/branston/tmp/performance/BrowsingTest#test_homepage_process_time_graph.html +2041 -1307
  62. data/lib/branston/tmp/performance/BrowsingTest#test_homepage_process_time_tree.txt +7922 -7922
  63. data/lib/branston/vendor/plugins/state_machine/CHANGELOG.rdoc +298 -0
  64. data/lib/branston/vendor/plugins/state_machine/LICENSE +20 -0
  65. data/lib/branston/vendor/plugins/state_machine/README.rdoc +466 -0
  66. data/lib/branston/vendor/plugins/state_machine/Rakefile +98 -0
  67. data/lib/branston/vendor/plugins/state_machine/examples/AutoShop_state.png +0 -0
  68. data/lib/branston/vendor/plugins/state_machine/examples/Car_state.png +0 -0
  69. data/lib/branston/vendor/plugins/state_machine/examples/TrafficLight_state.png +0 -0
  70. data/lib/branston/vendor/plugins/state_machine/examples/Vehicle_state.png +0 -0
  71. data/lib/branston/vendor/plugins/state_machine/examples/auto_shop.rb +11 -0
  72. data/lib/branston/vendor/plugins/state_machine/examples/car.rb +19 -0
  73. data/lib/branston/vendor/plugins/state_machine/examples/merb-rest/controller.rb +51 -0
  74. data/lib/branston/vendor/plugins/state_machine/examples/merb-rest/model.rb +28 -0
  75. data/lib/branston/vendor/plugins/state_machine/examples/merb-rest/view_edit.html.erb +24 -0
  76. data/lib/branston/vendor/plugins/state_machine/examples/merb-rest/view_index.html.erb +23 -0
  77. data/lib/branston/vendor/plugins/state_machine/examples/merb-rest/view_new.html.erb +13 -0
  78. data/lib/branston/vendor/plugins/state_machine/examples/merb-rest/view_show.html.erb +17 -0
  79. data/lib/branston/vendor/plugins/state_machine/examples/rails-rest/controller.rb +43 -0
  80. data/lib/branston/vendor/plugins/state_machine/examples/rails-rest/migration.rb +11 -0
  81. data/lib/branston/vendor/plugins/state_machine/examples/rails-rest/model.rb +23 -0
  82. data/lib/branston/vendor/plugins/state_machine/examples/rails-rest/view_edit.html.erb +25 -0
  83. data/lib/branston/vendor/plugins/state_machine/examples/rails-rest/view_index.html.erb +23 -0
  84. data/lib/branston/vendor/plugins/state_machine/examples/rails-rest/view_new.html.erb +14 -0
  85. data/lib/branston/vendor/plugins/state_machine/examples/rails-rest/view_show.html.erb +17 -0
  86. data/lib/branston/vendor/plugins/state_machine/examples/traffic_light.rb +7 -0
  87. data/lib/branston/vendor/plugins/state_machine/examples/vehicle.rb +31 -0
  88. data/lib/branston/vendor/plugins/state_machine/init.rb +1 -0
  89. data/lib/branston/vendor/plugins/state_machine/lib/state_machine/assertions.rb +36 -0
  90. data/lib/branston/vendor/plugins/state_machine/lib/state_machine/callback.rb +189 -0
  91. data/lib/branston/vendor/plugins/state_machine/lib/state_machine/condition_proxy.rb +94 -0
  92. data/lib/branston/vendor/plugins/state_machine/lib/state_machine/eval_helpers.rb +67 -0
  93. data/lib/branston/vendor/plugins/state_machine/lib/state_machine/event.rb +252 -0
  94. data/lib/branston/vendor/plugins/state_machine/lib/state_machine/event_collection.rb +122 -0
  95. data/lib/branston/vendor/plugins/state_machine/lib/state_machine/extensions.rb +149 -0
  96. data/lib/branston/vendor/plugins/state_machine/lib/state_machine/guard.rb +230 -0
  97. data/lib/branston/vendor/plugins/state_machine/lib/state_machine/integrations/active_record/locale.rb +11 -0
  98. data/lib/branston/vendor/plugins/state_machine/lib/state_machine/integrations/active_record/observer.rb +41 -0
  99. data/lib/branston/vendor/plugins/state_machine/lib/state_machine/integrations/active_record.rb +492 -0
  100. data/lib/branston/vendor/plugins/state_machine/lib/state_machine/integrations/data_mapper/observer.rb +139 -0
  101. data/lib/branston/vendor/plugins/state_machine/lib/state_machine/integrations/data_mapper.rb +351 -0
  102. data/lib/branston/vendor/plugins/state_machine/lib/state_machine/integrations/sequel.rb +322 -0
  103. data/lib/branston/vendor/plugins/state_machine/lib/state_machine/integrations.rb +68 -0
  104. data/lib/branston/vendor/plugins/state_machine/lib/state_machine/machine.rb +1467 -0
  105. data/lib/branston/vendor/plugins/state_machine/lib/state_machine/machine_collection.rb +155 -0
  106. data/lib/branston/vendor/plugins/state_machine/lib/state_machine/matcher.rb +123 -0
  107. data/lib/branston/vendor/plugins/state_machine/lib/state_machine/matcher_helpers.rb +54 -0
  108. data/lib/branston/vendor/plugins/state_machine/lib/state_machine/node_collection.rb +152 -0
  109. data/lib/branston/vendor/plugins/state_machine/lib/state_machine/state.rb +249 -0
  110. data/lib/branston/vendor/plugins/state_machine/lib/state_machine/state_collection.rb +112 -0
  111. data/lib/branston/vendor/plugins/state_machine/lib/state_machine/transition.rb +394 -0
  112. data/lib/branston/vendor/plugins/state_machine/lib/state_machine.rb +388 -0
  113. data/lib/branston/vendor/plugins/state_machine/state_machine.gemspec +30 -0
  114. data/lib/branston/vendor/plugins/state_machine/tasks/state_machine.rake +1 -0
  115. data/lib/branston/vendor/plugins/state_machine/tasks/state_machine.rb +30 -0
  116. data/lib/branston/vendor/plugins/state_machine/test/classes/switch.rb +11 -0
  117. data/lib/branston/vendor/plugins/state_machine/test/functional/state_machine_test.rb +941 -0
  118. data/lib/branston/vendor/plugins/state_machine/test/test_helper.rb +4 -0
  119. data/lib/branston/vendor/plugins/state_machine/test/unit/assertions_test.rb +40 -0
  120. data/lib/branston/vendor/plugins/state_machine/test/unit/callback_test.rb +455 -0
  121. data/lib/branston/vendor/plugins/state_machine/test/unit/condition_proxy_test.rb +328 -0
  122. data/lib/branston/vendor/plugins/state_machine/test/unit/eval_helpers_test.rb +120 -0
  123. data/lib/branston/vendor/plugins/state_machine/test/unit/event_collection_test.rb +326 -0
  124. data/lib/branston/vendor/plugins/state_machine/test/unit/event_test.rb +743 -0
  125. data/lib/branston/vendor/plugins/state_machine/test/unit/guard_test.rb +908 -0
  126. data/lib/branston/vendor/plugins/state_machine/test/unit/integrations/active_record_test.rb +1367 -0
  127. data/lib/branston/vendor/plugins/state_machine/test/unit/integrations/data_mapper_test.rb +962 -0
  128. data/lib/branston/vendor/plugins/state_machine/test/unit/integrations/sequel_test.rb +859 -0
  129. data/lib/branston/vendor/plugins/state_machine/test/unit/integrations_test.rb +42 -0
  130. data/lib/branston/vendor/plugins/state_machine/test/unit/invalid_event_test.rb +7 -0
  131. data/lib/branston/vendor/plugins/state_machine/test/unit/invalid_transition_test.rb +7 -0
  132. data/lib/branston/vendor/plugins/state_machine/test/unit/machine_collection_test.rb +938 -0
  133. data/lib/branston/vendor/plugins/state_machine/test/unit/machine_test.rb +2004 -0
  134. data/lib/branston/vendor/plugins/state_machine/test/unit/matcher_helpers_test.rb +37 -0
  135. data/lib/branston/vendor/plugins/state_machine/test/unit/matcher_test.rb +155 -0
  136. data/lib/branston/vendor/plugins/state_machine/test/unit/node_collection_test.rb +207 -0
  137. data/lib/branston/vendor/plugins/state_machine/test/unit/state_collection_test.rb +280 -0
  138. data/lib/branston/vendor/plugins/state_machine/test/unit/state_machine_test.rb +31 -0
  139. data/lib/branston/vendor/plugins/state_machine/test/unit/state_test.rb +795 -0
  140. data/lib/branston/vendor/plugins/state_machine/test/unit/transition_test.rb +1212 -0
  141. metadata +81 -2
@@ -0,0 +1,388 @@
1
+ require 'state_machine/machine'
2
+
3
+ # A state machine is a model of behavior composed of states, events, and
4
+ # transitions. This helper adds support for defining this type of
5
+ # functionality on any Ruby class.
6
+ module StateMachine
7
+ module MacroMethods
8
+ # Creates a new state machine with the given name. The default name, if not
9
+ # specified, is <tt>:state</tt>.
10
+ #
11
+ # Configuration options:
12
+ # * <tt>:attribute</tt> - The name of the attribute to store the state value
13
+ # in. By default, this is the same as the name of the machine.
14
+ # * <tt>:initial</tt> - The initial state of the attribute. This can be a
15
+ # static state or a lambda block which will be evaluated at runtime
16
+ # (e.g. lambda {|vehicle| vehicle.speed == 0 ? :parked : :idling}).
17
+ # Default is nil.
18
+ # * <tt>:action</tt> - The instance method to invoke when an object
19
+ # transitions. Default is nil unless otherwise specified by the
20
+ # configured integration.
21
+ # * <tt>:namespace</tt> - The name to use for namespacing all generated
22
+ # state / event instance methods (e.g. "heater" would generate
23
+ # :turn_on_heater and :turn_off_heater for the :turn_on/:turn_off events).
24
+ # Default is nil.
25
+ # * <tt>:integration</tt> - The name of the integration to use for adding
26
+ # library-specific behavior to the machine. Built-in integrations
27
+ # include :data_mapper, :active_record, and :sequel. By default, this
28
+ # is determined automatically.
29
+ #
30
+ # Configuration options relevant to ORM integrations:
31
+ # * <tt>:plural</tt> - The pluralized name of the attribute. By default,
32
+ # this will attempt to call +pluralize+ on the attribute. If this
33
+ # method is not available, an "s" is appended. This is used for
34
+ # generating scopes.
35
+ # * <tt>:messages</tt> - The error messages to use when invalidating
36
+ # objects due to failed transitions. Messages include:
37
+ # * <tt>:invalid</tt>
38
+ # * <tt>:invalid_event</tt>
39
+ # * <tt>:invalid_transition</tt>
40
+ # * <tt>:use_transactions</tt> - Whether transactions should be used when
41
+ # firing events. Default is true unless otherwise specified by the
42
+ # configured integration.
43
+ #
44
+ # This also expects a block which will be used to actually configure the
45
+ # states, events and transitions for the state machine. *Note* that this
46
+ # block will be executed within the context of the state machine. As a
47
+ # result, you will not be able to access any class methods unless you refer
48
+ # to them directly (i.e. specifying the class name).
49
+ #
50
+ # For examples on the types of state machine configurations and blocks, see
51
+ # the section below.
52
+ #
53
+ # == Examples
54
+ #
55
+ # With the default name/attribute and no configuration:
56
+ #
57
+ # class Vehicle
58
+ # state_machine do
59
+ # event :park do
60
+ # ...
61
+ # end
62
+ # end
63
+ # end
64
+ #
65
+ # The above example will define a state machine named "state" that will
66
+ # store the value in the +state+ attribute. Every vehicle will start
67
+ # without an initial state.
68
+ #
69
+ # With a custom name / attribute:
70
+ #
71
+ # class Vehicle
72
+ # state_machine :status, :attribute => :status_value do
73
+ # ...
74
+ # end
75
+ # end
76
+ #
77
+ # With a static initial state:
78
+ #
79
+ # class Vehicle
80
+ # state_machine :status, :initial => :parked do
81
+ # ...
82
+ # end
83
+ # end
84
+ #
85
+ # With a dynamic initial state:
86
+ #
87
+ # class Vehicle
88
+ # state_machine :status, :initial => lambda {|vehicle| vehicle.speed == 0 ? :parked : :idling} do
89
+ # ...
90
+ # end
91
+ # end
92
+ #
93
+ # == Instance Methods
94
+ #
95
+ # The following instance methods will be automatically generated by the
96
+ # state machine based on the *name* of the machine. Any existing methods
97
+ # will not be overwritten.
98
+ # * <tt>state</tt> - Gets the current value for the attribute
99
+ # * <tt>state=(value)</tt> - Sets the current value for the attribute
100
+ # * <tt>state?(name)</tt> - Checks the given state name against the current
101
+ # state. If the name is not a known state, then an ArgumentError is raised.
102
+ # * <tt>state_name</tt> - Gets the name of the state for the current value
103
+ # * <tt>state_events</tt> - Gets the list of events that can be fired on
104
+ # the current object's state (uses the *unqualified* event names)
105
+ # * <tt>state_transitions(requirements = {})</tt> - Gets the list of possible
106
+ # transitions that can be made on the current object's state. Additional
107
+ # requirements, such as the :from / :to state and :on event can be specified
108
+ # to restrict the transitions to select. By default, the current state
109
+ # will be used for the :from state.
110
+ #
111
+ # For example,
112
+ #
113
+ # class Vehicle
114
+ # state_machine :state, :initial => :parked do
115
+ # event :ignite do
116
+ # transition :parked => :idling
117
+ # end
118
+ #
119
+ # event :park do
120
+ # transition :idling => :parked
121
+ # end
122
+ # end
123
+ # end
124
+ #
125
+ # vehicle = Vehicle.new
126
+ # vehicle.state # => "parked"
127
+ # vehicle.state_name # => :parked
128
+ # vehicle.state?(:parked) # => true
129
+ #
130
+ # # Changing state
131
+ # vehicle.state = 'idling'
132
+ # vehicle.state # => "idling"
133
+ # vehicle.state_name # => :idling
134
+ # vehicle.state?(:parked) # => false
135
+ #
136
+ # # Getting current event / transition availability
137
+ # vehicle.state_events # => [:park]
138
+ # vehicle.park # => true
139
+ # vehicle.state_events # => [:ignite]
140
+ #
141
+ # vehicle.state_transitions # => [#<StateMachine::Transition attribute=:state event=:ignite from="parked" from_name=:parked to="idling" to_name=:idling>]
142
+ # vehicle.ignite
143
+ # vehicle.state_transitions # => [#<StateMachine::Transition attribute=:state event=:park from="idling" from_name=:idling to="parked" to_name=:parked>]
144
+ #
145
+ # == Attribute initialization
146
+ #
147
+ # For most classes, the initial values for state machine attributes are
148
+ # automatically assigned when a new object is created. However, this
149
+ # behavior will *not* work if the class defines an +initialize+ method
150
+ # without properly calling +super+.
151
+ #
152
+ # For example,
153
+ #
154
+ # class Vehicle
155
+ # state_machine :state, :initial => :parked do
156
+ # ...
157
+ # end
158
+ # end
159
+ #
160
+ # vehicle = Vehicle.new # => #<Vehicle:0xb7c8dbf8 @state="parked">
161
+ # vehicle.state # => "parked"
162
+ #
163
+ # In the above example, no +initialize+ method is defined. As a result,
164
+ # the default behavior of initializing the state machine attributes is used.
165
+ #
166
+ # In the following example, a custom +initialize+ method is defined:
167
+ #
168
+ # class Vehicle
169
+ # state_machine :state, :initial => :parked do
170
+ # ...
171
+ # end
172
+ #
173
+ # def initialize
174
+ # end
175
+ # end
176
+ #
177
+ # vehicle = Vehicle.new # => #<Vehicle:0xb7c77678>
178
+ # vehicle.state # => nil
179
+ #
180
+ # Since the +initialize+ method is defined, the state machine attributes
181
+ # never get initialized. In order to ensure that all initialization hooks
182
+ # are called, the custom method *must* call +super+ without any arguments
183
+ # like so:
184
+ #
185
+ # class Vehicle
186
+ # state_machine :state, :initial => :parked do
187
+ # ...
188
+ # end
189
+ #
190
+ # def initialize(attributes = {})
191
+ # ...
192
+ # super()
193
+ # end
194
+ # end
195
+ #
196
+ # vehicle = Vehicle.new # => #<Vehicle:0xb7c8dbf8 @state="parked">
197
+ # vehicle.state # => "parked"
198
+ #
199
+ # Because of the way the inclusion of modules works in Ruby, calling
200
+ # <tt>super()</tt> will not only call the superclass's +initialize+, but
201
+ # also +initialize+ on all included modules. This allows the original state
202
+ # machine hook to get called properly.
203
+ #
204
+ # If you want to avoid calling the superclass's constructor, but still want
205
+ # to initialize the state machine attributes:
206
+ #
207
+ # class Vehicle
208
+ # state_machine :state, :initial => :parked do
209
+ # ...
210
+ # end
211
+ #
212
+ # def initialize(attributes = {})
213
+ # ...
214
+ # initialize_state_machines
215
+ # end
216
+ # end
217
+ #
218
+ # vehicle = Vehicle.new # => #<Vehicle:0xb7c8dbf8 @state="parked">
219
+ # vehicle.state # => "parked"
220
+ #
221
+ # == States
222
+ #
223
+ # All of the valid states for the machine are automatically tracked based
224
+ # on the events, transitions, and callbacks defined for the machine. If
225
+ # there are additional states that are never referenced, these should be
226
+ # explicitly added using the StateMachine::Machine#state or
227
+ # StateMachine::Machine#other_states helpers.
228
+ #
229
+ # When a new state is defined, a predicate method for that state is
230
+ # generated on the class. For example,
231
+ #
232
+ # class Vehicle
233
+ # state_machine :initial => :parked do
234
+ # event :ignite do
235
+ # transition all => :idling
236
+ # end
237
+ # end
238
+ # end
239
+ #
240
+ # ...will generate the following instance methods (assuming they're not
241
+ # already defined in the class):
242
+ # * <tt>parked?</tt>
243
+ # * <tt>idling?</tt>
244
+ #
245
+ # Each predicate method will return true if it matches the object's
246
+ # current state. Otherwise, it will return false.
247
+ #
248
+ # == Events and Transitions
249
+ #
250
+ # Events defined on the machine are the interface to transitioning states
251
+ # for an object. Events can be fired either directly (through the method
252
+ # generated for the event) or indirectly (through attributes defined on
253
+ # the machine).
254
+ #
255
+ # For example,
256
+ #
257
+ # class Vehicle
258
+ # include DataMapper::Resource
259
+ # property :id, Serial
260
+ #
261
+ # state_machine :initial => :parked do
262
+ # event :ignite do
263
+ # transition :parked => :idling
264
+ # end
265
+ # end
266
+ #
267
+ # state_machine :alarm_state, :initial => :active do
268
+ # event :disable do
269
+ # transition all => :off
270
+ # end
271
+ # end
272
+ # end
273
+ #
274
+ # # Fire +ignite+ event directly
275
+ # vehicle = Vehicle.create # => #<Vehicle id=1 state="parked" alarm_state="active">
276
+ # vehicle.ignite # => true
277
+ # vehicle.state # => "idling"
278
+ # vehicle.alarm_state # => "active"
279
+ #
280
+ # # Fire +disable+ event automatically
281
+ # vehicle.alarm_state_event = 'disable'
282
+ # vehicle.save # => true
283
+ # vehicle.alarm_state # => "off"
284
+ #
285
+ # In the above example, the +state+ attribute is transitioned using the
286
+ # +ignite+ action that's generated from the state machine. On the other
287
+ # hand, the +alarm_state+ attribute is transitioned using the +alarm_state_event+
288
+ # attribute that automatically gets fired when the machine's action (+save+)
289
+ # is invoked.
290
+ #
291
+ # For more information about how to configure an event and its associated
292
+ # transitions, see StateMachine::Machine#event.
293
+ #
294
+ # == Defining callbacks
295
+ #
296
+ # Within the +state_machine+ block, you can also define callbacks for
297
+ # transitions. For more information about defining these callbacks,
298
+ # see StateMachine::Machine#before_transition and
299
+ # StateMachine::Machine#after_transition.
300
+ #
301
+ # == Namespaces
302
+ #
303
+ # When a namespace is configured for a state machine, the name provided
304
+ # will be used in generating the instance methods for interacting with
305
+ # states/events in the machine. This is particularly useful when a class
306
+ # has multiple state machines and it would be difficult to differentiate
307
+ # between the various states / events.
308
+ #
309
+ # For example,
310
+ #
311
+ # class Vehicle
312
+ # state_machine :heater_state, :initial => :off, :namespace => 'heater' do
313
+ # event :turn_on do
314
+ # transition all => :on
315
+ # end
316
+ #
317
+ # event :turn_off do
318
+ # transition all => :off
319
+ # end
320
+ # end
321
+ #
322
+ # state_machine :alarm_state, :initial => :active, :namespace => 'alarm' do
323
+ # event :turn_on do
324
+ # transition all => :active
325
+ # end
326
+ #
327
+ # event :turn_off do
328
+ # transition all => :off
329
+ # end
330
+ # end
331
+ # end
332
+ #
333
+ # The above class defines two state machines: +heater_state+ and +alarm_state+.
334
+ # For the +heater_state+ machine, the following methods are generated since
335
+ # it's namespaced by "heater":
336
+ # * <tt>can_turn_on_heater?</tt>
337
+ # * <tt>turn_on_heater</tt>
338
+ # * ...
339
+ # * <tt>can_turn_off_heater?</tt>
340
+ # * <tt>turn_off_heater</tt>
341
+ # * ..
342
+ # * <tt>heater_off?</tt>
343
+ # * <tt>heater_on?</tt>
344
+ #
345
+ # As shown, each method is unique to the state machine so that the states
346
+ # and events don't conflict. The same goes for the +alarm_state+ machine:
347
+ # * <tt>can_turn_on_alarm?</tt>
348
+ # * <tt>turn_on_alarm</tt>
349
+ # * ...
350
+ # * <tt>can_turn_off_alarm?</tt>
351
+ # * <tt>turn_off_alarm</tt>
352
+ # * ..
353
+ # * <tt>alarm_active?</tt>
354
+ # * <tt>alarm_off?</tt>
355
+ #
356
+ # == Scopes
357
+ #
358
+ # For integrations that support it, a group of default scope filters will
359
+ # be automatically created for assisting in finding objects that have the
360
+ # attribute set to one of a given set of states.
361
+ #
362
+ # For example,
363
+ #
364
+ # Vehicle.with_state(:parked) # => All vehicles where the state is parked
365
+ # Vehicle.with_states(:parked, :idling) # => All vehicles where the state is either parked or idling
366
+ #
367
+ # Vehicle.without_state(:parked) # => All vehicles where the state is *not* parked
368
+ # Vehicle.without_states(:parked, :idling) # => All vehicles where the state is *not* parked or idling
369
+ #
370
+ # *Note* that if class methods already exist with those names (i.e.
371
+ # :with_state, :with_states, :without_state, or :without_states), then a
372
+ # scope will not be defined for that name.
373
+ #
374
+ # See StateMachine::Machine for more information about using integrations
375
+ # and the individual integration docs for information about the actual
376
+ # scopes that are generated.
377
+ def state_machine(*args, &block)
378
+ StateMachine::Machine.find_or_create(self, *args, &block)
379
+ end
380
+ end
381
+ end
382
+
383
+ Class.class_eval do
384
+ include StateMachine::MacroMethods
385
+ end
386
+
387
+ # Register rake tasks for supported libraries
388
+ Merb::Plugins.add_rakefiles("#{File.dirname(__FILE__)}/../tasks/state_machine") if defined?(Merb::Plugins)
@@ -0,0 +1,30 @@
1
+ # -*- encoding: utf-8 -*-
2
+
3
+ Gem::Specification.new do |s|
4
+ s.name = %q{state_machine}
5
+ s.version = "0.8.0"
6
+
7
+ s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
8
+ s.authors = ["Aaron Pfeifer"]
9
+ s.date = %q{2009-08-15}
10
+ s.description = %q{Adds support for creating state machines for attributes on any Ruby class}
11
+ s.email = %q{aaron@pluginaweek.org}
12
+ s.files = ["examples/Car_state.png", "examples/AutoShop_state.png", "examples/rails-rest", "examples/rails-rest/view_show.html.erb", "examples/rails-rest/controller.rb", "examples/rails-rest/model.rb", "examples/rails-rest/view_index.html.erb", "examples/rails-rest/view_new.html.erb", "examples/rails-rest/view_edit.html.erb", "examples/rails-rest/migration.rb", "examples/merb-rest", "examples/merb-rest/view_show.html.erb", "examples/merb-rest/controller.rb", "examples/merb-rest/model.rb", "examples/merb-rest/view_index.html.erb", "examples/merb-rest/view_new.html.erb", "examples/merb-rest/view_edit.html.erb", "examples/vehicle.rb", "examples/TrafficLight_state.png", "examples/auto_shop.rb", "examples/traffic_light.rb", "examples/Vehicle_state.png", "examples/car.rb", "lib/state_machine.rb", "lib/state_machine", "lib/state_machine/condition_proxy.rb", "lib/state_machine/machine_collection.rb", "lib/state_machine/machine.rb", "lib/state_machine/event_collection.rb", "lib/state_machine/integrations", "lib/state_machine/integrations/active_record", "lib/state_machine/integrations/active_record/locale.rb", "lib/state_machine/integrations/active_record/observer.rb", "lib/state_machine/integrations/data_mapper.rb", "lib/state_machine/integrations/sequel.rb", "lib/state_machine/integrations/active_record.rb", "lib/state_machine/integrations/data_mapper", "lib/state_machine/integrations/data_mapper/observer.rb", "lib/state_machine/matcher_helpers.rb", "lib/state_machine/assertions.rb", "lib/state_machine/matcher.rb", "lib/state_machine/eval_helpers.rb", "lib/state_machine/guard.rb", "lib/state_machine/integrations.rb", "lib/state_machine/callback.rb", "lib/state_machine/event.rb", "lib/state_machine/extensions.rb", "lib/state_machine/state.rb", "lib/state_machine/transition.rb", "lib/state_machine/node_collection.rb", "lib/state_machine/state_collection.rb", "tasks/state_machine.rb", "tasks/state_machine.rake", "test/unit", "test/unit/assertions_test.rb", "test/unit/integrations_test.rb", "test/unit/node_collection_test.rb", "test/unit/invalid_event_test.rb", "test/unit/event_test.rb", "test/unit/state_collection_test.rb", "test/unit/callback_test.rb", "test/unit/condition_proxy_test.rb", "test/unit/integrations", "test/unit/integrations/sequel_test.rb", "test/unit/integrations/data_mapper_test.rb", "test/unit/integrations/active_record_test.rb", "test/unit/eval_helpers_test.rb", "test/unit/guard_test.rb", "test/unit/state_test.rb", "test/unit/transition_test.rb", "test/unit/matcher_test.rb", "test/unit/invalid_transition_test.rb", "test/unit/machine_test.rb", "test/unit/machine_collection_test.rb", "test/unit/state_machine_test.rb", "test/unit/event_collection_test.rb", "test/unit/matcher_helpers_test.rb", "test/test_helper.rb", "test/classes", "test/classes/switch.rb", "test/functional", "test/functional/state_machine_test.rb", "CHANGELOG.rdoc", "init.rb", "LICENSE", "Rakefile", "README.rdoc"]
13
+ s.has_rdoc = true
14
+ s.homepage = %q{http://www.pluginaweek.org}
15
+ s.require_paths = ["lib"]
16
+ s.rubyforge_project = %q{pluginaweek}
17
+ s.rubygems_version = %q{1.3.1}
18
+ s.summary = %q{Adds support for creating state machines for attributes on any Ruby class}
19
+ s.test_files = ["test/unit/assertions_test.rb", "test/unit/integrations_test.rb", "test/unit/node_collection_test.rb", "test/unit/invalid_event_test.rb", "test/unit/event_test.rb", "test/unit/state_collection_test.rb", "test/unit/callback_test.rb", "test/unit/condition_proxy_test.rb", "test/unit/integrations/sequel_test.rb", "test/unit/integrations/data_mapper_test.rb", "test/unit/integrations/active_record_test.rb", "test/unit/eval_helpers_test.rb", "test/unit/guard_test.rb", "test/unit/state_test.rb", "test/unit/transition_test.rb", "test/unit/matcher_test.rb", "test/unit/invalid_transition_test.rb", "test/unit/machine_test.rb", "test/unit/machine_collection_test.rb", "test/unit/state_machine_test.rb", "test/unit/event_collection_test.rb", "test/unit/matcher_helpers_test.rb", "test/functional/state_machine_test.rb"]
20
+
21
+ if s.respond_to? :specification_version then
22
+ current_version = Gem::Specification::CURRENT_SPECIFICATION_VERSION
23
+ s.specification_version = 2
24
+
25
+ if Gem::Version.new(Gem::RubyGemsVersion) >= Gem::Version.new('1.2.0') then
26
+ else
27
+ end
28
+ else
29
+ end
30
+ end
@@ -0,0 +1 @@
1
+ require File.join("#{File.dirname(__FILE__)}/state_machine")
@@ -0,0 +1,30 @@
1
+ namespace :state_machine do
2
+ desc 'Draws a set of state machines using GraphViz. Target files to load with FILE=x,y,z; Machine class with CLASS=x,y,z; Font name with FONT=x; Image format with FORMAT=x; Orientation with ORIENTATION=x'
3
+ task :draw do
4
+ # Load the library
5
+ $:.unshift(File.dirname(__FILE__) + '/lib')
6
+ require 'state_machine'
7
+
8
+ # Build drawing options
9
+ options = {}
10
+ options[:file] = ENV['FILE'] if ENV['FILE']
11
+ options[:path] = ENV['TARGET'] if ENV['TARGET']
12
+ options[:format] = ENV['FORMAT'] if ENV['FORMAT']
13
+ options[:font] = ENV['FONT'] if ENV['FONT']
14
+ options[:orientation] = ENV['ORIENTATION'] if ENV['ORIENTATION']
15
+
16
+ StateMachine::Machine.draw(ENV['CLASS'], options)
17
+ end
18
+
19
+ namespace :draw do
20
+ desc 'Draws a set of state machines using GraphViz for a Ruby on Rails application. Target class with CLASS=x,y,z; Font name with FONT=x; Image format with FORMAT=x; Orientation with ORIENTATION=x'
21
+ task :rails => [:environment, 'state_machine:draw']
22
+
23
+ desc 'Draws a set of state machines using GraphViz for a Merb application. Target class with CLASS=x,y,z; Font name with FONT=x; Image format with FORMAT=x; Orientation with ORIENTATION=x'
24
+ task :merb => [:merb_env] do
25
+ # Fix ruby-graphviz being incompatible with Merb's process title
26
+ $0 = 'rake'
27
+ Rake::Task['state_machine:draw'].invoke
28
+ end
29
+ end
30
+ end
@@ -0,0 +1,11 @@
1
+ class Switch
2
+ state_machine do
3
+ event :turn_on do
4
+ transition all => :on
5
+ end
6
+
7
+ event :turn_off do
8
+ transition all => :off
9
+ end
10
+ end
11
+ end