Module: Graphviz

Defined in:
lib/graphviz/version.rb,
lib/graphviz.rb,
lib/graphviz/edge.rb,
lib/graphviz/node.rb,
lib/graphviz/graph.rb

Overview

Copyright, 2014, by Samuel G. D. Williams. <www.codeotaku.com>

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.

Defined Under Namespace

Classes: Edge, Graph, Node

Constant Summary collapse

VERSION = 
"1.2.1"

Class Method Summary collapse

Class Method Details

.output(graph, path: nil, format: 'pdf', dot: 'dot') ⇒ String

Outputs the graph using the dot executable.

Parameters:

  • options (Hash) —

    a customizable set of options

Returns:

  • (String) —

    any data generated by the command unless an output path is specified.



33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
 
# File 'lib/graphviz.rb', line 33

def self.output(graph, path: nil, format: 'pdf', dot: 'dot')
	output_format = format
	
	if path
		# Grab the output format from the file name:
		if path =~ /\.(.*?)$/
			output_format ||= $1
		end
	end
	
	output, input = IO.pipe
	pipeline = Process::Pipeline.(dot, "-T#{output_format}")
	
	writer = Thread.new do
		graph.dump_graph(input)
		
		input.close
	end
	
	if path
		pipeline.write(path, input: output)
	else
		return pipeline.read(input: output)
	end
ensure
	writer.join
end