awkward 1.0.0

data/.autotest

@@ -0,0 +1,23 @@
+# -*- ruby -*-
+
+require 'autotest/restart'
+
+# Autotest.add_hook :initialize do |at|
+#   at.extra_files << "../some/external/dependency.rb"
+#
+#   at.libs << ":../some/external"
+#
+#   at.add_exception 'vendor'
+#
+#   at.add_mapping(/dependency.rb/) do |f, _|
+#     at.files_matching(/test_.*rb$/)
+#   end
+#
+#   %w(TestA TestB).each do |klass|
+#     at.extra_class_map[klass] = "test/test_misc.rb"
+#   end
+# end
+
+# Autotest.add_hook :run_command do |at|
+#   system "rake build"
+# end

data/CHANGELOG.rdoc

@@ -0,0 +1,6 @@
+=== 1.0.0 / 2010-11-12
+
+* 1 major enhancement
+
+  * Birthday!
+

data/Manifest.txt

@@ -0,0 +1,8 @@
+.autotest
+CHANGELOG.rdoc
+Manifest.txt
+README.rdoc
+Rakefile
+lib/awkward.rb
+lib/awkward/visitor.rb
+test/test_awkward.rb

data/README.rdoc

@@ -0,0 +1,60 @@
+= awkward
+
+* http://github.com/tenderlove/awkward
+
+== DESCRIPTION:
+
+Awkward helps you walk your Object Graph and output a dot file suitable for
+viewing in Graphviz.  Awkward doesn't know how to visit your objects, so you
+must teach it by implementing a subclass of Awkward::Visitor.
+
+== FEATURES/PROBLEMS:
+
+* May not work
+
+== SYNOPSIS:
+
+  class MyVisitor < Awkward::Visitor
+    def visit_My_Object object
+      edge(:some_method) do
+        visit object.some_method
+      end
+    end
+  end
+
+  viz = MyVisitor.new
+  viz.accept my_object
+  puts viz.to_dot
+
+== REQUIREMENTS:
+
+* FIX (list of requirements)
+
+== INSTALL:
+
+* FIX (sudo gem install, anything else)
+
+== LICENSE:
+
+(The MIT License)
+
+Copyright (c) 2010 Aaron Patterson
+
+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,13 @@
+# -*- ruby -*-
+
+require 'rubygems'
+require 'hoe'
+
+Hoe.spec 'awkward' do
+  developer('Aaron Patterson', 'aaron@tenderlovemaking.com')
+  self.readme_file   = 'README.rdoc'
+  self.history_file  = 'CHANGELOG.rdoc'
+  self.extra_rdoc_files  = FileList['*.rdoc']
+end
+
+# vim: syntax=ruby

data/lib/awkward.rb

@@ -0,0 +1,5 @@
+require 'awkward/visitor'
+
+module Awkward
+  VERSION = '1.0.0'
+end

data/lib/awkward/visitor.rb

