telvue_state_machine 1.2.1

data/lib/state_machine/extensions.rb

@@ -0,0 +1,149 @@
+require 'state_machine/machine_collection'
+
+module StateMachine
+  module ClassMethods
+    def self.extended(base) #:nodoc:
+      base.class_eval do
+        @state_machines = MachineCollection.new
+      end
+    end
+    
+    # Gets the current list of state machines defined for this class.  This
+    # class-level attribute acts like an inheritable attribute.  The attribute
+    # is available to each subclass, each having a copy of its superclass's
+    # attribute.
+    # 
+    # The hash of state machines maps <tt>:attribute</tt> => +machine+, e.g.
+    # 
+    #   Vehicle.state_machines # => {:state => #<StateMachine::Machine:0xb6f6e4a4 ...>}
+    def state_machines
+      @state_machines ||= superclass.state_machines.dup
+    end
+  end
+  
+  module InstanceMethods
+    # Runs one or more events in parallel.  All events will run through the
+    # following steps:
+    # * Before callbacks
+    # * Persist state
+    # * Invoke action
+    # * After callbacks
+    # 
+    # For example, if two events (for state machines A and B) are run in
+    # parallel, the order in which steps are run is:
+    # * A - Before transition callbacks
+    # * B - Before transition callbacks
+    # * A - Persist new state
+    # * B - Persist new state
+    # * A - Invoke action
+    # * B - Invoke action (only if different than A's action)
+    # * A - After transition callbacks
+    # * B - After transition callbacks
+    # 
+    # *Note* that multiple events on the same state machine / attribute cannot
+    # be run in parallel.  If this is attempted, an ArgumentError will be
+    # raised.
+    # 
+    # == Halting callbacks
+    # 
+    # When running multiple events in parallel, special consideration should
+    # be taken with regard to how halting within callbacks affects the flow.
+    # 
+    # For *before* callbacks, any <tt>:halt</tt> error that's thrown will
+    # immediately cancel the perform for all transitions.  As a result, it's
+    # possible for one event's transition to affect the continuation of
+    # another.
+    # 
+    # On the other hand, any <tt>:halt</tt> error that's thrown within an
+    # *after* callback with only affect that event's transition.  Other
+    # transitions will continue to run their own callbacks.
+    # 
+    # == Example
+    # 
+    #   class Vehicle
+    #     state_machine :initial => :parked do
+    #       event :ignite do
+    #         transition :parked => :idling
+    #       end
+    #       
+    #       event :park do
+    #         transition :idling => :parked
+    #       end
+    #     end
+    #     
+    #     state_machine :alarm_state, :namespace => 'alarm', :initial => :on do
+    #       event :enable do
+    #         transition all => :active
+    #       end
+    #       
+    #       event :disable do
+    #         transition all => :off
+    #       end
+    #     end
+    #   end
+    #   
+    #   vehicle = Vehicle.new                         # => #<Vehicle:0xb7c02850 @state="parked", @alarm_state="active">
+    #   vehicle.state                                 # => "parked"
+    #   vehicle.alarm_state                           # => "active"
+    #   
+    #   vehicle.fire_events(:ignite, :disable_alarm)  # => true
+    #   vehicle.state                                 # => "idling"
+    #   vehicle.alarm_state                           # => "off"
+    #   
+    #   # If any event fails, the entire event chain fails
+    #   vehicle.fire_events(:ignite, :enable_alarm)   # => false
+    #   vehicle.state                                 # => "idling"
+    #   vehicle.alarm_state                           # => "off"
+    #   
+    #   # Exception raised on invalid event
+    #   vehicle.fire_events(:park, :invalid)          # => StateMachine::InvalidEvent: :invalid is an unknown event
+    #   vehicle.state                                 # => "idling"
+    #   vehicle.alarm_state                           # => "off"
+    def fire_events(*events)
+      self.class.state_machines.fire_events(self, *events)
+    end
+    
+    # Run one or more events in parallel.  If any event fails to run, then
+    # a StateMachine::InvalidTransition exception will be raised.
+    # 
+    # See StateMachine::InstanceMethods#fire_events for more information.
+    # 
+    # == Example
+    # 
+    #   class Vehicle
+    #     state_machine :initial => :parked do
+    #       event :ignite do
+    #         transition :parked => :idling
+    #       end
+    #       
+    #       event :park do
+    #         transition :idling => :parked
+    #       end
+    #     end
+    #     
+    #     state_machine :alarm_state, :namespace => 'alarm', :initial => :active do
+    #       event :enable do
+    #         transition all => :active
+    #       end
+    #       
+    #       event :disable do
+    #         transition all => :off
+    #       end
+    #     end
+    #   end
+    #   
+    #   vehicle = Vehicle.new                         # => #<Vehicle:0xb7c02850 @state="parked", @alarm_state="active">
+    #   vehicle.fire_events(:ignite, :disable_alarm)  # => true
+    #   
+    #   vehicle.fire_events!(:ignite, :disable_alarm) # => StateMachine::InvalidTranstion: Cannot run events in parallel: ignite, disable_alarm
+    def fire_events!(*events)
+      run_action = [true, false].include?(events.last) ? events.pop : true
+      fire_events(*(events + [run_action])) || raise(StateMachine::InvalidParallelTransition.new(self, events))
+    end
+    
+    protected
+      def initialize_state_machines(options = {}, &block) #:nodoc:
+        self.class.state_machines.initialize_states(self, options, &block)
+      end
+  end
+end

