trace_tree 0.2.8 → 0.2.9

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: e6a33c823c7c9a9edef43b4a0a9a6131cb5088cf
-  data.tar.gz: 8fc50067cb0975e582b1450f0f5b4056aae86b1b
+  metadata.gz: 2acc2e68551caee98c0c8b0245646acea04bce6d
+  data.tar.gz: f7b038d0a709e7dc15f9225179177b1948168a54
 SHA512:
-  metadata.gz: 0ed48c6ec0f6b579f8e823c0d03bfb34c511b9f9c86d508f624ad313830313c24ffd9dbae30a52c4b0410453763a0d93224fbe47616d781d51c63f25bb2ffc3d
-  data.tar.gz: d54d68166144f9bbcc60498fe189ffbdb27d47516ddce71cf8ed5fd2bc77ac8ecb06153c9aa6f95f02b6204b9658a59c5fde30f4c5b025c829467f642cce0944
+  metadata.gz: f8c8e186db907601748d81fcd7c325c35084cb9cd504599337fc95fc0d81d59a2c5dc5cf5a4d4171ecf16b3e4660ace8e1c44f51c71a7e97a330917622f6066c
+  data.tar.gz: 9e650c794990c69ce8154fcaca17bef4c4c3684295eaa49c84218df412b2a5d1768de8fef6e5c78319f879dc366f45e24f66f99c29a8b3fd406ca684ab37e25a

data/README.md

@@ -45,7 +45,10 @@ end
 * `:gem => true` by default. Replace the gem paths in source_location with $GemPathN, can make the lines shorter. To see what are replaced, inspect `TraceTree::GemPaths`.
 * `:html => nil` by default. Set it true to generate a html in which a tree constructed with `<ul>`, `<li>`. (No need to set `color`).
 * `:tmp => nil` by default. Set it true or a string or an array of string to specify a tmp file under the default tmp dir of your system. (No need to provide `file` argument. It makes parent directories as needed)
+* `:htmp => nil` by default. It is combination of `:html` and `:tmp`.
+* `:in => //, :out => nil` by default. Give them regexp(s) to include/exclude methods defined in files match that regexp(s). Notice thread-calls and methods defined by `define_method` are always included. Also, once you set any of these two options, the code to trace should not be in same line with `binding.trace_tree() do`.
 * `:timer => nil` by default. Set it true if you want to know how much time spent in tracing and drawing tree. Notice the `file` should be appendable, otherwise the time will overwrite the tree.
+* `:debug =>` by default. Give it somthing like what for `:tmp` to output a whole list of TracePoints in file for debug.
 
 ### Example
 

data/lib/trace_tree/point.rb

@@ -7,7 +7,7 @@ class TraceTree
     include TreeGraphable
     include TreeHtmlable
 
-    attr_reader :current, :thread
+    attr_reader :current, :thread, :frame_env
     attr_accessor :terminal
 
     Interfaces = [:event, :defined_class, :method_id, :path, :lineno]
@@ -27,16 +27,21 @@ class TraceTree
       end
 
       def hashify point
-        attrs = Interfaces.each_with_object({}) do |attr, hash|
-          hash[attr] = point.send attr
-        end
-        attrs.merge!({return_value: point.return_value}) if point.event =~ /return/
-        attrs.merge!({thread: point.thread}) if point.respond_to? :thread
-        attrs
+        h = {}
+        h[:event] = point.event
+        h[:defined_class] = point.defined_class
+        h[:method_id] = point.method_id
+        h[:frame_env] = point.frame_env unless point.thread?
+        h[:path] = point.path
+        h[:lineno] = point.lineno
+        h[:thread] = point.thread
+        h[:return_value] = point.return_value if point.event =~ /return/
+        h
       end
 
       def class_of? point
-        [point.event, point.defined_class, point.method_id] == event_class_method
+        e, c, m = event_class_method
+        point.method_id == m && point.event == e && point.defined_class == c
       end
 
       def initialize_clone proto
@@ -46,6 +51,19 @@ class TraceTree
       end
 
       attr_reader :proto
+
+      def cache_event_class_method!
+        bases.each do |base|
+          base.class_eval <<-EOM
+            class << self
+              alias_method :_event_class_method, :event_class_method
+              def self.event_class_method
+                @ecm ||= _event_class_method.freeze
+              end
+            end
+EOM
+        end
+      end
     end
 
     def method_missing method_id, *args, &blk
@@ -56,17 +74,33 @@ class TraceTree
       Interfaces.each do |i|
         instance_variable_set "@#{i}", trace_point.send(i)
       end
+
       @return_value = trace_point.return_value if x_return?
-      @current = BindingOfCallers::Revealed.new trace_point.binding.of_caller(3) unless thread?
-      @thread = thread? ? trace_point.self : current.send(:eval, 'Thread.current')
+
+      if thread?
+        @thread = trace_point.self
+      else
+        there = trace_point.binding.of_caller(3)
+        @current = BindingOfCallers::Revealed.new there
+        @frame_env = current.frame_env.to_sym
+        @thread = current.send(:eval, 'Thread.current')
+      end
     rescue => e
       puts e
     end
 
+    def b_call?
+      event == :b_call
+    end
+
     def c_call?
       event == :c_call
     end
 
+    def class?
+      event == :class
+    end
+
     def x_return?
       event =~ /return/
     end
@@ -75,6 +109,13 @@ class TraceTree
       event =~ /thread/
     end
 
