kotovalexarian-likes-github/aasm
1
0
Fork 0
mirror of https://github.com/aasm/aasm synced 2023-03-27 23:22:41 -04:00
Code Releases Activity

Update readme

Browse source
This commit is contained in:
Reid Morrison 2015-02-14 13:16:27 -05:00
parent 7134072568
commit 436e16de50
2 changed files with 20 additions and 4 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

1
.gitignore vendored
View file

@ -17,4 +17,3 @@ alto
.rspec .rspec
.bundle .bundle
tags tags
/nbproject/

23
README.md
View file

@ -9,8 +9,8 @@ This package contains AASM, a library for adding finite state machines to Ruby c
AASM started as the *acts_as_state_machine* plugin but has evolved into a more generic library AASM started as the *acts_as_state_machine* plugin but has evolved into a more generic library
that no longer targets only ActiveRecord models. It currently provides adapters for that no longer targets only ActiveRecord models. It currently provides adapters for
[ActiveRecord](http://api.rubyonrails.org/classes/ActiveRecord/Base.html) and [ActiveRecord](http://api.rubyonrails.org/classes/ActiveRecord/Base.html),
[Mongoid](http://mongoid.org/), but it can be used for any Ruby class, no matter what [Mongoid](http://mongoid.org/), and [Mongomapper](http://mongomapper.com/) but it can be used for any Ruby class, no matter what
parent class it has (if any). parent class it has (if any).
## Upgrade from version 3 to 4 ## Upgrade from version 3 to 4
@ -435,7 +435,7 @@ to ```false```.
### Sequel ### Sequel
AASM also supports [Sequel](http://sequel.jeremyevans.net/) besides _ActiveRecord_ and _Mongoid_. AASM also supports [Sequel](http://sequel.jeremyevans.net/) besides _ActiveRecord_, _Mongoid_, and _MongoMapper_.
```ruby ```ruby
class Job < Sequel::Model class Job < Sequel::Model
@ -466,6 +466,23 @@ class Job
end end
``` ```
### MongoMapper
AASM also supports persistence to Mongodb if you're using MongoMapper. Make sure
to include MongoMapper::Document before you include AASM.
```ruby
class Job
include MongoMapper::Document
include AASM
key :aasm_state, Symbol
aasm do
...
end
end
```
### Automatic Scopes ### Automatic Scopes
AASM will automatically create scope methods for each state in the model. AASM will automatically create scope methods for each state in the model.