faasm 2.1.1

data/CHANGELOG

@@ -0,0 +1,33 @@
+* In AR persistence, move state column from class level variables into the StateMachine object for the class
+
+* allowed :to array and :on_transition callback [Kevin Triplett]
+
+* Support enter and exit actions on states
+
+* Use named_scope in AR persistence layer, if available [Jan De Poorter]
+
+* Incremented version number
+
+* Cleaned up aasm_states_for_select to return the value as a string
+
+* Specs and bug fixes for the ActiveRecordPersistence, keeping persistence columns in sync
+  Allowing for nil values in states for active record
+  Only set state to default state before_validation_on_create
+  New rake task to uninstall, build and reinstall the gem (useful for development)
+  Changed scott's email address to protect it from spambots when publishing rdocs
+  New non-(!) methods that allow for firing events without persisting [Jeff Dean]
+
+* Added aasm_states_for_select that will return a select friendly collection of states. 
+
+* Add some event callbacks, #aasm_event_fired(from, to), and #aasm_event_failed(event)
+  Based on transition logging suggestion [Artem Vasiliev] and timestamp column suggestion [Mike Ferrier]
+
+* Add #aasm_events_for_state and #aasm_events_for_current_state [Joao Paulo Lins]
+
+* Ensure that a state is written for a new record even if aasm_current_state or
+  {state}= are never called.
+
+* Fix AR persistence so new records have their state set. [Joao Paulo Lins]
+
+* Make #event! methods return a boolean [Joel Chippindale]
+

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2008 Scott Barron
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.rdoc

@@ -0,0 +1,122 @@
+= 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:
+
+* States
+* Machines
+* Events
+* Transitions
+
+== New Callbacks
+
+The callback chain & order on a successful event looks like:
+
+  oldstate:exit*
+  event:before
+  __find transition, if possible__
+  transition:on_transition*
+  oldstate:before_exit
+  newstate:before_enter
+  newstate:enter*
+  __update state__
+  event:success*
+  oldstate:after_exit
+  oldstate:after_enter
+  event:after
+  obj:aasm_event_fired*
+
+  (*) marks old callbacks
+
+
+== Download
+
+The latest AASM can currently be pulled from the git repository on github.
+
+* http://github.com/ttilley/aasm/tree/master
+
+
+== Installation
+
+=== From GitHub hosted gems
+
+  % sudo gem sources -a http://gems.github.com # (you only need to do this once)
+  % sudo gem install ttilley-aasm
+
+=== Building your own gems
+
+  % rake gem
+  % sudo gem install pkg/aasm-2.1.gem
+
+
+== Simple Example
+
+Here's a quick example highlighting some of the features.
+
+  class Conversation
+    include AASM
+
+    aasm_initial_state :unread
+
+    aasm_state :unread
+    aasm_state :read
+    aasm_state :closed
+
+
+    aasm_event :view do
+      transitions :to => :read, :from => [:unread]
+    end
+
+    aasm_event :close do
+      transitions :to => :closed, :from => [:read, :unread]
+    end
+  end
+
+== A Slightly More Complex Example
+
+This example uses a few of the more complex features available.
+
+  class Relationship
+    include AASM
+    
+    aasm_initial_state Proc.new { |relationship| relationship.strictly_for_fun? ? :intimate : :dating }
+    
+    aasm_state :dating,   :enter => :make_happy,        :exit => :make_depressed
+    aasm_state :intimate, :enter => :make_very_happy,   :exit => :never_speak_again
+    aasm_state :married,  :enter => :give_up_intimacy,  :exit => :buy_exotic_car_and_wear_a_combover
+    
+    aasm_event :get_intimate do
+      transitions :to => :intimate, :from => [:dating], :guard => :drunk?
+    end
+    
+    aasm_event :get_married do
+      transitions :to => :married, :from => [:dating, :intimate], :guard => :willing_to_give_up_manhood?
+    end
+    
+    def strictly_for_fun?; end
+    def drunk?; end
+    def willing_to_give_up_manhood?; end
+    def make_happy; end
+    def make_depressed; end
+    def make_very_happy; end
+    def never_speak_again; end
+    def give_up_intimacy; end
+    def buy_exotic_car_and_wear_a_combover; end
+  end
+
+= Other Stuff
+
+Author::  Scott Barron <scott at elitists dot net>
+License:: Original code 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.