+    def end_of_trace?
+      MainFile == path && (
+        (:c_return == event && :instance_eval == method_id) ||
+          (:c_call == event && :disable == method_id)
+      )
+    end
+
     def return_value
       raise RuntimeError.new('RuntimeError: not supported by this event') unless x_return?
       @return_value
@@ -127,7 +168,9 @@ class TraceTree
     end
 
     def method_name
-      c_call? ? method_id : current.frame_env
+      return method_id if c_call?
+      return frame_env if b_call? || class?
+      (method_id == frame_env) ? method_id : "#{method_id} -> #{frame_env}"
     end
 
     def call_symbol
@@ -162,7 +205,32 @@ class TraceTree
   end
 end
 
-Dir.glob(File.expand_path('../point/*', __FILE__)).each do |concreate_point_path|
-  load concreate_point_path
-  #puts "---->#{concreate_point_path}"
+Dir.glob(File.expand_path('../point/*', __FILE__)).each do |concrete_point_path|
+  load concrete_point_path
+  #puts "---->#{concrete_point_path}"
+end
+
+class TraceTree
+  class Point
+
+    cache_event_class_method!
+
+    NativeThreadCall = [CcallClassthreadNew,
+                        CreturnClassthreadNew,
+                        CcallThreadInitialize,
+                        CreturnThreadInitialize,
+                        Threadbegin,
+                        Threadend]
+
+    def thread_relative?
+      NativeThreadCall.any?{ |k| k.class_of? self } ||
+        Thread == defined_class
+    end
+
+    def method_defined_by_define_method?
+      (event == :call || event == :return) &&
+        method_id != frame_env
+    end
+
+  end
 end

data/lib/trace_tree/version.rb

@@ -1,3 +1,3 @@
 class TraceTree
-  VERSION = "0.2.8"
+  VERSION = "0.2.9"
 end

data/lib/trace_tree.rb

@@ -16,6 +16,8 @@ end
 
 class TraceTree
 
+  MainFile = __FILE__
+
   Events = [:b_call, :b_return,
             :c_call, :c_return,
             :call, :return,
@@ -31,19 +33,18 @@ class TraceTree
   def generate *log, **opt, &to_do
     @opt = opt
     @log = dump_location *log
-    enhance_point **opt
-    @build_command = opt[:html] ? :tree_html_full : :tree_graph
-    @ignore = opt[:ignore] || {}
-    here = bi.eval('self')
+    @debug = TmpFile.new opt[:debug] if opt[:debug]
+    enhance_point
+    @build_command = (opt[:html] || opt[:htmp]) ? :tree_html_full : :tree_graph
+    make_filter
+    @__file__, @__line__, there = bi.eval('[__FILE__, __LINE__, self]')
 
     #start_trace
     timer[:trace]
-    @tp = TracePoint.new(*Events) do |point|
-      trace_points << point_loader.create(point) if wanted? point
-    end
+    @tp = TracePoint.new *Events, &@deal
     @tp.enable
 
-    here.instance_eval &to_do
+    there.instance_eval &to_do
   ensure
     #stop_trace
     return unless @tp
@@ -58,10 +59,11 @@ class TraceTree
 
   def dump_location *log
     return TmpFile.new opt[:tmp] if opt[:tmp]
+    return TmpFile.new(opt[:htmp] + '.html') if opt[:htmp]
     log.empty? ? STDOUT : log[0]
   end
 
-  def enhance_point opt
+  def enhance_point
     enhancement = []
     enhancement << TraceTree::Color unless opt[:color] == false
     enhancement << TraceTree::ShortGemPath unless opt[:gem] == false
@@ -72,18 +74,40 @@ class TraceTree
     timer[:tree]
     tree = sort(trace_points_array).send build_command
     timer[:tree]
+    @debug.puts table_of_points if defined? @debug
     log.puts tree
     log.puts timer.to_s if opt[:timer]
   rescue => e
     log.puts timer.to_s
     log.puts e
-    log.puts Terminal::Table.from_hashes trace_points_array.map(&:to_h)
+    log.puts table_of_points
+  end
+
+  def table_of_points
+    Terminal::Table.from_hashes trace_points_array.map(&:to_h)
   end
 
-  def wanted? trace_point
-    @ignore.any? do |attr, pattern|
-      pattern =~ trace_point.send(attr)
-    end ? false : true
+  def make_filter
+    if !opt.key?(:in) && !opt.key?(:out)
+      return @deal = -> point { trace_points << point_loader.create(point) }
+    end
+    @in, @out = Array(opt[:in] || //), Array(opt[:out])
+    @deal = -> point do
+      po = point_loader.create(point)
+      trace_points << po if wanted? po
+    end
+  end
+
+  def wanted? point
+    return false if point.end_of_trace?
+    return true if native?(point) || point.thread_relative? || point.method_defined_by_define_method?
+    @in.any?{ |pattern| pattern =~ point.path } &&
+      @out.all?{ |pattern| pattern !~ point.path }
+  end
+
+  def native? point
+    MainFile == point.path ||
+      (:b_call == point.event && @__file__ == point.path && @__line__ == point.lineno)
   end
 
   def sort trace_points
@@ -111,6 +135,8 @@ class TraceTree
       point.thread_begin = began_threads[thread]
     end
 
+    #binding.pry
+
     stacks[trace_points.first.thread][0].
       callees[0].
       callees[0]

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: trace_tree
 version: !ruby/object:Gem::Version
-  version: 0.2.8
+  version: 0.2.9
 platform: ruby
 authors:
 - ken
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2017-06-10 00:00:00.000000000 Z
+date: 2017-07-01 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler