Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with HTTPS or Subversion.

Download ZIP
Adds support for creating state machines for attributes on any Ruby class

Fetching latest commit…

Cannot retrieve the latest commit at this time

Failed to load latest commit information.
lib
test
.gitignore
CHANGELOG.rdoc
LICENSE
README.rdoc
Rakefile
init.rb

README.rdoc

state_machine

state_machine adds support for creating state machines for attributes within a model.

Resources

API

Bugs

Development

Source

  • git://github.com/pluginaweek/state_machine.git

Description

State machines make it dead-simple to manage the behavior of a model. Too often, the status of a record is kept by creating multiple boolean columns in the table and deciding how to behave based on the values in those columns. This can become cumbersome and difficult to maintain when the complexity of your models starts to increase.

state_machine simplifies this design by introducing the various parts of a state machine, including states, events, and transitions. However, its api is designed to be similar to ActiveRecord in terms of validations and callbacks, making it so simple you don't even need to know what a state machine is :)

Usage

Example

class Vehicle < ActiveRecord::Base
  state_machine :state, :initial => 'idling' do
    before_exit   'parked', :put_on_seatbelt
    after_enter   'parked', Proc.new {|vehicle| vehicle.update_attribute(:seatbelt_on, false)}

    event :park do
      transition :to => 'parked', :from => %w(idling first_gear)
    end

    event :ignite do
      transition :to => 'stalled', :from => 'stalled'
      transition :to => 'idling', :from => 'parked'
    end

    event :idle do
      transition :to => 'idling', :from => 'first_gear'
    end

    event :shift_up do
      transition :to => 'first_gear', :from => 'idling'
      transition :to => 'second_gear', :from => 'first_gear'
      transition :to => 'third_gear', :from => 'second_gear'
    end

    event :shift_down do
      transition :to => 'second_gear', :from => 'third_gear'
      transition :to => 'first_gear', :from => 'second_gear'
    end

    event :crash, :after => :tow! do
      transition :to => 'stalled', :from => %w(first_gear second_gear third_gear), :unless => :auto_shop_busy?
    end

    event :repair, :after => :fix! do
      transition :to => 'parked', :from => 'stalled', :if => :auto_shop_busy?
    end
  end
end

Tools

Jean Bovet - Visual Automata Simulator. This is a great tool for “simulating, visualizing and transforming finite state automata and Turing Machines”. This tool can help in the creation of states and events for your models. It is cross-platform, written in Java.

Testing

Before you can run any tests, the following gem must be installed:

To run against a specific version of Rails:

rake test RAILS_FRAMEWORK_ROOT=/path/to/rails

Dependencies

  • Rails 2.1 or later

References

Something went wrong with that request. Please try again.