data/Rakefile

@@ -0,0 +1,95 @@
+# Copyright 2008 Scott Barron (scott@elitists.net)
+# All rights reserved
+
+# This file may be distributed under an MIT style license.
+# See MIT-LICENSE for details.
+
+begin
+  require 'rubygems'
+  require 'rake/gempackagetask'
+  require 'rake/testtask'
+  require 'rake/rdoctask'
+  require 'spec/rake/spectask'
+rescue Exception
+  nil
+end
+
+if `ruby -Ilib -raasm -e "print AASM.Version"` =~ /([0-9.]+)$/
+  CURRENT_VERSION = $1
+else
+  CURRENT_VERSION = '0.0.0'
+end
+$package_version = CURRENT_VERSION
+
+PKG_FILES = FileList['[A-Z]*',
+  'lib/**/*.rb',
+  'doc/**/*'
+]
+
+desc 'Generate documentation for the acts as state machine plugin.'
+rd = Rake::RDocTask.new(:rdoc) do |rdoc|
+  rdoc.rdoc_dir = 'html'
+  rdoc.template = 'doc/jamis.rb'
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title    = 'AASM'
+  rdoc.options << '--line-numbers' << '--inline-source' <<  '--main' << 'README.rdoc' << '--title' << 'AASM'
+  rdoc.rdoc_files.include('README.rdoc', 'MIT-LICENSE', 'TODO', 'CHANGELOG')
+  rdoc.rdoc_files.include('lib/*.rb', 'lib/**/*.rb', 'doc/**/*.rdoc')
+end
+
+if !defined?(Gem)
+  puts "Package target requires RubyGEMs"
+else
+  spec = Gem::Specification.new do |s|
+    s.name = 'aasm'
+    s.version = $package_version
+    s.summary = 'State machine mixin for Ruby objects'
+    s.description = <<EOF
+AASM is a continuation of the acts as state machine rails plugin, built for plain Ruby objects.
+EOF
+
+    s.files = PKG_FILES.to_a
+    s.require_path = 'lib'
+    s.has_rdoc = true
+    s.extra_rdoc_files = rd.rdoc_files.reject {|fn| fn =~ /\.rb$/}.to_a
+    s.rdoc_options = rd.options
+
+    s.authors = ['Scott Barron', 'Scott Petersen', 'Travis Tilley']
+    s.email = 'ttilley@gmail.com'
+    s.homepage = 'http://github.com/ttilley/aasm'
+  end
+
+  package_task = Rake::GemPackageTask.new(spec) do |pkg|
+    pkg.need_zip = true
+    pkg.need_tar = true
+  end
+end
+
+if !defined?(Spec)
+  puts "spec and cruise targets require RSpec"
+else
+  desc "Run all examples with RCov"
+  Spec::Rake::SpecTask.new('cruise') do |t|
+    t.spec_files = FileList['spec/**/*.rb']
+    t.rcov = true
+    t.rcov_opts = ['--exclude', 'spec', '--exclude', 'Library', '--exclude', 'rcov.rb']
+  end
+
+  desc "Run all examples"
+  Spec::Rake::SpecTask.new('spec') do |t|
+    t.spec_files = FileList['spec/**/*.rb']
+    t.rcov = false
+    t.spec_opts = ['-cfs']
+  end
+end
+
+if !defined?(Gem)
+  puts "Package target requires RubyGEMs"
+else
+  desc "sudo gem uninstall aasm && rake gem && sudo gem install pkg/aasm-3.0.0.gem"
+  task :reinstall do
+    puts `sudo gem uninstall aasm && rake gem && sudo gem install pkg/aasm-3.0.0.gem`
+  end
+end
+
+task :default => [:spec]

data/TODO

@@ -0,0 +1,9 @@
+Before Next Release:
+
+* Add #aasm_next_state_for_event
+* Add #aasm_next_states_for_event
+
+Cool ideas from users:
+
+* Support multiple state machines on one object (Chris Nelson)
+* http://justbarebones.blogspot.com/2007/11/actsasstatemachine-enhancements.html (Chetan Patil)

data/lib/aasm.rb

@@ -0,0 +1 @@
+require File.join(File.dirname(__FILE__), 'aasm', 'aasm')

data/lib/aasm/aasm.rb

@@ -0,0 +1,185 @@
+require File.join(File.dirname(__FILE__), 'event')
+require File.join(File.dirname(__FILE__), 'state')
+require File.join(File.dirname(__FILE__), 'state_machine')
+require File.join(File.dirname(__FILE__), 'persistence')
+
+module AASM
+  def self.Version
+    '2.1.1'
+  end
+
+  class InvalidTransition < RuntimeError
+  end
+
+  class UndefinedState < RuntimeError
+  end
+
+  def self.included(base) #:nodoc:
+    base.extend AASM::ClassMethods
+    AASM::Persistence.set_persistence(base)
+    unless AASM::StateMachine[base]
+      AASM::StateMachine[base] = AASM::StateMachine.new('')
+    end
+  end
+
+  module ClassMethods
+    def inherited(klass)
+      AASM::StateMachine[klass] = AASM::StateMachine[self].clone
+      super
+    end
+
+    def aasm_initial_state(set_state=nil)
+      if set_state
+        AASM::StateMachine[self].initial_state = set_state
+      else
+        AASM::StateMachine[self].initial_state
+      end
+    end
+
+    def aasm_initial_state=(state)
+      AASM::StateMachine[self].initial_state = state
+    end
+
+    def aasm_state(name, options={})
+      sm = AASM::StateMachine[self]
+      sm.create_state(name, options)
+      sm.initial_state = name unless sm.initial_state
+
+      define_method("#{name.to_s}?") do
+        aasm_current_state == name
+      end
+    end
+
+    def aasm_event(name, options = {}, &block)
+      sm = AASM::StateMachine[self]
+
+      unless sm.events.has_key?(name)
+        sm.events[name] = AASM::SupportingClasses::Event.new(name, options, &block)
+      end
+
+      define_method("#{name.to_s}!") do |*args|
+        aasm_fire_event(name, true, *args)
+      end
+
+      define_method("#{name.to_s}") do |*args|
+        aasm_fire_event(name, false, *args)
+      end
+    end
+
+    def aasm_states
+      AASM::StateMachine[self].states
+    end
+
+    def aasm_events
+      AASM::StateMachine[self].events
+    end
+
+    def aasm_states_for_select
+      AASM::StateMachine[self].states.map { |state| state.for_select }
+    end
+
+  end
+
+  # Instance methods
+  def aasm_current_state
+    return @aasm_current_state if @aasm_current_state
+
+    if self.respond_to?(:aasm_read_state) || self.private_methods.include?('aasm_read_state')
+      @aasm_current_state = aasm_read_state
+    end
+    return @aasm_current_state if @aasm_current_state
+    aasm_determine_state_name(self.class.aasm_initial_state)
+  end
+
+  def aasm_events_for_current_state
+    aasm_events_for_state(aasm_current_state)
+  end
+
+  def aasm_events_for_state(state)
+    events = self.class.aasm_events.values.select {|event| event.transitions_from_state?(state) }
+    events.map {|event| event.name}
+  end
+
+  private
+  def set_aasm_current_state_with_persistence(state)
+    save_success = true
+    if self.respond_to?(:aasm_write_state) || self.private_methods.include?('aasm_write_state')
+      save_success = aasm_write_state(state)
+    end
+    self.aasm_current_state = state if save_success
+
+    save_success
+  end
+
+  def aasm_current_state=(state)
+    if self.respond_to?(:aasm_write_state_without_persistence) || self.private_methods.include?('aasm_write_state_without_persistence')
+      aasm_write_state_without_persistence(state)
+    end
+    @aasm_current_state = state
+  end
+
+  def aasm_determine_state_name(state)
+    case state
+    when Symbol, String
+      state
+    when Proc
+      state.call(self)
+    else
+      raise NotImplementedError, "Unrecognized state-type given.  Expected Symbol, String, or Proc."
+    end
+  end
+
+  def aasm_state_object_for_state(name)
+    obj = self.class.aasm_states.find {|s| s == name}
+    raise AASM::UndefinedState, "State :#{name} doesn't exist" if obj.nil?
+    obj
+  end
+
+  def aasm_fire_event(name, persist, *args)
+    old_state = aasm_state_object_for_state(aasm_current_state)
+    event = self.class.aasm_events[name]
+
+    old_state.call_action(:exit, self)
+
+    # new event before callback
+    event.call_action(:before, self)
+
+    new_state_name = event.fire(self, *args)
+
+    unless new_state_name.nil?
+      new_state = aasm_state_object_for_state(new_state_name)
+    
+      # new before_ callbacks
+      old_state.call_action(:before_exit, self)
+      new_state.call_action(:before_enter, self)
+      
+      new_state.call_action(:enter, self)
+      
+      persist_successful = true
+      if persist
+        persist_successful = set_aasm_current_state_with_persistence(new_state_name)
+        event.execute_success_callback(self) if persist_successful
+      else
+        self.aasm_current_state = new_state_name
+      end
+
+      if persist_successful 
+        old_state.call_action(:after_exit, self)
+        new_state.call_action(:after_enter, self)
+        event.call_action(:after, self)
+
+        self.aasm_event_fired(name, old_state.name, self.aasm_current_state) if self.respond_to?(:aasm_event_fired)
+      else
+        self.aasm_event_failed(name, old_state.name) if self.respond_to?(:aasm_event_failed)
+      end
+
+      persist_successful
+    else
+      if self.respond_to?(:aasm_event_failed)
+        self.aasm_event_failed(name, old_state.name)
+      end
+
+      false
+    end
+  end
+end