data/lib/state_machine/graph.rb

@@ -0,0 +1,92 @@
+begin
+  require 'rubygems'
+  gem 'ruby-graphviz', '>=0.9.17'
+  require 'graphviz'
+rescue LoadError => ex
+  $stderr.puts "Cannot draw the machine (#{ex.message}). `gem install ruby-graphviz` >= v0.9.17 and try again."
+  raise
+end
+
+require 'state_machine/assertions'
+
+module StateMachine
+  # Provides a set of higher-order features on top of the raw GraphViz graphs
+  class Graph < GraphViz
+    include Assertions
+    
+    # The name of the font to draw state names in
+    attr_reader :font
+    
+    # The graph's full filename
+    attr_reader :file_path
+    
+    # The image format to generate the graph in
+    attr_reader :file_format
+    
+    # Creates a new graph with the given name.
+    # 
+    # Configuration options:
+    # * <tt>:path</tt> - The path to write the graph file to.  Default is the
+    #   current directory (".").
+    # * <tt>:format</tt> - The image format to generate the graph in.
+    #   Default is "png'.
+    # * <tt>:font</tt> - The name of the font to draw state names in.
+    #   Default is "Arial".
+    # * <tt>:orientation</tt> - The direction of the graph ("portrait" or
+    #   "landscape").  Default is "portrait".
+    def initialize(name, options = {})
+      options = {:path => '.', :format => 'png', :font => 'Arial', :orientation => 'portrait'}.merge(options)
+      assert_valid_keys(options, :path, :format, :font, :orientation)
+      
+      @font = options[:font]
+      @file_path = File.join(options[:path], "#{name}.#{options[:format]}")
+      @file_format = options[:format]
+      
+      super('G', :rankdir => options[:orientation] == 'landscape' ? 'LR' : 'TB')
+    end
+    
+    # Generates the actual image file based on the nodes / edges added to the
+    # graph.  The path to the file is based on the configuration options for
+    # this graph.
+    def output
+      super(@file_format => @file_path)
+    end
+    
+    # Adds a new node to the graph.  The font for the node will be automatically
+    # set based on the graph configuration.  The generated node will be returned.
+    # 
+    # For example,
+    # 
+    #   graph = StateMachine::Graph.new('test')
+    #   graph.add_nodes('parked', :label => 'Parked', :width => '1', :height => '1', :shape => 'ellipse')
+    def add_nodes(*args)
+      node = v0_api? ? add_node(*args) : super
+      node.fontname = @font
+      node
+    end
+    
+    # Adds a new edge to the graph.  The font for the edge will be automatically
+    # set based on the graph configuration.  The generated edge will be returned.
+    # 
+    # For example,
+    # 
+    #   graph = StateMachine::Graph.new('test')
+    #   graph.add_edges('parked', 'idling', :label => 'ignite')
+    def add_edges(*args)
+      edge = v0_api? ? add_edge(*args) : super
+      edge.fontname = @font
+      edge
+    end
+    
+    private
+    # Determines whether the old v0 api is in use
+    def v0_api?
+      version[0] == '0' || version[0] == '1' && version[1] == '0' && version[2] <= '2'
+    end
+    
+    # The ruby-graphviz version data
+    def version
+      Constants::RGV_VERSION.split('.')
+    end
+  end
+end

