• Stars
    star
    606
  • Rank 71,120 (Top 2 %)
  • Language
    Ruby
  • License
    Other
  • Created almost 15 years ago
  • Updated 12 months ago

Reviews

There are no reviews yet. Be the first to send feedback to the community and the maintainers!

Repository Details

[MIRROR] Ruby interface to the GraphViz graphing tool

Ruby/GraphViz

All Contributors Travis CI build Gem Version

Copyright (C) 2004-2018 Gregoire Lejeune

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" ) << g.hello( :label => "Hello" )
}.output( :png => "hello_world.png" )

Or with the DSL

    require 'ruby-graphviz/dsl'
    digraph :G do
      world[:label => "World"] << hello[:label => "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
$ cat hello.dot
digraph G {Hello->World;}

$ dot2ruby hello.dot
# This code was generated by dot2ruby.g

require 'rubygems'
require 'ruby-graphviz'
graph_g = GraphViz.digraph( "G" ) { |graph_g|
  graph_g[:bb] = '0,0,70,108'
  node_hello = graph_g.add_nodes( "Hello", :height => '0.5', :label => '\N', :pos => '35,90', :width => '0.88889' )
  graph_g.add_edges( "Hello", "World", :pos => 'e,35,36.413 35,71.831 35,64.131 35,54.974 35,46.417' )
  node_world = graph_g.add_nodes( "World", :height => '0.5', :label => '\N', :pos => '35,18', :width => '0.97222' )
}
puts graph_g.output( :canon => String )
  • 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

require 'ruby-graphviz'
require 'ruby-graphviz/theory'

g = GraphViz.new( :G ) { ... }

t = GraphViz::Theory.new( g )

puts "Adjancy matrix : "
puts t.adjancy_matrix

puts "Symmetric ? #{t.symmetric?}"

puts "Incidence matrix :"
puts t.incidence_matrix

g.each_node do |name, node|
  puts "Degree of node `#{name}' = #{t.degree(node)}"
end

puts "Laplacian matrix :"
puts t.laplacian_matrix

puts "Dijkstra between a and f"
r = t.moore_dijkstra(g.a, g.f)
if r.nil?
  puts "No way !"
else
  print "\tPath : "; p r[:path]
  puts "\tDistance : #{r[:distance]}"
end

print "Ranges : "
rr = t.range
p rr
puts "Your graph contains circuits" if rr.include?(nil)

puts "Critical path : "
rrr = t.critical_path
print "\tPath "; p rrr[:path]
puts "\tDistance : #{rrr[:distance]}"

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!

More Repositories

1

node-graphviz

Node.js interface to the GraphViz graphing tool
JavaScript
195
star
2

jekyll-epub

Create an eBook (epub) of your Jekyll blog
Ruby
68
star
3

ruby-lua

Call Lua from Ruby (and Ruby from Lua in Ruby)
C
55
star
4

Leonhard

A simple viewer/editor for GraphViz using MacRuby
Ruby
52
star
5

ruby-yuml

Ruby/yUML is a small DSL to generate UML diagrams with yuml.me
Ruby
29
star
6

ruby-leap-motion

Ruby interface to the Leap Motion Controller
C++
25
star
7

ruby-xslt

Ruby/XSLT is a simple XSLT class based on libxml <xmlsoft.org/> and libxslt <xmlsoft.org/XSLT/>
Ruby
24
star
8

syncftp

Sync via FTP, only modified files
Ruby
20
star
9

ews

Elixir Web Shell
Elixir
19
star
10

ruby-leap-motion-ws

Ruby interface to the Leap Motion Controller (via WebSocket)
Ruby
18
star
11

RConsole

A simple Ruby console for Mac
Ruby
13
star
12

vf

Enhanced version of the standard "cd" command
Ruby
12
star
13

GemMenu

Manage your gems from the MacOSX Menu
Ruby
10
star
14

erlang-graphviz

Erlang interface to the GraphViz graphing tool
Erlang
10
star
15

lipsum

A Ruby class to retrive "lorem ipsum" placeholder text from lipsum.com.
Ruby
9
star
16

Capcode

Capcode is a tiny MVC framework
Ruby
9
star
17

cmake-samples

CMake samples
C++
9
star
18

node-prowl

Wrapprer for prowl, http://prowl.weks.net/
JavaScript
5
star
19

.dotrc

My dot files for vim, zsh, ...
Vim Script
5
star
20

ceres

A tiny Planet powered by Capcode
Ruby
5
star
21

elixir-tar

Manipulate Tar Archive
Elixir
5
star
22

sh-xml

A (very) naive XML parser
Shell
4
star
23

soap-lc

SOAP Lite Client provides support for developing clients interfaces from WSDL files.
Ruby
4
star
24

daemonize

Daemonize for node.js
JavaScript
3
star
25

shakkei

Useful modules for Elixir
Elixir
3
star
26

kuraudo

[WIP] Kuraudo is a multi-cloud framework for Elixir
Elixir
3
star
27

tempfile

Elixir module for managing temporary files
Elixir
3
star
28

ara

Ara is a tiny class that’s allow you to use actors in Ruby
Ruby
3
star
29

kex

Easy building and installing of Elixir instances
Shell
3
star
30

Jubular

A Java/Play! clone of Rubular (http://rubular.com/)
JavaScript
3
star
31

exos

Elixir module for managing OS informations
Elixir
2
star
32

sh-mvc

A (very) naive MVC framework
Shell
2
star
33

couchc

couchc is a tiny console for CouchDB
Ruby
2
star
34

emery

Node.js extended
JavaScript
2
star
35

Capcode.more

Capcode plugins
Ruby
2
star
36

miki

A Mini wIKI - Erlang & AngularJS powered
CSS
2
star
37

Mixr

Mixr is a tiny memory object caching system
Ruby
2
star
38

capcode-oauth-example

Example client/server code for oauth with Ruby and Capcode
Ruby
1
star
39

OpenInCoda

OS X toolbar script to open files or folders in Coda.
1
star
40

clish

A CLI to create shell CLI.
Shell
1
star
41

ROSXAuth

A small class to execute process with root privileges on MacOSX
C
1
star
42

ExMix

Sublime Text 2 plugin to run mix
Python
1
star
43

espresso

Snippets for Cappuccino
1
star
44

rubyfrance.org

Site de l'association RubyFrance
Ruby
1
star
45

micro_frontend

Micro frontend
Ruby
1
star
46

iPhoneRDocTemplate

A RDoc template "Γ  la iPhone"
JavaScript
1
star
47

chocbomb

ChocBomb is a shameful copy of ChocTop - Build and deploy tools for Cocoa apps using Sparkle for distributions and upgrades; it’s like Hoe but for Cocoa apps.
Ruby
1
star