The ActiveModel integration is useful for both standalone usage and for providing the base implementation for ORMs which implement the ActiveModel API. This integration adds support for validation errors and dirty attribute tracking.
Add this line to your application's Gemfile:
gem 'state_machines-activemodel'
And then execute:
$ bundle
Or install it yourself as:
$ gem install state_machines-activemodel
Active Model 8.0+
class Vehicle
include ActiveModel::Dirty
include ActiveModel::Validations
attr_accessor :state
define_attribute_methods [:state]
state_machine initial: :parked do
before_transition parked: any - :parked, do: :put_on_seatbelt
after_transition any: :parked do |vehicle, transition|
vehicle.seatbelt = 'off'
end
around_transition :benchmark
event ignite: do
transition parked: :idling
end
state :first_gear, :second_gear do
validates :seatbelt_on, presence: true
end
end
def put_on_seatbelt
...
end
def benchmark
...
yield
...
end
endAn event method still returns false when it is refused, and errors is filled
as before. The <event>_refusal reader from state_machines tells the reasons
apart (nil after a success):
vehicle.park # => false
vehicle.park_refusal # => :no_transition (errors: State cannot transition via "park")
vehicle.ignite # => false, a before_transition returned false
vehicle.ignite_refusal # => :halted
# With `action: :save`, a save that returns false (e.g. failed validations)
vehicle.shift_up # => false
vehicle.shift_up_refusal # => :action_failed
vehicle.errors.full_messages # => ["Seatbelt on can't be blank"]
vehicle.shift_up! # => StateMachines::InvalidTransition, #reason => :action_failedThe reasons are :no_transition, :guard, :halted, :action_failed (and
:contended in async mode). They are also recorded for event attributes
(vehicle.state_event = 'park'; vehicle.save). See the state_machines README
for parallel events.
- Fork it ( https://github.com/state-machines/state_machines-activemodel/fork )
- Create your feature branch (
git checkout -b my-new-feature) - Commit your changes (
git commit -am 'Add some feature') - Push to the branch (
git push origin my-new-feature) - Create a new Pull Request