module StateMachine::Integrations

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:

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.

Public Class Methods

all() click to toggle source

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]
    # File lib/state_machine/integrations.rb
104 def self.all
105   constants = self.constants.map {|c| c.to_s}.select {|c| c != 'ActiveModel'}.sort << 'ActiveModel'
106   constants.map {|c| const_get(c)}
107 end
find_by_name(name) click to toggle source

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
   # File lib/state_machine/integrations.rb
91 def self.find_by_name(name)
92   all.detect {|integration| integration.integration_name == name} || raise(IntegrationNotFound.new(name))
93 end
match(klass) click to toggle source

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
   # File lib/state_machine/integrations.rb
75 def self.match(klass)
76   all.detect {|integration| integration.available? && integration.matches?(klass)}
77 end