visualize_ruby 0.2.1 → 0.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 284bdd9d3e46c28221780826ae5376b9630aa1d528614a2aa0fc4d577cfabbaa
-  data.tar.gz: a56f98ea0a7b26cdb206594bd9e1b08407b4cc3035452a56bd022ab1b6046ce4
+  metadata.gz: 22fab7a1a3ea1d95c60b2898fe001fa851f8b67111e8c206e6ae0c190074e481
+  data.tar.gz: 84ec463c7e0f3f7f5e8585a0c7dd205ec9015fe50b9562549920430cf675e8c3
 SHA512:
-  metadata.gz: 3637961a42bca6ea8f9c017d23c42b3627fbf24575faa5da775d98fb9f0b09006d0f93fce0bae4cf3ca7bad7cdfd5283e4b1e6dc3e6a82e3bc5df3d1afdcc23e
-  data.tar.gz: 0b1660513b29d821a74f402f93aa5383182f50e885777550b577d2e8ca87d8d81a51b6b35ec18c4fc82be01875e7289d3cf1aa2c676f4b31ebf11ca8063729f8
+  metadata.gz: f3b08e5a1dbed0d824ee5722114746d77bcc36892a45b0d18005921bfd304a1ce0e4e3ab984e83229d54956698e4cb5dd8e52302e4203c5a8ac543b7d17dc90d
+  data.tar.gz: 0d01fb92334397496ff94cf483f9bf47a98222bfe89429489c66a96b21ff6f860f088d2a013d6a9c3451ec806a8a8a1810e1d9f44fb4e3a62fcead7c1fb36856

data/CHANGELOG.md

@@ -0,0 +1,21 @@
+# Changelog
+All notable changes to this project will be documented in this file.
+
+## 0.5.0 - 2018-06-22
+### Enhancement
+* Change some visual display for flow charts.
+
+## 0.4.0 - 2018-06-22
+
+### Enhancement
+* Add special parsing for case statements.
+
+## 0.3.1 - 2018-06-22
+
+### Fix
+* Better handle variables assignment before control flow. 
+
+## 0.3.0 - 2018-06-22
+
+### Enhancement
+* Node text now parses ast back to Ruby code. Improve accurately displaying all type of ruby code.

data/lib/visualize_ruby/builder.rb

@@ -30,7 +30,8 @@ module VisualizeRuby
           sub_graph.nodes.each do |node|
             sub_graph.edges << Edge.new(
                 nodes: [node, graph.nodes.first],
-                dir:   :none
+                dir:   :none,
+                style: :dashed
             ) if node.name == graph.name
           end
         end

data/lib/visualize_ruby/edge.rb

@@ -3,20 +3,23 @@ module VisualizeRuby
     attr_reader :name,
                 :node_a,
                 :node_b,
-                :dir
-    def initialize(name: nil, nodes:, dir: :forward)
+                :dir,
+                :style
+
+    def initialize(name: nil, nodes:, dir: :forward, style: :solid)
       @name   = name.to_s if name
       @node_a = nodes[0]
       @node_b = nodes[1]
       @dir    = dir
+      @style  = style
     end
 
     def to_a
       [
-          node_a.to_sym,
+          node_a.name.to_s,
           name,
           direction_symbol,
-          node_b.to_sym,
+          node_b.name.to_s,
       ].compact
     end
 

data/lib/visualize_ruby/graphviz.rb

@@ -10,22 +10,62 @@ module VisualizeRuby
     end
 
     def to_graph(type: :digraph, **output)
-      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
+      g          = main_graph(type)
+      sub_graphs = sub_graphs(g)
+
+      create_edges(sub_graphs)
+      g.output(output)
+    end
+
+    private
+
+    def sub_graphs(g)
+      graphs.reverse.map.with_index do |graph, index|
+        sub_graph = create_sub_graph(g, graph, index)
+        create_nodes(graph, sub_graph)
         [graph, sub_graph]
       end
+    end
 
+    def nodes
+      @nodes ||= {}
+    end
+
+    def create_edges(sub_graphs)
       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? })
+          g_graph.add_edges(
+              nodes[edge.node_a.name],
+              nodes[edge.node_b.name],
+              **compact({ label: edge.name, dir: edge.dir, style: edge.style })
+          )
         end
       end
