graphviz 0.0.2 → 0.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 5ecf43f4dc20f7751fdcab695ed60c56c05d2c99
-  data.tar.gz: caa5d9ee7b24714b8804085456ab55f020f069e1
+  metadata.gz: 52082025c42ba958329ac76f235b64c81e2408f8
+  data.tar.gz: 0b6592cfcda1720987e9565eff5b8ae4382624a7
 SHA512:
-  metadata.gz: 704db8989d9806ae9846f224272e10c4c80e10179e6da9259798e1cf9c0c7b34330733432de305f1f3e88de56a34812011861ac736d076eed31e35c066fdeba0
-  data.tar.gz: 7c4a946acc7edc8dc0d93e14803e960299ed8d17c57d3684a0ce4d7242fe01b7b079d485a9f57b9a5935d808ea1842f02012d2e3eea1e9427dd66fd4cb80275e
+  metadata.gz: cf66ca0b9b9c46f539f8705afcb210469703f9ed83be6ad95ddca9b52b0e9283357bfa7fe9ae58cc244d6c71cf71fa0374e24c28e16a91006ed4685dbc4513da
+  data.tar.gz: 4d99844ff54a143ddde00d64bcd36738c605c5edfee9457f2970f16c3adc7644c17007c97faaa7283bbf569fbb446ca0dc478a1950f4e92288b1f60a432d1192

data/.travis.yml

@@ -0,0 +1,10 @@
+language: ruby
+before_install:
+  - sudo apt-get install graphviz
+rvm:
+  - "1.9"
+  - "2.0"
+  - "2.1"
+matrix:
+  allow_failures:
+    - rvm: "1.9"

data/README.md

@@ -2,6 +2,9 @@
 
 Graphviz is a graph visualisation system. This gem is a lightweight interface for generating graphs with Graphviz.
 
