ruby_tracer 0.1.0 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 752f406d1a3b8967596a30cc918fe2176f0da30df84651316ce452fae36cc940
-  data.tar.gz: cc21e0f38a5508be8154621d7a68a247a2cc1a43d0fc9c3294176bb32ad079ca
+  metadata.gz: ed2853558a9d7a761617ee215d7f46c9b146cdb4fcb431564052f0330d84069a
+  data.tar.gz: ad54ea0f5958215ea2271f782354539cf74907af3a53bb16cc6ce7412007eceb
 SHA512:
-  metadata.gz: ef97f505b367ef51efe01877912697208f42be67e5d531515c176aa9b2e6c14a0c795a5707b075d3a9f4b4051a96257220c905c0437bfc64f7e99a01deb942aa
-  data.tar.gz: 5162367688b0581d28c63219f6a38953eff903fcbe9473b22001edb8670ad1f945c89308f9833d7684d7b331457dc35d25e3ff6cdb4cef4d34defccee1d0ef5e
+  metadata.gz: e38ef5d999c9a01a32148cc6f5709fac2b6d19430ab345823dfa7896ec37a6349f759552623ae47e6c12d61dabddde71cc9647d1ffd3213d2457bacbdff90363
+  data.tar.gz: ae263df3f94d33ae886e4d1966fc06265349839f05b9fd8538e48f81e3b7d9cb4ab7c84ae0c8299567f031480d0d53c03d645e2e97351fc7f41b64c3ad14de58

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    ruby_tracer (0.1.0)
+    ruby_tracer (0.2.0)
 
 GEM
   remote: https://rubygems.org/

data/README.md

@@ -24,6 +24,46 @@ $ gem install ruby_tracer
 
 ## Usage
 
+```rb
+Tracer.trace(object) { ... } # trace object's activities in the given block
+Tracer.trace_call { ... } # trace method calls in the given block
+Tracer.trace_exception { ... } # trace exceptions in the given block
+```
+
+**Example**
+
+```rb
+require "ruby_tracer"
+
+obj = Object.new
+
+def obj.foo
+  100
+end
+
+def bar(obj)
+  obj.foo
+end
+
+Tracer.trace(obj) { bar(obj) }
+ #depth:1  #<Object:0x000000010903c190> is used as a parameter obj of Object#bar at test.rb:13:in `block in <main>'
+ #depth:2  #<Object:0x000000010903c190> receives .foo at test.rb:10:in `bar'
+```
+
+### `ruby_tracer/helper`
+
+If you want to avoid the `Tracer` namespace, you can do `require "ruby_tracer/helper"` instead:
+
+```rb
+require "ruby_tracer/helper"
+
+trace(object) { ... } # trace object's activities in the given block
+trace_call { ... } # trace method calls in the given block
+trace_exception { ... } # trace exceptions in the given block
+```
+
+If you want to have more control over individual traces, you can use individual tracer classes:
+
 ### ObjectTracer
 
 ```rb
