Module | StateMachine::Integrations::MongoMapper |
In: |
lib/state_machine/integrations/mongo_mapper.rb
lib/state_machine/integrations/mongo_mapper/versions.rb |
Adds support for integrating state machines with MongoMapper models.
Below is an example of a simple state machine defined within a MongoMapper model:
class Vehicle include MongoMapper::Document state_machine :initial => :parked do event :ignite do transition :parked => :idling end end end
The examples in the sections below will use the above class as a reference.
By default, the action that will be invoked when a state is transitioned is the save action. This will cause the record to save the changes made to the state machine‘s attribute. Note that if any other changes were made to the record prior to transition, then those changes will be saved as well.
For example,
vehicle = Vehicle.create # => #<Vehicle id: 1, name: nil, state: "parked"> vehicle.name = 'Ford Explorer' vehicle.ignite # => true vehicle.reload # => #<Vehicle id: 1, name: "Ford Explorer", state: "idling">
As described in StateMachine::InstanceMethods#state_machine, event attributes are created for every machine that allow transitions to be performed automatically when the object‘s action (in this case, :save) is called.
In MongoMapper, these automated events are run in the following order:
For example,
vehicle = Vehicle.create # => #<Vehicle id: 1, name: nil, state: "parked"> vehicle.state_event # => nil vehicle.state_event = 'invalid' vehicle.valid? # => false vehicle.errors.full_messages # => ["State event is invalid"] vehicle.state_event = 'ignite' vehicle.valid? # => true vehicle.save # => true vehicle.state # => "idling" vehicle.state_event # => nil
Note that this can also be done on a mass-assignment basis:
vehicle = Vehicle.create(:state_event => 'ignite') # => #<Vehicle id: 1, name: nil, state: "idling"> vehicle.state # => "idling"
This technique is always used for transitioning states when the save action (which is the default) is configured for the machine.
Beware that public event attributes mean that events can be fired whenever mass-assignment is being used. If you want to prevent malicious users from tampering with events through URLs / forms, the attribute should be protected like so:
class Vehicle include MongoMapper::Document attr_protected :state_event # attr_accessible ... # Alternative technique state_machine do ... end end
If you want to only have some events be able to fire via mass-assignment, you can build two state machines (one public and one protected) like so:
class Vehicle include MongoMapper::Document attr_protected :state_event # Prevent access to events in the first machine state_machine do # Define private events here end # Public machine targets the same state as the private machine state_machine :public_state, :attribute => :state do # Define public events here end end
As mentioned in StateMachine::Machine#state, you can define behaviors, like validations, that only execute for certain states. One important caveat here is that, due to a constraint in MongoMapper‘s validation framework, custom validators will not work as expected when defined to run in multiple states. For example:
class Vehicle include MongoMapper::Document state_machine do ... state :first_gear, :second_gear do validate :speed_is_legal end end end
In this case, the :speed_is_legal validation will only get run for the :second_gear state. To avoid this, you can define your custom validation like so:
class Vehicle include MongoMapper::Document state_machine do ... state :first_gear, :second_gear do validate {|vehicle| vehicle.speed_is_legal} end end end
If an event fails to successfully fire because there are no matching transitions for the current record, a validation error is added to the record‘s state attribute to help in determining why it failed and for reporting via the UI.
For example,
vehicle = Vehicle.create(:state => 'idling') # => #<Vehicle id: 1, name: nil, state: "idling"> vehicle.ignite # => false vehicle.errors.full_messages # => ["State cannot transition via \"ignite\""]
If an event fails to fire because of a validation error on the record and not because a matching transition was not available, no error messages will be added to the state attribute.
To assist in filtering models with specific states, a series of basic scopes are defined on the model for finding records with or without a particular set of states.
These scopes are essentially the functional equivalent of the following definitions:
class Vehicle include MongoMapper::Document def self.with_states(*states) all(:conditions => {:state => {'$in' => states}}) end # with_states also aliased to with_state def self.without_states(*states) all(:conditions => {:state => {'$nin' => states}}) end # without_states also aliased to without_state end
Note, however, that the states are converted to their stored values before being passed into the query.
Because of the way named scopes work in MongoMapper, they cannot be chained.
All before/after transition callbacks defined for MongoMapper models behave in the same way that other MongoMapper callbacks behave. The object involved in the transition is passed in as an argument.
For example,
class Vehicle include MongoMapper::Document state_machine :initial => :parked do before_transition any => :idling do |vehicle| vehicle.put_on_seatbelt end before_transition do |vehicle, transition| # log message end event :ignite do transition :parked => :idling end end def put_on_seatbelt ... end end
Note, also, that the transition can be accessed by simply defining additional arguments in the callback block.
# File lib/state_machine/integrations/mongo_mapper/versions.rb, line 5 5: def self.active? 6: !defined?(::MongoMapper::Plugins) 7: end
# File lib/state_machine/integrations/mongo_mapper/versions.rb, line 81 81: def self.active? 82: # Only 0.8.x and up has a Version string available, so Plugins is used 83: # to detect when 0.7.x is active 84: defined?(::MongoMapper::Plugins) && (!defined?(::MongoMapper::Version) || ::MongoMapper::Version <= '0.8.3') 85: end
# File lib/state_machine/integrations/mongo_mapper/versions.rb, line 100 100: def self.active? 101: defined?(::MongoMapper::Version) && ::MongoMapper::Version =~ /^0\.9\./ 102: end
# File lib/state_machine/integrations/mongo_mapper/versions.rb, line 25 25: def self.active? 26: !defined?(::MongoMapper::Version) || ::MongoMapper::Version < '0.8.0' 27: end
# File lib/state_machine/integrations/mongo_mapper/versions.rb, line 35 35: def self.active? 36: !defined?(::MongoMapper::Version) || ::MongoMapper::Version < '0.9.0' 37: end
Whether this integration is available. Only true if MongoMapper::Document is defined.
# File lib/state_machine/integrations/mongo_mapper.rb, line 233 233: def self.available? 234: defined?(::MongoMapper::Document) 235: end
Should this integration be used for state machines in the given class? Classes that include MongoMapper::Document will automatically use the MongoMapper integration.
# File lib/state_machine/integrations/mongo_mapper.rb, line 240 240: def self.matches?(klass) 241: klass <= ::MongoMapper::Document 242: end
# File lib/state_machine/integrations/mongo_mapper/versions.rb, line 53 53: def action_hook 54: action == :save ? :create_or_update : super 55: end
# File lib/state_machine/integrations/mongo_mapper/versions.rb, line 72 72: def callback_terminator 73: end
# File lib/state_machine/integrations/mongo_mapper/versions.rb, line 104 104: def define_action_hook 105: # +around+ callbacks don't have direct access to results until AS 3.1 106: owner_class.set_callback(:save, :after, 'value', :prepend => true) if action_hook == :save 107: super 108: end
# File lib/state_machine/integrations/mongo_mapper/versions.rb, line 29 29: def define_scope(name, scope) 30: lambda {|model, values| model.all(scope.call(values))} 31: end
# File lib/state_machine/integrations/mongo_mapper/versions.rb, line 43 43: def define_state_accessor 44: owner_class.key(attribute, String) unless owner_class.keys.include?(attribute) 45: 46: name = self.name 47: owner_class.validates_each(attribute, :logic => lambda {|*| 48: machine = self.class.state_machine(name) 49: machine.invalidate(self, :state, :invalid) unless machine.states.match(self) 50: }) 51: end
# File lib/state_machine/integrations/mongo_mapper/versions.rb, line 87 87: def define_state_initializer 88: define_helper :instance, "def initialize(*args)\nattrs, from_db = args\nfrom_db ? super : self.class.state_machines.initialize_states(self) { super }\nend\n", __FILE__, __LINE__ + 1 89: end
# File lib/state_machine/integrations/mongo_mapper/versions.rb, line 13 13: def define_state_initializer 14: define_helper :instance, "def initialize(*args)\nattrs, * = args\nattrs && attrs.stringify_keys.key?('_id') ? super : self.class.state_machines.initialize_states(self) { super }\nend\n", __FILE__, __LINE__ + 1 15: end
# File lib/state_machine/integrations/mongo_mapper/versions.rb, line 9 9: def filter_attributes(object, attributes) 10: attributes 11: end
# File lib/state_machine/integrations/mongo_mapper/versions.rb, line 39 39: def invalidate(object, attribute, message, values = []) 40: object.errors.add(self.attribute(attribute), generate_message(message, values)) 41: end
# File lib/state_machine/integrations/mongo_mapper/versions.rb, line 68 68: def supports_dirty_tracking?(object) 69: true 70: end
# File lib/state_machine/integrations/mongo_mapper/versions.rb, line 60 60: def supports_observers? 61: false 62: end
# File lib/state_machine/integrations/mongo_mapper/versions.rb, line 64 64: def supports_validations? 65: true 66: end
# File lib/state_machine/integrations/mongo_mapper/versions.rb, line 75 75: def translate(klass, key, value) 76: value.to_s.humanize.downcase 77: end
Runs state events around the machine‘s :save action
# File lib/state_machine/integrations/mongo_mapper.rb, line 278 278: def around_save(object) 279: object.class.state_machines.transitions(object, action).perform { yield } 280: end
Creates a scope for finding records with a particular state or states for the attribute
# File lib/state_machine/integrations/mongo_mapper.rb, line 284 284: def create_with_scope(name) 285: define_scope(name, lambda {|values| {:conditions => {attribute => {'$in' => values}}}}) 286: end
Creates a scope for finding records without a particular state or states for the attribute
# File lib/state_machine/integrations/mongo_mapper.rb, line 290 290: def create_without_scope(name) 291: define_scope(name, lambda {|values| {:conditions => {attribute => {'$nin' => values}}}}) 292: end
Uses around callbacks to run state events if using the :save hook
# File lib/state_machine/integrations/mongo_mapper.rb, line 269 269: def define_action_hook 270: if action_hook == :save 271: owner_class.set_callback(:save, :around, self, :prepend => true) 272: else 273: super 274: end 275: end
Defines a new scope with the given name
# File lib/state_machine/integrations/mongo_mapper.rb, line 295 295: def define_scope(name, scope) 296: lambda {|model, values| model.query.merge(model.query(scope.call(values)))} 297: end
Skips defining reader/writer methods since this is done automatically
# File lib/state_machine/integrations/mongo_mapper.rb, line 263 263: def define_state_accessor 264: owner_class.key(attribute, String) unless owner_class.keys.include?(attribute) 265: super 266: end
Defines an initialization hook into the owner class for setting the initial state of the machine before any attributes are set on the object
# File lib/state_machine/integrations/mongo_mapper.rb, line 253 253: def define_state_initializer 254: define_helper :instance, "def initialize(*args)\nself.class.state_machines.initialize_states(self) { super }\nend\n", __FILE__, __LINE__ + 1 255: end