Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/funbox/statesman-diagram
Generates DOT representations of Statesman machines and runs dot to render them to PNGs
https://github.com/funbox/statesman-diagram
graphviz state-diagram state-machine statesman
Last synced: about 1 month ago
JSON representation
Generates DOT representations of Statesman machines and runs dot to render them to PNGs
- Host: GitHub
- URL: https://github.com/funbox/statesman-diagram
- Owner: funbox
- License: mit
- Created: 2017-02-15T06:11:48.000Z (almost 8 years ago)
- Default Branch: master
- Last Pushed: 2020-10-26T20:11:06.000Z (about 4 years ago)
- Last Synced: 2024-10-19T10:42:10.096Z (3 months ago)
- Topics: graphviz, state-diagram, state-machine, statesman
- Language: Ruby
- Homepage:
- Size: 24.4 KB
- Stars: 5
- Watchers: 11
- Forks: 4
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE.txt
Awesome Lists containing this project
README
# Statesman State Diagram
[](https://rubygems.org/gems/statesman-diagram)
[](https://travis-ci.com/github/funbox/statesman-diagram)
[](https://coveralls.io/github/funbox/statesman-diagram)
Extension of [Statesman](https://rubygems.org/gems/statesman) to get state diagrams.
Adds `.to_dot` method to `Statesman::Machine`. It can export your machine
class definition to the
[DOT](https://en.wikipedia.org/wiki/DOT_%28graph_description_language%29) 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:
```ruby
group :development do
gem 'statesman-diagram'
end
```
And then execute:
```bash
bundle
```
Or install it yourself as:
```bash
gem install statesman-diagram
```
## Prerequisites
* GraphViz (the `dot` program):
* `brew install graphviz` on 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]
```
And the state diagram of this class will be placed 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](https://rubygems.org).
## Contributing
Bug reports and pull requests are welcome on GitHub at https://github.com/funbox/statesman-diagram.
## License
The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).
[](https://funbox.ru)