Class: Graph

Inherits:
Object show all
Defined in:
lib/graph.rb

Overview

Graph models directed graphs and subgraphs and outputs in graphviz’s dot format.

Defined Under Namespace

Classes: Attribute, CompoundAttribute, Edge, Node, Thingy

Constant Summary collapse

VERSION =

:nodoc:

"2.6.0"
LIGHT_COLORS =

:stopdoc:

%w(gray lightblue lightcyan lightgray lightpink
lightslategray lightsteelblue white)
BOLD_COLORS =

WTF – can’t be %w() because of a bug in rcov

["black", "brown", "mediumblue", "blueviolet",
"orange", "magenta", "darkgreen", "maroon",
"violetred", "purple", "greenyellow", "deeppink",
"midnightblue", "firebrick", "darkturquoise",
"mediumspringgreen", "chartreuse", "navy",
"lightseagreen", "chocolate", "lawngreen", "green",
"indigo", "darkgoldenrod", "darkviolet", "red",
"springgreen", "saddlebrown", "mediumvioletred",
"goldenrod", "tomato", "cyan", "forestgreen",
"darkorchid", "crimson", "coral", "deepskyblue",
"seagreen", "peru", "turquoise", "orangered",
"dodgerblue", "sienna", "limegreen", "royalblue",
"darkorange", "blue"]
COLOR_SCHEME_MAX =

Defines the brewer color schemes and the maximum number of colors in each set.

{
  :accent   => 8,  :blues    => 9,  :brbg     => 11, :bugn     => 9,
  :dark2    => 8,  :gnbu     => 9,  :greens   => 9,  :greys    => 9,
  :oranges  => 9,  :orrd     => 9,  :paired   => 12, :pastel1  => 9,
  :pastel2  => 8,  :piyg     => 11, :prgn     => 11, :pubu     => 9,
  :pubugn   => 9,  :puor     => 11, :purd     => 9,  :purples  => 9,
  :rdbu     => 11, :rdgy     => 11, :rdylbu   => 11, :rdylgn   => 11,
  :reds     => 9,  :set1     => 9,  :set2     => 8,  :set3     => 12,
  :spectral => 11, :ylgn     => 9,  :ylgnbu   => 9,  :ylorbr   => 9,
  :ylorrd   => 9
}
SHAPES = 
%w(Mcircle Mdiamond Msquare box box3d circle component
diamond doublecircle doubleoctagon egg ellipse folder
hexagon house invhouse invtrapezium invtriangle none
note octagon parallelogram pentagon plaintext point
polygon rect rectangle septagon square tab trapezium
triangle tripleoctagon)
STYLES = 
%w(dashed dotted solid invis bold filled diagonals rounded)
ARROW_RE = 
/(?:o?[lr]?(?:box|crow|diamond|dot|inv|none|normal|tee|vee)){1,4}/
ARROWS = 
%w(box crow diamond dot inv none normal tee vee)

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(name = nil, graph = nil, &block) ⇒ Graph

Creates a new graph object. Optional name and parent graph are available. Also takes an optional block for DSL-like use.



135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
 
# File 'lib/graph.rb', line 135

def initialize name = nil, graph = nil, &block
  @name = name
  @graph = graph
  graph << self if graph
  @nodes_order = []
  @nodes  = Hash.new { |h,k| @nodes_order << k; h[k] = Node.new self, k }
  @edges_order = []
  @edges  = Hash.new { |h,k|
    h[k] = Hash.new { |h2, k2|
      @edges_order << [k, k2]
      h2[k2] = Edge.new self, self[k], self[k2]
    }
  }
  @graph_attribs = []
  @node_attribs  = []
  @edge_attribs  = []
  @subgraphs     = []

  self.scheme = graph.scheme if graph
  node_attribs << scheme if scheme

  instance_eval(&block) if block
end

Instance Attribute Details

#edge_attribs ⇒ Object (readonly)

Global attributes for edges in this graph.



100
101
102
 
# File 'lib/graph.rb', line 100

def edge_attribs
  @edge_attribs
end

#edges ⇒ Object (readonly)

The hash of hashes of edges in this graph. Use #[] or #node to create edges.



105
106
107
 
# File 'lib/graph.rb', line 105

def edges
  @edges
end

#edges_order ⇒ Object (readonly)

:nodoc:



129
130
131
 
# File 'lib/graph.rb', line 129

def edges_order
  @edges_order
end

#graph ⇒ Object

A parent graph, if any. Only used for subgraphs.



89
90
91
 
# File 'lib/graph.rb', line 89

def graph
  @graph
end