+[![Build Status](https://travis-ci.org/ioquatix/graphviz.svg)](https://travis-ci.org/ioquatix/graphviz)
+[![Code Climate](https://codeclimate.com/github/ioquatix/graphviz.png)](https://codeclimate.com/github/ioquatix/graphviz)
+
 ## Installation
 
 Add this line to your application's Gemfile:

data/Rakefile

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/graphviz.gemspec

@@ -20,8 +20,10 @@ Gem::Specification.new do |spec|
 	spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
 	spec.require_paths = ["lib"]
 
+	spec.has_rdoc = 'yard'
+
+	spec.add_development_dependency "yard", "~> 0.8.7"
 	spec.add_development_dependency "bundler", "~> 1.3"
+	spec.add_development_dependency "rspec", "~> 3.0.0"
 	spec.add_development_dependency "rake"
-	
-	spec.add_dependency "rexec"
 end

data/lib/graphviz.rb

@@ -1,15 +1,15 @@
-# Copyright (c) 2013 Samuel G. D. Williams. <http://www.codeotaku.com>
-# 
+# Copyright, 2014, by Samuel G. D. Williams. <http://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
@@ -19,14 +19,19 @@
 # THE SOFTWARE.
 
 require "graphviz/version"
-
 require "graphviz/graph"
-require 'rexec'
 
 module Graphviz
+	# Signals that the process exited with a non-zero status.
 	class OutputError < StandardError
 	end
 	
+	# Outputs the graph using the +dot+ executable.
+	# @return [String] any data generated by the command unless an output path is specified.
+	#
+	# @option options [String] :output_format ('pdf') The output format (e.g. pdf).
+	# @option options [String] :path The output path, if not specified data is returned.
+	# @option options [String] :dot ('dot') The +dot+ executable to use.
 	def self.output(graph, options = {})
 		text = graph.to_dot
 		
@@ -43,20 +48,24 @@ module Graphviz
 			output_file = IO.pipe
 		end
 		
-		RExec::Task.open(["dot", "-T#{output_format}"], :out => output_file) do |task|
-			task.input.puts(graph.to_dot)
-			task.input.close
-			
-			status = task.wait
-			
-			if status != 0
-				raise OutputError.new(task.error.read)
-			end
+		output, input = IO.pipe
+		pid = Process.spawn(options[:dot] || "dot", "-T#{output_format}", :out => output_file, :in => output)
+		
+		output.close
+		
+		# Send graph data to process:
+		input.write(graph.to_dot)
+		input.close
+		
+		_, status = Process.wait2(pid)
+		
+		if status != 0
+			raise OutputError.new("dot exited with status #{status}")
+		end
 			
-			# Did we use a local pipe for output?
-			if Array === output_file
-				return task.output.read
-			end
+		# Did we use a local pipe for output?
+		if Array === output_file
+			return task.output.read
 		end
 	end
 end

data/lib/graphviz/graph.rb

@@ -1,15 +1,15 @@
-# Copyright (c) 2013 Samuel G. D. Williams. <http://www.codeotaku.com>
-# 
+# Copyright, 2014, by Samuel G. D. Williams. <http://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
@@ -21,7 +21,10 @@
 require 'stringio'
 
 module Graphviz
+	# Represents a visual node in the graph, which can be connected to other nodes.
 	class Node
+		# Initialize the node in the graph with the unique name.
+		# @param attributes [Hash] The associated graphviz attributes for this node.
 		def initialize(graph, name, attributes = {})
 			@graph = graph
 			@graph.nodes[name] = self
@@ -32,26 +35,34 @@ module Graphviz
 			@edges = []
 		end
 		
+		# @return [String] The unique name of the node.
 		attr :name
-		attr :options
 		
+		# @return [Array<Edge>] Any edges connecting to other nodes.
 		attr :edges
+		
+		# @return [Hash] Any attributes specified for this node.
 		attr_accessor :attributes
 		
-		def connect(destination, options = {})
-			edge = Edge.new(@graph, self, destination, options)
+		# Create an edge between this node and the destination with the specified options.
+		# @param attributes [Hash] The associated graphviz attributes for the edge.
+		def connect(destination, attributes = {})
+			edge = Edge.new(@graph, self, destination, attributes)
 			
 			@edges << edge
 			
 			return edge
 		end
 		
+		# Calculate if this node is connected to another. +O(N)+ search required.
 		def connected?(node)
 			return @edges.find{|edge| edge.destination == node}
 		end
 		
-		def add_node(name, options = {})
-			node = Node.new(@graph, name, options)
+		# Add a node and #connect to it.
+		# @param attributes [Hash] The associated graphviz attributes for the new node.
+		def add_node(name, attributes = {})
+			node = Node.new(@graph, name, attributes)
 			
 			connect(node)
 			
@@ -59,7 +70,10 @@ module Graphviz
 		end
 	end
 	
+	# Represents a visual edge between two nodes.
 	class Edge
+		# Initialize the edge in the given graph, with a source and destination node.
+		# @param attributes [Hash] The associated graphviz attributes for this edge.
 		def initialize(graph, source, destination, attributes = {})
 			@graph = graph
 			@graph.edges << self
@@ -70,23 +84,24 @@ module Graphviz
 			@attributes = attributes
 		end
 		
+		# @return [Node] The source node.
 		attr :source
+		
+		# @return [Node] The destination node.
 		attr :destination
 		
+		# @return [Hash] Any attributes specified for this edge.
 		attr_accessor :attributes
 		
-		attr :options
-		attr_accessor :line
-		
+		# @return [String] A convenient ASCII arrow.
 		def to_s
 			'->'
 		end
 	end
 	
-	class EdgeNode < Node
-	end
-	
+	# Contains a set of nodes, edges and subgraphs.
 	class Graph
+		# Initialize the graph with the specified unique name.
 		def initialize(name = 'G', attributes = {})
 			@name = name
 			
@@ -99,16 +114,28 @@ module Graphviz
 			@attributes = attributes
 		end
 		
+		# @return [Graph] The parent graph, if any.
+		attr :parent
+		
+		# @return [Array<Node>] All nodes in the graph.
 		attr :nodes
+		
+		# @return [Array<Edge>] All edges in the graph.
 		attr :edges
+		
+		# @return [Array<Graph>] Any subgraphs.
 		attr :graphs
 		
+		# @return [Hash] Any associated graphviz attributes.
 		attr_accessor :attributes
 		
+		# @return [Node] Add a node to this graph.
 		def add_node(name, attributes = {})
 			Node.new(self, name, attributes)
 		end
 		
+		# Add a subgraph with a given name and attributes.
+		# @return [Graph] the new graph.
 		def add_subgraph(name, attributes = {})
 			graph = Graph.new(name, attributes)
 			
@@ -118,10 +145,12 @@ module Graphviz
 			return graph
 		end
 		
+		# Make this graph a subgraph of the parent.
 		def attach(parent)
 			@parent = parent
 		end
 		
+		# @return [String] Output the graph using the dot format.
 		def to_dot(options = {})
 			buffer = StringIO.new
 			
@@ -132,6 +161,7 @@ module Graphviz
 		
 		protected
 		
+		# Dump the entire graph and all subgraphs to dot text format.
 		def dump_graph(buffer, indent, options)
 			format = options[:format] || 'digraph'
 			
@@ -164,6 +194,7 @@ module Graphviz
 			buffer.puts "#{indent}}"
 		end
 		
+		# Dump the value to dot text format.
 		def dump_value(value)
 			if Symbol === value
 				value.to_s
@@ -172,6 +203,7 @@ module Graphviz
 			end
 		end
 		
+		# Dump the attributes to dot text format.
 		def dump_attributes(attributes)
 			if attributes.size > 0
 				"[" + attributes.collect{|(name, value)| "#{name}=#{dump_value(value)}"}.join(", ") + "]"

data/lib/graphviz/version.rb

@@ -1,3 +1,24 @@
+# Copyright, 2014, by Samuel G. D. Williams. <http://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.
+
 module Graphviz
-	VERSION = "0.0.2"
+	# The version.
+	VERSION = "0.1.0"
 end

data/spec/graphviz/graph_spec.rb

@@ -0,0 +1,48 @@
+# Copyright, 2014, by Samuel G. D. Williams. <http://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.
+
+require 'graphviz'
+
+module Graphviz::GraphSpec
+	SAMPLE_GRAPH_DOT = <<-EOF
+digraph "G" {
+	"Foo"[shape="box3d", color="red"];
+	"Foo" -> "Bar";
+	"Bar";
+}
+	EOF
+	
+	describe Graphviz::Graph do
+		it "should construct a simple graph" do
+			foo = subject.add_node("Foo")
+			foo.add_node("Bar")
+			
+			foo.attributes[:shape] = 'box3d'
+			foo.attributes[:color] = 'red'
+			
+			expect(subject.to_dot).to be == SAMPLE_GRAPH_DOT
+			
+			# Process the graph to output:
+			Graphviz::output(subject, :path => "test.pdf")
+			
+			expect(File.exist? "test.pdf").to be true
+		end
+	end
+end

metadata

@@ -1,55 +1,69 @@
 --- !ruby/object:Gem::Specification
 name: graphviz
 version: !ruby/object:Gem::Version
-  version: 0.0.2
+  version: 0.1.0
 platform: ruby
 authors:
 - Samuel Williams
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-10-04 00:00:00.000000000 Z
+date: 2014-07-11 00:00:00.000000000 Z
 dependencies:
+- !ruby/object:Gem::Dependency
+  name: yard
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.8.7
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.8.7
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '1.3'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '1.3'
 - !ruby/object:Gem::Dependency
-  name: rake
+  name: rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 3.0.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 3.0.0
 - !ruby/object:Gem::Dependency
-  name: rexec
+  name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
-  type: :runtime
+  type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
 description: "\t\tGraphviz is a graph visualisation system. This gem is a lightweight
@@ -60,15 +74,16 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- .gitignore
+- ".gitignore"
+- ".travis.yml"
 - Gemfile
 - README.md
+- Rakefile
 - graphviz.gemspec
 - lib/graphviz.rb
 - lib/graphviz/graph.rb
 - lib/graphviz/version.rb
-- rakefile.rb
-- sample.rb
+- spec/graphviz/graph_spec.rb
 homepage: ''
 licenses:
 - MIT
@@ -79,18 +94,20 @@ require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
-  - - '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.0.6
+rubygems_version: 2.2.2
 signing_key: 
 specification_version: 4
 summary: A lightweight interface for generating graphs with Graphviz.
-test_files: []
+test_files:
+- spec/graphviz/graph_spec.rb
+has_rdoc: yard

data/rakefile.rb

@@ -1 +0,0 @@
-require "bundler/gem_tasks"

data/sample.rb

@@ -1,16 +0,0 @@
-require 'graphviz';
-
-g = Graphviz::Graph.new
-
-foo = g.add_node("Foo")
-foo.add_node("Bar")
-
-foo.attributes[:shape] = 'box3d'
-foo.attributes[:color] = 'red'
-
-# Dup the dot data:
-puts g.to_dot
-
-# Process the graph to output:
-Graphviz::output(g, :path => "test.pdf")
-