@@ -120,6 +160,10 @@ end
  #depth:5  at test.rb:8
 ```
 
+## Customization
+
+TBD
+
 ## Acknowledgement
 
 [@ko1](https://github.com/ko1) (Koichi Sasada) implemented the majority of [`ruby/debug`](https://github.com/ruby/debug), including its tracers. So this project wouldn't exist without his amazing work there.

data/lib/ruby_tracer/base.rb

@@ -70,10 +70,11 @@ module Tracer
       end
     end
 
-    def initialize(output: STDOUT, pattern: nil, colorize: nil)
+    def initialize(output: STDOUT, pattern: nil, colorize: nil, depth_offset: 0)
       @name = self.class.name
       @type = @name.sub(/Tracer\z/, "")
       @output = output
+      @depth_offset = depth_offset
       @colorize = colorize || colorizable?
 
       if pattern

data/lib/ruby_tracer/call_tracer.rb

@@ -7,22 +7,30 @@ class CallTracer < Tracer::Base
     TracePoint.new(:a_call, :a_return) do |tp|
       next if skip?(tp)
 
+      location = caller_locations(2, 1).first
+      next if location.to_s.match?(/<internal:/)
+
       depth = caller.size
 
       call_identifier_str = (tp.defined_class ? minfo(tp) : "block")
-
       call_identifier_str = colorize_blue(call_identifier_str)
 
       case tp.event
       when :call, :c_call, :b_call
         depth += 1 if tp.event == :c_call
         sp = " " * depth
-        out tp, ">#{sp}#{call_identifier_str}", depth: depth
+        out tp,
+            ">#{sp}#{call_identifier_str}",
+            depth: depth - 2 - @depth_offset,
+            location: location
       when :return, :c_return, :b_return
         depth += 1 if tp.event == :c_return
         sp = " " * depth
         return_str = colorize_magenta(safe_inspect(tp.return_value))
-        out tp, "<#{sp}#{call_identifier_str} #=> #{return_str}", depth: depth
+        out tp,
+            "<#{sp}#{call_identifier_str} #=> #{return_str}",
+            depth: depth - 2 - @depth_offset,
+            location: location
       end
     end
   end

data/lib/ruby_tracer/exception_tracer.rb

@@ -9,7 +9,9 @@ class ExceptionTracer < Tracer::Base
 
       exc = tp.raised_exception
 
-      out tp, " #{colorize_magenta(exc.inspect)}"
+      out tp,
+          " #{colorize_magenta(exc.inspect)}",
+          depth: caller.size - (1 + @depth_offset)
     rescue Exception => e
       p e
     end

data/lib/ruby_tracer/helper.rb

@@ -0,0 +1,3 @@
+require "ruby_tracer"
+
+Object.include(Tracer::Helper)

data/lib/ruby_tracer/object_tracer.rb

@@ -65,7 +65,7 @@ class ObjectTracer < Tracer::Base
         out tp,
             " #{colorized_target_label} receives #{colorize_blue(method_info)}",
             location: caller_locations(internal_depth, 1).first,
-            depth: caller.size - internal_depth
+            depth: caller.size - internal_depth - @depth_offset
       elsif !tp.parameters.empty?
         b = tp.binding
         method_info = colorize_blue(minfo(tp))
@@ -82,7 +82,7 @@ class ObjectTracer < Tracer::Base
               out tp,
                   " #{colorized_target_label} is used as a parameter #{colorized_name} of #{method_info}",
                   location: caller_locations(internal_depth, 1).first,
-                  depth: caller.size - internal_depth
+                  depth: caller.size - internal_depth - @depth_offset
             end
           when :rest
             next if name == :"*"
@@ -94,7 +94,7 @@ class ObjectTracer < Tracer::Base
                 out tp,
                     " #{colorized_target_label} is used as a parameter in #{colorized_name} of #{method_info}",
                     location: caller_locations(internal_depth, 1).first,
-                    depth: caller.size - internal_depth
+                    depth: caller.size - internal_depth - @depth_offset
               end
             end
           when :keyrest
@@ -106,7 +106,7 @@ class ObjectTracer < Tracer::Base
                 out tp,
                     " #{colorized_target_label} is used as a parameter in #{colorized_name} of #{method_info}",
                     location: caller_locations(internal_depth, 1).first,
-                    depth: caller.size - internal_depth
+                    depth: caller.size - internal_depth - @depth_offset
               end
             end
           end

data/lib/ruby_tracer/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Tracer
-  VERSION = "0.1.0"
+  VERSION = "0.2.0"
 end

data/lib/ruby_tracer.rb

@@ -5,3 +5,26 @@ require_relative "ruby_tracer/line_tracer"
 require_relative "ruby_tracer/call_tracer"
 require_relative "ruby_tracer/exception_tracer"
 require_relative "ruby_tracer/object_tracer"
+
+module Tracer
+  module Helper
+    DEPTH_OFFSET = 3
+
+    def trace_exception(&block)
+      tracer = ExceptionTracer.new(depth_offset: DEPTH_OFFSET)
+      tracer.start(&block)
+    end
+
+    def trace_call(&block)
+      tracer = CallTracer.new(depth_offset: DEPTH_OFFSET)
+      tracer.start(&block)
+    end
+
+    def trace(target, &block)
+      tracer = ObjectTracer.new(target, depth_offset: DEPTH_OFFSET)
+      tracer.start(&block)
+    end
+  end
+
+  extend Helper
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: ruby_tracer
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors:
 - Stan Lo
@@ -29,6 +29,7 @@ files:
 - lib/ruby_tracer/call_tracer.rb
 - lib/ruby_tracer/color.rb
 - lib/ruby_tracer/exception_tracer.rb
+- lib/ruby_tracer/helper.rb
 - lib/ruby_tracer/line_tracer.rb
 - lib/ruby_tracer/object_tracer.rb
 - lib/ruby_tracer/version.rb