trace_graph 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: dd780ac25e119f53019469ce53d16566fb3acbe251ca04eec7f275b5170bcdae
+  data.tar.gz: d0055ce4f5bf0c69d384b40b4fb72b88584de876bc830084c3b527fc290a3e88
+SHA512:
+  metadata.gz: 45e82dac33a5477f396d3f4bff13f4eef95bc4ad6435f63a16d94a9268ae08e83009a4e2420e2e7a67b15b8db2c68f27bd141ee6aaed94d35d48085ce562da52
+  data.tar.gz: 8b4066d99e34ea38b1e1cb4957a6a732b795fa001b1912337f8da12d2926c5351eb495c2df3c630c806fe6be80b2eaca70c2366e7fecb9192e143304b9701fc7

data/.gitignore

@@ -0,0 +1,13 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+
+# rspec failure tracking
+.rspec_status
+
+.byebug_history

data/.rspec

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

data/.travis.yml

@@ -0,0 +1,7 @@
+---
+sudo: false
+language: ruby
+cache: bundler
+rvm:
+  - 2.6.3
+before_install: gem install bundler -v 2.0.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 jeremy@octolabs.com. 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,4 @@
+source "https://rubygems.org"
+
+# Specify your gem's dependencies in trace_graph.gemspec
+gemspec

data/Gemfile.lock

