code_mapper 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: c09ff60cb95061ba580b0ee3f2243402f7f07702
+  data.tar.gz: 2f2a7f7799cf6439891b70295410ace5e3418bd5
+SHA512:
+  metadata.gz: 2084b073da582a80ae866c7d3320e47299ad201a9d8509192d3b30004957950ffa4f3ed7d8af6839c3d10be2b68aff90901cd39ad76a6de8c3d50c53459646d3
+  data.tar.gz: de1cb2c4e0d4df8a0629b514291601cb4f8caf0a8395e5015d1d292877e5078a741e7895628551d594c029dce9dedae86fd0bc4bd997d1036935996cd3aee61a

data/.gitignore

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

data/.travis.yml

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

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 cmallette@gmail.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 code_mapper.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2017 Christian Joudrey
+
+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,95 @@
+# CodeMapper
+
+CodeMapper is a tool to generate call graphs from your Ruby code.
+
+I built this tool in order to familiarize myself with new Ruby codebases. You can read all about it [here](https://medium.com/@cjoudrey/familiarizing-myself-with-a-new-codebase-using-rubys-tracepoint-and-graphviz-aebd5d6ac2cd).
+
+![](https://github.com/cjoudrey/code_mapper/raw/master/sample-graph.png)
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'code_mapper'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install code_mapper
+
+## Usage
+
+Generating a call graph and outputting as text to STDOUT:
+
+```ruby
+CodeMapper.trace do
+  # Code to trace
+end
+```
+
+You can limit what classes and methods are outputted using `filter`:
+
+```ruby
+CodeMapper.trace(filter: /^Dog\./) do
+  Dog.new # will get outputted
+  Cat.new # won't get outputted
+end
+```
+
+You can also limit the tracing to a specific lexical scope using `start_at`:
+
+```ruby
+CodeMapper.trace(filter: /^Dog\./, start_at: 'Dog.bark') do
+  dog = Dog.new # won't get outputted
+  dog.bark # will get outputted and all Dog.* calls made within Dog.bark
+  Dog.new # will get outputted
+  Cat.new # won't get outputted
+end
+```
+
+You can limit the depth of the call graph using `max_depth`:
+
+```ruby
+CodeMapper.trace(max_depth: 3) do
+  # Code to trace - only first 3 levels will be outputted
+end
+```
+
+By default, the call graph will be outputted as text to `STDOUT`.
+
+However you can output the call graph to any `IO`:
+
+```ruby
+CodeMapper.trace(output: CodeMapper::Output::Text.new($STDERR)) do
+  # Code to trace
+end
+```
+
+CodeMapper is also capable of outputting `dot` graphs which can be converted to an image using [`graphviz`](http://graphviz.org):
+
+```ruby
+file = File.open('graph.dot', 'w')
+CodeMapper.trace(output: CodeMapper::Output::Dot.new(file)) do
+  # Code to trace
+end
+file.close
+```
+
+```
+$ dot -Tpng graph.dot > graph.png
+```
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/cjoudrey/code_mapper. 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,10 @@
+require "bundler/gem_tasks"
+require "rake/testtask"
+
+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 "code_mapper"
+
+# 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/code_mapper.gemspec

@@ -0,0 +1,28 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'code_mapper/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "code_mapper"
+  spec.version       = CodeMapper::VERSION
+  spec.authors       = ["Christian Joudrey"]
+  spec.email         = ["cmallette@gmail.com"]
+
+  spec.summary       = %q{CodeMapper is a tool to generate call graphs from your Ruby code.}
+  spec.homepage      = "https://github.com/cjoudrey/code_mapper"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0").reject do |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 "graphviz", "~> 0.4"
+
+  spec.add_development_dependency "bundler", "~> 1.14"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "minitest", "~> 5.0"
+end

data/lib/code_mapper.rb

@@ -0,0 +1,25 @@
+require "code_mapper/version"
+require "code_mapper/tracer"
+require "code_mapper/filter/start_at"
+require "code_mapper/filter/callee"
+require "code_mapper/filter/max_depth"
+require "code_mapper/output/text"
+require "code_mapper/output/dot"
+
+module CodeMapper
+  def self.trace(filter: nil, start_at: nil, max_depth: nil, output: CodeMapper::Output::Text.new($stdout), &block)
+    filters = []
+    filters << Filter::Callee.new(filter) if filter
+    filters << Filter::StartAt.new(start_at) if start_at
+    filters << Filter::MaxDepth.new(max_depth) if max_depth
+
+    tracer = Tracer.new(filters: filters, output: output)
+    tracer.enable
+
+    begin
+      yield
+    ensure
+      tracer.disable
+    end
+  end
+end

data/lib/code_mapper/filter.rb

@@ -0,0 +1,5 @@
+module CodeMapper
+  module Filter
+
+  end
+end

data/lib/code_mapper/filter/callee.rb

@@ -0,0 +1,15 @@
+module CodeMapper
+  module Filter
+    class Callee
+      def initialize(callee_matcher)
+        @callee_matcher = callee_matcher
+      end
+
+      def keep?(tp, normalized_class_name)
+        class_and_method = "#{normalized_class_name}.#{tp.method_id}"
+
+        (@callee_matcher =~ class_and_method) != nil
+      end
+    end
+  end
+end

data/lib/code_mapper/filter/max_depth.rb

@@ -0,0 +1,33 @@
+module CodeMapper
+  module Filter
+    class MaxDepth
+      def initialize(max_depth)
+        @max_depth = max_depth
+        @depth = 0
+      end
+
+      def keep?(tp, _)
+        if call_event?(tp)
+          @depth += 1
+          return false if @depth > @max_depth
+        elsif return_event?(tp)
+          old_depth = @depth
+          @depth -= 1
+          return false if old_depth > @max_depth
+        end
+
+        true
+      end
+
+      private
+
+      def call_event?(tp)
+        tp.event == :call || tp.event == :c_call
+      end
+
+      def return_event?(tp)
+        tp.event == :return || tp.event == :c_return
+      end
+    end
+  end
+end

data/lib/code_mapper/filter/start_at.rb

@@ -0,0 +1,53 @@
+module CodeMapper
+  module Filter
+    class StartAt
+      def initialize(start_matcher)
+        @start_matcher = start_matcher
+        @started = false
+        @stack = []
+      end
+
+      def keep?(tp, normalized_class_name)
+        class_and_method = "#{normalized_class_name}.#{tp.method_id}"
+
+        if !@started && call_event?(tp) && matches?(class_and_method)
+          @started = true
+        end
+
+        if @started && call_event?(tp)
+          @stack << class_and_method
+          return true
+        end
+
+        if @started && return_event?(tp)
+          @stack.pop
+
+          if @stack.empty?
+            @started = false
+          end
+        end
+
+        @started
+      end
+
+      private
+
+      def call_event?(tp)
+        tp.event == :call || tp.event == :c_call
+      end
+
+      def return_event?(tp)
+        tp.event == :return || tp.event == :c_return
+      end
+
+      def matches?(class_and_method)
+        case @start_matcher
+        when Regexp
+          (@start_matcher =~ class_and_method) != nil
+        when String
+          @start_matcher == class_and_method
+        end
+      end
+    end
+  end
+end

data/lib/code_mapper/output.rb

@@ -0,0 +1,4 @@
+module CodeMapper
+  module Output
+  end
+end

data/lib/code_mapper/output/dot.rb

@@ -0,0 +1,34 @@
+require 'graphviz'
+
+module CodeMapper
+  module Output
+    class Dot
+      def initialize(io)
+        @io = io
+        @stack = []
+
+        @graph = Graphviz::Graph.new('CodeMapper')
+        @graph.attributes[:rankdir] = 'LR'
+      end
+
+      def push(tp, normalized_class_name)
+        node = @graph.add_node("#{normalized_class_name}.#{tp.method_id.to_s}")
+        node.attributes[:shape] = 'rectangle'
+
+        if @stack != []
+          @stack.last.connect(node)
+        end
+
+        @stack << node
+      end
+
+      def pop(tp, normalized_class_name)
+        @stack.pop
+      end
+
+      def done
+        @io.puts @graph.to_dot
+      end
+    end
+  end
+end

data/lib/code_mapper/output/text.rb

@@ -0,0 +1,22 @@
+module CodeMapper
+  module Output
+    class Text
+      def initialize(io)
+        @io = io
+        @indent = ''
+      end
+
+      def push(tp, normalized_class_name)
+        @io.puts "#{@indent}#{normalized_class_name}.#{tp.method_id.to_s}\n"
+        @indent << '  '
+      end
+
+      def pop(tp, normalized_class_name)
+        @indent = @indent[0...-2]
+      end
+
+      def done
+      end
+    end
+  end
+end

data/lib/code_mapper/tracer.rb

@@ -0,0 +1,37 @@
+module CodeMapper
+  class Tracer
+    def initialize(filters: [], output:)
+      @filters = filters
+      @output = output
+    end
+
+    def enable
+      tracer.enable
+    end
+
+    def disable
+      tracer.disable
+      @output.done
+    end
+
+    private
+
+    def tracer
+      indent = ''
+
+      @tracer ||= TracePoint.new(:call, :c_call, :return, :c_return) do |tp|
+        normalized_class_name = tp.defined_class.to_s
+          .sub(/\#<Class\:(.*)\>/, '\1')
+          .sub(/\#<(.*)\:0x[0-f]+\>/, '\1')
+
+        next if @filters.any?{ |filter| !filter.keep?(tp, normalized_class_name) }
+
+        if tp.event == :call || tp.event == :c_call
+          @output.push(tp, normalized_class_name)
+        elsif tp.event == :return || tp.event == :c_return
+          @output.pop(tp, normalized_class_name)
+        end
+      end
+    end
+  end
+end

data/lib/code_mapper/version.rb

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

metadata

@@ -0,0 +1,121 @@
+--- !ruby/object:Gem::Specification
+name: code_mapper
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Christian Joudrey
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2017-07-10 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: graphviz
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.4'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.4'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.14'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.14'
+- !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: 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:
+- cmallette@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".travis.yml"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- code_mapper.gemspec
+- lib/code_mapper.rb
+- lib/code_mapper/filter.rb
+- lib/code_mapper/filter/callee.rb
+- lib/code_mapper/filter/max_depth.rb
+- lib/code_mapper/filter/start_at.rb
+- lib/code_mapper/output.rb
+- lib/code_mapper/output/dot.rb
+- lib/code_mapper/output/text.rb
+- lib/code_mapper/tracer.rb
+- lib/code_mapper/version.rb
+- sample-graph.png
+homepage: https://github.com/cjoudrey/code_mapper
+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: []
+rubyforge_project: 
+rubygems_version: 2.6.8
+signing_key: 
+specification_version: 4
+summary: CodeMapper is a tool to generate call graphs from your Ruby code.
+test_files: []