graphviz 0.3.0 → 0.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 3c4f0f3b611287cceb14c4dac3e77e2497ffae13
-  data.tar.gz: fe7cf2f64b8febce78609be21cce9ef81f7cccc7
+  metadata.gz: 26ed6f42266187f65af641382518c0d00e2eabd8
+  data.tar.gz: 3ac7a918a5f7da7288fec080a712b572eddecfbb
 SHA512:
-  metadata.gz: 65d2682330f3b2d3aaa63590950eeb0c52db5a7071d3e0d89a110ab19de7df2a3f4759cc3f007529db310e8c1d8aa8f742133dca3270b17031332c4ea5193252
-  data.tar.gz: 36c924356952539a6856848857607d4b1d67d512132595f09f02373becc85aae462f214490ace2912699e560e8a231531a6f6ae2957af606b1c2fe330777c9c4
+  metadata.gz: 23e5b1deba81bd053beb0dab4c03450b16324df909999233d5a344f8e205682d412f1d27c3c80a81693b0dbbdadcaae3eb463dda72f7eb9b1d6f16b235420602
+  data.tar.gz: 82088298acc5dd68c759a1ae87ed5c40a15d7b863da5e643e9d402d94c2ffa465dc124608bb058e69570c492c9a9fcd985c3a9d6943a6973325f29e1b04063a6

data/.rspec

@@ -1,2 +1,5 @@
---color 
---format documentation 
+--color
+--format documentation
+--backtrace
+--require spec_helper
+--warnings

data/.travis.yml

@@ -1,17 +1,15 @@
 language: ruby
-sudo: required
-before_install:
-  # We need GraphViz for testing:
-  - sudo apt-get install graphviz
+sudo: false
+dist: trusty
+
+addons:
+  apt:
+    packages:
+      - graphviz
+
 rvm:
-  - 2.0.0
-  - 2.1.8
-  - 2.2.4
-  - 2.3.0
+  - 2.1
+  - 2.2
+  - 2.3
+  - 2.4
   - ruby-head
-  - rbx-2
-env: COVERAGE=true
-matrix:
-  allow_failures:
-    - rvm: "rbx-2"
-

data/Gemfile

@@ -2,3 +2,8 @@ source 'https://rubygems.org'
 
 # Specify your gem's dependencies in graphviz.gemspec
 gemspec
+
+group :development do
+	gem "guard-rspec"
+	gem "simplecov"
+end

data/Guardfile

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+directories %w(lib spec)
+clearing :on
+
+ENV['COVERAGE'] = 'y'
+
+guard :rspec, cmd: "bundle exec rspec" do
+  watch(%r{^spec/.+_spec\.rb$})
+  watch(%r{^lib/(.+)\.rb$})    { |m| "spec/#{m[1]}_spec.rb" }
+  watch("spec/spec_helper.rb") { "spec" }
+end

data/README.md

@@ -3,7 +3,8 @@
 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)
