1
0
Fork 0
mirror of https://github.com/aasm/aasm synced 2023-03-27 23:22:41 -04:00
AASM - State machines for Ruby classes (plain Ruby, ActiveRecord, Mongoid, NoBrainer, Dynamoid)
Find a file
Jeff Dean cb6bd4f534 * Specs and bug fixes for the ActiveRecordPersistence, keeping persistence columns in sync
Allowing for nil values in states for active record
  New non-(!) methods that allow for firing events without persisting [Jeff Dean]
2008-04-29 01:27:56 -04:00
doc Prepare rakefile and rake tasks for gem packaging and rdocing 2008-02-21 11:41:56 -05:00
lib * Specs and bug fixes for the ActiveRecordPersistence, keeping persistence columns in sync 2008-04-29 01:27:56 -04:00
spec * Specs and bug fixes for the ActiveRecordPersistence, keeping persistence columns in sync 2008-04-29 01:27:56 -04:00
.gitignore * Specs and bug fixes for the ActiveRecordPersistence, keeping persistence columns in sync 2008-04-29 01:27:56 -04:00
aasm.rb Import into git 2008-01-07 14:11:38 -05:00
CHANGELOG * Specs and bug fixes for the ActiveRecordPersistence, keeping persistence columns in sync 2008-04-29 01:27:56 -04:00
MIT-LICENSE Add .aasm_states method to get a list of all states for a class 2008-02-21 12:54:42 -05:00
Rakefile Adding .rdoc to README just to see github's rendering. 2008-03-13 13:10:28 -04:00
README.rdoc Adding .rdoc to README just to see github's rendering. 2008-03-13 13:10:28 -04:00
TODO Add two event callbacks: 2008-03-02 07:52:46 -05:00

= AASM - Ruby state machines

This package contains AASM, a library for adding finite state machines to Ruby classes.

AASM started as the acts_as_state_machine plugin but has evolved into a more generic library that no longer targets only ActiveRecord models.

AASM has the following features:

* Feature

* Feature


== Download

The latest AASM can currently be pulled from the git repository on github.

* http://github.com/rubyist/aasm/tree/master

A release and a gem are forthcoming.



== Installation

Until the gem release is made your best bet is to build the gem yourself and install it.

  % rake gem
  % sudo gem install pkg/aasm-3.0.0.gem


== Simple Example

Here's a quick example highlighting some of the features.

  class Conversation
    include AASM

    aasm_initial_state :new

    aasm_state :new
    aasm_state :read
    aasm_state :closed


    aasm_event :view do
      transitions :to => :read, :from => [:new]
    end

    aasm_event :close do
      transitions :to => :closed, :from => [:read, :new]
    end
  end

= Other Stuff

Author::  Scott Barron <scott@elitists.net>
License:: Copyright 2006, 2007, 2008 by Scott Barron.
          Released under an MIT-style license.  See the LICENSE  file
          included in the distribution.

== Warranty

This software is provided "as is" and without any express or
implied warranties, including, without limitation, the implied
warranties of merchantibility and fitness for a particular
purpose.