gun_dog 0.0.1 → 0.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 61ac60f86383d4ec2f4df7d5dba8d6ab0f503dc7
-  data.tar.gz: 4dba94dd287a55fd391fdae2bce8168d2dc84bf9
+  metadata.gz: 8553b5cae7081c781faffb51279789d50c10b352
+  data.tar.gz: f1dae43fce48c756e6bc004a7708879d3f1e7d94
 SHA512:
-  metadata.gz: 340f5de44210a25028553ddb84a31183b997327258eb30331c1cfb0683450f77aef5518fb2cb18492d3aa427828bcd827782d05c7bccdfe6889777dc12d60d38
-  data.tar.gz: 595cb603c9f1c57030f5cbffa9e4ceb419ffe95869e3f085fb79aaea7fb82405cc56186d6439299e36b89527c75fc88f0f439e73a969a374294957cbef32534c
+  metadata.gz: bab212ec57b6f8d3b10b8fbb4adda795a932aa6b539ecd53b35b3977d628040696fe9544d49508f24be2c4827195b86100269694a8a05cb1ffd8f421c955cc70
+  data.tar.gz: 53117f89da46453a9e567265ab8bb781c2c6431b859b713fdefa57c502b5f62355ef9e1456001fe5c88439505bfa0704bcd7f432cd7ca4610f0155e6d71107b8

data/gun_dog.gemspec

@@ -27,4 +27,6 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency "rake", "~> 10.0"
   spec.add_development_dependency "rspec", "~> 3.0"
   spec.add_development_dependency "pry-byebug"
+  spec.add_development_dependency "activerecord", ">= 4.2.9"
+  spec.add_development_dependency "sqlite3"
 end

data/lib/gun_dog/call_record.rb

@@ -1,30 +1,36 @@
 module GunDog
   class CallRecord
+    using ClassEncoding
+
     attr_accessor :args, :return_value, :method_name
     attr_accessor :stack
 
-    attr_writer :internal, :cyclical
+    attr_writer :internal, :cyclical, :dynamic
 
     def self.from_json(json)
-      cr = new(const_get(json['klass']),
-          json['method_name'],
-          class_method: json['class_method'])
+      cr = new(
+        Utilities.get_class(json['klass']),
+        json['method_name'],
+        class_method: json['class_method'],
+        generated: json['generated']
+      )
 
       cr.instance_eval do
         @internal = json['internal']
         @cyclical = json['cyclical']
         @args = json['args']
         @return_value = json['return_value']
-        @stack = json['stack']
+        @stack = TraceStack.from_array(klass: @klass, stack: json['stack']) if json['stack']
       end
 
       cr
     end
 
-    def initialize(klass, method_name, class_method: false)
+    def initialize(klass, method_name, class_method: false, generated: false)
       @klass = klass
       @method_name = method_name
       @class_method = class_method
+      @generated = generated
     end
 
     def method_location
@@ -39,31 +45,59 @@ module GunDog
       !!@cyclical
     end
 
+    def dynamic?
+      !!@dynamic
+    end
+
     def class_method?
       !!@class_method
     end
 
-    def to_s
-      "def #{method_name}(#{type_signatures(args)}) => #{return_value}"
+    def generated?
+      !!@generated
+    end
+
+    def unbound_method
+      if class_method?
+        @klass.method(method_name).unbind
+      else
+        @klass.instance_method(method_name)
+      end
+    end
+
+    def call_record_signature
+      "#{generated? ? "[generated] " : nil } \
+        def #{class_method? ? "self." : nil}#{method_name}(#{type_signatures(args)}) : #{return_value.class} \
+        #{ internal? ? " (internal)" : nil } \
+        #{ cyclical? ? " (cyclical)" : nil } \
+        #{ dynamic? ? " (dynamic)" : nil }".squish
     end
 
     def as_json
       {
-        "klass" => @klass,
-        "method_name" => method_name,
+        "klass" => @klass.json_encoded,
+        "method_name" => method_name.to_s,
         "class_method" => class_method?,
+        "generated" => generated?,
         "internal" => internal?,
         "cyclical" => cyclical?,
-        "args" => args,
+        "dynamic" => dynamic?,
+        "args" => args.each_pair.with_object({}) { |(k,v), memo| memo[k.to_s] = v},
         "return_value" => return_value,
-        "stack" => stack
+        "stack" => stack&.as_json
       }.reject { |_,v| v.nil? }
     end
 
     private
 
     def type_signatures(args)
-      args.each_pair.map { |k,v| "#{k} : #{v}" }.join(', ')
+      if method_name == :method_missing
+        #TODO pass v here back through this method to show the type signatures for each method rather than
+        # individual arguments
+        args.each_pair.map { |k,v| "#{k} : #{v ? v.to_s : v.class}" }.join(', ')
+      else
+        args.each_pair.map { |k,v| "#{k} : #{v.class}" }.join(', ')
+      end
     end
 
     def method_separator

data/lib/gun_dog/class_encoding.rb

@@ -0,0 +1,20 @@
+module GunDog
+  module ClassEncoding
+    refine Class do
+      def json_encoded
+        if singleton_class?
+          "#{ObjectSpace.each_object(self).first}.singleton_class"
+        else
+          name || "(anonymous subclass of #{superclass.name}"
+        end
+      end
+    end
+
+    refine Module do
+      def json_encoded
+        return name if name
+        "(anonymous module extended to an instance of #{ObjectSpace.each_object(self).first.class})"
+      end
+    end
+  end
+end

data/lib/gun_dog/method_owner_stack_frame.rb

@@ -1,7 +1,16 @@
 module GunDog
   class MethodOwnerStackFrame < Struct.new(:klass, :method_name)
+    using ClassEncoding
+
     def to_s
       "#{klass}##{method_name}"
     end
+
+    def as_json
+      {
+        "klass" => klass.json_encoded,
+        "method_name" => method_name.to_s
+      }
+    end
   end
 end

data/lib/gun_dog/trace_explorer.rb

@@ -0,0 +1,57 @@
+require 'active_support/core_ext/module/delegation'
+
+module GunDog
+  class TraceExplorer
+    attr_reader :trace_report
+
+    def initialize(trace_report)
+      @trace_report = trace_report
+    end
+
+    def unique_call_signatures
+      @trace_report.call_records.map(&:call_record_signature).uniq
+    end
+
+    def cyclical_methods
+      @trace_report.call_records.select(&:cyclical?)
+    end
+
+    def internal_methods
+      @trace_report.call_records.select(&:internal?)
+    end
+
+    def collaborating_local_classes
+      @trace_report.collaborating_classes.select { |k| Utilities.local_locations_for_class(k).any? }
+    end
+
+    def collaborating_classes
+      @trace_report.collaborating_classes
+    end
+
+    def trace
+      @trace_report
+    end
+
+    def [](method_location)
+      find_cache[method_location]
+    end
+
+    def methods
+      find_cache.keys
+    end
+
+    def unique_traces(doc_name)
+      find_cache[doc_name].map { |cr| cr.stack&.map(&:to_s) }.uniq.compact
+    end
+
+    def call_count
+      find_cache.each_pair.with_object({}) { |(k,v), memo| memo[k] = v.count }
+    end
+
+    private
+
+    def find_cache
+      find_cache ||= @trace_report.call_records.group_by(&:method_location)
+    end
+  end
+end

data/lib/gun_dog/trace_maker.rb

@@ -1,11 +1,14 @@
+require 'active_support/core_ext/module/anonymous'
+
 module GunDog
   class TraceMaker
-    attr_reader :trace_report, :return_trace, :call_trace, :klass
+    attr_reader :trace_report, :return_trace, :call_trace, :klass, :complete_call_list
 
-    def initialize(klass, &exec_block)
+    def initialize(klass, suppress: [], &exec_block)
       @klass = klass
-      @trace_report = TraceReport.new(klass)
+      @trace_report = TraceReport.new(klass, suppression_set: build_suppression_set(suppress))
       @trace_report.stack << MethodOwnerStackFrame.new(GunDog, :trace)
+      @ancestor_cache = {}
       @exec_block = exec_block
     end
 
@@ -39,14 +42,36 @@ module GunDog
     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)
+        binding_class = tp.binding.eval('self').class
+        trace_type = trace_method(binding_class, tp.defined_class)
+
+        unless trace_type
+          tp.enable
+          next
+        end
+
+        method_id = tp.binding.eval('__callee__') || tp.method_id
+
+        called_method = if trace_type == :meta
+          tp.binding.eval('self').method(method_id)
+        else
+          tp.self.method(tp.method_id)
+        end
+
+        # next if trace_report.suppression_set.include?(called_method.unbind)
+
+        call_record = CallRecord.new(
+          klass,
+          called_method.name,
+          class_method: trace_type == :eigen,
+          generated: trace_type == :meta
+        )
+
         call_record.args = called_method.parameters.each.with_object({}) do |p, memo|
-          memo[p.last] = tp.binding.local_variable_get(p.last).class
+          memo[p.last] = tp.binding.local_variable_get(p.last)
         end
 
         trace_report.call_records << call_record
@@ -57,23 +82,62 @@ module GunDog
       end
     end
 
+    def trace_method(binding_class, defined_class)
+      return :eigen if defined_class == klass.singleton_class
+      return false if binding_class != klass
+      return :meta if klass < defined_class && (defined_class.anonymous? || after_super?(defined_class))
+      return :instance if defined_class == klass
+      false
+    end
+
+    def after_super?(defined_class)
+      return true unless klass.superclass != Object
+
+      if @ancestor_cache.has_key?(defined_class)
+        @ancestor_cache[defined_class]
+      else
+        ancestors = klass.ancestors
+        @ancestor_cache[defined_class] = ancestors.index(klass.superclass) > ancestors.index(defined_class)
+      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
+        method_id = mrt.binding.eval('__callee__') || mrt.method_id
+        next if method_id != call_record.method_name
         mrt.disable
-        call_record.return_value = mrt.return_value.class
+        call_record.return_value = mrt.return_value
 
         if trace_report.stack.internal_stack?
           call_record.internal = true
-          call_record.stack = trace_report.stack.dup
+          call_record.stack = trace_report.stack.since_first_klass_entry
         elsif trace_report.stack.cyclical_stack?
           call_record.cyclical = true
-          call_record.stack = trace_report.stack.dup
+          call_record.stack = trace_report.stack.since_first_klass_entry
+        end
+
+        if trace_report.stack.dynamic_stack?
+          call_record.dynamic = true
+          call_record.stack = trace_report.stack.since_first_klass_entry
         end
       end
     end
+
+    def build_suppression_set(suppression_list)
+      suppression_list.map { |method_id|
+        begin
+          if class_method = method_id[/self\.(.*)/,1]
+            klass.method(class_method).unbind
+          else
+            klass.instance_method(method_id)
+          end
+        rescue NameError
+          nil
+        end
+      }.uniq.to_set
+    end
   end
 end

data/lib/gun_dog/trace_report.rb

@@ -1,6 +1,8 @@
 module GunDog
   class TraceReport
-    attr_reader :klass
+    using ClassEncoding
+
+    attr_reader :klass, :suppression_set
 
     def self.load(filename)
       json = MultiJson.load(File.open(filename, 'r') { |f| f.read })
@@ -19,12 +21,21 @@ module GunDog
       tr
     end
 
+    def all_calls
+      @all_calls ||= []
+    end
+
+    def explore
+      GunDog::TraceExplorer.new(self)
+    end
+
     def call_records
       @call_records ||= []
     end
 
-    def initialize(klass)
+    def initialize(klass, suppression_set: [])
       @klass = klass
+      @suppression_set = suppression_set
     end
 
     def collaborating_classes
