method_call_tracer 0.1.0 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: c0a180a16f9d4798139f03dc6cc487632ec0cfbf
-  data.tar.gz: d7294c63a4bc0e293fa9e883338248aee417c050
+  metadata.gz: 5ec122bd2856f55ddd0958f690f667cfac0dd6d0
+  data.tar.gz: c517dc70ab2c883d8acc5e8b32e78a833c0565ba
 SHA512:
-  metadata.gz: 9f03140a84d526cc297d97c650ae3a55df9e28dbfe2b5d8be5ed832aee97689a73b4eb2402faaca16d5ad1a9b2a2c434fe9f1d4032041b45cabc2e2135e818d8
-  data.tar.gz: 2e36e0b7bcbb327ffa925f3667f23532238d47956ca70ce6a46e852732aca43b700288473bd45fe82eefcb0854ccab39310fe69849ea68b49448d9fd23601f1b
+  metadata.gz: f1f235d6fe985239be47614b1bcfd9a925c157152de974d7dabf071d0cf36a024dbc63f37db9b9bbfc71351faec6cfd0b93d5fef9874916199e456e1b26366a2
+  data.tar.gz: 672b73d90ab60177d87b3f0a67ab828800154e077c20cdc51facc2178637ba3ff015731e7bf85a13c53d844827406218c61575799a114f335c7869272af34a01

data/README.md

@@ -4,6 +4,8 @@ MethodTracer is a tool for detecting lines in an application that call certain m
 
 <sup>1</sup> Designating traced methods by file lets you trace methods defined in the "namespace" of a different gem. For example, if a hypothetical gem `activerecord-extension` defines some methods on the class `ActiveRecord`, we still have the ability to trace only the methods from `activerecord-extension` without capturing the methods from `activerecord`.
 
+**Note about gem name**: due to a naming collision on rubygems.org, this gem appears there as `method_call_tracer`.
+
 ## Usage
 
 To attach tracers to methods, instantiate `MethodTracer::Tracer` objects. For Rails applications, these can be placed in the provided initializer.
@@ -35,7 +37,7 @@ MethodTracer theoretically does not interfere with the original behavior of meth
 Add this line to your application's Gemfile:
 
 ```ruby
-gem 'method_tracer'
+gem 'method_call_tracer'
 ```
 
 And then execute:
@@ -44,7 +46,7 @@ And then execute:
 
 Or install it yourself as:
 
-    $ gem install method_tracer
+    $ gem install method_call_tracer
 
 If you are using it with Rails, run the installation generator to install an example config initializer:
 

data/lib/generators/method_tracer/templates/initializer.rb

@@ -1,3 +1,5 @@
+require 'method_tracer'
+
 # Define the prefix for the application code. Only calls matching this pattern
 # will be recorded.
 MethodTracer::Config.app_path = Rails.application.paths.path.to_s

data/lib/method_tracer/tracer.rb

@@ -1,37 +1,28 @@
+require 'where_is'
+
 module MethodTracer
   class Tracer
-    UNCOOPERATIVE_NAMES = [
-      # Some classes don't behave well when we try to hook them, at least with
-      # the methods currently used.
-      'CGI',    # Waits for input from stdin when opening rails console
-      'RSpec'   # RSpec doesn't run
-    ].freeze
-
     def initialize(target)
       @target_path = target
 
-      find_methods!
-
-      add_hooks_to_class_methods
-      add_hooks_to_instance_methods
+      @tracer = TracePoint.trace(:call) do |tp|
+        record_call_if_interesting(tp)
+      end
     end
 
-    def self.uncooperative_class?(class_name)
-      !class_name.nil? &&
-        UNCOOPERATIVE_NAMES.any? { |bad_name| class_name.include?(bad_name) }
-    end
+    def record_call_if_interesting(tp)
+      return unless class_is_interesting?(tp.defined_class)
 