data/lib/aasm/event.rb

@@ -0,0 +1,76 @@
+require File.join(File.dirname(__FILE__), 'state_transition')
+
+module AASM
+  module SupportingClasses
+    class Event
+      attr_reader :name, :success, :options
+      
+      def initialize(name, options = {}, &block)
+        @name = name
+        @success = options[:success]
+        @transitions = []
+        @options = options
+        instance_eval(&block) if block
+      end
+
+      def fire(obj, to_state=nil, *args)
+        transitions = @transitions.select { |t| t.from == obj.aasm_current_state }
+        raise AASM::InvalidTransition, "Event '#{name}' cannot transition from '#{obj.aasm_current_state}'" if transitions.size == 0
+
+        next_state = nil
+        transitions.each do |transition|
+          next if to_state and !Array(transition.to).include?(to_state)
+          if transition.perform(obj)
+            next_state = to_state || Array(transition.to).first
+            transition.execute(obj, *args)
+            break
+          end
+        end
+        next_state
+      end
+
+      def transitions_from_state?(state)
+        @transitions.any? { |t| t.from == state }
+      end
+
+      def transitions_from_state(state)
+        @transitions.select { |t| t.from == state }
+      end
+
+      def execute_success_callback(obj, success = nil)
+        callback = success || @success
+        case(callback)
+        when String, Symbol
+          obj.send(callback)
+        when Proc
+          callback.call(obj)
+        when Array
+          callback.each{|meth|self.execute_success_callback(obj, meth)}
+        end
+      end
+
+      def call_action(action, record)
+        action = @options[action]
+        case action
+        when Symbol, String
+          record.send(action)
+        when Proc
+          action.call(record)
+        when Array
+          action.each { |a| record.send(a) }
+        end
+      end
+
+      def all_transitions
+        @transitions
+      end
+
+      private
+      def transitions(trans_opts)
+        Array(trans_opts[:from]).each do |s|
+          @transitions << SupportingClasses::StateTransition.new(trans_opts.merge({:from => s.to_sym}))
+        end
+      end
+    end
+  end
+end

data/lib/aasm/persistence.rb

@@ -0,0 +1,16 @@
+module AASM
+  module Persistence
+
+    # Checks to see this class or any of it's superclasses inherit from
+    # ActiveRecord::Base and if so includes ActiveRecordPersistence
+    def self.set_persistence(base)
+      # Use a fancier auto-loading thingy, perhaps.  When there are more persistence engines.
+      hierarchy = base.ancestors.map {|klass| klass.to_s}
+
+      if hierarchy.include?("ActiveRecord::Base")
+        require File.join(File.dirname(__FILE__), 'persistence', 'active_record_persistence')
+        base.send(:include, AASM::Persistence::ActiveRecordPersistence)
+      end
+    end
+  end
+end

data/lib/aasm/persistence/active_record_persistence.rb

@@ -0,0 +1,251 @@
+module AASM
+  module Persistence
+    module ActiveRecordPersistence
+      # This method:
+      #
+      # * extends the model with ClassMethods
+      # * includes InstanceMethods
+      #
+      # Unless the corresponding methods are already defined, it includes
+      # * ReadState
+      # * WriteState
+      # * WriteStateWithoutPersistence
+      #
+      # Adds
+      #
+      #   before_validation_on_create :aasm_ensure_initial_state
+      #
+      # As a result, it doesn't matter when you define your methods - the following 2 are equivalent
+      #
+      #   class Foo < ActiveRecord::Base
+      #     def aasm_write_state(state)
+      #       "bar"
+      #     end
+      #     include AASM
+      #   end
+      #
+      #   class Foo < ActiveRecord::Base
+      #     include AASM
+      #     def aasm_write_state(state)
+      #       "bar"
+      #     end
+      #   end
+      #
+      def self.included(base)
+        base.extend AASM::Persistence::ActiveRecordPersistence::ClassMethods
+        base.send(:include, AASM::Persistence::ActiveRecordPersistence::InstanceMethods)
+        base.send(:include, AASM::Persistence::ActiveRecordPersistence::ReadState) unless base.method_defined?(:aasm_read_state)
+        base.send(:include, AASM::Persistence::ActiveRecordPersistence::WriteState) unless base.method_defined?(:aasm_write_state)
+        base.send(:include, AASM::Persistence::ActiveRecordPersistence::WriteStateWithoutPersistence) unless base.method_defined?(:aasm_write_state_without_persistence)
+
+        if base.respond_to?(:named_scope)
+          base.extend(AASM::Persistence::ActiveRecordPersistence::NamedScopeMethods)
+
+          base.class_eval do
+            class << self
+              unless method_defined?(:aasm_state_without_named_scope)
+                alias_method :aasm_state_without_named_scope, :aasm_state
+                alias_method :aasm_state, :aasm_state_with_named_scope
+              end
+            end
+          end
+        end
+
+        #base.before_validation_on_create :aasm_ensure_initial_state
+        
+        base.before_validation(:on => :create){ :aasm_ensure_initial_state }
+        
+      end
+
+      module ClassMethods
+        # Maps to the aasm_column in the database.  Deafults to "aasm_state".  You can write:
+        #
+        #   create_table :foos do |t|
+        #     t.string :name
+        #     t.string :aasm_state
+        #   end
+        #
+        #   class Foo < ActiveRecord::Base
+        #     include AASM
+        #   end
+        #
+        # OR:
+        #
+        #   create_table :foos do |t|
+        #     t.string :name
+        #     t.string :status
+        #   end
+        #
+        #   class Foo < ActiveRecord::Base
+        #     include AASM
+        #     aasm_column :status
+        #   end
+        #
+        # This method is both a getter and a setter
+        def aasm_column(column_name=nil)
+          if column_name
+            AASM::StateMachine[self].config.column = column_name.to_sym
+            # @aasm_column = column_name.to_sym
+          else
+            AASM::StateMachine[self].config.column ||= :aasm_state
+            # @aasm_column ||= :aasm_state
+          end
+          # @aasm_column
+          AASM::StateMachine[self].config.column
+        end
+
+        def find_in_state(number, state, *args)
+          with_state_scope state do
+            find(number, *args)
+          end
+        end
+
+        def count_in_state(state, *args)
+          with_state_scope state do
+            count(*args)
+          end
+        end
+
+        def calculate_in_state(state, *args)
+          with_state_scope state do
+            calculate(*args)
+          end
+        end
+
+        protected
+        def with_state_scope(state)
+          with_scope :find => {:conditions => ["#{table_name}.#{aasm_column} = ?", state.to_s]} do
+            yield if block_given?
+          end
+        end
+      end
+
+      module InstanceMethods
+
+        # Returns the current aasm_state of the object.  Respects reload and
+        # any changes made to the aasm_state field directly
+        #
+        # Internally just calls <tt>aasm_read_state</tt>
+        #
+        #   foo = Foo.find(1)
+        #   foo.aasm_current_state # => :pending
+        #   foo.aasm_state = "opened"
+        #   foo.aasm_current_state # => :opened
+        #   foo.close # => calls aasm_write_state_without_persistence
+        #   foo.aasm_current_state # => :closed
+        #   foo.reload
+        #   foo.aasm_current_state # => :pending
+        #
+        def aasm_current_state
+          @current_state = aasm_read_state
+        end
+
+        private
+
+        # Ensures that if the aasm_state column is nil and the record is new
+        # that the initial state gets populated before validation on create
+        #
+        #   foo = Foo.new
+        #   foo.aasm_state # => nil
+        #   foo.valid?
+        #   foo.aasm_state # => "open" (where :open is the initial state)
+        #
+        #
+        #   foo = Foo.find(:first)
+        #   foo.aasm_state # => 1
+        #   foo.aasm_state = nil
+        #   foo.valid?
+        #   foo.aasm_state # => nil
+        #
+        def aasm_ensure_initial_state
+          send("#{self.class.aasm_column}=", self.aasm_current_state.to_s)
+        end
+
+      end
+
+      module WriteStateWithoutPersistence
+        # Writes <tt>state</tt> to the state column, but does not persist it to the database
+        #
+        #   foo = Foo.find(1)
+        #   foo.aasm_current_state # => :opened
+        #   foo.close
+        #   foo.aasm_current_state # => :closed
+        #   Foo.find(1).aasm_current_state # => :opened
+        #   foo.save
+        #   foo.aasm_current_state # => :closed
+        #   Foo.find(1).aasm_current_state # => :closed
+        #
+        # NOTE: intended to be called from an event
+        def aasm_write_state_without_persistence(state)
+          write_attribute(self.class.aasm_column, state.to_s)
+        end
+      end
+
+      module WriteState
+        # Writes <tt>state</tt> to the state column and persists it to the database
+        # using update_attribute (which bypasses validation)
+        #
+        #   foo = Foo.find(1)
+        #   foo.aasm_current_state # => :opened
+        #   foo.close!
+        #   foo.aasm_current_state # => :closed
+        #   Foo.find(1).aasm_current_state # => :closed
+        #
+        # NOTE: intended to be called from an event
+        def aasm_write_state(state)
+          old_value = read_attribute(self.class.aasm_column)
+          write_attribute(self.class.aasm_column, state.to_s)
+
+          unless self.save(false)
+            write_attribute(self.class.aasm_column, old_value)
+            return false
+          end
+
+          true
+        end
+      end
+
+      module ReadState
+
+        # Returns the value of the aasm_column - called from <tt>aasm_current_state</tt>
+        #
+        # If it's a new record, and the aasm state column is blank it returns the initial state:
+        #
+        #   class Foo < ActiveRecord::Base
+        #     include AASM
+        #     aasm_column :status
+        #     aasm_state :opened
+        #     aasm_state :closed
+        #   end
+        #
+        #   foo = Foo.new
+        #   foo.current_state # => :opened
+        #   foo.close
+        #   foo.current_state # => :closed
+        #
+        #   foo = Foo.find(1)
+        #   foo.current_state # => :opened
+        #   foo.aasm_state = nil
+        #   foo.current_state # => nil
+        #
+        # NOTE: intended to be called from an event
+        #
+        # This allows for nil aasm states - be sure to add validation to your model
+        def aasm_read_state
+          if new_record?
+            send(self.class.aasm_column).blank? ? aasm_determine_state_name(self.class.aasm_initial_state) : send(self.class.aasm_column).to_sym
+          else
+            send(self.class.aasm_column).nil? ? nil : send(self.class.aasm_column).to_sym
+          end
+        end
+      end
+
+      module NamedScopeMethods
+        def aasm_state_with_named_scope name, options = {}
+          aasm_state_without_named_scope name, options
+          self.named_scope name, :conditions => { "#{table_name}.#{self.aasm_column}" => name.to_s} unless self.respond_to?(name)
+        end
+      end
+    end
+  end
+end

