Module StateMachine::Integrations::ActiveModel
In: lib/state_machine/integrations/active_model.rb
lib/state_machine/integrations/active_model/versions.rb
lib/state_machine/integrations/active_model/observer.rb

Adds support for integrating state machines with ActiveModel classes.

Examples

If using ActiveModel directly within your class, then any one of the following features need to be included in order for the integration to be detected:

  • ActiveModel::Dirty
  • ActiveModel::Observing
  • ActiveModel::Validations

Below is an example of a simple state machine defined within an ActiveModel class:

  class Vehicle
    include ActiveModel::Dirty
    include ActiveModel::Observing
    include ActiveModel::Validations

    attr_accessor :state
    define_attribute_methods [:state]

    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.

Actions

By default, no action will be invoked when a state is transitioned. This means that if you want to save changes when transitioning, you must define the action yourself like so:

  class Vehicle
    include ActiveModel::Validations
    attr_accessor :state

    state_machine :action => :save do
      ...
    end

    def save
      # Save changes
    end
  end

Validations

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 ActiveModel‘s validation framework, custom validators will not work as expected when defined to run in multiple states. For example:

  class Vehicle
    include ActiveModel::Validations

    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 ActiveModel::Validations

    state_machine do
      ...
      state :first_gear, :second_gear do
        validate {|vehicle| vehicle.speed_is_legal}
      end
    end
  end

Validation errors

In order to hook in validation support for your model, the ActiveModel::Validations feature must be included. If this is included and an event fails to successfully fire because there are no matching transitions for the object, a validation error is added to the object‘s state attribute to help in determining why it failed.

For example,

  vehicle = Vehicle.new
  vehicle.ignite                # => false
  vehicle.errors.full_messages  # => ["State cannot transition via \"ignite\""]

Security implications

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 ActiveModel::MassAssignmentSecurity
    attr_accessor :state

    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 ActiveModel::MassAssignmentSecurity
    attr_accessor :state

    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

Callbacks

All before/after transition callbacks defined for ActiveModel models behave in the same way that other ActiveSupport callbacks behave. The object involved in the transition is passed in as an argument.

For example,

  class Vehicle
    include ActiveModel::Validations
    attr_accessor :state

    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.

Observers

In order to hook in observer support for your application, the ActiveModel::Observing feature must be included. Because of the way ActiveModel observers are designed, there is less flexibility around the specific transitions that can be hooked in. However, a large number of hooks are supported. For example, if a transition for a object‘s state attribute changes the state from parked to idling via the ignite event, the following observer methods are supported:

  • before/after/after_failure_to-_ignite_from_parked_to_idling
  • before/after/after_failure_to-_ignite_from_parked
  • before/after/after_failure_to-_ignite_to_idling
  • before/after/after_failure_to-_ignite
  • before/after/after_failure_to-_transition_state_from_parked_to_idling
  • before/after/after_failure_to-_transition_state_from_parked
  • before/after/after_failure_to-_transition_state_to_idling
  • before/after/after_failure_to-_transition_state
  • before/after/after_failure_to-_transition

The following class shows an example of some of these hooks:

  class VehicleObserver < ActiveModel::Observer
    # Callback for :ignite event *before* the transition is performed
    def before_ignite(vehicle, transition)
      # log message
    end

    # Callback for :ignite event *after* the transition has been performed
    def after_ignite(vehicle, transition)
      # put on seatbelt
    end

    # Generic transition callback *before* the transition is performed
    def after_transition(vehicle, transition)
      Audit.log(vehicle, transition)
    end

    def after_failure_to_transition(vehicle, transition)
      Audit.error(vehicle, transition)
    end
  end

More flexible transition callbacks can be defined directly within the model as described in StateMachine::Machine#before_transition and StateMachine::Machine#after_transition.

To define a single observer for multiple state machines:

  class StateMachineObserver < ActiveModel::Observer
    observe Vehicle, Switch, Project

    def after_transition(object, transition)
      Audit.log(object, transition)
    end
  end

Dirty Attribute Tracking

In order to hook in validation support for your model, the ActiveModel::Validations feature must be included. If this is included then state attributes will always be properly marked as changed whether they were a callback or not.

