ruby-graphviz 0.9.7 → 0.9.8

data/AUTHORS

@@ -4,6 +4,8 @@ Dave Burt <http://github.com/dburt>
 Miguel Cabrera <http://mfcabrera.com>
 obruening <http://github.com/obruening>
 reactive <http://github.com/reactive>
+Hugh Sasse <hgs@dmu.ac.uk>
+axgle <http://github.com/axgle>
 
 Thanks to :
 

data/ChangeLog.rdoc

@@ -1,3 +1,12 @@
+0.9.8 :
+* Update graph and node posibility to set properties (see sample28.rb)
+* Issue #7: Path option is never being used to find the executable
+* Adding classes to check if the attributes are in the correct type
+* Issue #8: dots in href are escaped with backslash, which corrupts the URL (see sample29.rb)
+* Add posibility to use external libraries (see sample30.rb)
+* Add options -u and -s to ruby2gv
+* Add gem2gv
+
 0.9.7 :
 * Issue #2: Small bug correction in escape_path_containing_blanks (by Andreas Ronge)
 * Issue #4: New find_executable (by reactive)

data/README.rdoc

@@ -4,6 +4,7 @@ Copyright (C) 2004, 2005, 2006, 2007, 2008, 2009 Gregoire Lejeune
 
 * Doc : http://rdoc.info/projects/glejeune/Ruby-Graphviz
 * Sources : http://github.com/glejeune/Ruby-Graphviz
+* Continuous Integration : http://runcoderun.com/glejeune/Ruby-Graphviz
 
 == DESCRIPTION
 
@@ -52,6 +53,16 @@ Create a graph from a file
     }
   }.output(:png => "sample.png")
 
+Ruby/GraphViz also include :
+
+* ruby2gv, a simple tool that's allow you to create a dependency graph from a ruby script. Example : http://drp.ly/dShaZ
+
+	ruby2gv -Tpng -oruby2gv.png ruby2gv
+
+* gem2gv, a tools that's allow you to create a dependency graph between gems. Example : http://drp.ly/dSj9Y
+
+	gem2gv -Tpng -oruby-graphviz.png ruby-graphviz
+
 == INSTALLATION
 
   sudo gem install ruby-graphviz

data/bin/gem2gv

@@ -0,0 +1,166 @@
+#!/usr/bin/env ruby
+# Copyright (C) 2010 Gregoire Lejeune <gregoire.lejeune@free.fr>
+# 
+# This program is free software; you can redistribute it and/or modify
+# it under the terms of the GNU General Public License as published by
+# the Free Software Foundation; either version 2 of the License, or
+# (at your option) any later version.
+# 
+# This program is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+# GNU General Public License for more details.
+# 
+# You should have received a copy of the GNU General Public License
+# along with this program; if not, write to the Free Software
+# Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307  USA
+
+require 'rubygems'
+require 'graphviz'
+require 'getoptlong'
+
+class Gem2Gv
+  def initialize( xGVPath, xUse )
+    @oGraph = GraphViz::new( :G, :path => xGVPath, :use => xUse )
+    
+    @nodes = []
+    @name = 'gem2gv'
+  end
+  
+  def out( xFormat = "dot", xFile = nil )
+    if xFile.nil? == true
+      @oGraph.output( xFormat => String )
+    else
+      @oGraph.output( xFormat => xFile )
+    end
+  end
+  
+  def go( gemName, version = ">0" )
+    nodes = getDependency(gemName, version)
+    
+    createEdges( gemName, version, nodes )
+    
+    nodes.each do |node|
+      unless @nodes.include?(node)
+        @nodes << node
+        go( node[:name], node[:version] )
+      end
+    end
+  end
+
+  def getDependency( gemName, version = ">0" )
+    nodes = []
+    
+    dependency = Gem::Dependency.new( gemName, version )
+    fetcher = Gem::SpecFetcher.fetcher
+    
+    fetcher.find_matching(dependency).each do |spec_tuple, source_uri|
+      spec = fetcher.fetch_spec spec_tuple, URI.parse(source_uri)
+      
+      spec.dependencies.each do |dep|
+        #nodes << { :name => dep.name, :version => dep.version_requirements.to_s} unless nodes.include?({ :name => dep.name, :version => dep.version_requirements.to_s})
+        nodes << { :name => dep.name, :version => ">0" } unless nodes.include?({ :name => dep.name, :version => ">0" })
+      end
+    end
+    
+    return nodes
+  end
+  
+  def getNode( name, version )
+    #nodeName = "#{name}#{version}"
+    #nodeLabel = "#{name}\n#{version}"
+    nodeName = "#{name}"
+    nodeLabel = "#{name}"
+    return @oGraph.get_node(nodeName) || @oGraph.add_node( nodeName, "label" => nodeLabel )
+  end
+  
+  def createEdges( gemName, version, nodes )
+    nodeA = getNode( gemName, version )
+    
+    nodes.each do |node|
+      nodeB = getNode( node[:name], node[:version] )
+      @oGraph.add_edge( nodeA, nodeB )
+    end
+  end
+end
+
+def usage 
+  puts "usage: gem2gv [-Tformat] [-ofile] [-h] [-V] gemname"
+  puts "-T, --output-format format    Output format (default: PNG)"
+  puts "-o, --output-file file        Output file (default: STDOUT)"
+  puts "-p, --path                    Graphviz path"
+  puts "-u, --use PROGRAM             Program to use (default: dot)"
+  puts "-s, --stop LIB[,LIB, ...]     Stop on libs"
+  puts "-V, --version                 Show version"
+  puts "-h, --help                    Show this usage message"
+end
+
+def version
+  puts "Gem2GraphViz v#{Constants::RGV_VERSION}, (c)2010 Gregoire Lejeune <gregoire.lejeune@free.fr>"
+  puts ""
+  puts "This program is free software; you can redistribute it and/or modify"
+  puts "it under the terms of the GNU General Public License as published by"
+  puts "the Free Software Foundation; either version 2 of the License, or"
+  puts "(at your option) any later version."
+  puts ""
+  puts "This program is distributed in the hope that it will be useful,"
+  puts "but WITHOUT ANY WARRANTY; without even the implied warranty of"
+  puts "MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the"
+  puts "GNU General Public License for more details."
+  puts ""
+  puts "You should have received a copy of the GNU General Public License"
+  puts "along with this program; if not, write to the Free Software"
+  puts "Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307  USA"
+end
+
+xOutFormat = "png"
+xOutFile = nil
+xGVPath = ""
+xUse = "dot"
+xStops = []
+
+oOpt = GetoptLong.new(
+  ['--output-format', '-T', GetoptLong::REQUIRED_ARGUMENT],
+  ['--output-file',   '-o', GetoptLong::REQUIRED_ARGUMENT],
+  ['--path',          '-p', GetoptLong::REQUIRED_ARGUMENT],
+  ['--use',           '-u', GetoptLong::REQUIRED_ARGUMENT],
+  ['--help',          '-h', GetoptLong::NO_ARGUMENT],
+  ['--version',       '-V', GetoptLong::NO_ARGUMENT]
+)
+
+begin
+  oOpt.each_option do |xOpt, xValue|
+    case xOpt
+      when '--output-format'
+        xOutFormat = xValue
+      when '--output-file'
+        xOutFile = xValue
+      when '--path'
+        xGVPath = xValue
+      when '--use'
+        xUse = xValue
+      when '--help'
+        usage( )
+        exit
+      when '--version'
+        version( )
+        exit
+    end
+  end
+rescue GetoptLong::InvalidOption => e
+  usage( )
+  exit
+end
+
+xGem = ARGV[0]
+
+if xGem.nil? == true
+  usage( )
+  exit
+end
+
+
+g = Gem2Gv.new( xGVPath, xUse )
+g.go( xGem )
+result = g.out( xOutFormat, xOutFile )
+puts result unless result.nil?