@@ -0,0 +1,43 @@
+PATH
+  remote: .
+  specs:
+    trace_graph (0.1.0)
+      ruby-graphviz
+      tree_graph
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    byebug (11.1.3)
+    diff-lcs (1.3)
+    rake (10.5.0)
+    rexml (3.2.4)
+    rspec (3.9.0)
+      rspec-core (~> 3.9.0)
+      rspec-expectations (~> 3.9.0)
+      rspec-mocks (~> 3.9.0)
+    rspec-core (3.9.2)
+      rspec-support (~> 3.9.3)
+    rspec-expectations (3.9.2)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.9.0)
+    rspec-mocks (3.9.1)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.9.0)
+    rspec-support (3.9.3)
+    ruby-graphviz (1.2.5)
+      rexml
+    tree_graph (0.2.2)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (~> 2.0)
+  byebug
+  rake (~> 10.0)
+  rspec (~> 3.0)
+  trace_graph!
+
+BUNDLED WITH
+   2.0.2

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2020 Jeremy Green
+
+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,129 @@
+# TraceGraph
+
+TraceGraph gives you visibility into the control flow of your application. Rather than read all the code
+trying to form a mental picture of it, let TraceGraph draw you a picture like this:
+
+![Document Worker Trace](docs/images/document_worker_trace.png)
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'trace_graph'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install trace_graph
+
+## Usage
+
+A simple use might look like this:
+
+```ruby
+foo = Foo.new
+tracer = TraceGraph::Tracer.new({ included_paths: ["foo"], png: 'foo_trace.png' })
+tracer.trace{ foo.foo_both }
+```
+
+For the `Foo` class shown below you'd see output like this in your console:
+
+```
+trace
+└─Foo#foo_both
+  ├─Foo#first_method
+  └─Foo#second_method
+```
+
+And a graph like this would be generated at `foo_trace.png`
+
+
+![Document Worker Trace](docs/images/foo_trace.png)
+
+
+```ruby
+# foo.rb
+class Foo
+  def first_method
+  end
+
+  def second_method
+  end
+
+  def foo_both
+    first_method
+    second_method
+  end
+end
+```
+
+## Options
+
+When constructing a tracer you can pass in a number of options to control what shows up
+in the graph.
+
+* `included_paths` - By default TraceGraph will not capture any lines, so you need to tell it
+  what files you're interested in. If your app lives in a directory called `my_app` and you
+  want to see everything in your app you could pass `["my_app"]`. You can include as many paths
+  as you need in the array. Default value is an empty array. If you weant to see _everythin_ you
+  can pass `nil`. (For something like a Rails app you probably really don't want to see everything.)
+
+* `excluded_paths` - A list of paths to exclude. Maybe `["my_app/some_utility_helper"]`. Default
+  value is `nil`.
+
+* `png` - A string path where to write a png graph.
+
+* `mark_duplicate_calls` - Either `true` or `false`. Default value is `false`. When `true` any
+  repeat calls to a method will be marked with a count, and will be colored red on the png.
+
+* `show_arguments` - Either `true` or `false`. Default value is `false`. When `true` the arguments
+  passed to each method call will be shown. (This doesn't work so well if there are lots of arguments
+  or some very large ones...)
+
+* `show_return_values` - Either `true` or `false`. Default value is `false`. When `true` the return
+  values from each method call will be shown. (This doesn't work so well for lots or large return values.)
+
+A robust tracer might look like this:
+
+```ruby
+tracer = TraceGraph::Tracer.new({
+  included_paths: ["my_app/app"],         # See everything local to a rails app
+  excluded_paths: ["my_app/app/helpers"], # Except the helpers
+  mark_duplicate_calls: true,
+  show_arguments: true,
+  show_return_values: true,
+  png: 'my_very_busy_trace.png'
+})
+```
+
+### Matching for `included_paths` and `excluded_paths`
+
+TraceGraph uses the ruby TracePoint class, and paths are matched on the `inspect` value
+for a trace. A typical `inspect` values looks like this:
+
+```
+#<TracePoint:call `first_method'@/Users/jgreen/projects/trace_graph/spec/support/foo.rb:2>
+```
+
+## 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/jagthedrummer/trace_graph. 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 TraceGraph project’s codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/[USERNAME]/trace_graph/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 "trace_graph"
+
+# 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/lib/trace_graph/trace_node.rb

@@ -0,0 +1,35 @@
+require 'tree_graph'
+
+module TraceGraph
+  class TraceNode
+    include TreeGraph
+    attr_accessor :label
+    attr_accessor :sub_nodes
+    attr_accessor :is_duplicate
+
+    alias_method :label_for_tree_graph, :label
+    alias_method :children_for_tree_graph, :sub_nodes
+
+    def initialize(label, is_duplicate: false)
+      self.label = label
+      self.is_duplicate = is_duplicate
+      self.sub_nodes = []
+    end
+
+    def << child_node
+      sub_nodes << child_node
+    end
+
+    def node_count
+      sub_nodes.length
+    end
+
+    def first
+      sub_nodes.first
+    end
+
+    def second
+      sub_nodes[1]
+    end
+  end
+end

data/lib/trace_graph/tracer.rb

@@ -0,0 +1,166 @@
+module TraceGraph
+  class Tracer
+    require 'ruby-graphviz'
+
+    def initialize(options)
+      @options = options
+      # We check included paths differently than excluded ones to allow nil to be bassed, to include everyting
+      @included_paths = options.key?(:included_paths) ? options[:included_paths] : []
+      @excluded_paths = options[:excluded_paths] || []
+      @include_protected = options[:include_protected] || false
+      @mark_duplicate_calls = options.key?(:mark_duplicate_calls) ? options[:mark_duplicate_calls] : true
+      @show_arguments = options[:show_arguments] || false
+      @show_return_values = options[:show_return_values] || false
+
+      @trace_point = build_trace_point
+      @top_node = TraceGraph::TraceNode.new("trace")
+      @stack = []
+      @all_nodes = [@top_node]
+      @edge_count = 0
+      @unique_node_counts = {}
+    end
+
+    def trace
+      unless block_given?
+        raise Error.new "You must pass a block to the tracer."
+      end
+
+      @edge_count = 0
+      @unique_node_counts = {}
+      @trace_point.enable
+      yield
+      @trace_point.disable
+      # TODO : Maybe outputting this should be an options, or a different tracer?
+      puts @top_node.tree_graph
+      if @options[:png]
+        write_png @options[:png]
+      end
+    end
+
+    def call_trace
+      @top_node
+    end
+
+    def node_count
+      @all_nodes.length - 1 # should top_node count as a node?
+    end
+
+    private
+
+    def write_png png
+      g = ::GraphViz.new( :G, :type => :digraph )
+      add_node g, @top_node, nil
+      g.output( :png => png )
+    end
+
+    def add_node graph, node, parent
+      label = node.label.gsub("←","\n←").gsub("→","\n→")
+      gnode = graph.add_nodes(label)
+      if node.is_duplicate
+        gnode[:color] = "red:white"
+      end
+      if parent
+        edge = graph.add_edges(parent.label, label)
+        edge[:label] = @edge_count + 1
+        @edge_count += 1
+        # add edge
+      end
+      node.sub_nodes.each do |sub_node|
+        add_node graph, sub_node, node
+      end
+    end
+
+    def build_trace_point
+      TracePoint.new(:call,:return) do |tp|
+        if should_include_trace_line(tp)
+          if tp.event == :call
+            handle_call(tp)
+          elsif tp.event == :return
+            handle_return(tp)
+          end
+        end
+      end
+    end
+
+    def extract_arguments(trace)
+      return {} unless trace.respond_to?(:parameters)
+      param_names = trace.parameters.map(&:last)
+      param_names.map { |n| [n, trace.binding.eval(n.to_s)] }.to_h
+    end
+
+    def build_node_label(tp, for_call: true)
+      label = "#{tp.defined_class}##{tp.method_id}"
+      args = extract_arguments(tp)
+      if @show_arguments && args.any?
+        label = "#{label} →(#{args})"
+      end
+      is_dupicate = false
+      if @mark_duplicate_calls
+        if for_call # we don't want to mess with the count on a return
+          if @unique_node_counts[label]
+            @unique_node_counts[label] += 1
+          else
+            @unique_node_counts[label] = 0
+          end
+        end
+        if @unique_node_counts[label] && @unique_node_counts[label] > 0
+          label = "#{label} (##{@unique_node_counts[label]+1})"
+          is_duplicate = true
+        end
+      end
+      return label, is_duplicate
+    end
+
+    def handle_call(tp)
+      parent = @stack.last
+      label, is_duplicate = build_node_label(tp)
+      new_node = TraceGraph::TraceNode.new(label, is_duplicate: is_duplicate)
+      @stack << new_node
+      @all_nodes << new_node
+      if parent
+        parent << new_node
+      else
+        @top_node << new_node
+      end
+    end
+
+    def handle_return(tp)
+      label, _is_duplicate = build_node_label(tp, for_call: false)
+      last_node = @stack.last
+      if last_node && last_node.label == label
+        if @show_return_values && tp.return_value
+          last_node.label = "#{last_node.label} ←(#{tp.return_value})"
+        end
+        @stack.pop
+      end
+    end
+
+    def should_include_trace_line(tp)
+      should_include = false
+      if @included_paths
+        @included_paths.each do |path|
+          path = path.is_a?(String) ? /#{path}/ : path
+          if tp.inspect =~ path
+            should_include = true
+          end
+        end
+      else
+        # If included_paths was passed as nil that means to include everything that's not excluded
+        should_include = true
+      end
+      @excluded_paths.each do |path|
+        path = path.is_a?(String) ? /#{path}/ : path
+        if tp.inspect =~ path
+          should_include = false
+        end
+      end
+      klass = tp.defined_class
+      method = tp.method_id
+      public_methods = klass.public_methods(false) + klass.public_instance_methods(false)
+      unless public_methods.include?(method) || @include_protected
+        should_include = false
+      end
+      return should_include
+    end
+  end
+end

data/lib/trace_graph/version.rb

@@ -0,0 +1,3 @@
+module TraceGraph
+  VERSION = "0.1.0"
+end

data/lib/trace_graph.rb

@@ -0,0 +1,8 @@
+require "trace_graph/tracer"
+require "trace_graph/trace_node"
+require "trace_graph/version"
+
+module TraceGraph
+  class Error < StandardError; end
+  # Your code goes here...
+end

data/trace_graph.gemspec

@@ -0,0 +1,38 @@
+lib = File.expand_path("lib", __dir__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "trace_graph/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "trace_graph"
+  spec.version       = TraceGraph::VERSION
+  spec.authors       = ["Jeremy Green"]
+  spec.email         = ["jeremy@octolabs.com"]
+
+  spec.summary       = %q{Generate a visual graph of method calls}
+  spec.description   = %q{Generate a visua graph of method calls}
+  spec.homepage      = "https://github.com/jagthedrummer/trace_graph"
+  spec.license       = "MIT"
+
+  #spec.metadata["allowed_push_host"] = "TODO: Set to 'http://mygemserver.com'"
+
+  spec.metadata["homepage_uri"] = spec.homepage
+  spec.metadata["source_code_uri"] = "https://github.com/jagthedrummer/trace_graph"
+  #spec.metadata["changelog_uri"] = "TODO: Put your gem's CHANGELOG.md URL here."
+
+  # Specify which files should be added to the gem when it is released.
+  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
+  spec.files         = Dir.chdir(File.expand_path('..', __FILE__)) do
+    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  end
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency "tree_graph"
+  spec.add_dependency "ruby-graphviz"
+
+  spec.add_development_dependency "bundler", "~> 2.0"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.0"
+  spec.add_development_dependency "byebug"
+end

metadata

@@ -0,0 +1,147 @@
+--- !ruby/object:Gem::Specification
+name: trace_graph
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Jeremy Green
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2020-05-12 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: tree_graph
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: ruby-graphviz
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: byebug
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Generate a visua graph of method calls
+email:
+- jeremy@octolabs.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- docs/images/document_worker_trace.png
+- docs/images/foo_trace.png
+- lib/trace_graph.rb
+- lib/trace_graph/trace_node.rb
+- lib/trace_graph/tracer.rb
+- lib/trace_graph/version.rb
+- trace_graph.gemspec
+homepage: https://github.com/jagthedrummer/trace_graph
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/jagthedrummer/trace_graph
+  source_code_uri: https://github.com/jagthedrummer/trace_graph
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.0.3
+signing_key: 
+specification_version: 4
+summary: Generate a visual graph of method calls
+test_files: []