-      g.output(output)
+    end
+
+    def create_sub_graph(g, graph, index)
+      g.add_graph(
+          "cluster#{index}",
+          **compact({ label: graph.name, style: graphs.count == 1 ? :invis : :dotted })
+      )
+    end
+
+    def create_nodes(graph, sub_graph)
+      graph.nodes.each do |node|
+        nodes[node.name] = sub_graph.add_node(
+            node.name,
+            shape: node.shape,
+            style: node.style
+        )
+      end
+    end
+
+    def main_graph(type)
+      GraphViz.new(:G, type: type, label: label)
+    end
+
+    def compact(hash)
+      hash.reject { |_, v| v.nil? }
     end
   end
 end

data/lib/visualize_ruby/node.rb

@@ -1,10 +1,12 @@
 module VisualizeRuby
   class Node
-    attr_reader :name
+    attr_reader :name, :style
     attr_accessor :type
-    def initialize(name:, type: :action)
-      @name = name.to_s
-      @type = type
+
+    def initialize(name:, type: :action, style: :rounded)
+      @name  = name.to_s
+      @type  = type
+      @style = style
     end
 
     def to_sym
@@ -12,7 +14,7 @@ module VisualizeRuby
     end
 
     def to_a
-      [type, to_sym]
+      [type, name.to_s]
     end
 
     def type_display

data/lib/visualize_ruby/parser.rb

@@ -9,6 +9,7 @@ require_relative "parser/if"
 require_relative "parser/type"
 require_relative "parser/true"
 require_relative "parser/false"
+require_relative "parser/case"
 
 module VisualizeRuby
   class Parser

data/lib/visualize_ruby/parser/ast_helper.rb

@@ -6,21 +6,7 @@ module VisualizeRuby
       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
+        Unparser.unparse(ast)
       end
     end
   end

data/lib/visualize_ruby/parser/begin.rb

@@ -8,11 +8,14 @@ module VisualizeRuby
       # @return [Array<VisualizeRuby::Node>, Array<VisualizeRuby::Edge>]
       def parse
         edges     = []
+        nodes = []
         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
+        @ast.children.to_a.compact.reverse.each do |a|
+          _nodes, _edges = Parser.new(ast: a).parse
+          edges.concat(_edges.reverse)
+          nodes.concat(_nodes.reverse)
+          edges << Edge.new(nodes: [_nodes.first, last_node]) if last_node
+          last_node = _nodes.first
         end
 
         return nodes.reverse, edges.reverse

data/lib/visualize_ruby/parser/case.rb

@@ -0,0 +1,36 @@
+module VisualizeRuby
+  class Parser
+    class Case
+      def initialize(ast)
+        @ast = ast
+      end
+
+      # @return [Array<VisualizeRuby::Node>, Array<VisualizeRuby::Edge>]
+      def parse
+        condition, *_whens, _else = @ast.children
+        condition_node = Node.new(name: AstHelper.new(condition).description, type: :decision)
+        nodes << condition_node
+        _whens.each do |_when|
+          edge_name, actions = _when.children
+          action_nodes, action_edges = Parser.new(ast: actions).parse
+          edges << Edge.new(name:  AstHelper.new(edge_name).description, nodes: [condition_node, action_nodes.first])
+          nodes.concat(action_nodes)
+          edges.concat(action_edges)
+        end
+        _else_node = Node.new(name: AstHelper.new(_else).description, type: :action)
+        _else_edge = Edge.new(name: "else", nodes: [condition_node, _else_node])
+        nodes << _else_node
+        edges << _else_edge
+        return nodes, edges
+      end
+
+      def nodes
+        @nodes ||= []
+      end
+
+      def edges
+        @edges ||= []
+      end
+    end
+  end
+end

data/lib/visualize_ruby/version.rb

@@ -1,3 +1,3 @@
 module VisualizeRuby
-  VERSION = "0.2.1"
+  VERSION = "0.5.0"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: visualize_ruby
 version: !ruby/object:Gem::Version
-  version: 0.2.1
+  version: 0.5.0
 platform: ruby
 authors:
 - Dustin Zeisler
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2018-06-17 00:00:00.000000000 Z
+date: 2018-06-22 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -123,6 +123,7 @@ files:
 - ".gitignore"
 - ".rspec"
 - ".travis.yml"
+- CHANGELOG.md
 - CODE_OF_CONDUCT.md
 - Gemfile
 - LICENSE.txt
@@ -141,6 +142,7 @@ files:
 - lib/visualize_ruby/parser/and.rb
 - lib/visualize_ruby/parser/ast_helper.rb
 - lib/visualize_ruby/parser/begin.rb
+- lib/visualize_ruby/parser/case.rb
 - lib/visualize_ruby/parser/false.rb
 - lib/visualize_ruby/parser/if.rb
 - lib/visualize_ruby/parser/or.rb