{"id":21301702,"url":"https://github.com/funbox/statesman-diagram","last_synced_at":"2025-07-11T20:31:15.942Z","repository":{"id":59156389,"uuid":"82026632","full_name":"funbox/statesman-diagram","owner":"funbox","description":"Generates DOT representations of Statesman machines and runs dot to render them to PNGs","archived":false,"fork":false,"pushed_at":"2020-10-26T20:11:06.000Z","size":25,"stargazers_count":5,"open_issues_count":0,"forks_count":4,"subscribers_count":10,"default_branch":"master","last_synced_at":"2025-06-01T00:01:46.105Z","etag":null,"topics":["graphviz","state-diagram","state-machine","statesman"],"latest_commit_sha":null,"homepage":"","language":"Ruby","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/funbox.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE.txt","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2017-02-15T06:11:48.000Z","updated_at":"2020-12-04T15:09:33.000Z","dependencies_parsed_at":"2022-09-13T20:10:17.941Z","dependency_job_id":null,"html_url":"https://github.com/funbox/statesman-diagram","commit_stats":null,"previous_names":["vassilevsky/statesman-diagram"],"tags_count":4,"template":false,"template_full_name":null,"purl":"pkg:github/funbox/statesman-diagram","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/funbox%2Fstatesman-diagram","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/funbox%2Fstatesman-diagram/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/funbox%2Fstatesman-diagram/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/funbox%2Fstatesman-diagram/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/funbox","download_url":"https://codeload.github.com/funbox/statesman-diagram/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/funbox%2Fstatesman-diagram/sbom","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":263901587,"owners_count":23527437,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["graphviz","state-diagram","state-machine","statesman"],"created_at":"2024-11-21T15:50:23.433Z","updated_at":"2025-07-11T20:31:10.928Z","avatar_url":"https://github.com/funbox.png","language":"Ruby","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Statesman State Diagram\n\n[![Gem Version](https://img.shields.io/gem/v/statesman-diagram.svg)](https://rubygems.org/gems/statesman-diagram)\n[![Travis CI](https://img.shields.io/travis/com/funbox/statesman-diagram)](https://travis-ci.com/github/funbox/statesman-diagram)\n[![Coveralls](https://img.shields.io/coveralls/funbox/statesman-diagram.svg)](https://coveralls.io/github/funbox/statesman-diagram)\n\nExtension of [Statesman](https://rubygems.org/gems/statesman) to get state diagrams.\n\nAdds `.to_dot` method to `Statesman::Machine`. It can export your machine\nclass definition to the\n[DOT](https://en.wikipedia.org/wiki/DOT_%28graph_description_language%29) format.\n\nAlso adds a Rake task called `statesman:diagram`. It runs the `dot`\nprogram (GraphViz) to make a PNG image from the DOT representation of the\nmachine class.\n\n## Installation\n\nAdd this line to your application's Gemfile:\n\n```ruby\ngroup :development do\n  gem 'statesman-diagram'\nend\n```\n\nAnd then execute:\n\n```bash\nbundle\n```\n\nOr install it yourself as:\n\n```bash\ngem install statesman-diagram\n```\n\n## Prerequisites\n\n* GraphViz (the `dot` program):\n  * `brew install graphviz` on macOS.\n  * `sudo apt-get install graphviz` on Ubuntu / Debian.\n\n## Usage\n\nRun:\n\n```\nrake statesman:diagram[My::State::Machine::Class]\n```\n\nFind the state diagram of this class in `My_State_Machine_Class.png`.\n\nYou can also specify the name of the file:\n\n```\nrake statesman:diagram[My::State::Machine::Class, ./temp/state]\n```\n\nAnd the state diagram of this class will be placed in `./temp/state.png`.\n\n## Development\n\nAfter checking out the repo, run `bin/setup` to install dependencies.\nYou can also run `bin/console` for an interactive prompt that will allow you to experiment.\n\nTo install this gem onto your local machine, run `bundle exec rake install`.\nTo release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`,\nwhich will create a git tag for the version, push git commits and tags,\nand push the `.gem` file to [rubygems.org](https://rubygems.org).\n\n## Contributing\n\nBug reports and pull requests are welcome on GitHub at https://github.com/funbox/statesman-diagram.\n\n## License\n\nThe gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).\n\n[![Sponsored by FunBox](https://funbox.ru/badges/sponsored_by_funbox_centered.svg)](https://funbox.ru)\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Ffunbox%2Fstatesman-diagram","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Ffunbox%2Fstatesman-diagram","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Ffunbox%2Fstatesman-diagram/lists"}