-    def self.record_and_call_original(unbound_m, receiver, *args, &block)
-      outfile.write "#{receiver}.#{unbound_m.name} called from:\n"
-      caller_locations.select { |loc| loc.path.start_with?(Config.app_path) }
-                      .each do |loc|
-                        outfile.write "#{loc.path}:#{loc.lineno}\n"
-                      end
+      locations = caller_locations.select { |loc| loc.path.start_with?(Config.app_path) }
+      return if locations.empty?
 
-      unbound_m.bind(receiver).call(*args, &block)
+      outfile.write "#{@target_path} :#{tp.method_id}\n"
+      locations.each do |loc|
+        outfile.write "#{loc.path}:#{loc.lineno}\n"
+      end
     end
 
-    def self.outfile
+    def outfile
       @outfile ||= begin
                      output_file = Config.output_file
                      if output_file.instance_of?(IO) || output_file.instance_of?(StringIO)
@@ -44,58 +35,13 @@ module MethodTracer
                    end
     end
 
-    private
-
-    def add_hooks_to_class_methods
-      methods_of_interest(@all_class_methods).each do |m|
-        unbound_m = m.unbind
-        receiver = m.receiver
-
-        receiver.send(:define_singleton_method, unbound_m.name) do |*args, &block|
-          Tracer.record_and_call_original(unbound_m, receiver, *args, &block)
-        end
-      end
-    end
-
-    def add_hooks_to_instance_methods
-      methods_of_interest(@all_instance_methods).each do |m|
-        unbound_m = m.unbind
-        receiver = m.receiver
-
-        receiver.class.send(:define_method, m.name) do |*args, &block|
-          Tracer.record_and_call_original(unbound_m, receiver, *args, &block)
-        end
-      end
-    end
-
-    def find_methods!
-      @all_class_methods = []
-      @all_instance_methods = []
-      ObjectSpace.each_object(Class) do |defined_class|
-        next if Tracer.uncooperative_class?(defined_class.name)
-
-        defined_class.methods(false).each do |method_sym|
-          @all_class_methods << defined_class.method(method_sym)
-        end
-
-        begin
-          instance = defined_class.new
-          defined_class.instance_methods(false).each do |method_sym|
-            @all_instance_methods << instance.method(method_sym)
-          end
-        rescue StandardError, NotImplementedError, LoadError
-          # If the class isn't instantiable, skip it
-          next
-        end
-      end
-    end
-
-    def methods_of_interest(methods)
-      methods.select do |m|
-        m.instance_of?(Method) &&
-          !m.source_location.nil? &&
-          m.source_location[0].start_with?(@target_path)
+    def class_is_interesting?(candidate_class)
+      begin
+        location = Where.is(candidate_class)
+      rescue NameError
+        return false
       end
+      location[:file].start_with?(@target_path)
     end
   end
 end

data/lib/method_tracer/version.rb

@@ -1,3 +1,3 @@
 module MethodTracer
-  VERSION = '0.1.0'.freeze
+  VERSION = '0.2.0'.freeze
 end

data/method_tracer.gemspec

@@ -21,5 +21,7 @@ Gem::Specification.new do |spec|
   end
   spec.require_paths = ['lib']
 
-  spec.add_development_dependency 'minitest', '~> 0'
+  spec.add_dependency 'where_is', '~> 0'
+
+  spec.add_development_dependency 'minitest', '~> 5'
 end

metadata

@@ -1,29 +1,43 @@
 --- !ruby/object:Gem::Specification
 name: method_call_tracer
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors:
 - Eddie Lebow
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-09-24 00:00:00.000000000 Z
+date: 2018-09-25 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
-  name: minitest
+  name: where_is
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '0'
-  type: :development
+  type: :runtime
   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'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5'
 description: This tool wraps every specified method with some logging statements that
   record the call stack, allowing you to see exactly which lines in your application
   make calls to methods in question. The specified methods can constitute all methods