visualize_ruby 0.5.0 → 0.6.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 22fab7a1a3ea1d95c60b2898fe001fa851f8b67111e8c206e6ae0c190074e481
-  data.tar.gz: 84ec463c7e0f3f7f5e8585a0c7dd205ec9015fe50b9562549920430cf675e8c3
+  metadata.gz: 99eee38b1b8d2b5fc815dc04c37b5fec84a73762b66295898bed31bee5ee235d
+  data.tar.gz: aa7d28887b07d5b4ae096b2341fc74e2906bbe7452effcb5f0a19db7ee42f2a9
 SHA512:
-  metadata.gz: f3b08e5a1dbed0d824ee5722114746d77bcc36892a45b0d18005921bfd304a1ce0e4e3ab984e83229d54956698e4cb5dd8e52302e4203c5a8ac543b7d17dc90d
-  data.tar.gz: 0d01fb92334397496ff94cf483f9bf47a98222bfe89429489c66a96b21ff6f860f088d2a013d6a9c3451ec806a8a8a1810e1d9f44fb4e3a62fcead7c1fb36856
+  metadata.gz: f552a2787de005e1459951380fb1d58e412e2901298a73c65a1a4b3d984eb2d1f28d7681b1e3ea62fec3d89131e6507263d644037b0e5037155f4492aa4bd1ad
+  data.tar.gz: 87539a36683428a0debda868deac2e9fc50c1f207ef4b64a9c87f7664482bb8929e5cdb5fbbfd2cea4cc8db8a0d1312e01e7739183bff415f833e15112b05f20

data/CHANGELOG.md

@@ -1,6 +1,11 @@
 # Changelog
 All notable changes to this project will be documented in this file.
 
+## 0.6.0 - 2018-06-27
+### Enhancement
+* Visualize Enumerable looping
+* Display nodes for block arguments
+
 ## 0.5.0 - 2018-06-22
 ### Enhancement
 * Change some visual display for flow charts.

data/LICENSE.txt

@@ -1,6 +1,6 @@
 The MIT License (MIT)
 
-Copyright (c) 2018 TODO: Write your name
+Copyright (c) 2018 Dustin Zeisler
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

data/README.md

@@ -36,7 +36,7 @@ ruby_code = <<-RUBY
 RUBY
 
 results = VisualizeRuby::Builder.new(ruby_code: ruby_code).build
-VisualizeRuby::Graphviz.new(*results).to_graph(png: "example.png")
+VisualizeRuby::Graphviz.new(*results).to_graph(path: "example.png")
 ```
 
 ## Development
@@ -47,7 +47,7 @@ To install this gem onto your local machine, run `bundle exec rake install`. To
 
 ## Contributing
 
-Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/visualize_ruby. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
+Bug reports and pull requests are welcome on GitHub at https://github.com/zeisler/visualize_ruby. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
 
 ## License
 
@@ -55,4 +55,4 @@ The gem is available as open source under the terms of the [MIT License](https:/
 
 ## Code of Conduct
 
-Everyone interacting in the VisualizeRuby project’s codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/[USERNAME]/visualize_ruby/blob/master/CODE_OF_CONDUCT.md).
+Everyone interacting in the VisualizeRuby project’s codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/zeisler/visualize_ruby/blob/master/CODE_OF_CONDUCT.md).

data/lib/visualize_ruby/edge.rb

@@ -4,14 +4,16 @@ module VisualizeRuby
                 :node_a,
                 :node_b,
                 :dir,
-                :style
+                :style,
+                :color
 
-    def initialize(name: nil, nodes:, dir: :forward, style: :solid)
+    def initialize(name: nil, nodes:, dir: :forward, style: :solid, color: nil)
       @name   = name.to_s if name
       @node_a = nodes[0]
       @node_b = nodes[1]
       @dir    = dir
       @style  = style
+      @color  = color
     end
 
     def to_a

data/lib/visualize_ruby/graph.rb

@@ -3,7 +3,7 @@ module VisualizeRuby
     attr_reader :name, :nodes, :edges
 
     def initialize(ruby_code:, name: nil)
-      @name          = name.to_s
+      @name          = name.to_s if name
       @nodes, @edges = Parser.new(ruby_code).parse
     end
 

data/lib/visualize_ruby/graphviz.rb

@@ -1,4 +1,4 @@
-require "ruby-graphviz"
+require "graphviz"
 
 module VisualizeRuby
   class Graphviz
@@ -9,19 +9,34 @@ module VisualizeRuby
       @label  = label
     end
 
-    def to_graph(type: :digraph, **output)
-      g          = main_graph(type)
-      sub_graphs = sub_graphs(g)
-
-      create_edges(sub_graphs)
-      g.output(output)
+    def to_graph(format: nil, path: nil)
+      build
+      if format == String
+        str = StringIO.new
+        main_graph.dump_graph(str)
+        str.string
+      else
+        ::Graphviz.output(main_graph, path: path, format: format)
+      end
     end
 
     private
 
-    def sub_graphs(g)
-      graphs.reverse.map.with_index do |graph, index|
-        sub_graph = create_sub_graph(g, graph, index)
+    def label
+      if graphs.count == 1
+        @label = graphs.first.name
+      else
+        @label
+      end
+    end
+
+    def build
+      create_edges(sub_graphs)
+    end
+
+    def sub_graphs
+      @sub_graphs ||= graphs.reverse.map.with_index do |graph, index|
+        sub_graph = create_sub_graph(graph, index)
         create_nodes(graph, sub_graph)
         [graph, sub_graph]
       end
@@ -34,18 +49,19 @@ module VisualizeRuby
     def create_edges(sub_graphs)
       sub_graphs.each do |r_graph, g_graph|
         r_graph.edges.each do |edge|
-          g_graph.add_edges(
+          ::Graphviz::Edge.new(
+              g_graph,
               nodes[edge.node_a.name],
               nodes[edge.node_b.name],
-              **compact({ label: edge.name, dir: edge.dir, style: edge.style })
+              **compact({ label: edge.name, dir: edge.dir, style: edge.style, color: edge.color })
           )
         end
       end
     end
 
-    def create_sub_graph(g, graph, index)
-      g.add_graph(
-          "cluster#{index}",
+    def create_sub_graph(graph, index)
+      main_graph.add_subgraph(
+          "cluster_#{index}",
           **compact({ label: graph.name, style: graphs.count == 1 ? :invis : :dotted })
       )
     end
@@ -60,8 +76,8 @@ module VisualizeRuby
       end
     end
 
-    def main_graph(type)
-      GraphViz.new(:G, type: type, label: label)
+    def main_graph
+      @main_graph ||= ::Graphviz::Graph.new(:G, compact(label: label))
     end
 
     def compact(hash)

data/lib/visualize_ruby/node.rb

@@ -23,6 +23,8 @@ module VisualizeRuby
         "<>"
       when :action
         "[]"
+      when :argument
+        "[>"
       end
     end
 
@@ -32,6 +34,8 @@ module VisualizeRuby
         :diamond
       when :action
         :ellipse
+      when :argument
+        :box
       end
     end
 

data/lib/visualize_ruby/parser/and.rb

@@ -1,10 +1,6 @@
 module VisualizeRuby
   class Parser
-    class And
-      def initialize(ast)
-        @ast = ast
-      end
-
+    class And < Base
       # @return [Array<VisualizeRuby::Node>, Array<VisualizeRuby::Edge>]
       def parse
         last_node = nil

data/lib/visualize_ruby/parser/ast_helper.rb

@@ -6,6 +6,7 @@ module VisualizeRuby
       end
 
       def description(ast: @ast)
+        return ast if ast.is_a?(Symbol)
         Unparser.unparse(ast)
       end
     end

data/lib/visualize_ruby/parser/base.rb

@@ -0,0 +1,19 @@
+module VisualizeRuby
+  class Parser
+    class Base
+      def initialize(ast)
+        @ast = ast
+      end
+
+      private
+
+      def nodes
+        @nodes ||= []
+      end
+
+      def edges
+        @edges ||= []
+      end
+    end
+  end
+end

data/lib/visualize_ruby/parser/begin.rb

@@ -1,14 +1,8 @@
 module VisualizeRuby
   class Parser
-    class Begin
-      def initialize(ast)
-        @ast = ast
-      end
-
+    class Begin < Base
       # @return [Array<VisualizeRuby::Node>, Array<VisualizeRuby::Edge>]
       def parse
-        edges     = []
-        nodes = []
         last_node = nil
         @ast.children.to_a.compact.reverse.each do |a|
           _nodes, _edges = Parser.new(ast: a).parse

data/lib/visualize_ruby/parser/block.rb

@@ -0,0 +1,43 @@
+module VisualizeRuby
+  class Parser
+    class Block < Base
+      # @return [Array<VisualizeRuby::Node>, Array<VisualizeRuby::Edge>]
+      def parse
+        iterator, arguments, action = @ast.children
+        item                        = arguments.children[0]
+        collection, iterator_type   = iterator.to_a
+        if enumerable?(collection) || enumerable?(iterator_type)
+          enumerable(action, collection, iterator_type, item)
+        else
+          yield_block(action, item, iterator)
+        end
+        return nodes, edges
+      end
+
+      private
+
+      def yield_block(action, item, on_object)
+        nodes << on_object_node = Node.new(name: AstHelper.new(on_object).description)
+        nodes << item_node = Node.new(name: AstHelper.new(item).description, type: :argument)
+        nodes << action_node = Node.new(name: AstHelper.new(action).description)
+        edges << Edge.new(nodes: [on_object_node, item_node])
+        edges << Edge.new(nodes: [item_node, action_node], color: "orange")
+      end
+
+      def enumerable(action, collection, iterator_type, item)
+        nodes << collection_node = Node.new(name: AstHelper.new(collection).description)
+        nodes << item_node = Node.new(name: AstHelper.new(item).description, type: :argument)
+        nodes << iterator_node = Node.new(name: iterator_type)
+        nodes << action_node = Node.new(name: AstHelper.new(action).description)
+        edges << Edge.new(nodes: [collection_node, iterator_node])
+        edges << Edge.new(nodes: [iterator_node, item_node], color: "blue")
+        edges << Edge.new(nodes: [item_node, action_node], color: "blue")
+        edges << Edge.new(nodes: [action_node, iterator_node], color: "blue", name: "↺")
+      end
+
+      def enumerable?(meth)
+        meth == :each || Enumerable.instance_methods.include?(meth)
+      end
+    end
+  end
+end

data/lib/visualize_ruby/parser/case.rb

@@ -1,10 +1,6 @@
 module VisualizeRuby
   class Parser
-    class Case
-      def initialize(ast)
-        @ast = ast
-      end
-
+    class Case < Base
       # @return [Array<VisualizeRuby::Node>, Array<VisualizeRuby::Edge>]
       def parse
         condition, *_whens, _else = @ast.children
@@ -23,14 +19,6 @@ module VisualizeRuby
         edges << _else_edge
         return nodes, edges
       end
-
-      def nodes
-        @nodes ||= []
-      end
-
-      def edges
-        @edges ||= []
-      end
     end
   end
 end

data/lib/visualize_ruby/parser/if.rb

@@ -1,10 +1,6 @@
 module VisualizeRuby
   class Parser
-    class If
-      def initialize(ast)
-        @ast = ast
-      end
-
+    class If < Base
       # @return [Array<VisualizeRuby::Node>, Array<VisualizeRuby::Edge>]
       def parse
         break_ast
@@ -44,14 +40,6 @@ module VisualizeRuby
       def break_ast
         @condition, @on_true, @on_false = @ast.children.to_a
       end
-
-      def nodes
-        @nodes ||= []
-      end
-
-      def edges
-        @edges ||= []
-      end
     end
   end
 end

data/lib/visualize_ruby/parser/or.rb

@@ -1,19 +1,15 @@
 module VisualizeRuby
   class Parser
-    class Or
-      def initialize(ast)
-        @ast = ast
-      end
+    class Or < Base
 
       # @return [Array<VisualizeRuby::Node>, Array<VisualizeRuby::Edge>]
       def parse
         last_node = nil
-        edges     = []
-        nodes     = @ast.children.reverse.map do |c|
+        @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
+          nodes << node
         end.reverse
         return nodes, edges
       end

data/lib/visualize_ruby/parser/send.rb

@@ -1,10 +1,6 @@
 module VisualizeRuby
   class Parser
-    class Send
-      def initialize(ast)
-        @ast = ast
-      end
-
+    class Send < Base
       # @return [Array<VisualizeRuby::Node>, Array<VisualizeRuby::Edge>]
       def parse
         return [Node.new(name: AstHelper.new(@ast).description, type: :action)], []

data/lib/visualize_ruby/parser/str.rb

@@ -1,10 +1,6 @@
 module VisualizeRuby
   class Parser
-    class Str
-      def initialize(ast)
-        @ast = ast
-      end
-
+    class Str < Base
       # @return [Array<VisualizeRuby::Node>, Array<VisualizeRuby::Edge>]
       def parse
         return [Node.new(name: AstHelper.new(@ast).description, type: :action)], []

data/lib/visualize_ruby/parser/type.rb

@@ -1,10 +1,6 @@
 module VisualizeRuby
   class Parser
-    class Type
-      def initialize(ast)
-        @ast = ast
-      end
-
+    class Type < Base
       # @return [Array<VisualizeRuby::Node>, Array<VisualizeRuby::Edge>]
       def parse
         return [Node.new(name: @ast.type, type: :action)], []

data/lib/visualize_ruby/parser.rb

@@ -1,4 +1,5 @@
 require "parser/current"
+require_relative "parser/base"
 require_relative "parser/or"
 require_relative "parser/and"
 require_relative "parser/ast_helper"
@@ -10,6 +11,7 @@ require_relative "parser/type"
 require_relative "parser/true"
 require_relative "parser/false"
 require_relative "parser/case"
+require_relative "parser/block"
 
 module VisualizeRuby
   class Parser

data/lib/visualize_ruby/version.rb

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

data/visualize_ruby.gemspec

@@ -26,7 +26,7 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency "rake",  "~> 12.3", ">= 12.3.1"
   spec.add_development_dependency "rspec", "~> 3.7"
 
-  spec.add_runtime_dependency "ruby-graphviz", "~> 1.2", ">= 1.2.3"
+  spec.add_runtime_dependency "graphviz", "~> 1.0"
   spec.add_runtime_dependency "dissociated_introspection", "~> 0.9.1"
   spec.add_runtime_dependency "parser", "~> 2.1", ">= 2.5.1.0"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: visualize_ruby
 version: !ruby/object:Gem::Version
-  version: 0.5.0
+  version: 0.6.0
 platform: ruby
 authors:
 - Dustin Zeisler
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2018-06-22 00:00:00.000000000 Z
+date: 2018-06-27 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -59,25 +59,19 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '3.7'
 - !ruby/object:Gem::Dependency
-  name: ruby-graphviz
+  name: graphviz
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.2'
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: 1.2.3
+        version: '1.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.2'
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: 1.2.3
+        version: '1.0'
 - !ruby/object:Gem::Dependency
   name: dissociated_introspection
   requirement: !ruby/object:Gem::Requirement
@@ -141,7 +135,9 @@ files:
 - lib/visualize_ruby/parser.rb
 - lib/visualize_ruby/parser/and.rb
 - lib/visualize_ruby/parser/ast_helper.rb
+- lib/visualize_ruby/parser/base.rb
 - lib/visualize_ruby/parser/begin.rb
+- lib/visualize_ruby/parser/block.rb
 - lib/visualize_ruby/parser/case.rb
 - lib/visualize_ruby/parser/false.rb
 - lib/visualize_ruby/parser/if.rb