ruby-graphviz 0.9.10 → 0.9.11

data/examples/sample37.rb

@@ -0,0 +1,87 @@
+$:.unshift( "../lib" )
+require "graphviz"
+
+# The goal is to set each planet to its own orbit + set some (earth+moon) to the same orbit
+
+g = GraphViz::new( "Solarsys",
+ :type => "digraph",
+ :use => "twopi"
+)
+
+# the star
+sun  = g.add_node(
+ 'Sun',
+ :shape => "circle",
+ :penwidth => 2,
+ :fontsize => 12,
+ :style => :filled,
+ :fillcolor => "orange",
+ :label => "Sun\n"
+)
+
+planets = Hash.new
+
+# The Earth and the Moon - in the same subgraph\rank
+g.subgraph { |c|
+ c[:rank => 'same']
+ planets['Moon']  = c.add_node(
+   'Moon',
+   :shape => "circle",
+   :penwidth => 2,
+   :fontsize => 12,
+   :style => :filled,
+   :fillcolor => "red",
+   :label => "Moon\n"
+ )
+ planets['Earth']  = c.add_node(
+   'Earth',
+   :shape => "circle",
+   :penwidth => 2,
+   :fontsize => 12,
+   :style => :filled,
+   :fillcolor => "blue",
+   :label => "Earth\n"
+ )
+ c.add_edge( planets['Moon'], planets['Earth'],
+   :penwidth => 2,
+   :labeltooltip => "distance",
+   :color => "black"
+ )
+
+
+}
+
+g.add_edge( sun, planets['Earth'],
+  :penwidth => 2,
+  :labeltooltip => "distance",
+  :color => "black"
+)
+
+i = 0
+# some more planets - each supposed having its own orbit - im trying to do it with rank
+['Mercury','Venus','Mars','Jupiter','Saturn','Uranus','Neptune','Pluto'].each { |p|
+  i = i + 1
+ # set each to its own orbit
+ # that doesnt seem to work ...
+ g.subgraph { |c|
+   c[:rank => "same"]
+   planets[p] = c.add_node(
+     p,
+     :shape => "circle",
+     :penwidth => 2,
+     :fontsize => 12,
+     :fillcolor => "green",
+     :style => :filled,
+     :label => "#{p}\n"
+   )
+   c.add_edge( sun, planets[p],
+     :penwidth => 2,
+     :label => "distance",
+     :color => "black"
+   )
+ }
+
+}
+
+g.output( :png => "#{$0}.png" )
+g.output( :none => "#{$0}.dot" )

data/examples/sample37.rb.dot

@@ -0,0 +1,50 @@
+digraph Solarsys {
+  Sun [label = "Sun\n", penwidth = "2", fillcolor = "orange", shape = "circle", fontsize = "12", style = "filled"];
+subgraph  {
+  rank = "same";
+  Moon [label = "Moon\n", penwidth = "2", fillcolor = "red", shape = "circle", fontsize = "12", style = "filled"];
+  Earth [label = "Earth\n", penwidth = "2", fillcolor = "blue", shape = "circle", fontsize = "12", style = "filled"];
+  Moon -> Earth [penwidth = "2", color = "black", labeltooltip = "distance"]
+}
+  Sun -> Earth [penwidth = "2", color = "black", labeltooltip = "distance"]
+subgraph  {
+  rank = "same";
+  Mercury [label = "Mercury\n", penwidth = "2", fillcolor = "green", shape = "circle", fontsize = "12", style = "filled"];
+  Sun -> Mercury [label = "distance", penwidth = "2", color = "black"]
+}
+subgraph  {
+  rank = "same";
+  Venus [label = "Venus\n", penwidth = "2", fillcolor = "green", shape = "circle", fontsize = "12", style = "filled"];
+  Sun -> Venus [label = "distance", penwidth = "2", color = "black"]
+}
+subgraph  {
+  rank = "same";
+  Mars [label = "Mars\n", penwidth = "2", fillcolor = "green", shape = "circle", fontsize = "12", style = "filled"];
+  Sun -> Mars [label = "distance", penwidth = "2", color = "black"]
+}
+subgraph  {
+  rank = "same";
+  Jupiter [label = "Jupiter\n", penwidth = "2", fillcolor = "green", shape = "circle", fontsize = "12", style = "filled"];
+  Sun -> Jupiter [label = "distance", penwidth = "2", color = "black"]
+}
+subgraph  {
+  rank = "same";
+  Saturn [label = "Saturn\n", penwidth = "2", fillcolor = "green", shape = "circle", fontsize = "12", style = "filled"];
+  Sun -> Saturn [label = "distance", penwidth = "2", color = "black"]
+}
+subgraph  {
+  rank = "same";
+  Uranus [label = "Uranus\n", penwidth = "2", fillcolor = "green", shape = "circle", fontsize = "12", style = "filled"];
+  Sun -> Uranus [label = "distance", penwidth = "2", color = "black"]
+}
+subgraph  {
+  rank = "same";
+  Neptune [label = "Neptune\n", penwidth = "2", fillcolor = "green", shape = "circle", fontsize = "12", style = "filled"];
+  Sun -> Neptune [label = "distance", penwidth = "2", color = "black"]
+}
+subgraph  {
+  rank = "same";
+  Pluto [label = "Pluto\n", penwidth = "2", fillcolor = "green", shape = "circle", fontsize = "12", style = "filled"];
+  Sun -> Pluto [label = "distance", penwidth = "2", color = "black"]
+}
+}