@@ -52,21 +63,18 @@ module GunDog
 
     def as_json
       {
-        "klass" => klass,
-        "collaborating_classes" => collaborating_classes.to_a,
+        "klass" => klass.to_s,
+        "collaborating_classes" => collaborating_classes.map { |k| k.json_encoded },
         "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

data/lib/gun_dog/trace_stack.rb

@@ -6,7 +6,16 @@ module GunDog
       ts = new(json['klass'])
 
       ts.instance_eval do
-        @collaborating_classes = Set.new(json['collaborating_classes'].map { |k| Kernel.const_get(k) })
+        @collaborating_classes = Set.new(json['collaborating_classes'].map { |k| Utilities.get_class(k) })
+      end
+
+      ts
+    end
+
+    def self.from_array(klass:, stack: )
+      ts = new(klass)
+      stack.each do |f|
+        ts << GunDog::MethodOwnerStackFrame.new(Utilities.get_class(f['klass']), f['method_name'])
       end
 
       ts
@@ -18,21 +27,27 @@ module GunDog
 
     def initialize(klass)
       @klass = klass
+      @traced_klass_entry_points = Array.new
       @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
+      # if the set of classes contained in the trace since we entered our own
+      # class is equivalent to the set of our own class then it is an internal
+      # trace
+      since_first_klass_entry.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
+      # if the set of classes contained in the trace since we entered our own
+      # class 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)
+      since_first_klass_entry.classes_in_stack > self_set
+    end
+
+    def dynamic_stack?
+      methods = since_first_klass_entry.map { |f| f.method_name.to_s }
+      methods.include?('method_missing') || methods.include?('send') || methods.include?('__send__')
     end
 
     def preceded_by_traced_klass?
@@ -44,14 +59,37 @@ module GunDog
       [klass].to_set
     end
 
+    def since_first_klass_entry
+      # the stack since the first call to a traced method excluding the current
+      # frame
+      self.slice((@traced_klass_entry_points.first || 1) .. -2) || GunDog::TraceStack.new(@klass)
+    end
+
     def call_stack
-      # the stack excluding the sentinel (element zero) and our selves (element -1)
+      # the stack excluding the gundog sentinel (element zero) and ourselves (element -1)
       self.slice(1 .. -2) || TraceStack.new(klass)
     end
 
+    def pop
+      super.tap do |popped|
+        if length == @traced_klass_entry_points.last
+          @traced_klass_entry_points.pop
+        end
+      end
+    end
+
     def <<(frame)
       collaborating_classes.add(frame.klass) if preceded_by_traced_klass?
+      @traced_klass_entry_points << length if frame_owned_by_traced_klass?(frame)
       super(frame)
     end
+
+    def frame_owned_by_traced_klass?(frame)
+      frame.klass == klass || frame.klass.singleton_class == klass.singleton_class
+    end
+
+    def as_json
+      map(&:as_json)
+    end
   end
 end

data/lib/gun_dog/utilities.rb

@@ -0,0 +1,36 @@
+module GunDog
+  module Utilities
+    class UnencodableClass; end
+
+    def self.get_class(str)
+      if str =~ /anonymous/
+        Class.new(UnencodableClass) do |k|
+          def json_encoded
+            k
+          end
+        end
+      else
+        begin
+          eval(str)
+        rescue => e
+          require 'pry'; binding.pry
+          e.message
+        end
+      end
+    end
+
+    def self.local_locations_for_class(c)
+      all_locations_for_class(c)
+        .reject { |p| p =~ /(gem)|(rubies)|(eval)/ }
+    end
+
+    def self.all_locations_for_class(c)
+      c.instance_methods
+        .map { |m| c.instance_method(m) }
+        .select { |m| m.owner == c }
+        .map { |m| m.source_location&.first }
+        .compact
+        .uniq
+    end
+  end
+end

data/lib/gun_dog/version.rb

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

data/lib/gun_dog.rb

@@ -1,17 +1,38 @@
-require "gun_dog/version"
+require 'gun_dog/version'
 require 'json'
 require 'multi_json'
 require 'active_support/core_ext/hash/slice'
 require 'active_support/core_ext/string/filters'
+require 'active_support/configurable'
 
 module GunDog
+  include ActiveSupport::Configurable
+
+  config_accessor :suppress_methods do
+    {}
+  end
+
   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'
+  autoload :TraceExplorer, 'gun_dog/trace_explorer'
+  autoload :ClassEncoding, 'gun_dog/class_encoding'
+  autoload :Utilities, 'gun_dog/utilities'
+
+  class << self
+    private def suppressed_methods_for_klass(klass)
+      config.suppress_methods.values_at(*klass.ancestors).flatten.compact
+    end
+  end
+
 
   def self.trace(klass, &block)
-    TraceMaker.new(klass, &block).exec
+    TraceMaker.new(klass, suppress: suppressed_methods_for_klass(klass), &block).exec
+  end
+
+  def self.load_trace(path)
+    TraceReport.load(path)
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: gun_dog
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.0.2
 platform: ruby
 authors:
 - Stephen Prater
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2017-10-12 00:00:00.000000000 Z
+date: 2017-10-19 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: multi_json
@@ -94,6 +94,34 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: activerecord
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 4.2.9
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 4.2.9
+- !ruby/object:Gem::Dependency
+  name: sqlite3
+  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
@@ -112,11 +140,14 @@ files:
 - gun_dog.gemspec
 - lib/gun_dog.rb
 - lib/gun_dog/call_record.rb
+- lib/gun_dog/class_encoding.rb
 - lib/gun_dog/indexed_array.rb
 - lib/gun_dog/method_owner_stack_frame.rb
+- lib/gun_dog/trace_explorer.rb
 - lib/gun_dog/trace_maker.rb
 - lib/gun_dog/trace_report.rb
 - lib/gun_dog/trace_stack.rb
+- lib/gun_dog/utilities.rb
 - lib/gun_dog/version.rb
 homepage: http://github.com/stephenprater/gun_dog
 licenses: []