data/lib/aasm/state.rb

@@ -0,0 +1,35 @@
+module AASM
+  module SupportingClasses
+    class State
+      attr_reader :name, :options
+
+      def initialize(name, options={})
+        @name, @options = name, options
+      end
+
+      def ==(state)
+        if state.is_a? Symbol
+          name == state
+        else
+          name == state.name
+        end
+      end
+
+      def call_action(action, record)
+        action = @options[action]
+        case action
+        when Symbol, String
+          record.send(action)
+        when Proc
+          action.call(record)
+        when Array
+          action.each { |a| record.send(a) }
+        end
+      end
+
+      def for_select
+        [name.to_s.gsub(/_/, ' ').capitalize, name.to_s]
+      end
+    end
+  end
+end

data/lib/aasm/state_machine.rb

@@ -0,0 +1,35 @@
+require 'ostruct'
+
+module AASM
+  class StateMachine
+    def self.[](*args)
+      (@machines ||= {})[args]
+    end
+
+    def self.[]=(*args)
+      val = args.pop
+      (@machines ||= {})[args] = val
+    end
+
+    attr_accessor :states, :events, :initial_state, :config
+    attr_reader :name
+
+    def initialize(name)
+      @name   = name
+      @initial_state = nil
+      @states = []
+      @events = {}
+      @config = OpenStruct.new
+    end
+
+    def clone
+      klone = super
+      klone.states = states.clone
+      klone
+    end
+
+    def create_state(name, options)
+      @states << AASM::SupportingClasses::State.new(name, options) unless @states.include?(name)
+    end
+  end
+end

