ruby-graphviz 0.9.13 → 0.9.14

data/README.rdoc

@@ -17,6 +17,11 @@ Interface to the GraphViz graphing tool
 
 == CHANGELOG
 
+=== 0.9.14 :
+* Add dot2ruby script
+* Remove NULL character in the DOT script
+* <b>WARNING</b> : FamilyTree is (still) broken in this version !
+
 === 0.9.13 :
 * Add dot2ruby.g
 * Bug correction with HTML label
@@ -193,11 +198,29 @@ 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
+    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
+    gem2gv -Tpng -oruby-graphviz.png ruby-graphviz
+
+* dot2ruby, a tools that's allow you to create a ruby script from a graphviz script
+
+    $ cat hello.dot
+    digraph G {Hello->World;}
+    
+    $ dot2ruby hello.dot
+    # This code was generated by dot2ruby.g
+    
+    require 'rubygems'
+    require 'graphviz'
+    graph_g = GraphViz.digraph( "G" ) { |graph_g|
+      graph_g[:bb] = '0,0,70,108'
+      node_hello = graph_g.add_node( "Hello", :height => '0.5', :label => '\N', :pos => '35,90', :width => '0.88889' )
+      graph_g.add_edge( "Hello", "World", :pos => 'e,35,36.413 35,71.831 35,64.131 35,54.974 35,46.417' )
+      node_world = graph_g.add_node( "World", :height => '0.5', :label => '\N', :pos => '35,18', :width => '0.97222' )
+    }
+    puts graph_g.output( :canon => String )
 
 At last, you can create familly tree with GraphViz::FamilyTree (<b>beta</b>) :
 

data/bin/dot2ruby

