visualize_ruby 0.1.0 → 0.2.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 8489b3403bb2883ed03313d4faf03e784de496e0fce4cf2f7ab77c03144a9a40
-  data.tar.gz: fcd4b746efc60f1c2dff570b9b946ad38b2521d05e28db91e590868a9a8ec880
+  metadata.gz: 284bdd9d3e46c28221780826ae5376b9630aa1d528614a2aa0fc4d577cfabbaa
+  data.tar.gz: a56f98ea0a7b26cdb206594bd9e1b08407b4cc3035452a56bd022ab1b6046ce4
 SHA512:
-  metadata.gz: 04b3288b13388cbab83b196b2b5c7930419c68cb3129bf29524eabde800e21c6ed754a61673eaad3f96190863373e4600367f9661865945be7821e30e5abe3f0
-  data.tar.gz: ced7743c62506238228f807c180b666d659c8d02adac2be0e57e8c48f0250cfccd03768f53aede1a07de1965e763b1f358db2bb40b0ecc44692570756ef28874
+  metadata.gz: 3637961a42bca6ea8f9c017d23c42b3627fbf24575faa5da775d98fb9f0b09006d0f93fce0bae4cf3ca7bad7cdfd5283e4b1e6dc3e6a82e3bc5df3d1afdcc23e
+  data.tar.gz: 0b1660513b29d821a74f402f93aa5383182f50e885777550b577d2e8ca87d8d81a51b6b35ec18c4fc82be01875e7289d3cf1aa2c676f4b31ebf11ca8063729f8

data/.gitignore

@@ -9,3 +9,7 @@
 
 # rspec failure tracking
 .rspec_status