data/lib/aasm/state_transition.rb

@@ -0,0 +1,36 @@
+module AASM
+  module SupportingClasses
+    class StateTransition
+      attr_reader :from, :to, :opts
+
+      def initialize(opts)
+        @from, @to, @guard, @on_transition = opts[:from], opts[:to], opts[:guard], opts[:on_transition]
+        @opts = opts
+      end
+
+      def perform(obj)
+        case @guard
+        when Symbol, String
+          obj.send(@guard)
+        when Proc
+          @guard.call(obj)
+        else
+          true
+        end
+      end
+
+      def execute(obj, *args)
+        case @on_transition
+        when Symbol, String
+          obj.send(@on_transition, *args)
+        when Proc
+          @on_transition.call(obj, *args)
+        end
+      end
+
+      def ==(obj)
+        @from == obj.from && @to == obj.to
+      end
+    end
+  end
+end

metadata

@@ -0,0 +1,116 @@
+--- !ruby/object:Gem::Specification 
+name: faasm
+version: !ruby/object:Gem::Version 
+  prerelease: false
+  segments: 
+  - 2
+  - 1
+  - 1
+  version: 2.1.1
+platform: ruby
+authors: 
+- Scott Barron
+- Scott Petersen
+- Travis Tilley
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2010-01-30 00:00:00 +00:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: rspec
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 0
+        version: "0"
+  type: :development
+  version_requirements: *id001
+- !ruby/object:Gem::Dependency 
+  name: shoulda
+  prerelease: false
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 0
+        version: "0"
+  type: :development
+  version_requirements: *id002
+- !ruby/object:Gem::Dependency 
+  name: sdoc
+  prerelease: false
+  requirement: &id003 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 0
+        version: "0"
+  type: :development
+  version_requirements: *id003
+description: Fixed AASM is a continuation of the acts as state machine rails plugin, built for plain Ruby objects.
+email: scott@elitists.net, ttilley@gmail.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- CHANGELOG
+- MIT-LICENSE
+- README.rdoc
+- Rakefile
+- TODO
+- lib/aasm.rb
+- lib/aasm/aasm.rb
+- lib/aasm/event.rb
+- lib/aasm/persistence.rb
+- lib/aasm/persistence/active_record_persistence.rb
+- lib/aasm/state.rb
+- lib/aasm/state_machine.rb
+- lib/aasm/state_transition.rb
+has_rdoc: true
+homepage: http://rubyist.github.com/aasm/
+licenses: []
+
+post_install_message: 
+rdoc_options: 
+- --charset=UTF-8
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.3.7
+signing_key: 
+specification_version: 3
+summary: State machine mixin for Ruby objects
+test_files: []
+