eric-aasm 2.0.2

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,98 @@
+= 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
+
+== 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
+
+=== From GitHub hosted gems
+
+  % sudo gem sources -a http://gems.github.com # (you only need to do this once)
+  % sudo gem install rubyist-aasm
+
+=== Building your own gems
+
+  % rake gem
+  % sudo gem install pkg/aasm-2.0.1.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, :enter => :mark_thread_as_read
+    aasm_state :closed
+
+
+    aasm_event :view do
+      transitions :to => :read, :from => [:new], 
+        :on_transition => :send_received_receipt, :guard => :user_authorized
+    end
+
+    aasm_event :close do
+      transitions :to => :closed, :from => [:read, :new]
+    end
+  end
+
+
+== Explanation of transitions
+
+The current state machine has the following process. If we were to call 
+<tt>Conversation#view!</tt>, we would get:
+
+     state:new
+         |
+         | <-- :exit called on state[new]
+         |
+         | <-- :guard called on state[read]
+         |
+         | <-- :on_transition called on state[read]
+         |
+         | <-- aasm_current_state set to "read"
+         |
+         | <-- :success called on state[read]
+         |
+         | <-- :enter called on state[read]
+         |
+     state:read
+
+
+= Other Stuff
+
+Author::  Scott Barron <scott at elitists dot net>
+License:: Copyright 2006, 2007, 2008 by Scott Barron.
+          Released under an MIT-style license.  See the LICENSE  file
+          included in the distribution.
+Bugs::    http://rubyist.lighthouseapp.com/projects/13207-aasm/
+GitHub::  http://github.com/rubyist/aasm/tree/master
+
+== 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,94 @@
+# 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 -rversion -e "print AASM::VERSION::STRING"` =~ /([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', '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.author = 'Scott Barron'
+    s.email = 'scott@elitists.net'
+    s.homepage = 'http://rubyi.st/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']
+  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)