For example,

  class Vehicle
    include ActiveModel::Dirty
    attr_accessor :state

    state_machine :initial => :parked do
      event :park do
        transition :parked => :parked
      end
    end
  end

  vehicle = Vehicle.new
  vehicle.changed         # => []
  vehicle.park            # => true
  vehicle.changed         # => ["state"]

Creating new integrations

If you want to integrate state_machine with an ORM that implements parts or all of the ActiveModel API, the following features must be specified:

  • i18n scope (locale)
  • Machine defaults

For example,

  module StateMachine::Integrations::MyORM
    include StateMachine::Integrations::ActiveModel

    @defaults = {:action = > :persist}

    def self.matches?(klass)
      defined?(::MyORM::Base) && klass <= ::MyORM::Base
    end

    def self.extended(base)
      locale = "#{File.dirname(__FILE__)}/my_orm/locale.rb"
      I18n.load_path << locale unless I18n.load_path.include?(locale)
    end

    protected
      def runs_validations_on_action?
        action == :persist
      end

      def i18n_scope
        :myorm
      end
  end

If you wish to implement other features, such as attribute initialization with protected attributes, named scopes, or database transactions, you must add these independent of the ActiveModel integration. See the ActiveRecord implementation for examples of these customizations.

Methods

Included Modules

Base

Classes and Modules

Module StateMachine::Integrations::ActiveModel::Observer

Public Class methods

[Source]

   # File lib/state_machine/integrations/active_model/versions.rb, line 5
5:         def self.active?
6:           !defined?(::ActiveModel::VERSION) || ::ActiveModel::VERSION::MAJOR == 2
7:         end

[Source]

    # File lib/state_machine/integrations/active_model/versions.rb, line 20
20:         def self.active?
21:           defined?(::ActiveModel::VERSION) && ::ActiveModel::VERSION::MAJOR == 3 && ::ActiveModel::VERSION::MINOR == 0
22:         end

Whether this integration is available. Only true if ActiveModel is defined.

[Source]

     # File lib/state_machine/integrations/active_model.rb, line 306
306:       def self.available?
307:         defined?(::ActiveModel)
308:       end

Should this integration be used for state machines in the given class? Classes that include ActiveModel::Dirty, ActiveModel::Observing, or ActiveModel::Validations will automatically use the ActiveModel integration.

[Source]

     # File lib/state_machine/integrations/active_model.rb, line 314
314:       def self.matches?(klass)
315:         %w(Dirty Observing Validations).any? {|feature| ::ActiveModel.const_defined?(feature) && klass <= ::ActiveModel.const_get(feature)}
316:       end

Public Instance methods

[Source]

    # File lib/state_machine/integrations/active_model/versions.rb, line 9
 9:         def define_validation_hook
10:           define_helper :instance, "def valid?(*)\nself.class.state_machines.transitions(self, \#{action.inspect}, :after => false).perform { super }\nend\n", __FILE__, __LINE__ + 1
11:         end

[Source]

    # File lib/state_machine/integrations/active_model/versions.rb, line 24
24:         def define_validation_hook
25:           # +around+ callbacks don't have direct access to results until AS 3.1
26:           owner_class.set_callback(:validation, :after, 'value', :prepend => true)
27:           super
28:         end

Adds a validation error to the given object

[Source]

     # File lib/state_machine/integrations/active_model.rb, line 331
331:       def invalidate(object, attribute, message, values = [])
332:         if supports_validations?
333:           attribute = self.attribute(attribute)
334:           options = values.inject({}) do |options, (key, value)|
335:             options[key] = value
336:             options
337:           end
338:           
339:           default_options = default_error_message_options(object, attribute, message)
340:           object.errors.add(attribute, message, options.merge(default_options))
341:         end
342:       end

Resets any errors previously added when invalidating the given object

[Source]

     # File lib/state_machine/integrations/active_model.rb, line 345
345:       def reset(object)
346:         object.errors.clear if supports_validations?
347:       end

Forces the change in state to be recognized regardless of whether the state value actually changed

[Source]

     # File lib/state_machine/integrations/active_model.rb, line 320
320:       def write(object, attribute, value, *args)
321:         result = super
322:         
323:         if (attribute == :state || attribute == :event && value) && supports_dirty_tracking?(object) && !object.send("#{self.attribute}_changed?")
324:           object.send("#{self.attribute}_will_change!")
325:         end
326:         
327:         result
328:       end

