visualize_ruby 0.1.0

data/.rspec

@@ -0,0 +1,3 @@
+--format documentation
+--color
+--require spec_helper

data/.travis.yml

@@ -0,0 +1,5 @@
+sudo: false
+language: ruby
+rvm:
+  - 2.5.1
+before_install: gem install bundler -v 1.16.2

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,74 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+In the interest of fostering an open and welcoming environment, we as
+contributors and maintainers pledge to making participation in our project and
+our community a harassment-free experience for everyone, regardless of age, body
+size, disability, ethnicity, gender identity and expression, level of experience,
+nationality, personal appearance, race, religion, or sexual identity and
+orientation.
+
+## Our Standards
+
+Examples of behavior that contributes to creating a positive environment
+include:
+
+* Using welcoming and inclusive language
+* Being respectful of differing viewpoints and experiences
+* Gracefully accepting constructive criticism
+* Focusing on what is best for the community
+* Showing empathy towards other community members
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery and unwelcome sexual attention or
+advances
+* Trolling, insulting/derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or electronic
+  address, without explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Our Responsibilities
+
+Project maintainers are responsible for clarifying the standards of acceptable
+behavior and are expected to take appropriate and fair corrective action in
+response to any instances of unacceptable behavior.
+
+Project maintainers have the right and responsibility to remove, edit, or
+reject comments, commits, code, wiki edits, issues, and other contributions
+that are not aligned to this Code of Conduct, or to ban temporarily or
+permanently any contributor for other behaviors that they deem inappropriate,
+threatening, offensive, or harmful.
+
+## Scope
+
+This Code of Conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community. Examples of
+representing a project or community include using an official project e-mail
+address, posting via an official social media account, or acting as an appointed
+representative at an online or offline event. Representation of a project may be
+further defined and clarified by project maintainers.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting the project team at TODO: Write your email address. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. The project team is
+obligated to maintain confidentiality with regard to the reporter of an incident.
+Further details of specific enforcement policies may be posted separately.
+
+Project maintainers who do not follow or enforce the Code of Conduct in good
+faith may face temporary or permanent repercussions as determined by other
+members of the project's leadership.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
+available at [http://contributor-covenant.org/version/1/4][version]
+
+[homepage]: http://contributor-covenant.org
+[version]: http://contributor-covenant.org/version/1/4/

data/Gemfile

@@ -0,0 +1,6 @@
+source "https://rubygems.org"
+
+git_source(:github) {|repo_name| "https://github.com/#{repo_name}" }
+
+# Specify your gem's dependencies in visualize_ruby.gemspec
+gemspec

data/Gemfile.lock

@@ -0,0 +1,66 @@
+PATH
+  remote: .
+  specs:
+    visualize_ruby (0.1.0)
+      dissociated_introspection (~> 0.9.1)
+      parser (~> 2.1, >= 2.5.1.0)
+      ruby-graphviz (~> 1.2, >= 1.2.3)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    abstract_type (0.0.7)
+    adamantium (0.2.0)
+      ice_nine (~> 0.11.0)
+      memoizable (~> 0.4.0)
+    ast (2.4.0)
+    concord (0.1.5)
+      adamantium (~> 0.2.0)
+      equalizer (~> 0.0.9)
+    diff-lcs (1.3)
+    dissociated_introspection (0.9.1)
+      parser (~> 2.1, >= 2.1.9)
+      unparser (~> 0.2, >= 0.2.6)
+    equalizer (0.0.11)
+    ice_nine (0.11.2)
+    memoizable (0.4.2)
+      thread_safe (~> 0.3, >= 0.3.1)
+    parser (2.5.1.0)
+      ast (~> 2.4.0)
+    procto (0.0.3)
+    rake (12.3.1)
+    rspec (3.7.0)
+      rspec-core (~> 3.7.0)
+      rspec-expectations (~> 3.7.0)
+      rspec-mocks (~> 3.7.0)
+    rspec-core (3.7.1)
+      rspec-support (~> 3.7.0)
+    rspec-expectations (3.7.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.7.0)
+    rspec-mocks (3.7.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.7.0)
+    rspec-support (3.7.1)
+    ruby-graphviz (1.2.3)
+    thread_safe (0.3.6)
+    unparser (0.2.7)
+      abstract_type (~> 0.0.7)
+      adamantium (~> 0.2.0)
+      concord (~> 0.1.5)
+      diff-lcs (~> 1.3)
+      equalizer (~> 0.0.9)
+      parser (>= 2.3.1.2, < 2.6)
+      procto (~> 0.0.2)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (~> 1.16)
+  rake (~> 12.3, >= 12.3.1)
+  rspec (~> 3.7)
+  visualize_ruby!
+
+BUNDLED WITH
+   1.16.2

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2018 TODO: Write your name
+
+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/README.md

@@ -0,0 +1,43 @@
+# 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.
+
+TODO: Delete this and the text above, and describe your gem
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'visualize_ruby'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install visualize_ruby
+
+## Usage
+
+TODO: Write usage instructions here
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## 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.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
+
+## 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).

data/Rakefile

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "visualize_ruby"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start(__FILE__)

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/exe/visualize_ruby

@@ -0,0 +1,3 @@
+#!/usr/bin/env ruby
+
+require "visualize_ruby"

data/lib/visualize_ruby.rb

@@ -0,0 +1,9 @@
+require "visualize_ruby/version"
+require "visualize_ruby/parser"
+require "visualize_ruby/node"
+require "visualize_ruby/edge"
+require "visualize_ruby/graphviz"
+
+module VisualizeRuby
+  # Your code goes here...
+end

data/lib/visualize_ruby/edge.rb

@@ -0,0 +1,36 @@
+module VisualizeRuby
+  class Edge
+    attr_reader :name,
+                :node_a,
+                :node_b,
+                :dir
+    def initialize(name: nil, nodes:, dir: :forward)
+      @name   = name
+      @node_a = nodes[0]
+      @node_b = nodes[1]
+      @dir    = dir
+    end
+
+    def to_a
+      [
+          node_a.to_sym,
+          name,
+          direction_symbol,
+          node_b.to_sym,
+      ].compact
+    end
+
+    def direction_symbol
+      case dir
+      when :forward
+        "->"
+      end
+    end
+
+    def inspect
+      "#<VisualizeRuby::Edge #{to_a.join(" ")}>"
+    end
+
+    alias_method :to_s, :inspect
+  end
+end

data/lib/visualize_ruby/graphviz.rb

@@ -0,0 +1,23 @@
+require "ruby-graphviz"
+
+module VisualizeRuby
+  class Graphviz
+    attr_reader :nodes, :edges
+
+    def initialize(nodes, edges)
+      @nodes = nodes
+      @edges = edges
+    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)
+      end
+
+      g.output(output)
+    end
+  end
+end