+.idea/*
+npm-debug.log
+*.gem
+Gemfile.lock

data/README.md

@@ -1,8 +1,10 @@
 # VisualizeRuby
 
-Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file `lib/visualize_ruby`. To experiment with that code, run `bin/console` for an interactive prompt.
+Write a Ruby class and see method interactions. Works with procedural code and bare methods.</span>
+This is experimental project and does not support all types of code. 
+If you'd like it to support more types of code please pull request.
 
-TODO: Delete this and the text above, and describe your gem
+[Demo](https://visualize-ruby.herokuapp.com/)
 
 ## Installation
 
@@ -22,7 +24,20 @@ Or install it yourself as:
 
 ## Usage
 
-TODO: Write usage instructions here
+```ruby
+require "visualize_ruby"
+
+ruby_code = <<-RUBY
+  if hungry?
+    eat
+  else
+    work
+  end
+RUBY
+
+results = VisualizeRuby::Builder.new(ruby_code: ruby_code).build
+VisualizeRuby::Graphviz.new(*results).to_graph(png: "example.png")
+```
 
 ## Development
 

data/lib/visualize_ruby.rb

@@ -2,8 +2,9 @@ require "visualize_ruby/version"
 require "visualize_ruby/parser"
 require "visualize_ruby/node"
 require "visualize_ruby/edge"
+require "visualize_ruby/graph"
+require "visualize_ruby/builder"
 require "visualize_ruby/graphviz"
 
 module VisualizeRuby
-  # Your code goes here...
 end

data/lib/visualize_ruby/builder.rb

@@ -0,0 +1,64 @@
+require "dissociated_introspection"
+
+module VisualizeRuby
+  class Builder
+
+    def initialize(ruby_code:)
+      @ruby_code = ruby_code
+    end
+
+    def build
+      ruby_code  = DissociatedIntrospection::RubyCode.build_from_source(@ruby_code)
+      ruby_class = DissociatedIntrospection::RubyClass.new(ruby_code)
+
+      if ruby_class.class?
+        [build_from_class(ruby_class), { label: ruby_class.class_name }]
+      elsif bare_methods?(ruby_code)
+        wrap_bare_methods(ruby_code)
+      else
+        Graph.new(ruby_code: @ruby_code)
+      end
+    end
+
+    private
+
+    def build_from_class(ruby_class)
+      graphs = build_graphs_by_method(ruby_class)
+
+      graphs.each do |graph|
+        graphs.each do |sub_graph|
+          sub_graph.nodes.each do |node|
+            sub_graph.edges << Edge.new(
+                nodes: [node, graph.nodes.first],
+                dir:   :none
+            ) if node.name == graph.name
+          end
+        end
+      end
+
+      graphs
+    end
+
+    def build_graphs_by_method(ruby_class)
+     ruby_class.defs.map do |meth|
+        Graph.new(ruby_code: meth.body, name: meth.name)
+      end
+    end
+
+    def bare_methods?(ruby_code)
+      ruby_code.ast.type == :def ||
+      ruby_code.ast.type == :begin && ruby_code.ast.children.map(&:type).uniq == [:def]
+    end
+
+    def wrap_bare_methods(ruby_code)
+      wrapped_ruby_code = <<~Ruby
+        class BareMethodsClass
+          #{ruby_code.source}
+        end
+      Ruby
+      di_ruby_code  = DissociatedIntrospection::RubyCode.build_from_source(wrapped_ruby_code)
+      ruby_class = DissociatedIntrospection::RubyClass.new(di_ruby_code)
+      build_from_class(ruby_class)
+    end
+  end
+end

data/lib/visualize_ruby/edge.rb

@@ -5,7 +5,7 @@ module VisualizeRuby
                 :node_b,
                 :dir
     def initialize(name: nil, nodes:, dir: :forward)
-      @name   = name
+      @name   = name.to_s if name
       @node_a = nodes[0]
       @node_b = nodes[1]
       @dir    = dir
@@ -24,6 +24,8 @@ module VisualizeRuby
       case dir
       when :forward
         "->"
+      when :none
+        "-"
       end
     end
 
@@ -33,4 +35,4 @@ module VisualizeRuby
 
     alias_method :to_s, :inspect
   end
-end
+end

data/lib/visualize_ruby/graph.rb

@@ -0,0 +1,18 @@
+module VisualizeRuby
+  class Graph
+    attr_reader :name, :nodes, :edges
+
+    def initialize(ruby_code:, name: nil)
+      @name          = name.to_s
+      @nodes, @edges = Parser.new(ruby_code).parse
+    end
+
+    def to_hash
+      {
+          name:  name,
+          edges: edges.map(&:to_a),
+          nodes: nodes.map(&:to_a),
+      }
+    end
+  end
+end

data/lib/visualize_ruby/graphviz.rb

@@ -2,22 +2,30 @@ require "ruby-graphviz"
 
 module VisualizeRuby
   class Graphviz
-    attr_reader :nodes, :edges
+    attr_reader :graphs, :label
 
-    def initialize(nodes, edges)
-      @nodes = nodes
-      @edges = edges
+    def initialize(graphs, label: nil)
+      @graphs = [*graphs]
+      @label  = label
     end
 
     def to_graph(type: :digraph, **output)
-      g = GraphViz.new(:G, :type => type)
-      edges.each do |edge|
-        node_a = g.add_node(edge.node_a.name.to_s, shape: edge.node_a.shape)
-        node_b = g.add_node(edge.node_b.name.to_s, shape: edge.node_b.shape)
-        g.add_edges(node_a, node_b, label: edge.name.to_s, dir: edge.dir)
+      g          = GraphViz.new(:G, type: type, label: label)
+      nodes      = {}
+      sub_graphs = graphs.reverse.map.with_index do |graph, index|
+        sub_graph = g.add_graph("cluster#{index}", **{ label: graph.name }.reject { |_, v| v.nil? })
+        graph.nodes.each do |node|
+          nodes[node.name] = sub_graph.add_node(node.name, shape: node.shape)
+        end
+        [graph, sub_graph]
       end
 
+      sub_graphs.each do |r_graph, g_graph|
+        r_graph.edges.each do |edge|
+          g_graph.add_edges(nodes[edge.node_a.name], nodes[edge.node_b.name], **{ label: edge.name, dir: edge.dir }.reject { |_, v| v.nil? })
+        end
+      end
       g.output(output)
     end
   end
-end
+end

data/lib/visualize_ruby/node.rb

@@ -3,7 +3,7 @@ module VisualizeRuby
     attr_reader :name
     attr_accessor :type
     def initialize(name:, type: :action)
-      @name = name
+      @name = name.to_s
       @type = type
     end
 
@@ -39,4 +39,4 @@ module VisualizeRuby
 
     alias_method :to_s, :inspect
   end
-end
+end

data/lib/visualize_ruby/parser.rb

@@ -1,4 +1,14 @@
 require "parser/current"
+require_relative "parser/or"
+require_relative "parser/and"
+require_relative "parser/ast_helper"
+require_relative "parser/begin"
+require_relative "parser/send"
+require_relative "parser/str"
+require_relative "parser/if"
+require_relative "parser/type"
+require_relative "parser/true"
+require_relative "parser/false"
 
 module VisualizeRuby
   class Parser
@@ -8,136 +18,13 @@ module VisualizeRuby
       @ast = ast
     end
 
+    # @return [Array<VisualizeRuby::Node>, Array<VisualizeRuby::Edge>]
     def parse
-      merge *Parser.const_get(ast.type.to_s.capitalize).new(ast).parse
+      merge *parse_by_type
 
       return nodes, edges
     end
-
-    class If
-      def initialize(ast)
-        @ast = ast
-      end
-
-      def parse
-        condition, on_true, on_false     = @ast.children.to_a
-        nodes                            = []
-        edges                            = []
-        on_false_nodes, on_false_edges   = Parser.new(ast: on_false).parse
-        on_false_node                    = on_false_nodes.first
-        condition_nodes, condition_edges = Parser.new(ast: condition).parse
-        condition_nodes.first.type       = :decision
-        nodes.concat(condition_nodes)
-        edges.concat(condition_edges)
-        on_true_node = Node.new(name: AstHelper.new(on_true).description)
-        nodes << on_true_node
-        nodes.concat(on_false_nodes)
-
-        condition_nodes.each do |condition_node|
-          edges << Edge.new(name: "true", nodes: [condition_node, on_true_node])
-          edges << Edge.new(name: "false", nodes: [condition_node, on_false_node])
-        end
-        edges.concat(on_false_edges)
-        return [nodes, edges]
-      end
-    end
-
-    class Or
-      def initialize(ast)
-        @ast = ast
-      end
-
-      def parse
-        last_node = nil
-        edges     = []
-        nodes     = @ast.children.reverse.map do |c|
-          node = Node.new(name: AstHelper.new(c).description, type: :decision)
-          edges << Edge.new(name: "OR", nodes: [node, last_node]) if last_node
-          last_node = node
-          node
-        end.reverse
-        return nodes, edges
-      end
-    end
-
-    class And
-      def initialize(ast)
-        @ast = ast
-      end
-
-      def parse
-        last_node = nil
-        edges     = []
-        nodes     = @ast.children.reverse.map do |c|
-          node = Node.new(name: c.children.last, type: :decision)
-          edges << Edge.new(name: "AND", nodes: [node, last_node]) if last_node
-          last_node = node
-          node
-        end.reverse
-        return nodes, edges
-      end
-    end
-
-    class AstHelper
-      def initialize(ast)
-        @ast = ast
-      end
-
-      def description(ast: @ast)
-        case ast
-        when Symbol, String
-          ast
-        when NilClass
-          nil
-        else
-          ast.children.flat_map do |c|
-            description(ast: c)
-          end.reject do |c|
-            c.nil? || c == :""
-          end.join(" ")
-        end
-      end
-
-    end
-
-    class Begin
-      def initialize(ast)
-        @ast = ast
-      end
-
-      def parse
-        edges     = []
-        last_node = nil
-        nodes     = @ast.children.to_a.compact.reverse.map do |a|
-          node = Node.new(name: AstHelper.new(a).description, type: :action)
-          edges << Edge.new(nodes: [node, last_node]) if last_node
-          last_node = node
-        end
-
-        return nodes.reverse, edges.reverse
-      end
-    end
-
-    class Send
-      def initialize(ast)
-        @ast = ast
-      end
-
-      def parse
-        return [Node.new(name: AstHelper.new(@ast).description, type: :action)], []
-      end
-    end
-
-    class Str
-      def initialize(ast)
-        @ast = ast
-      end
-
-      def parse
-        return [Node.new(name: AstHelper.new(@ast).description, type: :action)], []
-      end
-    end
-
+    
     def nodes
       @nodes ||= []
     end
@@ -146,9 +33,17 @@ module VisualizeRuby
       @edges ||= []
     end
 
+    private
+
+    def parse_by_type
+      Parser.const_get(ast.type.to_s.capitalize).new(ast).parse
+    rescue NameError
+      Str.new(ast).parse
+    end
+
     def merge(nodes, edges)
       self.nodes.concat(nodes)
       self.edges.concat(edges)
     end
   end
-end
+end

data/lib/visualize_ruby/parser/and.rb

@@ -0,0 +1,22 @@
+module VisualizeRuby
+  class Parser
+    class And
+      def initialize(ast)
+        @ast = ast
+      end
+
+      # @return [Array<VisualizeRuby::Node>, Array<VisualizeRuby::Edge>]
+      def parse
+        last_node = nil
+        edges     = []
+        nodes     = @ast.children.reverse.map do |c|
+          node = Node.new(name: c.children.last, type: :decision)
+          edges << Edge.new(name: "AND", nodes: [node, last_node]) if last_node
+          last_node = node
+          node
+        end.reverse
+        return nodes, edges
+      end
+    end
+  end
+end

data/lib/visualize_ruby/parser/ast_helper.rb

@@ -0,0 +1,27 @@
+module VisualizeRuby
+  class Parser
+    class AstHelper
+      def initialize(ast)
+        @ast = ast
+      end
+
+      def description(ast: @ast)
+        case ast
+        when Symbol, String
+          ast
+        when NilClass
+          nil
+
+        else
+          ast.children.flat_map do |c|
+            description(ast: c)
+          end.reject do |c|
+            c.nil? || c == :""
+          end.join(" ")
+        end
+      rescue NoMethodError
+        ast
+      end
+    end
+  end
+end