Protected Instance methods

Creates a new callback in the callback chain, always inserting it before the default Observer callbacks that were created after initialization.

[Source]

     # File lib/state_machine/integrations/active_model.rb, line 472
472:         def add_callback(type, options, &block)
473:           options[:terminator] = callback_terminator
474:           
475:           if supports_observers?
476:             @callbacks[type == :around ? :before : type].insert(-2, callback = Callback.new(type, options, &block))
477:             add_states(callback.known_states)
478:             callback
479:           else
480:             super
481:           end
482:         end

Adds a set of default callbacks that utilize the Observer extensions

[Source]

     # File lib/state_machine/integrations/active_model.rb, line 434
434:         def add_default_callbacks
435:           if supports_observers?
436:             callbacks[:before] << Callback.new(:before) {|object, transition| notify(:before, object, transition)}
437:             callbacks[:after] << Callback.new(:after) {|object, transition| notify(:after, object, transition)}
438:             callbacks[:failure] << Callback.new(:failure) {|object, transition| notify(:after_failure_to, object, transition)}
439:           end
440:         end

Configures new event with the built-in humanize scheme

[Source]

     # File lib/state_machine/integrations/active_model.rb, line 492
492:         def add_events(new_events)
493:           super.each do |event|
494:             event.human_name = lambda {|event, klass| translate(klass, :event, event.name)}
495:           end
496:         end

Configures new states with the built-in humanize scheme

[Source]

     # File lib/state_machine/integrations/active_model.rb, line 485
485:         def add_states(new_states)
486:           super.each do |state|
487:             state.human_name = lambda {|state, klass| translate(klass, :state, state.name)}
488:           end
489:         end

Initializes class-level extensions and defaults for this machine

[Source]

     # File lib/state_machine/integrations/active_model.rb, line 416
416:         def after_initialize
417:           super
418:           load_locale
419:           load_observer_extensions
420:           add_default_callbacks
421:         end

Build a list of ancestors for the given class to use when determining which localization key to use for a particular string.

[Source]

     # File lib/state_machine/integrations/active_model.rb, line 411
411:         def ancestors_for(klass)
412:           klass.lookup_ancestors
413:         end

Runs state events around the object‘s validation process

[Source]

     # File lib/state_machine/integrations/active_model.rb, line 465
465:         def around_validation(object)
466:           object.class.state_machines.transitions(object, action, :after => false).perform { yield }
467:         end

Gets the terminator to use for callbacks

[Source]

     # File lib/state_machine/integrations/active_model.rb, line 376
376:         def callback_terminator
377:           @terminator ||= lambda {|result| result == false}
378:         end

The default options to use when generating messages for validation errors

[Source]

     # File lib/state_machine/integrations/active_model.rb, line 387
387:         def default_error_message_options(object, attribute, message)
388:           {:message => @messages[message]}
389:         end

Adds hooks into validation for automatically firing events

[Source]

     # File lib/state_machine/integrations/active_model.rb, line 453
453:         def define_action_helpers
454:           super
455:           define_validation_hook if runs_validations_on_action?
456:         end

Skips defining reader/writer methods since this is done automatically

[Source]

     # File lib/state_machine/integrations/active_model.rb, line 443
443:         def define_state_accessor
444:           name = self.name
445:           
446:           owner_class.validates_each(attribute) do |object, attr, value|
447:             machine = object.class.state_machine(name)
448:             machine.invalidate(object, :state, :invalid) unless machine.states.match(object)
449:           end if supports_validations?
450:         end

Hooks into validations by defining around callbacks for the :validation event

[Source]

     # File lib/state_machine/integrations/active_model.rb, line 460
460:         def define_validation_hook
461:           owner_class.set_callback(:validation, :around, self, :prepend => true)
462:         end

Determines the base scope to use when looking up translations

[Source]

     # File lib/state_machine/integrations/active_model.rb, line 381
381:         def i18n_scope(klass)
382:           klass.i18n_scope
383:         end

Loads any locale files needed for translating validation errors

[Source]

     # File lib/state_machine/integrations/active_model.rb, line 424
424:         def load_locale
425:           I18n.load_path.unshift(@integration.locale_path) unless I18n.load_path.include?(@integration.locale_path)
426:         end

