state_machine

https://github.com/pluginaweek/state_machine

Ruby

Adds support for creating state machines for attributes on any Ruby class

StateMachine::PathCollection#initialize

Creates a new collection of paths with the given requirements.

Configuration options:
* <tt>:from</tt> - The initial state to start from
* <tt>:to</tt> - The target end state
* <tt>:deep</tt> - Whether to enable deep searches for the target state.
* <tt>:guard</tt> - Whether to guard transitions with the if/unless
  conditionals defined for each one

Source | Google | Stack overflow

Edit

git clone [email protected]:pluginaweek/state_machine.git

cd state_machine

open lib/state_machine/path_collection.rb

Contribute

# Make a new branch

git checkout -b -your-name--update-docs-StateMachine--PathCollection-initialize-for-pr

# Commit to git

git add lib/state_machine/path_collection.rbgit commit -m "better docs for StateMachine::PathCollection#initialize"

# Open pull request

gem install hub # on a mac you can `brew install hub`

hub fork

git push <your name> -your-name--update-docs-StateMachine--PathCollection-initialize-for-pr

hub pull-request

# Celebrate!