Generates DOT representations of Statesman machines and runs dot to render them to PNGs
Switch branches/tags
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Failed to load latest commit information.
lib
spec
.gitignore
.vexor.yml
Gemfile
LICENSE.txt
README.md
Rakefile
statesman-diagram.gemspec

README.md

Statesman State Diagram

Gem Version Vexor CI

Extension of Statesman to get state diagrams.

Adds .to_dot method to Statesman::Machine. It can export your machine class definition to the DOT format.

Also adds a Rake task called statesman:diagram. It runs the dot program (GraphViz) to make a PNG image from the DOT representation of the machine class.

Installation

Add this line to your application's Gemfile:

group :development do
  gem 'statesman-diagram'
end

And then execute:

$ bundle

Or install it yourself as:

$ gem install statesman-diagram

Prerequisites

  • GraphViz (the dot program)
    • brew install graphviz on OS X / macOS
    • sudo apt-get install graphviz on Ubuntu / Debian

Usage

Run rake statesman:diagram[My::State::Machine::Class]. Find the state diagram of this class in My_State_Machine_Class.png.

You can also specify the name of the file rake statesman:diagram[My::State::Machine::Class, ./temp/state] Find the state diagram of this class in ./temp/state.png.

Development

After checking out the repo, run bin/setup to install dependencies. You can also run bin/console for an interactive prompt that will allow you to experiment.

To install this gem onto your local machine, run bundle exec rake install. To release a new version, update the version number in version.rb, and then run bundle exec rake release, which will create a git tag for the version, push git commits and tags, and push the .gem file to rubygems.org.

Contributing

Bug reports and pull requests are welcome on GitHub at https://github.com/vassilevsky/statesman-diagram.

License

The gem is available as open source under the terms of the MIT License.