Loads extensions to ActiveModel‘s Observers

[Source]

     # File lib/state_machine/integrations/active_model.rb, line 429
429:         def load_observer_extensions
430:           require 'state_machine/integrations/active_model/observer'
431:         end

Notifies observers on the given object that a callback occurred involving the given transition. This will attempt to call the following methods on observers:

  • #{type}_#{qualified_event}from#{from}to#{to}
  • #{type}_#{qualified_event}from#{from}
  • #{type}_#{qualified_event}to#{to}
  • #{type}_#{qualified_event}
  • #{type}transition#{machine_name}from#{from}to#{to}
  • #{type}transition#{machine_name}from#{from}
  • #{type}transition#{machine_name}to#{to}
  • #{type}transition#{machine_name}
  • #{type}_transition

This will always return true regardless of the results of the callbacks.

[Source]

     # File lib/state_machine/integrations/active_model.rb, line 513
513:         def notify(type, object, transition)
514:           name = self.name
515:           event = transition.qualified_event
516:           from = transition.from_name
517:           to = transition.to_name
518:           
519:           # Machine-specific updates
520:           ["#{type}_#{event}", "#{type}_transition_#{name}"].each do |event_segment|
521:             ["_from_#{from}", nil].each do |from_segment|
522:               ["_to_#{to}", nil].each do |to_segment|
523:                 object.class.changed if object.class.respond_to?(:changed)
524:                 object.class.notify_observers([event_segment, from_segment, to_segment].join, object, transition)
525:               end
526:             end
527:           end
528:           
529:           # Generic updates
530:           object.class.changed if object.class.respond_to?(:changed)
531:           object.class.notify_observers("#{type}_transition", object, transition)
532:           
533:           true
534:         end

Do validations run when the action configured this machine is invoked? This is used to determine whether to fire off attribute-based event transitions when the action is run.

[Source]

     # File lib/state_machine/integrations/active_model.rb, line 365
365:         def runs_validations_on_action?
366:           false
367:         end

Whether change (dirty) tracking is supported in the integration. Only true if the ActiveModel feature is enabled on the owner class.

[Source]

     # File lib/state_machine/integrations/active_model.rb, line 371
371:         def supports_dirty_tracking?(object)
372:           defined?(::ActiveModel::Dirty) && owner_class <= ::ActiveModel::Dirty && object.respond_to?("#{self.attribute}_changed?")
373:         end

Whether observers are supported in the integration. Only true if ActiveModel::Observer is available.

[Source]

     # File lib/state_machine/integrations/active_model.rb, line 352
352:         def supports_observers?
353:           defined?(::ActiveModel::Observing) && owner_class <= ::ActiveModel::Observing
354:         end

Whether validations are supported in the integration. Only true if the ActiveModel feature is enabled on the owner class.

[Source]

     # File lib/state_machine/integrations/active_model.rb, line 358
358:         def supports_validations?
359:           defined?(::ActiveModel::Validations) && owner_class <= ::ActiveModel::Validations
360:         end

Translates the given key / value combo. Translation keys are looked up in the following order:

  • #{i18n_scope}.state_machines.#{model_name}.#{machine_name}.#{plural_key}.#{value}
  • #{i18n_scope}.state_machines.#{machine_name}.#{plural_key}.#{value}
  • #{i18n_scope}.state_machines.#{plural_key}.#{value}

If no keys are found, then the humanized value will be the fallback.

[Source]

     # File lib/state_machine/integrations/active_model.rb, line 398
398:         def translate(klass, key, value)
399:           ancestors = ancestors_for(klass)
400:           group = key.to_s.pluralize
401:           value = value ? value.to_s : 'nil'
402:           
403:           # Generate all possible translation keys
404:           translations = ancestors.map {|ancestor| "#{ancestor.model_name.underscore}.#{name}.#{group}.#{value}""#{ancestor.model_name.underscore}.#{name}.#{group}.#{value}"}
405:           translations.concat(["#{name}.#{group}.#{value}""#{name}.#{group}.#{value}", "#{group}.#{value}""#{group}.#{value}", value.humanize.downcase])
406:           I18n.translate(translations.shift, :default => translations, :scope => [i18n_scope(klass), :state_machines])
407:         end

[Validate]