= 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.
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.