data/lib/state_machine/helper_module.rb

@@ -0,0 +1,17 @@
+module StateMachine
+  # Represents a type of module that defines instance / class methods for a
+  # state machine
+  class HelperModule < Module #:nodoc:
+    def initialize(machine, kind)
+      @machine = machine
+      @kind = kind
+    end
+    
+    # Provides a human-readable description of the module
+    def to_s
+      owner_class = @machine.owner_class
+      owner_class_name = owner_class.name && !owner_class.name.empty? ? owner_class.name : owner_class.to_s
+      "#{owner_class_name} #{@machine.name.inspect} #{@kind} helpers"
+    end
+  end
+end

data/lib/state_machine/initializers.rb

@@ -0,0 +1,4 @@
+# Load each application initializer
+Dir["#{File.dirname(__FILE__)}/initializers/*.rb"].sort.each do |path|
+  require "state_machine/initializers/#{File.basename(path)}"
+end

data/lib/state_machine/initializers/merb.rb

@@ -0,0 +1 @@
+Merb::Plugins.add_rakefiles("#{File.dirname(__FILE__)}/../../tasks/state_machine") if defined?(Merb::Plugins)

data/lib/state_machine/initializers/rails.rb

@@ -0,0 +1,25 @@
+if defined?(Rails)
+  # Track all of the applicable locales to load
+  locale_paths = []
+  StateMachine::Integrations.all.each do |integration|
+    locale_paths << integration.locale_path if integration.available? && integration.locale_path
+  end
+  
+  if defined?(Rails::Engine)
+    # Rails 3.x
+    class StateMachine::RailsEngine < Rails::Engine
+      rake_tasks do
+        load 'tasks/state_machine.rb'
+      end
+    end
+    
+    if Rails::VERSION::MAJOR == 3 && Rails::VERSION::MINOR == 0
+      StateMachine::RailsEngine.paths.config.locales = locale_paths
+    else
+      StateMachine::RailsEngine.paths['config/locales'] = locale_paths
+    end
+  elsif defined?(I18n)
+    # Rails 2.x
+    I18n.load_path.unshift(*locale_paths)
+  end
+end

data/lib/state_machine/integrations.rb