data/examples/sample38.rb

@@ -0,0 +1,11 @@
+$:.unshift( "../lib" )
+require "graphviz"
+
+g = GraphViz::new( :G ) { |g|
+  g.a[:label => "ε"]
+  g.add_node( "b", :label => "ε" )
+  g.c[:label => 'ε']
+  g.add_node( "d", :label => 'ε' )
+}
+
+puts g.output( :none => String, :png => "#{$0}.png", :path => "/usr/local/bin" )

data/lib/graphviz.rb

@@ -15,12 +15,8 @@
 # Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307  USA
 
 
-begin
-  include Java
-  IS_JRUBY = true
-rescue
-  IS_JRUBY= false
-end
+IS_JRUBY = (defined?( JRUBY_VERSION ) != nil)
+IS_CYGWIN = ((RUBY_PLATFORM =~ /cygwin/) != nil)
 
 require 'tempfile'
 
@@ -393,6 +389,8 @@ class GraphViz
 
       return( xDOTScript )
     else
+      hOutput = {}
+      
       hOpts.each do |xKey, xValue|
         xValue = xValue.to_s unless xValue.nil? or [Class, TrueClass, FalseClass].include?(xValue.class)
         case xKey.to_s
@@ -420,19 +418,30 @@ class GraphViz
             if FORMATS.index( xKey.to_s ).nil? == true
               raise ArgumentError, "output format '#{xValue}' invalid"
             end
-            @output[xKey.to_s] = xValue
+            hOutput[xKey.to_s] = xValue
         end
       end
+      
+      @output = hOutput if hOutput.size > 0
   
       xDOTScript = "#{@oGraphType} #{@name} {\n" << xDOTScript
 
       xOutputString = (@filename == String ||
         @output.any? {|format, file| file == String })
         
-      xOutput =
-      if @format.to_s == "none" || @output.any? {|fmt, fn| fmt.to_s == "none" }
-        xDOTScript
-      else
+      xOutput = ""
+      if @format.to_s == "none" or @output.any? {|fmt, fn| fmt.to_s == "none"}
+        if xOutputString
+          xOutput << xDOTScript
+        else
+          xFileName = @output["none"] || @filename
+          open( xFileName, "w" ) do |h|
+            h.puts xDOTScript
+          end
+        end
+      end
+      
+      if (@format.to_s != "none" and not @format.nil?) or (@output.any? {|format, file| format != "none" } and @output.size > 0)
         ## Act: Save script and send it to dot
         t = Tempfile::open( File.basename($0) )
         t.print( xDOTScript )
@@ -447,15 +456,15 @@ class GraphViz
 
         xOutputWithFile = ""
         xOutputWithoutFile = ""
-        unless @format.nil?
-          if @filename.nil? || @filename == String
+        unless @format.nil? or @format == "none"
+          if @filename.nil? or @filename == String
             xOutputWithoutFile = "-T#{@format} "
           else
             xOutputWithFile = "-T#{@format} -o#{@filename} "
           end
         end