data/lib/visualize_ruby/node.rb

@@ -0,0 +1,42 @@
+module VisualizeRuby
+  class Node
+    attr_reader :name
+    attr_accessor :type
+    def initialize(name:, type: :action)
+      @name = name
+      @type = type
+    end
+
+    def to_sym
+      name.to_s.gsub(" ", "_").to_sym
+    end
+
+    def to_a
+      [type, to_sym]
+    end
+
+    def type_display
+      case type
+      when :decision
+        "<>"
+      when :action
+        "[]"
+      end
+    end
+
+    def shape
+      case type
+      when :decision
+        :diamond
+      when :action
+        :ellipse
+      end
+    end
+
+    def inspect
+      "#<VisualizeRuby::Node #{type_display} #{name}>"
+    end
+
+    alias_method :to_s, :inspect
+  end
+end

data/lib/visualize_ruby/parser.rb

@@ -0,0 +1,154 @@
+require "parser/current"
+
+module VisualizeRuby
+  class Parser
+    attr_reader :ast
+
+    def initialize(ruby_code = nil, ast: ::Parser::CurrentRuby.parse(ruby_code))
+      @ast = ast
+    end
+
+    def parse
+      merge *Parser.const_get(ast.type.to_s.capitalize).new(ast).parse
+
+      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
+
+    def edges
+      @edges ||= []
+    end
+
+    def merge(nodes, edges)
+      self.nodes.concat(nodes)
+      self.edges.concat(edges)
+    end
+  end
+end