@@ -0,0 +1,121 @@
+# Load each available integration
+require 'state_machine/integrations/base'
+Dir["#{File.dirname(__FILE__)}/integrations/*.rb"].sort.each do |path|
+  require "state_machine/integrations/#{File.basename(path)}"
+end
+
+require 'state_machine/error'
+
+module StateMachine
+  # An invalid integration was specified
+  class IntegrationNotFound < Error
+    def initialize(name)
+      super(nil, "#{name.inspect} is an invalid integration")
+    end
+  end
+  
+  # Integrations allow state machines to take advantage of features within the
+  # context of a particular library.  This is currently most useful with
+  # database libraries.  For example, the various database integrations allow
+  # state machines to hook into features like:
+  # * Saving
+  # * Transactions
+  # * Observers
+  # * Scopes
+  # * Callbacks
+  # * Validation errors
+  # 
+  # This type of integration allows the user to work with state machines in a
+  # fashion similar to other object models in their application.
+  # 
+  # The integration interface is loosely defined by various unimplemented
+  # methods in the StateMachine::Machine class.  See that class or the various
+  # built-in integrations for more information about how to define additional
+  # integrations.
+  module Integrations
+    # Attempts to find an integration that matches the given class.  This will
+    # look through all of the built-in integrations under the StateMachine::Integrations
+    # namespace and find one that successfully matches the class.
+    # 
+    # == Examples
+    # 
+    #   class Vehicle
+    #   end
+    #   
+    #   class ActiveModelVehicle
+    #     include ActiveModel::Observing
+    #     include ActiveModel::Validations
+    #   end
+    #   
+    #   class ActiveRecordVehicle < ActiveRecord::Base
+    #   end
+    #   
+    #   class DataMapperVehicle
+    #     include DataMapper::Resource
+    #   end
+    #   
+    #   class MongoidVehicle
+    #     include Mongoid::Document
+    #   end
+    #   
+    #   class MongoMapperVehicle
+    #     include MongoMapper::Document
+    #   end
+    #   
+    #   class SequelVehicle < Sequel::Model
+    #   end
+    #   
+    #   StateMachine::Integrations.match(Vehicle)             # => nil
+    #   StateMachine::Integrations.match(ActiveModelVehicle)  # => StateMachine::Integrations::ActiveModel
+    #   StateMachine::Integrations.match(ActiveRecordVehicle) # => StateMachine::Integrations::ActiveRecord
+    #   StateMachine::Integrations.match(DataMapperVehicle)   # => StateMachine::Integrations::DataMapper
+    #   StateMachine::Integrations.match(MongoidVehicle)      # => StateMachine::Integrations::Mongoid
+    #   StateMachine::Integrations.match(MongoMapperVehicle)  # => StateMachine::Integrations::MongoMapper
+    #   StateMachine::Integrations.match(SequelVehicle)       # => StateMachine::Integrations::Sequel
+    def self.match(klass)
+      all.detect {|integration| integration.matches?(klass)}
+    end
+    
+    # Attempts to find an integration that matches the given list of ancestors.
+    # This will look through all of the built-in integrations under the StateMachine::Integrations
+    # namespace and find one that successfully matches one of the ancestors.
+    # 
+    # == Examples
+    # 
+    #   StateMachine::Integrations.match([])                    # => nil
+    #   StateMachine::Integrations.match(['ActiveRecord::Base') # => StateMachine::Integrations::ActiveModel
+    def self.match_ancestors(ancestors)
+      all.detect {|integration| integration.matches_ancestors?(ancestors)}
+    end
+    
+    # Finds an integration with the given name.  If the integration cannot be
+    # found, then a NameError exception will be raised.
+    # 
+    # == Examples
+    # 
+    #   StateMachine::Integrations.find_by_name(:active_record) # => StateMachine::Integrations::ActiveRecord
+    #   StateMachine::Integrations.find_by_name(:active_model)  # => StateMachine::Integrations::ActiveModel
+    #   StateMachine::Integrations.find_by_name(:data_mapper)   # => StateMachine::Integrations::DataMapper
+    #   StateMachine::Integrations.find_by_name(:mongoid)       # => StateMachine::Integrations::Mongoid
+    #   StateMachine::Integrations.find_by_name(:mongo_mapper)  # => StateMachine::Integrations::MongoMapper
+    #   StateMachine::Integrations.find_by_name(:sequel)        # => StateMachine::Integrations::Sequel
+    #   StateMachine::Integrations.find_by_name(:invalid)       # => StateMachine::IntegrationNotFound: :invalid is an invalid integration
+    def self.find_by_name(name)
+      all.detect {|integration| integration.integration_name == name} || raise(IntegrationNotFound.new(name))
+    end
+    
+    # Gets a list of all of the available integrations for use.  This will
+    # always list the ActiveModel integration last.
+    # 
+    # == Example
+    # 
+    #   StateMachine::Integrations.all
+    #   # => [StateMachine::Integrations::ActiveRecord, StateMachine::Integrations::DataMapper
+    #   #     StateMachine::Integrations::Mongoid, StateMachine::Integrations::MongoMapper,
+    #   #     StateMachine::Integrations::Sequel, StateMachine::Integrations::ActiveModel]
+    def self.all
+      constants = self.constants.map {|c| c.to_s}.select {|c| c != 'ActiveModel'}.sort << 'ActiveModel'
+      constants.map {|c| const_get(c)}
+    end
+  end
+end

data/lib/state_machine/integrations/active_model.rb