@@ -0,0 +1,116 @@
+#!/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/constants'
+require 'graphviz/ext'
+require 'graphviz/utils'
+require 'getoptlong'
+
+class Dot2Ruby
+  include GVUtils
+  
+  def initialize( xGVPath, xUse, xOutFile )
+    paths = (xGVPath.nil?) ? [] : [xGVPath]
+    @xUsePath = find_executable( xUse, paths )
+    @xGvprPath = find_executable( 'gvpr', paths )
+    @xOutFile = xOutFile
+    @gvprScript = GraphViz::Ext.find( "dot2ruby.g" )
+  end
+  
+  def run( xFile )
+    xCmd = "#{@xUsePath} #{xFile} | #{@xGvprPath} -f #{@gvprScript}"
+    xOutput = output_from_command( xCmd )
+    if @xOutFile.nil?
+      puts xOutput
+    else
+      File.open( @xOutFile, "w" ) do |io|
+        io.print xOutput
+      end
+    end 
+  end
+end
+
+def usage 
+  puts "usage: dot2ruby [-ofile] [-h] [-V] script"
+  puts "-o, --output-file file        Output file (default: STDOUT)"
+  puts "-p, --path                    Graphviz path"
+  puts "-u, --use PROGRAM             Program to use (default: dot)"
+  puts "-V, --version                 Show version"
+  puts "-h, --help                    Show this usage message"
+end
+
+def version
+  puts "Dot2Ruby 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
+
+xOutFile = nil
+xGVPath = nil
+xUse = "dot"
+
+oOpt = GetoptLong.new(
+  ['--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-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
+
+xFile = ARGV[0]
+
+if xFile.nil? == true
+  usage( )
+  exit
+end
+
+Dot2Ruby::new( xGVPath, xUse, xOutFile ).run( xFile )

data/lib/graphviz.rb

@@ -20,6 +20,7 @@ IS_CYGWIN = ((RUBY_PLATFORM =~ /cygwin/) != nil)
 
 require 'tempfile'
 
+require 'graphviz/utils'
 require 'graphviz/node'
 require 'graphviz/edge'
 require 'graphviz/attrs'
@@ -32,6 +33,7 @@ $KCODE = "UTF8"
 
 class GraphViz 
   include Constants
+  include GVUtils
 
   public
 
@@ -434,7 +436,7 @@ class GraphViz
       
       @output = hOutput if hOutput.size > 0
   
-      xDOTScript = "#{@oGraphType} #{@name} {\n" << xDOTScript
+      xDOTScript = ("#{@oGraphType} #{@name} {\n" << xDOTScript).gsub( /\0/, "" )
 
       xOutputString = (@filename == String ||
         @output.any? {|format, file| file == String })
@@ -523,37 +525,6 @@ class GraphViz
   end
   
   alias :save :output
-
-  def output_and_errors_from_command(cmd) #:nodoc:
-   unless defined? Open3
-     begin
-       require 'open3'
-       require 'win32/open3'
-     rescue LoadError
-     end
-   end
-   begin
-     Open3.popen3( cmd ) do |stdin, stdout, stderr|
-       stdin.close
-       stdout.binmode
-       [stdout.read, stderr.read]
-     end
-   rescue NotImplementedError, NoMethodError
-     IO.popen( cmd ) do |stdout|
-       stdout.binmode
-       [stdout.read, nil]
-     end
-   end
-  end
-
-  def output_from_command(cmd) #:nodoc:
-   output, errors = output_and_errors_from_command(cmd)
-   if errors.nil? || errors.strip.empty?
-     output
-   else
-     raise "Error from #{cmd}:\n#{errors}"
-   end
-  end
   
   # 
   # Get the graph name
@@ -763,67 +734,4 @@ class GraphViz
     end
   end
   
-  # Since this code is an adaptation of Launchy::Application#find_executable
-  # (http://copiousfreetime.rubyforge.org/launchy/Launchy/Application.html)
-  # it follow is licence :
-  #
-  # Permission to use, copy, modify, and/or distribute this software for any 
-  # purpose with or without fee is hereby granted, provided that the above 
-  # copyright notice and this permission notice appear in all copies.
-  #
-  # THE SOFTWARE IS PROVIDED AS IS AND THE AUTHOR DISCLAIMS ALL WARRANTIES 
-  # WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF 
-  # MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY 
-  # SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES 
-  # WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN ACTION 
-  # OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN 
-  # CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
-  def find_executable(bin, paths) #:nodoc:
-    paths = ENV['PATH'].split(File::PATH_SEPARATOR) if paths.nil? or paths.empty?
-    
-    paths.each do |path|    
-      file = (path.nil?)?bin:File.join(path,bin)
-      if File.executable?(file) and not File.directory?(file) then
-        return file
-      elsif RUBY_PLATFORM =~ /mswin|mingw/
-        found_ext = (ENV['PATHEXT'] || '.exe;.bat;.com').split(";").find {|ext| File.executable?(file + ext) }
-        return file + found_ext if found_ext
-      end
-    end
-    return nil
-  end
-#   def find_executable(bin = @prog, *paths) #:nodoc:
-#   
-#     paths = ENV['PATH'].split(File::PATH_SEPARATOR) if paths.empty?
-#     paths.each do |path|
-#       file = File.join(path, add_exe_suffix(bin))
-#       if File.executable?(file) then
-#         return file
-#       end
-#     end
-#     return nil
-#   end
-
-  def add_exe_suffix(prog) #:nodoc:
-    if /Windows/.match( ENV['OS'] )
-      suffix = '.exe'
-    else
-      suffix = ''
-    end
-    "#{prog}#{suffix}"
-  end
-
-  def escape_path_containing_blanks(path) #:nodoc:
-    path.gsub!(File::ALT_SEPARATOR, File::SEPARATOR) if File::ALT_SEPARATOR
-    path_elements = path.split(File::SEPARATOR)
-    path_elements.map! do |element|
-      if element.include?(' ')
-        "\"#{element}\""
-      else
-        element
-      end
-    end
-    path_elements.join(File::SEPARATOR)
-  end
-
 end

data/lib/graphviz/constants.rb

@@ -40,7 +40,7 @@
 #   C => cluster
 #
 module Constants
-  RGV_VERSION = "0.9.13"
+  RGV_VERSION = "0.9.14"
   
   ## Const: Output formats
   FORMATS = [

data/lib/graphviz/ext.rb

@@ -0,0 +1,17 @@
+require 'find'
+
+class GraphViz
+  class Ext
+    def self.find( ext = nil )
+      myPath = File.join( File.dirname( File.expand_path( __FILE__ ) ), "..", "ext" )
+      found = myPath
+      unless ext.nil?
+        Find.find(myPath) do |path|
+          found = path if File.basename( path ) == ext
+        end
+      end
+      
+      File.expand_path( found )
+    end
+  end
+end

data/lib/graphviz/utils.rb

@@ -0,0 +1,76 @@
+module GVUtils
+  # Since this code is an adaptation of Launchy::Application#find_executable
+  # (http://copiousfreetime.rubyforge.org/launchy/Launchy/Application.html)
+  # it follow is licence :
+  #
+  # Permission to use, copy, modify, and/or distribute this software for any 
+  # purpose with or without fee is hereby granted, provided that the above 
+  # copyright notice and this permission notice appear in all copies.
+  #
+  # THE SOFTWARE IS PROVIDED AS IS AND THE AUTHOR DISCLAIMS ALL WARRANTIES 
+  # WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF 
+  # MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY 
+  # SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES 
+  # WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN ACTION 
+  # OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN 
+  # CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
+  def find_executable(bin, paths) #:nodoc:
+    paths = ENV['PATH'].split(File::PATH_SEPARATOR) if paths.nil? or paths.empty?
+  
+    paths.each do |path|    
+      file = (path.nil?)?bin:File.join(path,bin)
+      if File.executable?(file) and not File.directory?(file) then
+        return file
+      elsif RUBY_PLATFORM =~ /mswin|mingw/
+        found_ext = (ENV['PATHEXT'] || '.exe;.bat;.com').split(";").find {|ext| File.executable?(file + ext) }
+        return file + found_ext if found_ext
+      end
+    end
+    return nil
+  end
+  
+  def escape_path_containing_blanks(path) #:nodoc:
+    path.gsub!(File::ALT_SEPARATOR, File::SEPARATOR) if File::ALT_SEPARATOR
+    path_elements = path.split(File::SEPARATOR)
+    path_elements.map! do |element|
+      if element.include?(' ')
+        "\"#{element}\""
+      else
+        element
+      end
+    end
+    path_elements.join(File::SEPARATOR)
+  end
+  
+  def output_and_errors_from_command(cmd) #:nodoc:
+   unless defined? Open3
+     begin
+       require 'open3'
+       require 'win32/open3'
+     rescue LoadError
+     end
+   end
+   begin
+     Open3.popen3( cmd ) do |stdin, stdout, stderr|
+       stdin.close
+       stdout.binmode
+       [stdout.read, stderr.read]
+     end
+   rescue NotImplementedError, NoMethodError
+     IO.popen( cmd ) do |stdout|
+       stdout.binmode
+       [stdout.read, nil]
+     end
+   end
+  end
+
+  def output_from_command(cmd) #:nodoc:
+   output, errors = output_and_errors_from_command(cmd)
+   if errors.nil? || errors.strip.empty?
+     output
+   else
+     raise "Error from #{cmd}:\n#{errors}"
+   end
+  end
+  
+end

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: ruby-graphviz
 version: !ruby/object:Gem::Version 
-  hash: 33
+  hash: 39
   prerelease: false
   segments: 
   - 0
   - 9
-  - 13
-  version: 0.9.13
+  - 14
+  version: 0.9.14
 platform: ruby
 authors: 
 - Gregoire Lejeune
@@ -15,7 +15,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-07-06 00:00:00 +02:00
+date: 2010-07-12 00:00:00 +02:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -37,6 +37,7 @@ email: gregoire.lejeune@free.fr
 executables: 
 - ruby2gv
 - gem2gv
+- dot2ruby
 extensions: []
 
 extra_rdoc_files: 
@@ -48,6 +49,7 @@ files:
 - README.rdoc
 - AUTHORS
 - setup.rb
+- bin/dot2ruby
 - bin/gem2gv
 - bin/ruby2gv
 - examples/dot/balanced.dot
@@ -132,13 +134,12 @@ files:
 - examples/simpsons.gv
 - examples/test.xml
 - lib/ext/gvpr/dot2ruby.g
-- lib/ext/gvpr/toto.gv
-- lib/ext/gvpr/toto.rb
 - lib/graphviz/attrs.rb
 - lib/graphviz/constants.rb
 - lib/graphviz/core_ext.rb
 - lib/graphviz/dot.treetop
 - lib/graphviz/edge.rb
+- lib/graphviz/ext.rb
 - lib/graphviz/family_tree/couple.rb
 - lib/graphviz/family_tree/generation.rb
 - lib/graphviz/family_tree/person.rb
@@ -152,6 +153,7 @@ files:
 - lib/graphviz/types/html_string.rb
 - lib/graphviz/types/lbl_string.rb
 - lib/graphviz/types.rb
+- lib/graphviz/utils.rb
 - lib/graphviz/xml.rb
 - lib/graphviz.rb
 - test/support.rb