-        @output.each do |format, file|
-          if file.nil? || file == String
+        @output.each_except( :key => ["none"] ) do |format, file|
+          if file.nil? or file == String
             xOutputWithoutFile << "-T#{format} "
           else
             xOutputWithFile << "-T#{format} -o#{file} "
@@ -469,11 +478,19 @@ class GraphViz
         
         if IS_JRUBY
           xCmd = "#{cmd} -q#{@errors} #{xExternalLibraries} #{xOutputWithFile} #{xOutputWithoutFile} #{t.path}"
+        elsif IS_CYGWIN
+          tmpPath = t.path
+          begin
+            tmpPath = "'" + `cygpath -w #{t.path}`.chomp + "'"
+          rescue
+            warn "cygpath is not installed!"
+          end
+          xCmd = "\"#{cmd}\" -q#{@errors} #{xExternalLibraries} #{xOutputWithFile} #{xOutputWithoutFile} #{tmpPath}"
         else
           xCmd = "\"#{cmd}\" -q#{@errors} #{xExternalLibraries} #{xOutputWithFile} #{xOutputWithoutFile} #{t.path}"
         end
 
-        output_from_command( xCmd )
+        xOutput << output_from_command( xCmd )
       end
             
       if xOutputString
@@ -743,7 +760,7 @@ class GraphViz
     
     paths.each do |path|    
       file = (path.nil?)?bin:File.join(path,bin)
-      if File.executable?(file) then
+      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) }

data/lib/graphviz/constants.rb

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

data/lib/graphviz/core_ext.rb

@@ -17,4 +17,27 @@ class Hash
       options
     end
   end
+  
+  # x = {
+  #   :none => String,
+  #   :png => "file.png",
+  #   :svg => "file.svg"
+  # }
+  # 
+  # x.each_except( :key => [:none], :value => [/\.png$/] ) do |k, v|
+  #   puts "#{k} -> #{v}"
+  # end
+  #
+  # => svg -> file.svg
+  def each_except( e, &b )
+    key_table = (e[:key]||[]).clone.delete_if {|i| i.kind_of? Regexp }
+    key_regexp = (e[:key]||[]).clone.delete_if {|i| key_table.include? i }.map {|i| i.to_s }.join("|")
+
+    value_table = (e[:value]||[]).clone.delete_if {|i| i.kind_of? Regexp }
+    value_regexp = (e[:value]||[]).clone.delete_if {|i| value_table.include? i }.map {|i| i.to_s }.join("|")
+
+    self.each do |k, v|
+      yield( k, v ) unless (key_table.size > 0 and key_table.include?(k)) or (key_regexp.size > 0 and k.to_s.match(key_regexp)) or (value_table.size > 0 and value_table.include?(v)) or (value_regexp.size > 0 and v.to_s.match(value_regexp))
+    end
+  end
 end

data/lib/graphviz/family_tree.rb

@@ -6,6 +6,12 @@ require 'graphviz/family_tree/couple'
 
 class GraphViz
   class FamilyTree
+    # Create a new family tree
+    #
+    #   require 'graphviz/family_tree'
+    #   t = GraphViz::FamilyTree.new do
+    #     ...
+    #   end
     def initialize( &block )
       @persons = {}
       @graph = GraphViz.new( "FamilyTree" )
@@ -15,30 +21,43 @@ class GraphViz
       instance_eval(&block) if block
     end
     
+    # Add a new generation in the tree
+    #
+    #   require 'graphviz/family_tree'
+    #   t = GraphViz::FamilyTree.new do
+    #     generation do
+    #       ...
+    #     end
+    #     generation do
+    #       ...
+    #     end
+    #   end
     def generation( &b )
       GraphViz::FamilyTree::Generation.new( @graph, @persons, self, @generation ).make( &b )
       @generation += 1
     end
     
-    def persons
+    def persons #:nodoc:
       @persons ||= {}
     end
     
-    def add_couple( x, y, node )
+    def add_couple( x, y, node ) #:nodoc:
       @couples[x] = {} if @couples[x].nil?
       @couples[x][y] = GraphViz::FamilyTree::Couple.new( @graph, node )
       @couples[y] = {} if @couples[y].nil?
       @couples[y][x] = @couples[x][y]
     end
     
-    def couple( x, y )
+    # Get a couple (GraphViz::FamilyTree::Couple)
+    def couple( x, y ) 
       @couples[x][y]
     end
     
