Updated some docs, etc
This commit is contained in:
parent
17884eb9f2
commit
c96f0f38d4
35
README.rdoc
35
README.rdoc
|
@ -11,14 +11,32 @@ AASM has the following features:
|
||||||
* Events
|
* Events
|
||||||
* Transitions
|
* Transitions
|
||||||
|
|
||||||
|
== New Callbacks
|
||||||
|
|
||||||
|
The only changes I've made are creating more callbacks with slightly more obvious semantics ;).
|
||||||
|
|
||||||
|
The callback chain & order on a successful event looks like:
|
||||||
|
|
||||||
|
oldstate:exit
|
||||||
|
transition:on_transition
|
||||||
|
newstate:enter
|
||||||
|
oldstate:before_exit
|
||||||
|
newstate:before_enter
|
||||||
|
event:before
|
||||||
|
__update state__
|
||||||
|
oldstate:after_exit
|
||||||
|
oldstate:after_enter
|
||||||
|
event:after
|
||||||
|
event:success
|
||||||
|
obj:aasm_event_fired
|
||||||
|
|
||||||
|
Note that the old callbacks haven't been removed and still have their same semantics. All of this behavior was added without removing any old behavior.
|
||||||
|
|
||||||
== Download
|
== Download
|
||||||
|
|
||||||
The latest AASM can currently be pulled from the git repository on github.
|
The latest AASM can currently be pulled from the git repository on github.
|
||||||
|
|
||||||
* http://github.com/rubyist/aasm/tree/master
|
* http://github.com/dunedain289/aasm/tree/master
|
||||||
|
|
||||||
A release and a gem are forthcoming.
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
== Installation
|
== Installation
|
||||||
|
@ -26,12 +44,12 @@ A release and a gem are forthcoming.
|
||||||
=== From GitHub hosted gems
|
=== From GitHub hosted gems
|
||||||
|
|
||||||
% sudo gem sources -a http://gems.github.com # (you only need to do this once)
|
% sudo gem sources -a http://gems.github.com # (you only need to do this once)
|
||||||
% sudo gem install rubyist-aasm
|
% sudo gem install dunedain289-aasm
|
||||||
|
|
||||||
=== Building your own gems
|
=== Building your own gems
|
||||||
|
|
||||||
% rake gem
|
% rake gem
|
||||||
% sudo gem install pkg/aasm-2.0.1.gem
|
% sudo gem install pkg/aasm-2.1.gem
|
||||||
|
|
||||||
|
|
||||||
== Simple Example
|
== Simple Example
|
||||||
|
@ -60,11 +78,10 @@ Here's a quick example highlighting some of the features.
|
||||||
= Other Stuff
|
= Other Stuff
|
||||||
|
|
||||||
Author:: Scott Barron <scott at elitists dot net>
|
Author:: Scott Barron <scott at elitists dot net>
|
||||||
License:: Copyright 2006, 2007, 2008 by Scott Barron.
|
License:: Original code Copyright 2006, 2007, 2008 by Scott Barron.
|
||||||
|
New changes Copyright 2009 by Scott Petersen.
|
||||||
Released under an MIT-style license. See the LICENSE file
|
Released under an MIT-style license. See the LICENSE file
|
||||||
included in the distribution.
|
included in the distribution.
|
||||||
Bugs:: http://rubyist.lighthouseapp.com/projects/13207-aasm/
|
|
||||||
GitHub:: http://github.com/rubyist/aasm/tree/master
|
|
||||||
|
|
||||||
== Warranty
|
== Warranty
|
||||||
|
|
||||||
|
|
|
@ -2,7 +2,7 @@ PKG_FILES = ["CHANGELOG", "MIT-LICENSE", "Rakefile", "README.rdoc", "TODO", "lib
|
||||||
|
|
||||||
Gem::Specification.new do |s|
|
Gem::Specification.new do |s|
|
||||||
s.name = 'aasm'
|
s.name = 'aasm'
|
||||||
s.version = "2.0.5"
|
s.version = "2.1"
|
||||||
s.summary = 'State machine mixin for Ruby objects'
|
s.summary = 'State machine mixin for Ruby objects'
|
||||||
s.description = <<-EOF
|
s.description = <<-EOF
|
||||||
AASM is a continuation of the acts as state machine rails plugin, built for plain Ruby objects.
|
AASM is a continuation of the acts as state machine rails plugin, built for plain Ruby objects.
|
||||||
|
@ -13,7 +13,7 @@ EOF
|
||||||
s.extra_rdoc_files = ['README.rdoc', 'MIT-LICENSE', 'TODO', 'CHANGELOG']
|
s.extra_rdoc_files = ['README.rdoc', 'MIT-LICENSE', 'TODO', 'CHANGELOG']
|
||||||
s.rdoc_options = ['--line-numbers', '--inline-source', '--main', 'README.rdoc', '--title', 'AASM']
|
s.rdoc_options = ['--line-numbers', '--inline-source', '--main', 'README.rdoc', '--title', 'AASM']
|
||||||
|
|
||||||
s.author = 'Scott Barron'
|
s.author = 'Scott Petersen'
|
||||||
s.email = 'scott@elitists.net'
|
s.email = 'petersen@dunedain289.com'
|
||||||
s.homepage = 'http://github.com/rubyist/aasm'
|
s.homepage = 'http://github.com/dunedain289/aasm'
|
||||||
end
|
end
|
||||||
|
|
Loading…
Reference in New Issue