@@ -0,0 +1,101 @@
+module Awkward
+  class Visitor
+    class Node < Struct.new :object, :name, :value # :nodoc:
+      def initialize object
+        super(object, object.class.name)
+      end
+    end
+
+    Edge = Struct.new :name, :left, :right
+
+    attr_reader :edges
+
+    def initialize
+      @nodes     = []
+      @stack     = []
+      @edges     = []
+      @callstack = []
+      @seen      = {}
+    end
+
+    def nodes
+      @seen.values
+    end
+
+    def accept o
+      return connect(@stack.last, @seen[o.object_id]) if @seen.key? o.object_id
+
+      node = Node.new o
+
+      @seen[o.object_id] = node
+
+      connect(@stack.last, node) unless @callstack.empty?
+
+      @stack.push node
+
+      send "visit_#{o.class.name.gsub('::', '_')}", o
+
+      @stack.pop
+    end
+
+    def to_dot
+      dot = <<-eodot
+digraph "Graph" {
+node [width=0.375,height=0.25,shape = "record"];
+      eodot
+
+      nodes.each do |node|
+        dot.concat <<-eonode
+        #{node.object_id} [label="<f0> #{[node.name, node.value].compact.join('|')}"];
+        eonode
+      end
+
+      edges.each do |edge|
+        dot.concat <<-eoedge
+        #{edge.left.object_id} -> #{edge.right.object_id} [label="#{edge.name}"];
+        eoedge
+      end
+      dot + "}"
+    end
+
+    private
+
+    def visit_Hash o
+      o.each_with_index do |(k,v),i|
+        edge("key: #{i}") { accept k }
+        edge("value: #{i}") { accept v }
+      end
+    end
+
+    def visit_Array o
+      o.each_with_index do |v, i|
+        edge(i) { accept v }
+      end
+    end
+
+
+    def escape string
+      string.gsub '"', '\"'
+    end
+
+    def visit_Symbol o
+      @seen[o.object_id].value = escape(o.to_s)
+    end
+
+    alias :visit_String :visit_Symbol
+    alias :visit_Regexp :visit_Symbol
+    alias :visit_Fixnum :visit_Symbol
+    alias :visit_Bignum :visit_Symbol
+    alias :visit_Float :visit_Symbol
+
+    def edge sym
+      @callstack.push sym
+      yield
+      @callstack.pop
+    end
+
+    def connect from, to
+      @edges << Edge.new(@callstack.last, from, to)
+    end
+  end
+end

data/test/test_awkward.rb

@@ -0,0 +1,54 @@
+require "test/unit"
+require "awkward"
+
+class TestAwkward < Test::Unit::TestCase
+  def setup
+    @tree = {
+      :foo => { 'bar' => %w{ a b c } }
+    }
+    @awkward = Awkward::Visitor.new
+  end
+
+  def test_leaves
+    [
+      /foo/,
+      1,
+      470948572349857203498572049358729345872345123435465,
+      "adsfadsfadsf",
+      1.2,
+      :foo,
+    ].each do |value|
+      @awkward.accept value
+    end
+  end
+
+  def test_nodes
+    @awkward.accept @tree
+    assert_equal 8, @awkward.nodes.length
+  end
+
+  def test_edges
+    @awkward.accept @tree
+    assert_equal 7, @awkward.edges.length
+  end
+
+  def test_edges_have_nodes
+    @awkward.accept @tree
+    nodes = @awkward.edges.map { |e| [e.left, e.right] }.flatten.uniq
+    expected = @awkward.nodes
+    assert_equal expected.sort_by(&:object_id), nodes.sort_by(&:object_id)
+  end
+
+  def test_to_dot
+    @awkward.accept @tree
+    @awkward.to_dot
+  end
+
+  def test_cyclic
+    foo = {}
+    foo[:a] = { :b => { :c => foo } }
+
+    @awkward.accept foo
+    @awkward.to_dot
+  end
+end

metadata

@@ -0,0 +1,107 @@
+--- !ruby/object:Gem::Specification 
+name: awkward
+version: !ruby/object:Gem::Version 
+  prerelease: false
+  segments: 
+  - 1
+  - 0
+  - 0
+  version: 1.0.0
+platform: ruby
+authors: 
+- Aaron Patterson
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2010-11-13 00:00:00 -06:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: rubyforge
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 2
+        - 0
+        - 4
+        version: 2.0.4
+  type: :development
+  version_requirements: *id001
+- !ruby/object:Gem::Dependency 
+  name: hoe
+  prerelease: false
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 2
+        - 6
+        - 2
+        version: 2.6.2
+  type: :development
+  version_requirements: *id002
+description: |-
+  Awkward helps you walk your Object Graph and output a dot file suitable for
+  viewing in Graphviz.  Awkward doesn't know how to visit your objects, so you
+  must teach it by implementing a subclass of Awkward::Visitor.
+email: 
+- aaron@tenderlovemaking.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- Manifest.txt
+- CHANGELOG.rdoc
+- README.rdoc
+files: 
+- .autotest
+- CHANGELOG.rdoc
+- Manifest.txt
+- README.rdoc
+- Rakefile
+- lib/awkward.rb
+- lib/awkward/visitor.rb
+- test/test_awkward.rb
+has_rdoc: true
+homepage: http://github.com/tenderlove/awkward
+licenses: []
+
+post_install_message: 
+rdoc_options: 
+- --main
+- README.rdoc
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: awkward
+rubygems_version: 1.3.7
+signing_key: 
+specification_version: 3
+summary: Awkward helps you walk your Object Graph and output a dot file suitable for viewing in Graphviz
+test_files: 
+- test/test_awkward.rb