Skip to content

Generate diagrams based on states, events and transitions defined for Transitions state machine

License

Notifications You must be signed in to change notification settings

natebird/graphviz_transitions

 
 

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

20 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

GraphvizTransitions

Adds support for generating graphs based on states, events and transitions defined for Transitions state machine using GraphViz and Ruby-GraphViz. It is a simplified version of the same functionality for state_machine gem.

Installation

Add this line to your application's Gemfile:

gem 'graphviz_transitions', group: :development

And then execute:

$ bundle

Or install it yourself as:

$ gem install graphviz_transitions

Usage

To generate a graph for a specific model:

$ rake transitions:draw CLASS=Vehicle

To save files to a specific path:

$ rake transitions:draw CLASS=Vehicle,Vehicle::Color TARGET=./tmp

If you only use symbolized method names in your event guards and you want to display them :

$ rake transitions:draw CLASS=Vehicle GUARDS=true

Contributing

  1. Fork it ( https://github.com/itkin/graphviz_transitions/fork )
  2. Create your feature branch (git checkout -b my-new-feature)
  3. Commit your changes (git commit -am 'Add some feature')
  4. Push to the branch (git push origin my-new-feature)
  5. Create new Pull Request

Credit

romatr/graphviz_aasm

About

Generate diagrams based on states, events and transitions defined for Transitions state machine

Resources

License

Stars

Watchers

Forks

Packages

No packages published

Languages

  • Ruby 100.0%