-    def method_missing(sym, *args, &block)
+    def method_missing(sym, *args, &block) #:nodoc:
       persons[sym.to_s]
     end
     
+    # Get the graph
     def graph
       @graph
     end

data/lib/graphviz/family_tree/couple.rb

@@ -1,15 +1,16 @@
 class GraphViz
   class FamilyTree
     class Couple
-      def initialize( g, n )
+      def initialize( g, n ) #:nodoc:
         @graph = g
         @node = n
       end
       
-      def node
+      def node #:nodoc:
         @node
       end
       
+      # Add kids to a couple
       def kids( *z )
         if z.size == 1
           @graph.add_edge( @node, z[0].node, "dir" => "none" )

data/lib/graphviz/family_tree/generation.rb

@@ -1,7 +1,7 @@
 class GraphViz
   class FamilyTree
     class Generation
-      def initialize( graph, persons, tree, gen_number )
+      def initialize( graph, persons, tree, gen_number ) #:nodoc:
         @graph = graph
         @persons = persons
         @cluster = @graph.add_graph( "Generation#{gen_number}" )
@@ -9,15 +9,15 @@ class GraphViz
         @tree = tree
       end
       
-      def persons
+      def persons #:nodoc:
         @persons
       end
       
-      def make( &block )
+      def make( &block ) #:nodoc:
         instance_eval(&block) if block
       end
       
-      def method_missing(sym, *args, &block)
+      def method_missing(sym, *args, &block) #:nodoc:
         persons[sym.to_s] ||= GraphViz::FamilyTree::Person.new( @graph, @cluster, @tree, sym.to_s )
       end
     end

data/lib/graphviz/family_tree/person.rb

@@ -4,7 +4,7 @@ require 'graphviz'
 class GraphViz
   class FamilyTree
     class Person
-      def initialize( graph, cluster, tree, name )
+      def initialize( graph, cluster, tree, name ) #:nodoc:
         @graph = graph
         @cluster = cluster
         @node = @cluster.add_node( name )
@@ -12,30 +12,45 @@ class GraphViz
         @tree = tree
       end
       
-      def couples
+      def couples #:nodoc:
         @couples
       end
       
-      def node
+      def node #:nodoc:
         @node
       end
       
+      # Define the current person as a man
+      #
+      #  greg.is_a_man( "Greg" )
       def is_a_man( name )
         @node["label"] = name
         @node["color"] = "blue"
       end
+      # Define the current person as a boy
+      #
+      #  greg.is_a_boy( "Greg" )
       def is_a_boy( name )
         is_a_man( name )
       end
       
+      # Define the current perdon as a woman
+      #
+      #  mu.is_a_woman( "Muriel" )
       def is_a_woman( name )
         @node["label"] = name
         @node["color"] = "pink"
       end
+      # Define the current perdon as a girl
+      #
+      #  maia.is_a_girl( "Maia" )
       def is_a_girl( name )
         is_a_woman( name )
       end
       
+      # Define that's two persons are maried
+      #
+      #  mu.is_maried_with greg
       def is_maried_with( x )
         node = @cluster.add_node( "#{@node.name}And#{x.node.name}" )
         node["shape"] = "point"
@@ -44,6 +59,9 @@ class GraphViz
         @tree.add_couple( self, x, node )
       end
       
+      # Define that's two persons are divorced
+      #
+      #  sophie.is_divorced_with john
       def is_divorced_with( x )
         node = @cluster.add_node( "#{@node.name}And#{x.node.name}" )
         node["shape"] = "point"
@@ -53,6 +71,9 @@ class GraphViz
         @tree.add_couple( self, x, node )
       end
       
+      # Define that's a person is widower of another
+      #
+      #  simon.is_widower_of elisa
       def is_widower_of( x ) #veuf
         node = @cluster.add_node( "#{@node.name}And#{x.node.name}" )
         node["shape"] = "point"
@@ -62,6 +83,9 @@ class GraphViz
         @tree.add_couple( self, x, node )
       end
 
+      # Define the kids of a single person
+      #
+      #   alice.kids( john, jack, julie )
       def kids( *z )
         GraphViz::FamilyTree::Couple.new( @graph, @node ).kids( *z )
       end