call_graph 1.3.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 7ec8d09cac62e18130df21d02f0b7eeea51154745075624690130ef86fea98f7
+  data.tar.gz: e838253ebd96b790b94060170479b40aaf332e9cb29a5e6b88f3270ab743dd92
+SHA512:
+  metadata.gz: 5963c9694168762faae31960ea239cd93dc4c28660d6ae029485e8d7b9c09ab0cf6f0e350aef3314cc13b53a1f2b1827ac3507e1f06631c663fecbc394482943
+  data.tar.gz: 36724ffefd64a31ff9f06240ee1e6a111158a8202702eae8f94be529a75dc0fa8092eea16f4cb880b45c68cdd235b6cd2d27de9d714c1ea5d333d407856ee080

data/.gitignore

@@ -0,0 +1,9 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/

data/.travis.yml

@@ -0,0 +1,16 @@
+sudo: false
+language: ruby
+env:
+  global:
+    - CC_TEST_REPORTER_ID=187c1770b00f655d852f632d3a491518c30fd3923674057bbbd03c2d8efb7503
+rvm:
+  - 2.6.1
+before_script:
+  - curl -L https://codeclimate.com/downloads/test-reporter/test-reporter-latest-linux-amd64 > ./cc-test-reporter
+  - chmod +x ./cc-test-reporter
+  - ./cc-test-reporter before-build
+after_script:
+  - ./cc-test-reporter after-build --exit-code $TRAVIS_TEST_RESULT
+matrix:
+  allow_failures:
+  - rvm: jruby

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,49 @@
+# Contributor Code of Conduct
+
+As contributors and maintainers of this project, and in the interest of
+fostering an open and welcoming community, we pledge to respect all people who
+contribute through reporting issues, posting feature requests, updating
+documentation, submitting pull requests or patches, and other activities.
+
+We are committed to making participation in this project a harassment-free
+experience for everyone, regardless of level of experience, gender, gender
+identity and expression, sexual orientation, disability, personal appearance,
+body size, race, ethnicity, age, religion, or nationality.
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery
+* Personal attacks
+* Trolling or insulting/derogatory comments
+* Public or private harassment
+* Publishing other's private information, such as physical or electronic
+  addresses, without explicit permission
+* Other unethical or unprofessional conduct
+
+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.
+
+By adopting this Code of Conduct, project maintainers commit themselves to
+fairly and consistently applying these principles to every aspect of managing
+this project. Project maintainers who do not follow or enforce the Code of
+Conduct may be permanently removed from the project team.
+
+This code of conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community.
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting a project maintainer at james.moriarty@rea-group.com. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. Maintainers are
+obligated to maintain confidentiality with regard to the reporter of an
+incident.
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage],
+version 1.3.0, available at
+[http://contributor-covenant.org/version/1/3/0/][version]
+
+[homepage]: http://contributor-covenant.org
+[version]: http://contributor-covenant.org/version/1/3/0/

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in call_graph.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2017 James Moriarty
+
+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,109 @@
+# CallGraph
+
+[![Code Climate](https://codeclimate.com/github/jamesmoriarty/call-graph/badges/gpa.svg)](https://codeclimate.com/github/jamesmoriarty/call-graph) [![Test Coverage](https://codeclimate.com/github/jamesmoriarty/call-graph/badges/coverage.svg)](https://codeclimate.com/github/jamesmoriarty/call-graph/coverage) [![Build Status](https://travis-ci.org/jamesmoriarty/call-graph.svg?branch=master)](https://travis-ci.org/jamesmoriarty/call-graph) [![Gem Version](https://badge.fury.io/rb/call_graph.svg)](https://badge.fury.io/rb/call_graph)
+
+## Why
+
+> The Law of Demeter (LoD) or principle of least knowledge is a design guideline for developing software, particularly object-oriented  programs. In its general form, the LoD is a specific case of loose coupling. The guideline was proposed by Ian Holland at Northeastern  University towards the end of 1987, and can be succinctly summarized in each of the following ways:[1]
+
+> - Each unit should have only limited knowledge about other units: only units "closely" related to the current unit.
+> - Each unit should only talk to its friends; don't talk to strangers.
+> - Only talk to your immediate friends.
+
+## Usage
+
+Capture the execution you want to graph between `CallGraph.start` and `CallGraph.stop`.
+
+```ruby
+class A
+  def self.x
+    B.new.y
+  end
+end
+
+class B
+  def y
+    1 + C.z do
+      1
+    end
+  end
+end
+
+class C
+  def self.z
+    yield
+  end
+end
+
+require 'call_graph'
+
+CallGraph.config do |config|
+  config.file_path = "examples/call-graph"
+end
+
+CallGraph.start
+A.x
+CallGraph.stop
+```
+
+Print the captured execution with the provided rake tasks.
+
+```ruby
+# Rakefile
+load 'call_graph/tasks/printer.rake'
+```
+
+```shell
+$ rake -T
+...
+rake call_graph:printer:dot  # write dot file
+rake call_graph:printer:png  # write png file from dot file
+```
+
+[![Example Graph](https://github.com/jamesmoriarty/call-graph/raw/master/examples/call-graph.png)](https://github.com/jamesmoriarty/call-graph/blob/master/examples/call-graph.png)
+
+
+## Configuration
+
+```ruby
+CallGraph.config do |config|
+  config.file_path = "examples/call-graph"
+  config.ignore_paths.clear
+  config.ignore_methods << "stop"
+  config.path(:png)
+end
+```
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'call_graph'
+```
+
+And then execute:
+
+```
+$ bundle
+```
+
+Or install it yourself as:
+
+```
+$ gem install call_graph
+```
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake test` 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]/call_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](http://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,12 @@
+require 'bundler/gem_tasks'
+require 'rake/testtask'
+
+load './lib/call_graph/tasks/printer.rake'
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << 'test'
+  t.libs << 'lib'
+  t.test_files = FileList['test/**/*_test.rb']
+end
+
+task default: :test

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require 'bundler/setup'
+require 'call_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

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/call_graph.gemspec

@@ -0,0 +1,24 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'call_graph/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'call_graph'
+  spec.version       = CallGraph::VERSION
+  spec.authors       = ['James Moriarty']
+  spec.email         = ['james.moriarty@rea-group.com']
+
+  spec.summary       = 'Capture execution and create dependency graphs.'
+  spec.license       = 'MIT'
+
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  spec.bindir        = 'exe'
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ['lib']
+
+  spec.add_dependency             'binding_of_caller'
+  spec.add_development_dependency 'rake', '~> 10.0'
+  spec.add_development_dependency 'simplecov'
+  spec.add_development_dependency 'minitest', '~> 5.0'
+end

data/examples/call-graph.dot

@@ -0,0 +1,5 @@
+digraph call_graph {
+  "Object (Instance)" -> "A (Class)" [label="x"];
+  "A (Class)" -> "B (Instance)" [label="y"];
+  "B (Instance)" -> "C (Class)" [label="z"];
+}

data/examples/call-graph.tmp

@@ -0,0 +1,3 @@
+Object (Instance),A (Class),x
+A (Class),B (Instance),y
+B (Instance),C (Class),z

data/examples/foobar.rb

@@ -0,0 +1,39 @@
+# require "bundler/setup"
+# require "call_graph"
+# require "pry"
+
+class A
+  def self.x
+    B.new.y
+  end
+end
+
+class B
+  def y
+    1 + C.z do
+      1
+    end
+  end
+end
+
+class C
+  def self.z
+    yield
+  end
+end
+
+CallGraph.config do |config|
+  config.file_path = "examples/call-graph"
+end
+
+[
+  CallGraph.config.path(:dot),
+  CallGraph.config.path(:tmp),
+  CallGraph.config.path(:png)
+].each do |path|
+  `rm -f #{path}`
+end
+
+CallGraph.start
+A.x
+CallGraph.stop

data/lib/call_graph/instrument.rb

@@ -0,0 +1,82 @@
+require 'set'
+require 'binding_of_caller'
+
+module CallGraph
+  class Instrument
+    attr_accessor :file_path, :ignore_paths, :ignore_methods, :set
+
+    def initialize(file_path: default_file_path, ignore_paths: default_ignore_paths, ignore_methods: default_ignore_methods)
+      @file_path      = file_path
+      @ignore_paths   = ignore_paths
+      @ignore_methods = ignore_methods
+      @set            = Set.new
+    end
+
+    def path(kind)
+      "#{file_path}.#{kind}"
+    end
+
+    def default_file_path
+      'call_graph'
+    end
+
+    def default_ignore_paths
+      [
+        /#{RUBY_VERSION}/,
+        /\(eval\)/,
+        /bundle\/gems/,
+        /spec/,
+        /test/
+      ]
+    end
+
+    def default_ignore_methods
+      [
+        :require,
+        :set_encoding,
+        :initialize,
+        :new,
+        :attr_reader,
+        :method_added,
+        :private,
+        :inherited,
+        :singleton_method_added,
+        :set_trace_func,
+        :call
+      ]
+    end
+
+    # :nocov:
+    # NOTE: - some calls outside the trace proc cause the vm to segvault.
+    #       - i've be unable to extract methods because of the above.
+    def start
+      set_trace_func ->(event, file, _line, id, receiver_binding, classname) {
+        return if ignore_paths.any? { |path| file[path] }
+
+        case event
+        when 'call', 'c-call'
+          caller_binding = receiver_binding.of_caller(2)
+
+          caller_class = caller_binding.eval('self.class == Class ? self.name : self.class.name')
+          caller_class = caller_binding.frame_description unless caller_class
+          caller_class = caller_class + ' ' + caller_binding.eval("self.class == Class ? '(Class)' : '(Instance)'")
+
+
+          receiver_class = receiver_binding.eval('self.class == Class ? self.name : self.class.name')
+          receiver_class = caller_binding.frame_description if receiver_class.nil?
+          receiver_class = receiver_class + ' ' + receiver_binding.eval("self.class == Class ? '(Class)' : '(Instance)'")
+
+          return if classname == CallGraph
+          return if caller_class == receiver_class
+          return if ignore_methods.include?(id)
+
+          set.add("#{caller_class},#{receiver_class},#{id}")
+        end
+      }
+    end
+
+    def stop
+      File.open(path(:tmp), 'w') { |fd| fd.write set.to_a.compact.join("\n") }
+    end
+  end
+end

data/lib/call_graph/printers/dot/line.rb

@@ -0,0 +1,15 @@
+module CallGraph
+  module Printers
+    class Dot
+      class Line
+        attr_reader :caller, :receiver, :attributes
+
+        def initialize(caller, receiver, attributes = {})
+          @caller     = caller
+          @receiver   = receiver
+          @attributes = attributes
+        end
+      end
+    end
+  end
+end

data/lib/call_graph/printers/dot.rb

@@ -0,0 +1,34 @@
+require 'call_graph/printers/dot/line'
+
+module CallGraph
+  module Printers
+    class Dot
+      attr_reader :config
+
+      def initialize(config)
+        @config = config
+      end
+
+      def to_s
+        ERB.new(TEMPLATE, trim_mode: '>').result(binding)
+      end
+
+      private
+
+      def lines
+        IO.read(config.path(:tmp))
+          .split("\n")
+          .uniq
+          .map { |line| line.split(',') }
+          .map { |c, r, id| Line.new(c, r, label: id) }
+      end
+
+      TEMPLATE = <<~EOF.chomp
+        digraph call_graph {
+        <% lines.each do |line| %>
+          "<%= line.caller %>" -> "<%= line.receiver %>" [<% line.attributes.each do |(name, value)| %><%= name %>="<%= value %>"<% end %>];
+        <% end %>}
+      EOF
+    end
+  end
+end

data/lib/call_graph/printers/png.rb

@@ -0,0 +1,25 @@
+module CallGraph
+  module Printers
+    class Png
+      attr_reader :config
+
+      def initialize(config)
+        @config = config
+      end
+
+      def to_s
+        unless `which dot`.empty?
+          `dot -Tpng #{src}`
+        else
+          raise 'Error: unable to find dot executable in $PATH'
+        end
+      end
+
+      private
+
+      def src
+        config.path(:dot)
+      end
+    end
+  end
+end

data/lib/call_graph/tasks/printer.rake

@@ -0,0 +1,29 @@
+require 'call_graph'
+
+namespace :call_graph do
+  namespace :printer do
+    desc 'write dot file'
+    task :dot do
+      content = CallGraph::Printers::Dot.new(CallGraph.config).to_s
+      path    = CallGraph.config.path(:dot)
+
+      write_file(path, content)
+    end
+
+    desc 'write png file from dot file'
+    task png: :dot do
+      content = CallGraph::Printers::Png.new(CallGraph.config).to_s
+      path    = CallGraph.config.path(:png)
+
+      write_file(path, content)
+    end
+
+    private
+
+    def write_file(path, content)
+      File.open(path, 'w') do |file|
+        file.write content
+      end
+    end
+  end
+end

data/lib/call_graph/version.rb

@@ -0,0 +1,3 @@
+module CallGraph
+  VERSION = '1.3.0'.freeze
+end

data/lib/call_graph.rb

@@ -0,0 +1,32 @@
+require 'call_graph/version'
+require 'call_graph/instrument'
+require 'call_graph/printers/dot'
+require 'call_graph/printers/png'
+
+module CallGraph
+  def self.start
+    instrument.start
+  end
+
+  def self.config
+    if block_given?
+      yield instrument
+    else
+      instrument
+    end
+  end
+
+  def self.stop
+    set_trace_func nil
+
+    instrument.stop
+  end
+
+  private
+
+  def self.instrument
+    @instrument ||= begin
+      Instrument.new
+    end
+  end
+end

metadata

@@ -0,0 +1,120 @@
+--- !ruby/object:Gem::Specification
+name: call_graph
+version: !ruby/object:Gem::Version
+  version: 1.3.0
+platform: ruby
+authors:
+- James Moriarty
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2019-02-24 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: binding_of_caller
+  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: 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: simplecov
+  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'
+- !ruby/object:Gem::Dependency
+  name: minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+description: 
+email:
+- james.moriarty@rea-group.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".travis.yml"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- call_graph.gemspec
+- examples/call-graph.dot
+- examples/call-graph.png
+- examples/call-graph.tmp
+- examples/foobar.rb
+- lib/call_graph.rb
+- lib/call_graph/instrument.rb
+- lib/call_graph/printers/dot.rb
+- lib/call_graph/printers/dot/line.rb
+- lib/call_graph/printers/png.rb
+- lib/call_graph/tasks/printer.rake
+- lib/call_graph/version.rb
+homepage: 
+licenses:
+- MIT
+metadata: {}
+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.1
+signing_key: 
+specification_version: 4
+summary: Capture execution and create dependency graphs.
+test_files: []