icaruswings/mm-transitions

a simple mongomapper plugin to add a full featured state machine to your models

mm-transitions¶ ↑

A simple MongoMapper plugin to add the Transitions State Machine to your documents

Usage¶ ↑

Install the gem

gem install mm-transitions

Or add it to your Gemfile

gem 'mm-transitions'

Then add the mm-transitions plugin to you MongoMapper::Document

class User
  include MongoMapper::Document
  plugin MongoMapper::Plugins::Transitions

  state_machine do
    state :pending
    state :active

    event :activate do
      transitions :to => :active, :from => [:pending]
    end

  end
end

user = User.create
user.current_state => :pending

user.activate
user.current_state => :active
user.reload
user.current_state => :pending

user.activate!
user.current_state => :active
user.reload
user.current_state => :active

More Info¶ ↑

for more information check out:

• [the specs](github.com/icaruswings/mm-transitions/blob/master/spec/mm-transitions_spec.rb)

• [the transitions gem](github.com/qoobaa/transitions)

Contributing to mm-transitions¶ ↑

• Check out the latest master to make sure the feature hasn’t been implemented or the bug hasn’t been fixed yet

• Check out the issue tracker to make sure someone already hasn’t requested it and/or contributed it

• Fork the project

• Start a feature/bugfix branch

• Commit and push until you are happy with your contribution

• Make sure to add tests for it. This is important so I don’t break it in a future version unintentionally.

• Please try not to mess with the Rakefile, version, or history. If you want to have your own version, or is otherwise necessary, that is fine, but please isolate to its own commit so I can cherry-pick around it.

Copyright¶ ↑

Copyright © 2011 Luke Cunningham. See LICENSE.txt for further details.