#graph_attribs ⇒ Object (readonly)

Global attributes for this graph.



110
111
112
 
# File 'lib/graph.rb', line 110

def graph_attribs
  @graph_attribs
end

#name ⇒ Object

The name of the graph. Optional for graphs and subgraphs. Prefix the name of a subgraph with “cluster” for subgraph that is boxed.



95
96
97
 
# File 'lib/graph.rb', line 95

def name
  @name
end

#node_attribs ⇒ Object (readonly)

Global attributes for nodes in this graph.



115
116
117
 
# File 'lib/graph.rb', line 115

def node_attribs
  @node_attribs
end

#nodes ⇒ Object (readonly)

The hash of nodes in this graph. Use #[] or #node to create nodes.



120
121
122
 
# File 'lib/graph.rb', line 120

def nodes
  @nodes
end

#nodes_order ⇒ Object (readonly)

TODO: remove if/when I drop 1.8 support.



128
129
130
 
# File 'lib/graph.rb', line 128

def nodes_order
  @nodes_order
end

#scheme ⇒ Object

Shortcut method to create a new colorscheme Attribute instance. If passed n, name must match one of the brewer color scheme names and it will generate accessors for each fillcolor as well as push the colorscheme onto the node_attribs.



217
218
219
 
# File 'lib/graph.rb', line 217

def scheme
  @scheme
end

#subgraphs ⇒ Object (readonly)

An array of subgraphs.



125
126
127
 
# File 'lib/graph.rb', line 125

def subgraphs
  @subgraphs
end

Class Method Details

.escape_label(s) ⇒ Object 



291
292
293
294
295
296
297
298
 
# File 'lib/graph.rb', line 291