@@ -0,0 +1,585 @@
+module StateMachine
+  module Integrations #:nodoc:
+    # 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::Observing
+    # * ActiveModel::Validations
+    # 
+    # Below is an example of a simple state machine defined within an
+    # ActiveModel class:
+    # 
+    #   class Vehicle
+    #     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 <tt>:speed_is_legal</tt> validation will only get run
+    # for the <tt>:second_gear</tt> 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\""]
+    # 
+    # In addition, if you're using the <tt>ignite!</tt> version of the event,
+    # then the failure reason (such as the current validation errors) will be
+    # included in the exception that gets raised when the event fails.  For
+    # example, assuming there's a validation on a field called +name+ on the class:
+    # 
+    #   vehicle = Vehicle.new
+    #   vehicle.ignite!       # => StateMachine::InvalidTransition: Cannot transition state via :ignite from :parked (Reason(s): Name cannot be blank)
+    # 
+    # === 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
+    # 
+    # == Internationalization
+    # 
+    # Any error message that is generated from performing invalid transitions
+    # can be localized.  The following default translations are used:
+    # 
+    #   en:
+    #     activemodel:
+    #       errors:
+    #         messages:
+    #           invalid: "is invalid"
+    #           # %{value} = attribute value, %{state} = Human state name
+    #           invalid_event: "cannot transition when %{state}"
+    #           # %{value} = attribute value, %{event} = Human event name, %{state} = Human current state name
+    #           invalid_transition: "cannot transition via %{event}"
+    # 
+    # You can override these for a specific model like so:
+    # 
+    #   en:
+    #     activemodel:
+    #       errors:
+    #         models:
+    #           user:
+    #             invalid: "is not valid"
+    # 
+    # In addition to the above, you can also provide translations for the
+    # various states / events in each state machine.  Using the Vehicle example,
+    # state translations will be looked for using the following keys, where
+    # +model_name+ = "vehicle", +machine_name+ = "state" and +state_name+ = "parked":
+    # * <tt>activemodel.state_machines.#{model_name}.#{machine_name}.states.#{state_name}</tt>
+    # * <tt>activemodel.state_machines.#{model_name}.states.#{state_name}</tt>
+    # * <tt>activemodel.state_machines.#{machine_name}.states.#{state_name}</tt>
+    # * <tt>activemodel.state_machines.states.#{state_name}</tt>
+    # 
+    # Event translations will be looked for using the following keys, where
+    # +model_name+ = "vehicle", +machine_name+ = "state" and +event_name+ = "ignite":
+    # * <tt>activemodel.state_machines.#{model_name}.#{machine_name}.events.#{event_name}</tt>
+    # * <tt>activemodel.state_machines.#{model_name}.events.#{event_name}</tt>
+    # * <tt>activemodel.state_machines.#{machine_name}.events.#{event_name}</tt>
+    # * <tt>activemodel.state_machines.events.#{event_name}</tt>
+    # 
+    # An example translation configuration might look like so:
+    # 
+    #   es:
+    #     activemodel:
+    #       state_machines:
+    #         states:
+    #           parked: 'estacionado'
+    #         events:
+    #           park: 'estacionarse'
+    # 
+    # == Dirty Attribute Tracking
+    # 
+    # When using the ActiveModel::Dirty extension, your model will keep track of
+    # any changes that are made to attributes.  Depending on your ORM, an object
+    # will only be saved when there are attributes that have changed on the
+    # object.  When integrating with state_machine, typically the +state+ field
+    # will be marked as dirty after a transition occurs.  In some situations,
+    # however, this isn't the case.
+    # 
+    # If you define loopback transitions in your state machine, the value for
+    # the machine's attribute (e.g. state) will not change.  Unless you explicitly
+    # indicate so, this means that your object won't persist anything on a
+    # loopback.  For example:
+    # 
+    #   class Vehicle
+    #     include ActiveModel::Validations
+    #     include ActiveModel::Dirty
+    #     attr_accessor :state
+    #     
+    #     state_machine :initial => :parked do
+    #       event :park do
+    #         transition :parked => :parked, ...
+    #       end
+    #     end
+    #   end
+    # 
+    # If, instead, you'd like your object to always persist regardless of
+    # whether the value actually changed, you can do so by using the
+    # <tt>#{attribute}_will_change!</tt> helpers or defining a +before_transition+
+    # callback that actually changes an attribute on the model.  For example:
+    # 
+    #   class Vehicle
+    #     ...
+    #     state_machine :initial => :parked do
+    #       before_transition all => same do |vehicle|
+    #         vehicle.state_will_change!
+    #         
+    #         # Alternative solution, updating timestamp
+    #         # vehicle.updated_at = Time.curent
+    #       end
+    #     end
+    #   end
+    # 
+    # == Creating new integrations
+    # 
+    # If you want to integrate state_machine with an ORM that implements parts
+    # or all of the ActiveModel API, only the machine defaults need to be
+    # specified.  Otherwise, the implementation is similar to any other
+    # integration.
+    # 
+    # For example,
+    # 
+    #   module StateMachine::Integrations::MyORM
+    #     include StateMachine::Integrations::ActiveModel
+    #     
+    #     @defaults = {:action = > :persist}
+    #     
+    #     def self.matches?(klass)
+    #       defined?(::MyORM::Base) && klass <= ::MyORM::Base
+    #     end
+    #     
+    #     protected
+    #       def runs_validations_on_action?
+    #         action == :persist
+    #       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.
+    module ActiveModel
+      def self.included(base) #:nodoc:
+        base.versions.unshift(*versions)
+      end
+      
+      include Base
+      extend ClassMethods
+      
+      require 'state_machine/integrations/active_model/versions'
+      
+      @defaults = {}
+      
+      # Classes that include ActiveModel::Observing or ActiveModel::Validations
+      # will automatically use the ActiveModel integration.
+      def self.matching_ancestors
+        %w(ActiveModel ActiveModel::Observing ActiveModel::Validations)
+      end
+      
+      # Adds a validation error to the given object 
+      def invalidate(object, attribute, message, values = [])
+        if supports_validations?
+          attribute = self.attribute(attribute)
+          options = values.inject({}) do |h, (key, value)|
+            h[key] = value
+            h
+          end
+          
+          default_options = default_error_message_options(object, attribute, message)
+          object.errors.add(attribute, message, options.merge(default_options))
+        end
+      end
+      
+      # Describes the current validation errors on the given object.  If none
+      # are specific, then the default error is interpeted as a "halt".
+      def errors_for(object)
+        object.errors.empty? ? 'Transition halted' : object.errors.full_messages * ', '
+      end
+      
+      # Resets any errors previously added when invalidating the given object
+      def reset(object)
+        object.errors.clear if supports_validations?
+      end
+      
+      # Runs state events around the object's validation process
+      def around_validation(object)
+        object.class.state_machines.transitions(object, action, :after => false).perform { yield }
+      end
+
+      protected
+        # Whether observers are supported in the integration.  Only true if
+        # ActiveModel::Observer is available.
+        def supports_observers?
+          defined?(::ActiveModel::Observing) && owner_class <= ::ActiveModel::Observing
+        end
+        
+        # Whether validations are supported in the integration.  Only true if
+        # the ActiveModel feature is enabled on the owner class.
+        def supports_validations?
+          defined?(::ActiveModel::Validations) && owner_class <= ::ActiveModel::Validations
+        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.
+        def runs_validations_on_action?
+          false
+        end
+        
+        # Gets the terminator to use for callbacks
+        def callback_terminator
+          @terminator ||= lambda {|result| result == false}
+        end
+        
+        # Determines the base scope to use when looking up translations
+        def i18n_scope(klass)
+          klass.i18n_scope
+        end
+        
+        # The default options to use when generating messages for validation
+        # errors
+        def default_error_message_options(object, attribute, message)
+          {:message => @messages[message]}
+        end
+        
+        # Translates the given key / value combo.  Translation keys are looked
+        # up in the following order:
+        # * <tt>#{i18n_scope}.state_machines.#{model_name}.#{machine_name}.#{plural_key}.#{value}</tt>
+        # * <tt>#{i18n_scope}.state_machines.#{model_name}.#{plural_key}.#{value}</tt>
+        # * <tt>#{i18n_scope}.state_machines.#{machine_name}.#{plural_key}.#{value}</tt>
+        # * <tt>#{i18n_scope}.state_machines.#{plural_key}.#{value}</tt>
+        # 
+        # If no keys are found, then the humanized value will be the fallback.
+        def translate(klass, key, value)
+          ancestors = ancestors_for(klass)
+          group = key.to_s.pluralize
+          value = value ? value.to_s : 'nil'
+          
+          # Generate all possible translation keys
+          translations = ancestors.map {|ancestor| :"#{ancestor.model_name.to_s.underscore}.#{name}.#{group}.#{value}"}
+          translations.concat(ancestors.map {|ancestor| :"#{ancestor.model_name.to_s.underscore}.#{group}.#{value}"})
+          translations.concat([:"#{name}.#{group}.#{value}", :"#{group}.#{value}", value.humanize.downcase])
+          I18n.translate(translations.shift, :default => translations, :scope => [i18n_scope(klass), :state_machines])
+        end
+        
+        # Build a list of ancestors for the given class to use when
+        # determining which localization key to use for a particular string.
+        def ancestors_for(klass)
+          klass.lookup_ancestors
+        end
+        
+        # Initializes class-level extensions and defaults for this machine
+        def after_initialize
+          super
+          load_locale
+          load_observer_extensions
+          add_default_callbacks
+        end
+        
+        # Loads any locale files needed for translating validation errors
+        def load_locale
+          I18n.load_path.unshift(@integration.locale_path) unless I18n.load_path.include?(@integration.locale_path)
+        end
+        
+        # Loads extensions to ActiveModel's Observers
+        def load_observer_extensions
+          require 'state_machine/integrations/active_model/observer'
+          require 'state_machine/integrations/active_model/observer_update'
+        end
+        
+        # Adds a set of default callbacks that utilize the Observer extensions
+        def add_default_callbacks
+          if supports_observers?
+            callbacks[:before] << Callback.new(:before) {|object, transition| notify(:before, object, transition)}
+            callbacks[:after] << Callback.new(:after) {|object, transition| notify(:after, object, transition)}
+            callbacks[:failure] << Callback.new(:failure) {|object, transition| notify(:after_failure_to, object, transition)}
+          end
+        end
+        
+        # Skips defining reader/writer methods since this is done automatically
+        def define_state_accessor
+          name = self.name
+          
+          owner_class.validates_each(attribute) do |object, attr, value|
+            machine = object.class.state_machine(name)
+            machine.invalidate(object, :state, :invalid) unless machine.states.match(object)
+          end if supports_validations?
+        end
+        
+        # Adds hooks into validation for automatically firing events
+        def define_action_helpers
+          super
+          define_validation_hook if runs_validations_on_action?
+        end
+        
+        # Hooks into validations by defining around callbacks for the
+        # :validation event
+        def define_validation_hook
+          owner_class.set_callback(:validation, :around, self, :prepend => true)
+        end
+        
+        # Creates a new callback in the callback chain, always inserting it
+        # before the default Observer callbacks that were created after
+        # initialization.
+        def add_callback(type, options, &block)
+          options[:terminator] = callback_terminator
+          
+          if supports_observers?
+            @callbacks[type == :around ? :before : type].insert(-2, callback = Callback.new(type, options, &block))
+            add_states(callback.known_states)
+            callback
+          else
+            super
+          end
+        end
+        
+        # Configures new states with the built-in humanize scheme
+        def add_states(new_states)
+          super.each do |new_state|
+            new_state.human_name = lambda {|state, klass| translate(klass, :state, state.name)}
+          end
+        end
+        
+        # Configures new event with the built-in humanize scheme
+        def add_events(new_events)
+          super.each do |new_event|
+            new_event.human_name = lambda {|event, klass| translate(klass, :event, event.name)}
+          end
+        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:
+        # * <tt>#{type}_#{qualified_event}_from_#{from}_to_#{to}</tt>
+        # * <tt>#{type}_#{qualified_event}_from_#{from}</tt>
+        # * <tt>#{type}_#{qualified_event}_to_#{to}</tt>
+        # * <tt>#{type}_#{qualified_event}</tt>
+        # * <tt>#{type}_transition_#{machine_name}_from_#{from}_to_#{to}</tt>
+        # * <tt>#{type}_transition_#{machine_name}_from_#{from}</tt>
+        # * <tt>#{type}_transition_#{machine_name}_to_#{to}</tt>
+        # * <tt>#{type}_transition_#{machine_name}</tt>
+        # * <tt>#{type}_transition</tt>
+        # 
+        # This will always return true regardless of the results of the
+        # callbacks.
+        def notify(type, object, transition)
+          name = self.name
+          event = transition.qualified_event
+          from = transition.from_name || 'nil'
+          to = transition.to_name || 'nil'
+          
+          # Machine-specific updates
+          ["#{type}_#{event}", "#{type}_transition_#{name}"].each do |event_segment|
+            ["_from_#{from}", nil].each do |from_segment|
+              ["_to_#{to}", nil].each do |to_segment|
+                object.class.changed if object.class.respond_to?(:changed)
+                object.class.notify_observers('update_with_transition', ObserverUpdate.new([event_segment, from_segment, to_segment].join, object, transition))
+              end
+            end
+          end
+          
+          # Generic updates
+          object.class.changed if object.class.respond_to?(:changed)
+          object.class.notify_observers('update_with_transition', ObserverUpdate.new("#{type}_transition", object, transition))
+          
+          true
+        end
+    end
+  end
+end