Ruby-Graphviz

Ruby/GraphViz

Copyright (C) 2004-2018 Gregoire Lejeune

• Doc : http://rdoc.info/projects/glejeune/Ruby-Graphviz
• Sources : https://github.com/glejeune/Ruby-Graphviz
• On Rubygems: https://rubygems.org/gems/ruby-graphviz

INSTALLATION

Add this line to your application's Gemfile:

gem 'ruby-graphviz'

And then execute:

$ bundle

Or install it yourself as:

$ gem install ruby-graphviz

DESCRIPTION

Interface to the GraphViz graphing tool

TODO

• New FamilyTree

SYNOPSIS

A basic example

require 'ruby-graphviz'

# Create a new graph
g = GraphViz.new( :G, :type => :digraph )

# Create two nodes
hello = g.add_nodes( "Hello" )
world = g.add_nodes( "World" )

# Create an edge between the two nodes
g.add_edges( hello, world )

# Generate output image
g.output( :png => "hello_world.png" )

The same but with a block

require 'ruby-graphviz'

GraphViz::new( :G, :type => :digraph ) { |g|
  g.world( :label => "World" )  "Hello" )
}.output( :png => "hello_world.png" )

Or with the DSL

    require 'ruby-graphviz/dsl'
    digraph :G do
      world[:label => "World"]  "Hello"]

      output :png => "hello_world.png"
    end

Create a graph from a file

    require 'ruby-graphviz'

    # In this example, hello.dot is :
    #   digraph G {Hello->World;}

    GraphViz.parse( "hello.dot", :path => "/usr/local/bin" ) { |g|
      g.get_node("Hello") { |n|
        n[:label] = "Bonjour"
      }
      g.get_node("World") { |n|
        n[:label] = "Le Monde"
      }
    }.output(:png => "sample.png")

GraphML support

    require 'ruby-graphviz/graphml'

    g = GraphViz::GraphML.new( "graphml/cluster.graphml" )
    g.graph.output( :path => "/usr/local/bin", :png => "#{$0}.png" )

TOOLS

Ruby/GraphViz also includes :

• ruby2gv, a simple tool that allows you to create a dependency graph from a ruby script. Example : http://drp.ly/dShaZ

ruby2gv -Tpng -oruby2gv.png ruby2gv

• gem2gv, a tool that allows you to create a dependency graph between gems. Example : http://drp.ly/dSj9Y

gem2gv -Tpng -oruby-graphviz.png ruby-graphviz

• dot2ruby, a tool that allows you to create a ruby script from a graphviz script

…

• git2gv, a tool that allows you to show your git commits

• xml2gv, a tool that allows you to show a xml file as graph.

GRAPH THEORY

…

INSTALLATION

sudo gem install ruby-graphviz

You also need to install GraphViz

On Windows you also need to install win32-open3. This is not an absolute requirement.

LICENCES

Ruby/GraphViz

Ruby/GraphViz is freely distributable according to the terms of the GNU General Public License (see the file 'COPYING').

This program is distributed without any warranty. See the file 'COPYING' for details.

GNU General Public Licence: https://en.wikipedia.org/wiki/Gpl

nothugly.xsl

By Vidar Hokstad and Ryan Shea; Contributions by Jonas Tingborn, Earl Cummings, Michael Kennedy (Graphviz 2.20.2 compatibility, bug fixes, testing, lots of gradients)

Copyright (c) 2009 Vidar Hokstad

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

MIT license: https://en.wikipedia.org/wiki/MIT_License

Contributors

Thanks goes to these wonderful people (emoji key):

Dave Burt

obruening

Chip Malice

Stefan Stüben

oupo

Gregoire Lejeune

Markus Hauck

Khalil Fazal

Kenichi Kamiya

Neven Has

Andrew

Daniel Zollinger

Guilherme Simoes

Oleg Orlov

Gabe Kopley

Jake Goulding

hirochachacha

ronen barzel

Jamison Dance

Joseph Anthony Pasquale Holsten

Miguel Cabrera

Mike Fiedler

Nathan Long

Olle Jonsson

Postmodern

Robert Reiz

Göran Bodenschatz

SHIBATA Hiroshi

moracca

TPei

Villu Orav

David Rodríguez

This project follows the all-contributors specification. Contributions of any kind welcome!