data/bin/ruby2gv

@@ -1,5 +1,5 @@
 #!/usr/bin/env ruby
-# Copyright (C) 2005, 2006, 2007 Gregoire Lejeune <gregoire.lejeune@free.fr>
+# Copyright (C) 2005, 2006, 2007, 2008, 2009, 2010 Gregoire Lejeune <gregoire.lejeune@free.fr>
 # 
 # This program is free software; you can redistribute it and/or modify
 # it under the terms of the GNU General Public License as published by
@@ -15,26 +15,29 @@
 # along with this program; if not, write to the Free Software
 # Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307  USA
 
+require 'rubygems'
 require 'getoptlong'
 require 'graphviz'
-require "graphviz/constants"
+require 'graphviz/constants'
 require 'rbconfig'
+require 'mkmf'
 
 DEBUG = false
 
 class Rb2Gv
-  REQUIRE = /^\s*require\s*("|')([^\1]*)(\1)/
+  REQUIRE = /^\s*require\s*("|')([^\1\s]*)(\1)/
 
-  def initialize( xGVPath )
-    @oGraph = GraphViz::new( "G", :path => xGVPath )
-    @oGraph['size'] = '10,10'
+  def initialize( xGVPath, xUse = "dot", xStops = [] )
+    @oGraph = GraphViz::new( "G", :path => xGVPath, :use => xUse )
+    # @oGraph['size'] = '10,10'
     @hxNodes = Hash::new( )
-    @hxEdge = Hash::new( )
+    @hxEdge = Array::new( )
+    @lxStops = xStops
   end
   
   public
   def parse( xFile )
-    @hxNodes[xFile] = gv_newNode( xFile )
+    @hxNodes[xFile] = gv_newNode( xFile, "box", "forestgreen" )
     puts "+ Node #{xFile}" if DEBUG
 
     parseFile( xFile, nil, xFile )
@@ -42,14 +45,14 @@ class Rb2Gv
 
   def out( xFormat = "dot", xFile = nil )
     if xFile.nil? == true
-      @oGraph.output( "output" => xFormat )
+      @oGraph.output( xFormat => String )
     else
-      @oGraph.output( "output" => xFormat, "file" => xFile )
+      @oGraph.output( xFormat => xFile )
     end
   end
   
   private
-  def gv_newNode( xNode, xShape = "box", xColor = nil )
+  def gv_newNode( xNode, xShape = "box", xColor = nil )  
     xNodeName = xNode.gsub( /[^a-zA-Z0-9]/, "_" )
     if xColor.nil? == true
       @oGraph.add_node( xNodeName, "label" => xNode, "shape" => xShape )
@@ -58,20 +61,43 @@ class Rb2Gv
     end
   end
   
-  def getLibraryPath( xLib, xExt = "rb" )
+  def getLibraryPath( xLib, xExt = ["rb"] )
+  
     xPath = [ "libexecdir", "libdir", "sitedir", "rubylibdir", "sitelibdir", "archdir", "sitedir", "sitearchdir" ]
     xRbLib = with_config( xLib+'lib', xLib)
-    if /\.(rb|so)$/.match( xRbLib )
-      xRbFile = xRbLib
+    
+    if /\.(rb|so|bundle|dll)$/.match( xRbLib )
+      match = /^(.*)\.([^\.]*)$/.match(xRbLib)
+      xRbFile, xExt = match[1], [match[2]]
     else
-      xRbFile = xRbLib + "." + xExt
+      xRbFile = xRbLib
     end
     
-    xPath.each do |xDir|
-      xCurrentPath = Config::expand( Config::CONFIG[xDir] )
-      xFileFound = File.join( xCurrentPath, xRbFile )
-      if File.exist?( xFileFound )
-        return xFileFound
+    xExt.each do |e|
+      xRbFileWithExt = xRbFile + "." + e
+    
+      # Search in "standard" paths
+      xPath.each do |xDir|
+        xCurrentPath = Config::expand( Config::CONFIG[xDir] )
+        xFileFound = File.join( xCurrentPath, xRbFileWithExt )
+        if File.exist?( xFileFound )
+          return xFileFound
+        end
+      end
+    
+      # Search in "rubygems" :: This is not utile but...
+      spec = Gem.searcher.find(xLib)
+      unless spec.nil?
+        spec.require_paths.unshift spec.bindir if spec.bindir
+        xPath = spec.require_paths.map do |path|
+          File.join spec.full_gem_path, path
+        end
+        xPath.each do |xCurrentPath|
+          xFileFound = File.join( xCurrentPath, xRbFileWithExt )
+          if File.exist?( xFileFound )
+            return xFileFound
+          end
+        end
       end
     end
 
@@ -92,28 +118,34 @@ class Rb2Gv
     
     xData.each do |xLine|
       if lxLineMatch = REQUIRE.match( xLine )
-        xRequiredLib = lxLineMatch[2]
+        xRequiredLib = lxLineMatch[2].gsub( /\.(rb|so)$/, "" )
         
         if @hxNodes.has_key?( xRequiredLib ) == false
           puts "  + Node #{xRequiredLib}" if DEBUG
 
           xRequiredFile = getLibraryPath( xRequiredLib )
           if xRequiredFile.nil? == false
-            @hxNodes[xRequiredLib] = gv_newNode( xRequiredLib )
-            parseFile( xRequiredFile, xFile, xRequiredLib )
+            unless @lxStops.include?(xRequiredLib)
+              @hxNodes[xRequiredLib] = gv_newNode( xRequiredLib )             
+              parseFile( xRequiredFile, xFile, xRequiredLib )
+            else
+              @hxNodes[xRequiredLib] = gv_newNode( xRequiredLib, "invhouse", "deepskyblue" )
+            end
           else
-            if getLibraryPath( xRequiredLib, "so" ).nil? == false
-              @hxNodes[xRequiredLib] = gv_newNode( xRequiredLib, "ellipse" )
+            if (v = getLibraryPath( xRequiredLib, ["so", "bundle", "dll"] )) == nil
+              @hxNodes[xRequiredLib] = gv_newNode( xRequiredLib, "box", "red" )
             else
-              @hxNodes[xRequiredLib] = gv_newNode( xRequiredLib, "ellipse", "red" )
+              @hxNodes[xRequiredLib] = gv_newNode( xRequiredLib, "box", "grey" )
             end
           end
 
         end
         
         puts "  + Edge #{xLib} -> #{xRequiredLib}" if DEBUG
-        @oGraph.add_edge( @hxNodes[xLib], @hxNodes[xRequiredLib] )
-
+        unless @hxEdge.include?( "#{@hxNodes[xLib].name}-#{@hxNodes[xRequiredLib].name}" )
+          @oGraph.add_edge( @hxNodes[xLib], @hxNodes[xRequiredLib] )
+          @hxEdge << "#{@hxNodes[xLib].name}-#{@hxNodes[xRequiredLib].name}"
+        end
       end
     end
     
@@ -122,16 +154,18 @@ class Rb2Gv
 end
 
 def usage 
-  puts "usage: ruby2gv.rb [-Tformat] [-ofile] [-h] [-V] script"
+  puts "usage: ruby2gv [-Tformat] [-ofile] [-h] [-V] script"
   puts "-T, --output-format format    Output format (default: PNG)"
   puts "-o, --output-file file        Output file (default: STDOUT)"
   puts "-p, --path                    Graphviz path"
+  puts "-u, --use PROGRAM             Program to use (default: dot)"
+  puts "-s, --stop LIB[,LIB, ...]     Stop on libs"
   puts "-V, --version                 Show version"
   puts "-h, --help                    Show this usage message"
 end
 
 def version
-  puts "Ruby2GraphViz v#{Constants::RGV_VERSION}, (c)2005 Gregoire Lejeune <gregoire.lejeune@free.fr>"
+  puts "Ruby2GraphViz v#{Constants::RGV_VERSION}, (c)2005, 2009, 2010 Gregoire Lejeune <gregoire.lejeune@free.fr>"
   puts ""
   puts "This program is free software; you can redistribute it and/or modify"
   puts "it under the terms of the GNU General Public License as published by"
@@ -150,12 +184,16 @@ end
 
 xOutFormat = "png"
 xOutFile = nil
-xGVPath = nil
+xGVPath = ""
+xUse = "dot"
+xStops = []
 
 oOpt = GetoptLong.new(
   ['--output-format', '-T', GetoptLong::REQUIRED_ARGUMENT],
   ['--output-file',   '-o', GetoptLong::REQUIRED_ARGUMENT],
   ['--path',          '-p', GetoptLong::REQUIRED_ARGUMENT],
+  ['--use',           '-u', GetoptLong::REQUIRED_ARGUMENT],
+  ['--stop',          '-s', GetoptLong::REQUIRED_ARGUMENT],
   ['--help',          '-h', GetoptLong::NO_ARGUMENT],
   ['--version',       '-V', GetoptLong::NO_ARGUMENT]
 )
@@ -169,6 +207,10 @@ begin
         xOutFile = xValue
       when '--path'
         xGVPath = xValue
+      when '--use'
+        xUse = xValue
+      when '--stop'
+        xStops = xValue.split( "," ).map{ |x| x.strip }
       when '--help'
         usage( )
         exit
@@ -189,6 +231,7 @@ if xFile.nil? == true
   exit
 end
 
-o = Rb2Gv::new( xGVPath )
+o = Rb2Gv::new( xGVPath, xUse, xStops )
 o.parse( xFile )
-o.out( xOutFormat, xOutFile )
+result = o.out( xOutFormat, xOutFile )
+puts result unless result.nil?

data/examples/HTML-Labels.rb

@@ -7,7 +7,14 @@ g.node["shape"] = "plaintext"
 
 g.add_node( "HTML" )
 
-g.add_node( "struct1", "html" => '<TABLE BORDER="0" CELLBORDER="1" CELLSPACING="0">  <TR><TD>left</TD><TD PORT="f1">mid dle</TD><TD PORT="f2">right</TD></TR> </TABLE>>]; struct2 [label=< <TABLE BORDER="0" CELLBORDER="1" CELLSPACING="0">  <TR><TD PORT="f0">one</TD><TD>two</TD></TR> </TABLE>')
+g.add_node( "struct1", "html" => '
+<TABLE BORDER="0" CELLBORDER="1" CELLSPACING="0">
+  <TR>
+    <TD>left</TD>
+    <TD PORT="f1">mid dle</TD>
+    <TD PORT="f2">right</TD>
+  </TR>
+</TABLE>' )
 
 g.add_node( "struct2", "html" => '<TABLE BORDER="0" CELLBORDER="1" CELLSPACING="0">  <TR><TD PORT="f0">one</TD><TD>two</TD></TR> </TABLE>' )
 g.add_node( "struct3", "html" => '<TABLE BORDER="0" CELLBORDER="1" CELLSPACING="0" CELLPADDING="4">  <TR>  <TD ROWSPAN="3">hello<BR/>world</TD>  <TD COLSPAN="3">b</TD>  <TD ROWSPAN="3">g</TD>  <TD ROWSPAN="3">h</TD>  </TR>  <TR>  <TD>c</TD><TD PORT="here">d</TD><TD>e</TD>  </TR>  <TR>  <TD COLSPAN="3">f</TD>  </TR> </TABLE>' )

data/examples/dot/hello_test.rb

@@ -10,5 +10,5 @@ GraphViz.parse( "hello.dot", :path => "/usr/local/bin" ) { |g|
   g.get_node("World") { |n|
     n.label = "Le Monde"
   }
-}.output(:png => "sample.png")
+}.output(:png => "#{$0}.png")