def self.escape_label s
  s = s.gsub(/\n/, '\n').gsub(/\"/, '\\\"')
  if s[0] == ?< and s[-1] == ?> then
    s
  else
    "\"#{s}\""
  end
end

Instance Method Details

#<<(subgraph) ⇒ Object

Push a subgraph into the current graph. Sets the subgraph’s graph to self.



162
163
164
165
 
# File 'lib/graph.rb', line 162

def << subgraph
  subgraphs << subgraph
  subgraph.graph = self
end

#[](name) ⇒ Object

Access a node by name



170
171
172
 
# File 'lib/graph.rb', line 170

def [] name
  nodes[name]
end

#arrowhead(shape) ⇒ Object

Shortcut method for creating an arrowhead attribute.

Raises:

  • (ArgumentError) 


177
178
179
180
 
# File 'lib/graph.rb', line 177

def arrowhead shape
  raise ArgumentError, "Bad arrow shape: #{shape}" unless shape =~ ARROW_RE
  Attribute.new "arrowhead = #{shape}"
end

#arrowsize(size) ⇒ Object

Shortcut method for creating an arrowsize attribute.



193
194
195
 
# File 'lib/graph.rb', line 193

def arrowsize size
  Attribute.new "arrowsize = #{size}"
end

#arrowtail(shape) ⇒ Object

Shortcut method for creating an arrowtail attribute.

Raises:

  • (ArgumentError) 


185
186
187
188
 
# File 'lib/graph.rb', line 185

def arrowtail shape
  raise ArgumentError, "Bad arrow shape: #{shape}" unless shape =~ ARROW_RE
  Attribute.new "arrowtail = #{shape}"
end

#boxes ⇒ Object

Shortcut method to set the global node attributes to use boxes.



200
201
202
 
# File 'lib/graph.rb', line 200

def boxes
  node_attribs << shape("box")
end

#cluster(name, &block) ⇒ Object

Shortcut method to create a clustered subgraph in the current graph. Use with the top-level digraph method in block form for a graph DSL.



369
370
371
 
# File 'lib/graph.rb', line 369

def cluster name, &block
  subgraph "cluster_#{name}", &block
end

#color(color) ⇒ Object

Shortcut method to create a new color Attribute instance.



207
208
209
 
# File 'lib/graph.rb', line 207

def color color
  Attribute.new "color = #{color}"
end

#colorscheme(name, n = nil) ⇒ Object

Shortcut method to create and set the graph to use a colorscheme.



222
223
224
225
226
227
228
229
 
# File 'lib/graph.rb', line 222

def colorscheme name, n = nil
  self.scheme = Attribute.new "colorscheme = #{name}#{n}"
  max = COLOR_SCHEME_MAX[name.to_sym]

  node_attribs << scheme if max

  scheme
end

#delete_node(node_name) ⇒ Object

Deletes a node from the graph



375
376
377
378
 
# File 'lib/graph.rb', line 375

def delete_node node_name
  nodes.delete node_name
  nodes_order.delete node_name
end

#edge(*names) ⇒ Object

Define one or more edges.

edge "a", "b", "c", ...

is equivalent to:

edge "a", "b"
edge "b", "c"
...



248
249
250
251
252
253
254
 
# File 'lib/graph.rb', line 248

def edge(*names)
  last = nil
  names.each_cons(2) do |from, to|
    last = self[from][to]
  end
  last
end

#fillcolor(n) ⇒ Object

Shortcut method to create a new fillcolor Attribute instance.



272
273
274
 
# File 'lib/graph.rb', line 272

def fillcolor n
  Attribute.new "fillcolor = #{n}"
end

#font(name) ⇒ Object

Shortcut method to create a new font Attribute instance. You can pass in both the name and an optional font size.



280
281
282
 
# File 'lib/graph.rb', line 280

def font name
  Attribute.new "fontname = #{name.inspect}"
end

#fontsize(size) ⇒ Object

Shortcut method to create a new fontsize Attribute instance.



287
288
289
 
# File 'lib/graph.rb', line 287

def fontsize size
  Attribute.new "fontsize = #{size}"
end

#invert ⇒ Object

Creates a new Graph whose edges point the other direction.



259
260
261
262
263
264
265
266
267
 
# File 'lib/graph.rb', line 259

def invert
  result = self.class.new
  edges.each do |from, h|
    h.each do |to, edge|
      result[to][from]
    end
  end
  result
end

#label(name) ⇒ Object

Shortcut method to set the graph’s label. Usually used with subgraphs.



303
304
305
 
# File 'lib/graph.rb', line 303

def label name
  graph_attribs << "label = #{Graph.escape_label name}"
end

#node(name, label = nil) ⇒ Object

Access a node by name, supplying an optional label



310
311
312
313
314
 
# File 'lib/graph.rb', line 310

def node name, label = nil
  n = nodes[name]
  n.label label if label
  n
end

#orient(dir = "TB") ⇒ Object

Shortcut method to specify the orientation of the graph. Defaults to the graphviz default “TB”.



320
321
322
 
# File 'lib/graph.rb', line 320

def orient dir = "TB"
  graph_attribs << "rankdir = #{dir}"
end

#rotate(dir = "LR") ⇒ Object

Shortcut method to specify the orientation of the graph. Defaults to “LR”.



327
328
329
 
# File 'lib/graph.rb', line 327

def rotate dir = "LR"
  orient dir
end

#save(path, type = nil) ⇒ Object

Saves out both a dot file to path and an image for the specified type. Specify type as nil to skip exporting an image.



335
336
337
338
339
340
 
# File 'lib/graph.rb', line 335

def save path, type = nil
  File.open "#{path}.dot", "w" do |f|
    f.puts self.to_s
  end
  system "dot -T#{type} #{path}.dot > #{path}.#{type}" if type
end

#shape(shape) ⇒ Object

Shortcut method to create a new shape Attribute instance.



345
346
347
 
# File 'lib/graph.rb', line 345

def shape shape
  Attribute.new "shape = #{shape}"
end

#style(name) ⇒ Object

Shortcut method to create a new style Attribute instance.



352
353
354
 
# File 'lib/graph.rb', line 352

def style name
  Attribute.new "style = #{name}"
end

#subgraph(name = nil, &block) ⇒ Object

Shortcut method to create a subgraph in the current graph. Use with the top-level digraph method in block form for a graph DSL.



360
361
362
 
# File 'lib/graph.rb', line 360

def subgraph name = nil, &block
  Graph.new name, self, &block
end

#to_s ⇒ Object

Outputs a graphviz graph.



383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
 
# File 'lib/graph.rb', line 383

def to_s
  result = []

  type = graph ? "subgraph " : "digraph "
  type << "\"#{name}\"" if name and !name.empty?
  result << type
  result << "  {"

  graph_attribs.each do |line|
    result << "    #{line};"
  end

  unless node_attribs.empty? then
    result << "    node [ #{node_attribs.join(", ")} ];"
  end

  unless edge_attribs.empty? then
    result << "    edge [ #{edge_attribs.join(", ")} ];"
  end

  subgraphs.each do |line|
    result << "    #{line};"
  end

  nodes_order.each do |name|
    node = nodes[name]
    result << "    #{node};" if graph or node.attributes? or node.orphan?
  end

  edges_order.uniq.each do |(from, to)|
    edge = edges[from][to]
    result << "    #{edge};"
  end

  result << "  }"
  result.join "\n"
end