ograph 0.0.1

data/History.txt

@@ -0,0 +1,4 @@
+== 0.0.1 / 2007-01-14
+
+* Birthday!
+

data/Manifest.txt

@@ -0,0 +1,5 @@
+History.txt
+Manifest.txt
+README.txt
+Rakefile
+lib/ograph.rb

data/README.txt

@@ -0,0 +1,56 @@
+= ObjectGraph
+
+  http://rubyforge.org/projects/seattlerb
+  http://seattlerb.rubyforge.org/
+
+== DESCRIPTION
+
+ObjectGraph will output Graphviz dot files of your objects in memory.  It will
+ferret out your instance variables and enumerate over your enumerables to
+give you a graph of your object and its relationships.
+
+For sample output and more sample code see:
+
+* http://flickr.com/photos/aaronp/tags/graphviz/
+* http://tenderlovemaking.com/2007/01/13/graphing-objects-in-memory-with-ruby/
+
+== PROBLEMS
+
+The output graph kind of lies when displaying Hashes.  A Hash will point to
+an Array with a key and value.  If the hash contains 7 pairs, it will point
+to 7 Arrays.
+
+== SYNOPSYS
+
+  list = %w{ hello world how are you? }
+  hash = { :list => list, :string => "tenderlovemaking.com" }
+  puts ObjectGraph.graph(hash)
+
+== INSTALL
+
+* sudo gem install ograph
+
+== LICENSE
+
+(The MIT License)
+
+Copyright (c) 2007 Aaron Patterson, Seattle.rb
+
+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.

data/Rakefile

@@ -0,0 +1,14 @@
+require 'rubygems'
+require 'hoe'
+require './lib/ograph.rb'
+
+Hoe.new('ograph', ObjectGraph::VERSION) do |p|
+  p.rubyforge_name  = 'ograph'
+  p.author          = 'Aaron Patterson'
+  p.email           = 'aaronp@rubyforge.org'
+  p.summary         = p.paragraphs_of('README.txt', 3).join("\n\n")
+  p.description     = p.paragraphs_of('README.txt', 3..5).join("\n\n")
+  p.url = p.paragraphs_of('README.txt', 1).first.split(/\n/)[1..-1].first.strip
+  p.changes         = p.paragraphs_of('History.txt', 0..1).join("\n\n")
+end
+

data/lib/ograph.rb

@@ -0,0 +1,72 @@
+class ObjectGraph
+  VERSION = '0.0.1'
+
+  def self.graph(target, opts = {})
+    opts = {  :class_filter => /./,
+              :show_ivars   => true,
+              :show_nil     => true,
+    }.merge(opts)
+
+    stack         = [target]
+    object_links  = []
+    seen_objects  = []
+    seen_hash     = {}
+
+    while stack.length > 0
+      object = stack.pop
+      next if seen_hash.key? object.object_id
+      seen_hash[object.object_id] = 1
+
+      if object.is_a?(Enumerable) && ! object.is_a?(String)
+        object.each { |iv|
+          next if iv.nil? && ! opts[:show_nil]
+          if iv.class.to_s =~ opts[:class_filter] || object.is_a?(Enumerable)
+            object_links.push([object.object_id, iv.object_id, nil])
+            stack.push(iv)
+          end
+        }
+      end
+
+      ivars = object.instance_variables.sort
+      ivars.each_with_index do |iv_sym, i|
+        iv = object.instance_variable_get iv_sym
+        next if iv.nil? && ! opts[:show_nil]
+        if iv.class.to_s =~ opts[:class_filter] || iv.is_a?(Enumerable)
+          object_links.push([ object.object_id,
+                              iv.object_id,
+                              opts[:show_ivars] ? i : nil])
+          stack.push(iv)
+        end
+      end
+
+      seen_objects.push([ object.object_id,
+                          object.class ] + (opts[:show_ivars] ? ivars : []))
+    end
+
+    s = <<END
+digraph g {
+    graph [ rankdir = "LR" ];
+    node [ fontsize = "8"
+           shape = "ellipse"
+    ];
+    edge [ ];
+END
+    seen_objects.each { |id, *rest|
+      s += "\"#{id}\" [\nlabel="
+      list = []
+      [id, *rest].each_with_index { |field, i|
+        list << "<f#{i}>#{field}"
+      }
+      s += "\"#{list.join('|')}\"\n"
+      s += <<END
+      shape = "record"
+      ]
+END
+    }
+    object_links.each_with_index { |(from, to, x), i|
+      s += "\"#{from}\":f#{x ? x + 2 : 0} -> \"#{to}\":f0 [ id = #{i} ]\n"
+    }
+    s += "}\n"
+    s
+  end
+end

metadata

@@ -0,0 +1,58 @@
+--- !ruby/object:Gem::Specification 
+rubygems_version: 0.9.0
+specification_version: 1
+name: ograph
+version: !ruby/object:Gem::Version 
+  version: 0.0.1
+date: 2007-01-20 00:00:00 -08:00
+summary: ObjectGraph will output Graphviz dot files of your objects in memory.  It will ferret out your instance variables and enumerate over your enumerables to give you a graph of your object and its relationships.
+require_paths: 
+  - lib
+email: aaronp@rubyforge.org
+homepage: http://seattlerb.rubyforge.org/
+rubyforge_project: ograph
+description: "ObjectGraph will output Graphviz dot files of your objects in memory.  It will
+  ferret out your instance variables and enumerate over your enumerables to give
+  you a graph of your object and its relationships.  For sample output and more
+  sample code see:  * http://flickr.com/photos/aaronp/tags/graphviz/ *
+  http://tenderlovemaking.com/2007/01/13/graphing-objects-in-memory-with-ruby/"
+autorequire: 
+default_executable: 
+bindir: bin
+has_rdoc: true
+required_ruby_version: !ruby/object:Gem::Version::Requirement 
+  requirements: 
+    - 
+      - ">"
+      - !ruby/object:Gem::Version 
+        version: 0.0.0
+  version: 
+platform: ruby
+signing_key: 
+cert_chain: 
+post_install_message: 
+authors: 
+  - Aaron Patterson
+files: 
+  - History.txt
+  - Manifest.txt
+  - README.txt
+  - Rakefile
+  - lib/ograph.rb
+test_files: []
+rdoc_options: []
+extra_rdoc_files: []
+executables: []
+extensions: []
+requirements: []
+dependencies: 
+  - !ruby/object:Gem::Dependency 
+    name: hoe
+    version_requirement: 
+    version_requirements: !ruby/object:Gem::Version::Requirement 
+      requirements: 
+        - 
+          - ">="
+          - !ruby/object:Gem::Version 
+            version: 1.1.6
+      version: