Graphy

DSL to create graph diagrams as code

Add this line to your application's Gemfile:

gem 'graphy'

And then execute:

$ bundle install

Or install it yourself as:

$ gem install graphy

Graphy.define 'Life View' do
  entity 'Friendly'
  namespace "Animal Kingdom" do
    entity 'Animal' do
      attributes :name
    end

    entity 'Dog', 'Animal' do
      attrs :color
      uses 'Friendly'
    end

    entity 'Cat', 'Animal' do
      meths :scratch
    end
  end

  write(png: 'hello.png')
end

Graphy.define 'State machine', orientation: :horizontal  do
  node 'A'
  node 'B', shape: 'diamond'
  node 'C'
  node 'D', shape: 'egg'

  step 'A', to: 'B'
  step 'B', to: 'C'
  step 'C', to: 'A'
  step 'C', to: 'D'
  step 'D', to: 'C'

  write(png: 'steps.png')
end

After checking out the repo, run bin/setup to install dependencies. Then, run rake test to run the tests. 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.

Bug reports and pull requests are welcome on GitHub at https://github.com/3zcurdia/graphy. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the code of conduct.

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

Everyone interacting in the Arq project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the code of conduct.