graphviz 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 53f53e53933990cd7d1db7893e889953abfcb29f
+  data.tar.gz: e5937034681308f0cc005cff8927427b5a14f8e4
+SHA512:
+  metadata.gz: e34c656a49ce0dc4ad30973e1093fef0bfc8fbef62622645e44d3f993bfc11c60a0ab8ad52a3f0badcd1102717132b8350b6c4632444d82a78ee8b7fe89057f4
+  data.tar.gz: 5b9196eed4421dc028400df9aa52a1610e8ddd8f20d654169823870ca90ff137c80f7b0b29f719db88bf13cfaca3ea56d624dbdd50c1de35488f12c15f5c548f

data/.gitignore

@@ -0,0 +1,17 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in graphviz.gemspec
+gemspec

data/README.md

@@ -0,0 +1,53 @@
+# Graphviz
+
+Graphviz is a graph visualisation system. This gem is a lightweight interface for generating graphs with Graphviz.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'graphviz'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install graphviz
+
+## Usage
+
+TODO: Write usage instructions here
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request
+
+## License
+
+Released under the MIT license.
+
+Copyright, 2013, by [Samuel G. D. Williams](http://www.codeotaku.com/samuel-williams).
+
+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.

data/graphviz.gemspec

@@ -0,0 +1,27 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'graphviz/version'
+
+Gem::Specification.new do |spec|
+	spec.name          = "graphviz"
+	spec.version       = Graphviz::VERSION
+	spec.authors       = ["Samuel Williams"]
+	spec.email         = ["samuel.williams@oriontransfer.co.nz"]
+	spec.description   = <<-EOF
+		Graphviz is a graph visualisation system. This gem is a lightweight interface for generating graphs with Graphviz.
+	EOF
+	spec.summary       = "A lightweight interface for generating graphs with Graphviz."
+	spec.homepage      = ""
+	spec.license       = "MIT"
+
+	spec.files         = `git ls-files`.split($/)
+	spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+	spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+	spec.require_paths = ["lib"]
+
+	spec.add_development_dependency "bundler", "~> 1.3"
+	spec.add_development_dependency "rake"
+	
+	spec.add_dependency "rexec"
+end

data/lib/graphviz.rb

@@ -0,0 +1,62 @@
+# Copyright (c) 2013 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/version"
+
+require "graphviz/graph"
+require 'rexec'
+
+module Graphviz
+	class OutputError < StandardError
+	end
+	
+	def self.output(graph, options = {})
+		text = graph.to_dot
+		
+		output_format = options[:format]
+		
+		if options[:path]
+			# Grab the output format from the file name:
+			if options[:path] =~ /\.(.*?)$/
+				output_format ||= $1
+			end
+			
+			output_file = File.open(options[:path], "w")
+		else
+			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
+			
+			# Did we use a local pipe for output?
+			if Array === output_file
+				return task.output.read
+			end
+		end
+	end
+end

data/lib/graphviz/graph.rb

@@ -0,0 +1,115 @@
+# Copyright (c) 2013 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 'stringio'
+
+module Graphviz
+	class Node
+		def initialize(graph, name, options)
+			@graph = graph
+			@graph.nodes[name] = self
+			
+			@name = name
+			@options = options
+			
+			@edges = []
+		end
+		
+		attr :name
+		attr :options
+		
+		attr :edges
+		
+		def connect(destination, options = {})
+			edge = Edge.new(@graph, self, destination, options)
+			
+			@edges << edge
+			
+			return edge
+		end
+		
+		def add_node(name, options = {})
+			node = Node.new(@graph, name, options)
+			
+			connect(node)
+			
+			return node
+		end
+	end
+	
+	class Edge
+		def initialize(graph, source, destination, options = {})
+			@graph = graph
+			@graph.edges << self
+			
+			@source = source
+			@destination = destination
+			
+			@options = options
+		end
+		
+		attr :source
+		attr :destination
+		
+		attr :options
+		
+		def to_s
+			"->"
+		end
+	end
+	
+	class Graph
+		def initialize(name = 'G', options = {})
+			@name = name
+			
+			@nodes = {}
+			@edges = []
+		end
+		
+		attr :nodes
+		attr :edges
+		
+		def add_node(name, options = {})
+			Node.new(self, name, options)
+		end
+		
+		def to_dot(options = {})
+			buffer = StringIO.new
+			
+			format = options[:format] || 'digraph'
+			
+			buffer.puts "#{format} #{@name} {"
+			
+			@nodes.each do |(name, node)|
+				if node.edges.size > 0
+					node.edges.each do |edge|
+						buffer.puts "\t#{edge.source.name.dump} #{edge} #{edge.destination.name.dump};"
+					end
+				else
+					buffer.puts "\t#{node.name.dump};"
+				end
+			end
+			
+			buffer.puts "}"
+			
+			return buffer.string
+		end
+	end
+end

data/lib/graphviz/version.rb

@@ -0,0 +1,3 @@
+module Graphviz
+	VERSION = "0.0.1"
+end

data/rakefile.rb

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

data/sample.rb

@@ -0,0 +1,10 @@
+require 'graphviz';
+
+g = Graphviz::Graph.new
+
+foo = g.add_node("Foo")
+foo.add_node("Bar")
+
+puts g.to_dot
+
+Graphviz::output(g, :path => "test.pdf")

metadata

@@ -0,0 +1,96 @@
+--- !ruby/object:Gem::Specification
+name: graphviz
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Samuel Williams
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-10-04 00:00:00.000000000 Z
+dependencies:
+- !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
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rexec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  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
+  interface for generating graphs with Graphviz.\n"
+email:
+- samuel.williams@oriontransfer.co.nz
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- README.md
+- graphviz.gemspec
+- lib/graphviz.rb
+- lib/graphviz/graph.rb
+- lib/graphviz/version.rb
+- rakefile.rb
+- sample.rb
+homepage: ''
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+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
+signing_key: 
+specification_version: 4
+summary: A lightweight interface for generating graphs with Graphviz.
+test_files: []