+[![Code Climate](https://codeclimate.com/github/ioquatix/graphviz.svg)](https://codeclimate.com/github/ioquatix/graphviz)
+[![Coverage Status](https://coveralls.io/repos/ioquatix/graphviz/badge.svg)](https://coveralls.io/r/ioquatix/graphviz)
 
 ## Installation
 

data/examples/demo.rb

@@ -0,0 +1,37 @@
+#!/usr/bin/env ruby
+
+require_relative 'lib/graphviz.rb'
+
+# Hello
+#   |
+# People
+
+hello = Graphviz::Graph.new("Hello")
+keywords = []
+keywords[0] = hello.add_node("Hello")
+keywords[1] = hello.add_node("People")
+
+# We link Hello to People
+hello_people = keywords[0].connect(keywords[1])
+
+#      People
+#   /    |    \
+#  Bob  Jim   Kev
+
+people = Graphviz::Graph.new("People")
+persons = []
+persons[0] = people.add_node("Bob")
+persons[1] = people.add_node("Jim")
+persons[2] = people.add_node("Kev")
+
+# We link people (People = {Bob, Jim, Kev})
+people_bob = keywords[1].connect(persons[0])
+people_jim = keywords[1].connect(persons[1])
+people_kev = keywords[1].connect(persons[2])
+
+# Attributes for "Hello"
+keywords[0].attributes[:shape] = 'box3d'
+keywords[0].attributes[:color] = 'red'
+
+# Generate the Graph (pdf format)
+Graphviz::output(hello, :path => "test.pdf")

data/lib/graphviz.rb

@@ -18,8 +18,8 @@
 # OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
 # THE SOFTWARE.
 
-require "graphviz/version"
-require "graphviz/graph"
+require_relative "graphviz/version"
+require_relative "graphviz/graph"
 
 module Graphviz
 	# Signals that the process exited with a non-zero status.
@@ -54,7 +54,7 @@ module Graphviz
 		output.close
 		
 		# Send graph data to process:
-		input.write(graph.to_dot)
+		input.write(text)
 		input.close
 		
 		_, status = Process.wait2(pid)

data/lib/graphviz/edge.rb

@@ -0,0 +1,52 @@
+# 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 'stringio'
+
+module Graphviz
+	# 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
+			
+			@source = source
+			@destination = destination
+			
+			@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
+		
+		# @return [String] A convenient ASCII arrow.
+		def to_s
+			"#{@source} -> #{@destination}"
+		end
+	end
+end

data/lib/graphviz/graph.rb

@@ -20,118 +20,9 @@
 
 require 'stringio'
 
+require_relative 'node'
+
 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(name, graph = nil, **attributes)
-			@name = name
-			@attributes = attributes
-			
-			@connections = []
-			
-			graph << self if graph
-		end
-		
-		# Attach this node to the given graph:
-		def attach(parent)
-			@graph = parent
-		end
-		
-		# @return [String] The unique name of the node.
-		attr :name
-		
-		# @return [Array<Edge>] Any edges connecting to other nodes.
-		attr :connections
-		
-		# @return [Hash] Any attributes specified for this node.
-		attr_accessor :attributes
-		
-		# 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)
-			
-			@connections << edge
-			
-			return edge
-		end
-		
-		# Calculate if this node is connected to another. +O(N)+ search required.
-		def connected?(node)
-			return @connections.find{|edge| edge.destination == node}
-		end
-		
-		# Add a node and #connect to it.
-		# @param attributes [Hash] The associated graphviz attributes for the new node.
-		def add_node(name = nil, **attributes)
-			node = @graph.add_node(name, **attributes)
-			
-			connect(node)
-			
-			return node
-		end
-		
-		def identifier
-			@name
-		end
-		
-		def dump_graph(buffer, indent, options)
-			node_attributes_text = dump_attributes(@attributes)
-			node_name = dump_value(self.identifier)
-			
-			buffer.puts "#{indent}#{node_name}#{node_attributes_text};"
-		end
-		
-		# Dump the value to dot text format.
-		def dump_value(value)
-			if Symbol === value
-				value.to_s
-			else
-				value.inspect
-			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(", ") + "]"
-			else
-				""
-			end
-		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
-			
-			@source = source
-			@destination = destination
-			
-			@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
-		
-		# @return [String] A convenient ASCII arrow.
-		def to_s
-			'->'
-		end
-	end
-	
 	# Contains a set of nodes, edges and subgraphs.
 	class Graph < Node
 		# Initialize the graph with the specified unique name.
@@ -148,9 +39,6 @@ module Graphviz
 		# @return [Array<Node>] All nodes in the graph.
 		attr :nodes
 		
-		# @return [Array<Graph>] Any subgraphs.
-		attr :graphs
-		
 		# @return [Hash] Any associated graphviz attributes.
 		attr_accessor :attributes
 		
@@ -206,11 +94,9 @@ module Graphviz
 		
 		def dump_edges(buffer, indent, options)
 			@edges.each do |edge|
-				from_name = dump_value(edge.source.identifier)
-				to_name = dump_value(edge.destination.identifier)
 				edge_attributes_text = dump_attributes(edge.attributes)
 				
-				buffer.puts "#{indent}#{from_name} #{edge} #{to_name}#{edge_attributes_text};"
+				buffer.puts "#{indent}#{edge}#{edge_attributes_text};"
 			end
 		end
 		
@@ -220,11 +106,11 @@ module Graphviz
 			
 			buffer.puts "#{indent}#{format} #{dump_value(self.identifier)} {"
 			
-			@attributes.each do |(name, value)|
+			@attributes.each do |name, value|
 				buffer.puts "#{indent}\t#{name}=#{dump_value(value)};"
 			end
 			
-			@nodes.each do |(name, node)|
+			@nodes.each do |name, node|
 				node.dump_graph(buffer, indent + "\t", options)
 			end
 			

data/lib/graphviz/node.rb

@@ -0,0 +1,111 @@
+# Copyright, 2017, 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_relative 'edge'
+
+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(name, graph = nil, **attributes)
+			@name = name
+			@attributes = attributes
+			
+			@connections = []
+			
+			# This sets up the connection between the node and the parent.
+			@graph = nil
+			graph << self if graph
+		end
+		
+		# Attach this node to the given graph:
+		def attach(parent)
+			@graph = parent
+		end
+		
+		# @return [String] The unique name of the node.
+		attr :name
+		
+		# @return [Array<Edge>] Any edges connecting to other nodes.
+		attr :connections
+		
+		# @return [Hash] Any attributes specified for this node.
+		attr_accessor :attributes
+		
+		# 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)
+			
+			@connections << edge
+			
+			return edge
+		end
+		
+		# Calculate if this node is connected to another. +O(N)+ search required.
+		def connected?(node)
+			return @connections.find{|edge| edge.destination == node}
+		end
+		
+		# Add a node and #connect to it.
+		# @param attributes [Hash] The associated graphviz attributes for the new node.
+		def add_node(name = nil, **attributes)
+			node = @graph.add_node(name, **attributes)
+			
+			connect(node)
+			
+			return node
+		end
+		
+		def identifier
+			@name
+		end
+		
+		def dump_graph(buffer, indent, options)
+			node_attributes_text = dump_attributes(@attributes)
+			node_name = dump_value(self.identifier)
+			
+			buffer.puts "#{indent}#{node_name}#{node_attributes_text};"
+		end
+		
+		def to_s
+			dump_value(@name)
+		end
+		
+		# Dump the value to dot text format.
+		def dump_value(value)
+			if Symbol === value
+				value.to_s
+			else
+				value.inspect
+			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(", ") + "]"
+			else
+				""
+			end
+		end
+	end
+end

data/lib/graphviz/version.rb

@@ -19,6 +19,5 @@
 # THE SOFTWARE.
 
 module Graphviz
-	# The version.
-	VERSION = "0.3.0"
+	VERSION = "0.4.0"
 end

data/spec/graphviz/edge_spec.rb

@@ -0,0 +1,15 @@
+
+RSpec.describe Graphviz::Edge do
+	let(:graph) {Graphviz::Graph.new}
+	
+	let(:a) {Graphviz::Node.new(:a, graph)}
+	let(:b) {Graphviz::Node.new(:b, graph)}
+	
+	describe '#to_s' do
+		subject{a.connect(b)}
+		
+		it 'should generate edge string' do
+			expect(subject.to_s).to be == 'a -> b'
+		end
+	end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,29 @@
+
+if ENV['COVERAGE'] || ENV['TRAVIS']
+	begin
+		require 'simplecov'
+		
+		SimpleCov.start do
+			add_filter "/spec/"
+		end
+		
+		if ENV['TRAVIS']
+			require 'coveralls'
+			Coveralls.wear!
+		end
+	rescue LoadError
+		warn "Could not load simplecov: #{$!}"
+	end
+end
+
+require "bundler/setup"
+require "graphviz"
+
+RSpec.configure do |config|
+	# Enable flags like --only-failures and --next-failure
+	config.example_status_persistence_file_path = ".rspec_status"
+
+	config.expect_with :rspec do |c|
+		c.syntax = :expect
+	end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: graphviz
 version: !ruby/object:Gem::Version
-  version: 0.3.0
+  version: 0.4.0
 platform: ruby
 authors:
 - Samuel Williams
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-02-05 00:00:00.000000000 Z
+date: 2017-04-24 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: yard
@@ -78,13 +78,19 @@ files:
 - ".rspec"
 - ".travis.yml"
 - Gemfile
+- Guardfile
 - README.md
 - Rakefile
+- examples/demo.rb
 - graphviz.gemspec
 - lib/graphviz.rb
+- lib/graphviz/edge.rb
 - lib/graphviz/graph.rb
+- lib/graphviz/node.rb
 - lib/graphviz/version.rb
+- spec/graphviz/edge_spec.rb
 - spec/graphviz/graph_spec.rb
+- spec/spec_helper.rb
 homepage: ''
 licenses:
 - MIT
@@ -105,10 +111,12 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.2.2
+rubygems_version: 2.6.10
 signing_key: 
 specification_version: 4
 summary: A lightweight interface for generating graphs with Graphviz.
 test_files:
+- spec/graphviz/edge_spec.rb
 - spec/graphviz/graph_spec.rb
+- spec/spec_helper.rb
 has_rdoc: yard