rviz 0.0.2

data/README.rdoc

@@ -0,0 +1,78 @@
+= Rviz: An Other Ruby Interface for Graphviz
+
+Provide a simple OOP interface and designed easy to extend.
+
+    g = Rviz::Graph.new
+    g.set('bgcolor', 'kahki')
+    g.set('dpi', '300')
+    g.set('rankdir', 'LR')
+    node_a = g.add_node('Node A', 'diamond')
+    node_b = g.add_node('Node B', 'box')
+    edge_a = g.add_edge('Node A', '', 'Node B', '', {arrowhead: 'onormal'})
+
+    node_a.set('fillcolor', 'yellow')
+    g.node('Node A').set('fillcolor', 'yellow') # same as above
+
+    other_node = Rviz::Node.new('The Node', 'diamond')
+    g.add(other_node) # same as g.add_node(...)
+
+    g.output('some.dot') # generate a dot file
+    g.output # send output to STDOUT
+
+An easy way to create <tt>record</tt> and <tt>Mrecord</tt> type of nodes:
+
+    g.add_record('Record A')
+    g.node('Record A').add_row('A Row 1', true) # add an anchor
+    g.node('Record A').add_row('A Row 2', true) # add an anchor
+    g.node('Record A').add_row('A Row 3', true) # add an anchor
+
+    g.add_record('Record B')
+    g.node('Record B').add_row('B Row 1', true) # add an anchor
+    g.add_edge('Record A', 'A Row 2', 'Record B', 'B Row 1', {label: 'link A:2 to B:1'})
+
+You can extend <tt>Rviz</tt> very easy:
+
+    # in file red_note.rb
+    module Rviz
+      class RedNote < Note
+        def initialize name
+          @attrs[:name] = name
+          @attrs[:shape] = 'note'
+          @attrs[:style] = 'filled'
+          @attrs[:fillcolor] = 'red'
+        end
+      end
+    end
+
+    # in your program:
+    g = Rviz::Graph.new
+    g.add(Rviz::RedNote.new('Red'))
+    g.output('notes.dot')
+
+And you can also mixin the <tt>Graph</tt> class:
+
+    # in file red_note.rb
+    module Rviz
+      class RedNote < Note
+        def initialize name
+          @attrs[:name] = name
+          @attrs[:shape] = 'note'
+          @attrs[:style] = 'filled'
+          @attrs[:fillcolor] = 'red'
+        end
+      end
+    end
+
+    module Rviz
+      class Graph
+        def add_red_note name
+          self.add(RedNote(name))
+        end
+      end
+    end
+
+    # now in your main program:
+    g = Rviz::Graph.new
+    g.add_red_note('Bloody Notes')
+    g.output('notes.dot')
+

data/Rakefile

@@ -0,0 +1,4 @@
+require 'rspec/core/rake_task'
+RSpec::Core::RakeTask.new('spec')
+
+

data/examples/hello.rb

@@ -0,0 +1,4 @@
+$:.unshift "lib", "../lib"
+require 'rviz'
+
+Rviz::Graph.new.add("Hello").add("World").link("Hello", "", "World").output

data/examples/record.rb

@@ -0,0 +1,13 @@
+# encoding: utf-8
+$:.unshift "lib", "../lib"
+require 'rviz'
+
+g = Rviz::Graph.new
+g.add(Rviz::Record.new('To', {color: 'blue'}))
+g.add(Rviz::Mrecord.new('Fu', {color: 'green'}))
+
+g.node('To').add_row("Hello").add_row("World", true)
+g.node('Fu').add_row("你好", true).add_row("世界")
+
+g.link('To', "World", 'Fu', "你好")
+g.output

data/lib/rviz/edge.rb

@@ -0,0 +1,30 @@
+module Rviz
+  # represent a -> 
+  class Edge
+    attr_reader :attrs
+
+    def initialize from_node, from_anchor, to_node, to_anchor = nil, attributes = {}
+      @from, @from_anchor, @to, @to_anchor, @attrs = from_node, from_anchor, to_node, to_anchor, attributes
+    end
+
+    def node_anchor node, anchor
+      if anchor and anchor.size > 0
+        quote(node) + ":" + anchor
+      else
+        quote(node)
+      end
+    end
+
+    include Helper
+
+    # output to dot format
+    def to_s
+      from, to = node_anchor(@from, @from_anchor), node_anchor(@to, @to_anchor)
+      if @attrs.keys.size > 0
+        sprintf "%s -> %s [%s]", from, to, self.attrs_to_s
+      else
+        sprintf "%s -> %s", from, to
+      end
+    end
+  end
+end

data/lib/rviz/graph.rb

@@ -0,0 +1,96 @@
+module Rviz
+  class Graph
+    attr_accessor :subgraphs, :nodes, :edges
+    
+    def initialize attrs = {}
+      @attrs = attrs
+      @nodes = Hash.new
+      @edges = Array.new
+      @links = Array.new
+      @subgraphs = Hash.new
+    end
+
+    def graph_start type = "digraph", name = "G"
+      "#{type} #{name} {"
+    end
+
+    def graph_end; "}" end
+
+    include Rviz::Helper
+    def graph_attr
+      @attrs["charset"] = "UTF-8" unless @attrs["charset"]
+      sprintf("  graph [%s]", self.attrs_to_s)
+    end
+
+    def node_attr
+      '  node [fontname="Arial Unicode MS", fontsize=9, width=2.0];'
+    end
+
+    def edge_attr
+      '  edge [fontname="Arial Unicode MS", fontsize=7];'
+    end
+
+    # return a specific node from the node list
+    def node name
+      @nodes[name]
+    end
+
+    # add a node or create a node with name, shae and attributes
+    def add name, shape='box', attrs = {}
+      if name.is_a?(Node)
+        node = name
+        name = name.name
+      else
+        node = Node.new(name, shape, attrs)
+      end
+      
+      @nodes[name] = node
+      self
+    end
+
+    # create edge between two nodes
+    def link from_name, from_anchor, to_name, to_anchor = "", attrs = {}
+      @links << [from_name, from_anchor, to_name, to_anchor, attrs]
+      self
+    end
+
+    def add_edge from_name, from_anchor, to_name, to_anchor, attrs = {}
+      @edges << Edge.new(from_name, from_anchor, to_name, to_anchor, attrs)
+      self
+    end
+
+    ## output dot language source to file or to STDOUT
+    def output file=STDOUT
+      fh = file
+      fh = File.open(file, "w:utf-8") if file.is_a?(String)
+
+      fh.puts self.graph_start
+      fh.puts self.graph_attr
+      fh.puts self.node_attr
+      fh.puts self.edge_attr
+      
+      @nodes.each {|n,node| fh.puts "  " + node.to_s}
+
+      @links.each do |ary|
+        raise "#{ary[0]} not found as a node" unless @nodes[ary[0]] # from
+        raise "#{ary[2]} not found as a node" unless @nodes[ary[2]] # to
+        if %w[Mrecord record].include?(@nodes[ary[0]].shape)
+          ary[1] = @nodes[ary[0]].get_anchor(ary[1])
+          ary[3] = @nodes[ary[2]].get_anchor(ary[3])
+        end
+        @edges << Edge.new(*ary)
+      end
+
+      @edges.each {|e| fh.puts "  " + e.to_s}
+
+      fh.puts self.graph_end
+      fh.close
+    end
+  end
+
+  class SubGraph
+    attr_accessor :name
+    def graph_start; "  subgraph #{self.name} {" end
+    def graph_end; "  }" end
+  end
+end

data/lib/rviz/node.rb

@@ -0,0 +1,20 @@
+module Rviz
+  class Node
+    attr_accessor :name
+    def initialize name, shape = "box", attrs = {}
+      @name = name
+      @attrs = {"shape" => shape}.merge attrs
+    end
+
+    def shape
+      @attrs["shape"]
+    end
+
+    include Rviz::Helper
+
+    # print out as dot source
+    def to_s
+      sprintf '%s [%s]', self.quote(@name), self.attrs_to_s
+    end
+  end
+end

data/lib/rviz/record.rb

@@ -0,0 +1,57 @@
+module Rviz
+  class Record < Node
+    def initialize name, attrs = {}
+      super name, "record", attrs
+      @label_rows = Array.new
+      @anchors = Hash.new
+    end
+
+    # from row_name returns the id corresponds to the anchor
+    def get_anchor_id row_name
+      @anchors[row_name]
+    end
+
+    # get the anchor name used for edge link
+    def get_anchor row_name
+      "f" + self.get_anchor_id(row_name).to_s
+    end
+
+    def add_row row_name, create_anchor = false, port_pos = 'n'
+      if create_anchor 
+        anchor_id = @anchors.keys.size + 1
+        @anchors[row_name] = anchor_id
+        row_name.gsub!(/([\/\|\\\<\>])/, '-') # escape special characters
+        row_name = "<f#{anchor_id.to_s}>" + row_name
+      end
+      if port_pos
+        raise "unknown port_pos, should in l, r or n" unless %w[l r n].include? port_pos
+      end
+      @label_rows << [row_name, port_pos]
+      self
+    end
+
+    def label_with_rows
+      labels = Array.new
+      i =0
+      @label_rows.each do |a|
+        str, lr = a[0], a[1]
+        str += " \\" + lr if %w[l r].include? lr
+        labels << str
+      end
+      labels.join('|')
+    end
+
+    def to_s
+      @attrs['label'] = self.label_with_rows
+      super
+    end
+  end
+
+  # a convenient way to inherit Record functions
+  class Mrecord < Record
+    def initialize name, attrs = {}
+      super name, attrs
+      @attrs["shape"] = "Mrecord"
+    end
+  end
+end

data/lib/rviz/version.rb

@@ -0,0 +1,4 @@
+module Rviz
+  VERSION = '0.0.2'
+end
+

data/lib/rviz.rb

@@ -0,0 +1,32 @@
+module Rviz
+  module Helper
+    # convert attr hash to a string in dot format
+    def attrs_to_s
+      attr_strs = Array.new
+
+      @attrs.each do |k,v|
+        k = self.quote(k)
+        v = self.quote(v)
+        attr_strs << sprintf('%s=%s', k, v)
+      end
+      attr_strs.join(", ")
+    end
+
+    def set key, value
+      @attrs[key] = value
+    end
+
+    def quote str
+      if str.match(/\W/)
+        %Q{"#{str.to_s}"}
+      else
+        str.to_s
+      end
+    end
+  end
+end
+
+require "rviz/edge.rb"
+require "rviz/graph.rb"
+require "rviz/node.rb"
+require "rviz/record.rb"

data/rviz.gemspec

@@ -0,0 +1,16 @@
+$LOAD_PATH.unshift File.expand_path('../lib', __FILE__)
+require 'rviz/version'
+
+Gem::Specification.new 'rviz', Rviz::VERSION do |s|
+  s.description       = "Rviz is an other ruby interface to graphviz."
+  s.summary           = "Graphviz ruby interface"
+  s.authors           = ["Huang Wei"]
+  s.email             = "huangw@pe-po.com"
+  s.homepage          = "https://github.com/huangw/rviz-gem"
+  s.files             = `git ls-files`.split("\n") - %w[.gitignore]
+  s.test_files        = Dir.glob("{spec,test}/**/*.rb")
+  s.rdoc_options      = %w[--line-numbers --inline-source --title Rviz --main README.rdoc --encoding=UTF-8]
+
+  s.add_development_dependency 'rspec', '~> 2.5'
+end
+

data/spec/edge_spec.rb

@@ -0,0 +1,38 @@
+require "spec_helper"
+
+describe Rviz::Edge do
+  describe "#to_s" do
+    it "should format a plain link" do
+      Rviz::Edge.new("A", "", "B").to_s.should eq "A -> B"
+    end
+
+    it "should format link with from anchor" do
+      Rviz::Edge.new("A", "a", "B").to_s.should eq "A:a -> B"
+    end
+
+    it "should format link with to anchor" do
+      Rviz::Edge.new("A", "", "B", "b").to_s.should eq "A -> B:b"
+    end
+
+    it "should format link with both anchor" do
+      Rviz::Edge.new("A", "a", "B", "b").to_s.should eq "A:a -> B:b"
+    end
+
+    it "should format link with special from node" do
+      Rviz::Edge.new("A C", "a", "B", "b").to_s.should eq %q|"A C":a -> B:b|
+    end
+
+    it "should format link with special nodes" do
+      Rviz::Edge.new("A C", "a", "B D", "b").to_s.should eq %q|"A C":a -> "B D":b|
+    end
+
+    it "should format link with label attributes" do
+      Rviz::Edge.new("A B C", "a", "B", "", {label: "Send to me"}).to_s.should eq %q{"A B C":a -> B [label="Send to me"]}
+    end
+
+    it "should format link with more attributes" do
+      Rviz::Edge.new("A B C", "a", "B", "", {label: "Send to me", color: "black"}).to_s.should eq %q{"A B C":a -> B [label="Send to me", color=black]}
+    end
+  end
+end
+

data/spec/graph_spec.rb

@@ -0,0 +1,7 @@
+require "spec_helper"
+
+describe Rviz::Graph do
+  it "can generate a empty graph" do
+   # pass 
+  end
+end

data/spec/node_spec.rb

@@ -0,0 +1,61 @@
+require "spec_helper"
+
+describe Rviz::Node do
+  describe "#to_s" do
+    it "should return a node in plain format" do
+      Rviz::Node.new("glue").to_s.should eq %Q{glue [shape=box]}
+    end
+
+    it "should return a note with specific shape and attribute" do
+      Rviz::Node.new("glue", "note", {color: "red"}).to_s.should eq %Q{glue [shape=note, color=red]}
+    end
+  end
+end
+
+describe Rviz::Record do
+  describe "#to_s" do
+    it "should return a record node in plain format" do
+      ar = Rviz::Record.new('a_record')
+      ar.add_row("A Row")
+      ar.add_row("B Row")
+      ar.to_s.should eq %Q{a_record [shape=record, label="A Row|B Row"]}
+    end
+
+    it "should return a record node with an anchor" do
+      ar = Rviz::Record.new('a_record')
+      ar.add_row("A Row", true)
+      ar.add_row("B Row")
+      ar.to_s.should eq %Q{a_record [shape=record, label="<f1>A Row|B Row"]}
+    end
+
+    it "should return a record node with more anchors" do
+      ar = Rviz::Record.new('a_record')
+      ar.add_row("A Row", true)
+      ar.add_row("B Row", true)
+      ar.add_row("C Row", true)
+      ar.to_s.should eq %Q{a_record [shape=record, label="<f1>A Row|<f2>B Row|<f3>C Row"]}
+    end
+  end
+
+  describe "#get_anchor" do
+    it "should labeled some row with proper id" do
+      ar = Rviz::Record.new('a_record')
+      ar.add_row("A Row", true)
+      ar.add_row("B Row", true)
+      ar.add_row("C Row", true)
+      ar.get_anchor_id("C Row").should eq(3)
+      ar.get_anchor("B Row").should eq("f2")
+    end
+  end
+end
+
+describe Rviz::Mrecord do
+  describe "#to_s" do
+    it "should have a shape of Mrecord" do
+      Rviz::Mrecord.new('m_record').shape.should eq "Mrecord"
+    end
+  end
+end
+
+
+

data/spec/rviz_helper_spec.rb

@@ -0,0 +1,19 @@
+require "spec_helper"
+
+describe Rviz do
+  describe "#attrs_to_s" do
+    it "return attribute set in format" do
+      # mock up
+      m = Rviz::Edge.new "from", "", "to", ""
+      m.set("label", "full stack")
+      m.attrs_to_s.should eq(%q{label="full stack"})
+    end
+
+    it "return initial attributes in format" do
+      m = Rviz::Edge.new "from", "", "to", "", {arrowhead: "onormal"}
+      m.set("label", "full stack")
+      m.attrs_to_s.should eq(%q{arrowhead=onormal, label="full stack"})
+    end
+  end
+end
+

data/spec/spec_helper.rb

@@ -0,0 +1,7 @@
+require 'rspec'
+require 'rviz'
+
+RSpec.configure do |config|
+  config.color_enabled = true
+  config.formatter     = 'documentation'
+end

data/tags

@@ -0,0 +1,33 @@
+!_TAG_FILE_FORMAT	2	/extended format; --format=1 will not append ;" to lines/
+!_TAG_FILE_SORTED	1	/0=unsorted, 1=sorted, 2=foldcase/
+!_TAG_PROGRAM_AUTHOR	Darren Hiebert	/dhiebert@users.sourceforge.net/
+!_TAG_PROGRAM_NAME	Exuberant Ctags	//
+!_TAG_PROGRAM_URL	http://ctags.sourceforge.net	/official site/
+!_TAG_PROGRAM_VERSION	5.8	//
+Edge	lib/rviz/edge.rb	/^  class Edge$/;"	c	class:Rviz
+Graph	lib/rviz/graph.rb	/^  class Graph$/;"	c	class:Rviz
+Helper	lib/rviz.rb	/^  module Helper$/;"	m	class:Rviz
+Mrecord	lib/rviz/record.rb	/^  class Mrecord < Record$/;"	c	class:Rviz
+Node	lib/rviz/node.rb	/^  class Node$/;"	c	class:Rviz
+Record	lib/rviz/record.rb	/^  class Record < Node$/;"	c	class:Rviz
+Rviz	lib/rviz.rb	/^module Rviz$/;"	m
+Rviz	lib/rviz/edge.rb	/^module Rviz$/;"	m
+Rviz	lib/rviz/graph.rb	/^module Rviz$/;"	m
+Rviz	lib/rviz/node.rb	/^module Rviz$/;"	m
+Rviz	lib/rviz/record.rb	/^module Rviz$/;"	m
+Rviz	lib/rviz/version.rb	/^module Rviz$/;"	m
+SubGraph	lib/rviz/graph.rb	/^  class SubGraph$/;"	c	class:Rviz
+add_row	lib/rviz/record.rb	/^    def add_row row_name, create_anchor = false, port_pos = 'n'$/;"	f	class:Rviz.Record
+attrs_to_s	lib/rviz.rb	/^    def attrs_to_s$/;"	f	class:Rviz.Helper
+get_anchor_id	lib/rviz/record.rb	/^    def get_anchor_id row_name$/;"	f	class:Rviz.Record
+initialize	lib/rviz/edge.rb	/^    def initialize from_node, from_anchor, to_node, to_anchor = nil, attributes = {}$/;"	f	class:Rviz.Edge
+initialize	lib/rviz/node.rb	/^    def initialize name, shape = "box", attrs = {}$/;"	f	class:Rviz.Node
+initialize	lib/rviz/record.rb	/^    def initialize name, attrs = {}$/;"	f	class:Rviz.Mrecord
+initialize	lib/rviz/record.rb	/^    def initialize name, attrs = {}$/;"	f	class:Rviz.Record
+label_with_rows	lib/rviz/record.rb	/^    def label_with_rows$/;"	f	class:Rviz.Record
+node_anchor	lib/rviz/edge.rb	/^    def node_anchor node, anchor$/;"	f	class:Rviz.Edge
+quote	lib/rviz.rb	/^    def quote str$/;"	f	class:Rviz.Helper
+set	lib/rviz.rb	/^    def set key, value$/;"	f	class:Rviz.Helper
+to_s	lib/rviz/edge.rb	/^    def to_s$/;"	f	class:Rviz.Edge
+to_s	lib/rviz/node.rb	/^    def to_s$/;"	f	class:Rviz.Node
+to_s	lib/rviz/record.rb	/^    def to_s$/;"	f	class:Rviz.Record

metadata

@@ -0,0 +1,91 @@
+--- !ruby/object:Gem::Specification
+name: rviz
+version: !ruby/object:Gem::Version
+  version: 0.0.2
+  prerelease: 
+platform: ruby
+authors:
+- Huang Wei
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-03-08 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '2.5'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '2.5'
+description: Rviz is an other ruby interface to graphviz.
+email: huangw@pe-po.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- README.rdoc
+- Rakefile
+- examples/hello.png
+- examples/hello.rb
+- examples/record.png
+- examples/record.rb
+- lib/rviz.rb
+- lib/rviz/edge.rb
+- lib/rviz/graph.rb
+- lib/rviz/node.rb
+- lib/rviz/record.rb
+- lib/rviz/version.rb
+- rviz.gemspec
+- spec/edge_spec.rb
+- spec/graph_spec.rb
+- spec/node_spec.rb
+- spec/rviz_helper_spec.rb
+- spec/spec_helper.rb
+- tags
+homepage: https://github.com/huangw/rviz-gem
+licenses: []
+post_install_message: 
+rdoc_options:
+- --line-numbers
+- --inline-source
+- --title
+- Rviz
+- --main
+- README.rdoc
+- --encoding=UTF-8
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.25
+signing_key: 
+specification_version: 3
+summary: Graphviz ruby interface
+test_files:
+- spec/edge_spec.rb
+- spec/graph_spec.rb
+- spec/node_spec.rb
+- spec/rviz_helper_spec.rb
+- spec/spec_helper.rb