https://github.com/3zcurdia/graphy

Create any graph diagram as code
https://github.com/3zcurdia/graphy

Last synced: about 1 month ago
JSON representation

Create any graph diagram as code

• Host: GitHub
• URL: https://github.com/3zcurdia/graphy
• Owner: 3zcurdia
• License: mit
• Created: 2020-09-21T04:38:11.000Z (over 4 years ago)
• Default Branch: master
• Last Pushed: 2020-09-29T18:11:24.000Z (over 4 years ago)
• Last Synced: 2024-10-31T14:47:07.360Z (2 months ago)
• Language: Ruby
• Size: 139 KB
• Stars: 0
• Watchers: 3
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE.txt
  • Code of conduct: CODE_OF_CONDUCT.md

Awesome Lists containing this project

README

        
# Graphy

DSL to create graph diagrams as code

## Installation

Add this line to your application's Gemfile:

```ruby

gem 'graphy'

```

And then execute:

    $ bundle install

Or install it yourself as:

    $ gem install graphy

## Usage

### Module

```ruby

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

```

![example02.png](https://github.com/3zcurdia/graphy/blob/master/examples/example02.rb.png)

### State machine

```ruby

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

```

![example01.png](https://github.com/3zcurdia/graphy/blob/master/examples/example01.rb.png)

## Development

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](https://rubygems.org).

## Contributing

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](https://github.com/3zcurdia/graphy/blob/master/CODE_OF_CONDUCT.md).

## License

The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

## Code of Conduct

Everyone interacting in the Arq project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/3zcurdia/graphy/blob/master/CODE_OF_CONDUCT.md).