gun_dog 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 61ac60f86383d4ec2f4df7d5dba8d6ab0f503dc7
+  data.tar.gz: 4dba94dd287a55fd391fdae2bce8168d2dc84bf9
+SHA512:
+  metadata.gz: 340f5de44210a25028553ddb84a31183b997327258eb30331c1cfb0683450f77aef5518fb2cb18492d3aa427828bcd827782d05c7bccdfe6889777dc12d60d38
+  data.tar.gz: 595cb603c9f1c57030f5cbffa9e4ceb419ffe95869e3f085fb79aaea7fb82405cc56186d6439299e36b89527c75fc88f0f439e73a969a374294957cbef32534c

data/.gitignore

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

data/.rspec

@@ -0,0 +1,2 @@
+--format documentation
+--color

data/.travis.yml

@@ -0,0 +1,5 @@
+sudo: false
+language: ruby
+rvm:
+  - 2.3.4
+before_install: gem install bundler -v 1.15.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 gun_dog.gemspec
+gemspec

data/README.md

@@ -0,0 +1,60 @@
+# GunDog
+
+GunDog is a Tracepoint tool for finding the interface of particular classes
+within a given context.
+
+Often times you'd like to refactor a class, but are not sure about what sort of
+calls the class may receive.  GunDog sets up special Tracepoint listeners to log
+and record code execution metrics on a given class.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby gem 'gun_dog' ```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install gun_dog
+
+## Usage
+
+To use GunDog find the general area were you'd like to refactor a class.
+
+```
+trace = GunDog.trace(MyClassName) do
+    some_code_that_executes_your_class
+end
+```
+
+Trace is a GunDog::TraceReport object that can be saved to JSON (and loaded from
+JSON) for analysis.
+
+GunDog is still a pup - here are some upcoming features.
+
+- [ ] TraceReport introspect methods from CallRecords
+- [ ] TraceReport pretty reports
+- [ ] Trace Multiple Classes with one Dog
+- [ ] Inhibit: Generate warnings when methods in a TraceReport are called.
+
+
+## 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/stephenprater/gun_dog.

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 "gun_dog"
+
+# 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/gun_dog.gemspec

@@ -0,0 +1,30 @@
+# coding: utf-8
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "gun_dog/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "gun_dog"
+  spec.version       = GunDog::VERSION
+  spec.authors       = ["Stephen Prater"]
+  spec.email         = ["me@stephenprater.com"]
+
+  spec.summary       = %q{Log callsite information for a given class.}
+  spec.description   = %q{Log callsite information for a given class.}
+  spec.homepage      = "http://github.com/stephenprater/gun_dog"
+
+  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 "multi_json", "~> 1.12"
+  spec.add_dependency "activesupport", ">= 4.2.9"
+
+  spec.add_development_dependency "bundler", "~> 1.15"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.0"
+  spec.add_development_dependency "pry-byebug"
+end

data/lib/gun_dog/call_record.rb

@@ -0,0 +1,73 @@
+module GunDog
+  class CallRecord
+    attr_accessor :args, :return_value, :method_name
+    attr_accessor :stack
+
+    attr_writer :internal, :cyclical
+
+    def self.from_json(json)
+      cr = new(const_get(json['klass']),
+          json['method_name'],
+          class_method: json['class_method'])
+
+      cr.instance_eval do
+        @internal = json['internal']
+        @cyclical = json['cyclical']
+        @args = json['args']
+        @return_value = json['return_value']
+        @stack = json['stack']
+      end
+
+      cr
+    end
+
+    def initialize(klass, method_name, class_method: false)
+      @klass = klass
+      @method_name = method_name
+      @class_method = class_method
+    end
+
+    def method_location
+      "#{@klass}#{method_separator}#{method_name}"
+    end
+
+    def internal?
+      !!@internal
+    end
+
+    def cyclical?
+      !!@cyclical
+    end
+
+    def class_method?
+      !!@class_method
+    end
+
+    def to_s
+      "def #{method_name}(#{type_signatures(args)}) => #{return_value}"
+    end
+
+    def as_json
+      {
+        "klass" => @klass,
+        "method_name" => method_name,
+        "class_method" => class_method?,
+        "internal" => internal?,
+        "cyclical" => cyclical?,
+        "args" => args,
+        "return_value" => return_value,
+        "stack" => stack
+      }.reject { |_,v| v.nil? }
+    end
+
+    private
+
+    def type_signatures(args)
+      args.each_pair.map { |k,v| "#{k} : #{v}" }.join(', ')
+    end
+
+    def method_separator
+      class_method? ? '.' : '#'
+    end
+  end
+end

data/lib/gun_dog/indexed_array.rb

@@ -0,0 +1,24 @@
+module GunDog
+  class IndexedArray < Array
+    attr_reader :lut
+
+    def initialize(*args)
+      super(args)
+      @lut = {}
+    end
+
+    def <<(obj)
+      super(obj)
+      @lut[obj.object_id] = length
+      obj
+    end
+
+    def index_of_object(obj)
+      @lut.fetch(obj.object_id)
+    end
+
+    def find_object(obj)
+      at(index_of_object(obj))
+    end
+  end
+end

data/lib/gun_dog/method_owner_stack_frame.rb

@@ -0,0 +1,7 @@
+module GunDog
+  class MethodOwnerStackFrame < Struct.new(:klass, :method_name)
+    def to_s
+      "#{klass}##{method_name}"
+    end
+  end
+end

data/lib/gun_dog/trace_maker.rb

@@ -0,0 +1,79 @@
+module GunDog
+  class TraceMaker
+    attr_reader :trace_report, :return_trace, :call_trace, :klass
+
+    def initialize(klass, &exec_block)
+      @klass = klass
+      @trace_report = TraceReport.new(klass)
+      @trace_report.stack << MethodOwnerStackFrame.new(GunDog, :trace)
+      @exec_block = exec_block
+    end
+
+    def exec
+      set_trace
+
+      call_trace.enable do
+        return_trace.enable do
+          @exec_block.call
+        end
+      end
+
+      trace_report.finalize_report
+      trace_report
+    ensure
+      call_trace.disable
+      return_trace.disable
+    end
+
+    def set_trace
+      set_return_trace
+      set_call_trace
+    end
+
+    def set_return_trace
+      @return_trace ||= TracePoint.new(:return) do |tp|
+        trace_report.stack.pop
+      end
+    end
+
+    def set_call_trace
+      @call_trace ||= TracePoint.new(:call) do |tp|
+        trace_report.stack << MethodOwnerStackFrame.new(tp.defined_class, tp.method_id)
+        next unless tp.defined_class == klass || tp.defined_class == klass.singleton_class
+
+        tp.disable
+
+        call_record = CallRecord.new(klass, tp.method_id, class_method: tp.defined_class == klass.singleton_class)
+        called_method = tp.self.method(tp.method_id)
+        call_record.args = called_method.parameters.each.with_object({}) do |p, memo|
+          memo[p.last] = tp.binding.local_variable_get(p.last).class
+        end
+
+        trace_report.call_records << call_record
+
+        set_method_return_trace(call_record).enable
+
+        tp.enable
+      end
+    end
+
+    def set_method_return_trace(call_record)
+      # instantiate a new return tracepoint to watch for the return of this
+      # method only
+      #
+      TracePoint.new(:return) do |mrt|
+        next if mrt.method_id != call_record.method_name
+        mrt.disable
+        call_record.return_value = mrt.return_value.class
+
+        if trace_report.stack.internal_stack?
+          call_record.internal = true
+          call_record.stack = trace_report.stack.dup
+        elsif trace_report.stack.cyclical_stack?
+          call_record.cyclical = true
+          call_record.stack = trace_report.stack.dup
+        end
+      end
+    end
+  end
+end

data/lib/gun_dog/trace_report.rb

@@ -0,0 +1,74 @@
+module GunDog
+  class TraceReport
+    attr_reader :klass
+
+    def self.load(filename)
+      json = MultiJson.load(File.open(filename, 'r') { |f| f.read })
+      from_json(json)
+    end
+
+    def self.from_json(json)
+      tr = new(nil)
+
+      tr.instance_eval do
+        @klass = Kernel.const_get(json['klass'])
+        @stack = TraceStack.from_json(json.slice('klass','collaborating_classes'))
+        @call_records = json['call_records'].map { |cr| CallRecord.from_json(cr) }
+      end
+
+      tr
+    end
+
+    def call_records
+      @call_records ||= []
+    end
+
+    def initialize(klass)
+      @klass = klass
+    end
+
+    def collaborating_classes
+      stack.collaborating_classes - [GunDog, klass]
+    end
+
+    def stack
+      @stack ||= TraceStack.new(klass)
+    end
+
+    def finalize_report
+      @call_records.freeze
+      @stack.clear.freeze
+      @finalized = true
+    end
+
+    def finalized?
+      !!@finalized
+    end
+
+    def save(filename)
+      File.open(filename, 'w') { |f| f.puts(to_json) }
+    end
+
+
+    def as_json
+      {
+        "klass" => klass,
+        "collaborating_classes" => collaborating_classes.to_a,
+        "call_records" => call_records.map(&:as_json)
+      }
+    end
+
+    def to_json
+      MultiJson.dump(as_json)
+    end
+
+    def find_call_record(doc_name)
+      @find_cache ||= @call_records.group_by(&:method_location)
+      @find_cache[doc_name]
+    end
+
+    def method_list
+      @call_records.map(&:method_location)
+    end
+  end
+end

data/lib/gun_dog/trace_stack.rb

@@ -0,0 +1,57 @@
+module GunDog
+  class TraceStack < Array
+    attr_reader :collaborating_classes, :klass
+
+    def self.from_json(json)
+      ts = new(json['klass'])
+
+      ts.instance_eval do
+        @collaborating_classes = Set.new(json['collaborating_classes'].map { |k| Kernel.const_get(k) })
+      end
+
+      ts
+    end
+
+    def classes_in_stack
+      self.group_by(&:klass).keys.to_set
+    end
+
+    def initialize(klass)
+      @klass = klass
+      @collaborating_classes = Set.new
+    end
+
+    def internal_stack?
+      # if the set of the classes contained in the trace is equivalent to the
+      # set of our own class then it is an interal stack (ie - all methods are
+      # internal to the traced class)
+      call_stack.classes_in_stack == self_set
+    end
+
+    def cyclical_stack?
+      # if the set of classes contained in the trace is a superset of the set
+      # of our class then it is a cyclical stack (ie, it contains calls both
+      # within and without of the class)
+      call_stack.classes_in_stack > self_set
+    end
+
+    def preceded_by_traced_klass?
+      traced_klasses = self.map(&:klass)
+      traced_klasses.include?(klass) || traced_klasses.include?(klass.singleton_class)
+    end
+
+    def self_set
+      [klass].to_set
+    end
+
+    def call_stack
+      # the stack excluding the sentinel (element zero) and our selves (element -1)
+      self.slice(1 .. -2) || TraceStack.new(klass)
+    end
+
+    def <<(frame)
+      collaborating_classes.add(frame.klass) if preceded_by_traced_klass?
+      super(frame)
+    end
+  end
+end

data/lib/gun_dog/version.rb

@@ -0,0 +1,3 @@
+module GunDog
+  VERSION = "0.0.1"
+end

data/lib/gun_dog.rb

@@ -0,0 +1,17 @@
+require "gun_dog/version"
+require 'json'
+require 'multi_json'
+require 'active_support/core_ext/hash/slice'
+require 'active_support/core_ext/string/filters'
+
+module GunDog
+  autoload :MethodOwnerStackFrame, 'gun_dog/method_owner_stack_frame'
+  autoload :CallRecord, 'gun_dog/call_record'
+  autoload :TraceMaker, 'gun_dog/trace_maker'
+  autoload :TraceReport, 'gun_dog/trace_report'
+  autoload :TraceStack, 'gun_dog/trace_stack'
+
+  def self.trace(klass, &block)
+    TraceMaker.new(klass, &block).exec
+  end
+end

metadata

@@ -0,0 +1,144 @@
+--- !ruby/object:Gem::Specification
+name: gun_dog
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Stephen Prater
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2017-10-12 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: multi_json
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.12'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.12'
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 4.2.9
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 4.2.9
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.15'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.15'
+- !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: pry-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: Log callsite information for a given class.
+email:
+- me@stephenprater.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- Gemfile
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- gun_dog.gemspec
+- lib/gun_dog.rb
+- lib/gun_dog/call_record.rb
+- lib/gun_dog/indexed_array.rb
+- lib/gun_dog/method_owner_stack_frame.rb
+- lib/gun_dog/trace_maker.rb
+- lib/gun_dog/trace_report.rb
+- lib/gun_dog/trace_stack.rb
+- lib/gun_dog/version.rb
+homepage: http://github.com/stephenprater/gun_dog
+licenses: []
+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.5.2
+signing_key: 
+specification_version: 4
+summary: Log callsite information for a given class.
+test_files: []