trace_tree 0.2.21 → 0.3.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 0be4af3563495464f3f18a8f3071777eaff9d29fbd90c99e79338dcd6ed97818
-  data.tar.gz: 82691f1633c340f8fcdc602564367db4d63769fa1d9a076d3a1ecba8f65d57dc
+  metadata.gz: 5faac3e419aae49a1d520caabd21eca4b4569b60bed6be5f29d69b26561781e6
+  data.tar.gz: 95441a432f9fdd29d4cd3ffa50ae468fec4764ccada641d0cdd25e6db5564da0
 SHA512:
-  metadata.gz: 67e6c97a69c109f44ae2f5527628caabb02e1c1aaff1ae05160b836f360b98432fc68d37a992664497c0089dcd7b02af2a9eb3999f27acf57134239129fd01fe
-  data.tar.gz: e24c3bab4d4a09883a450d91b0a3f8f10f517a9da35acb37b66f51e5435902fe4e6970cf4cc97c03c4e06d580fe262e96a7464339bbee99ae4669825b163812c
+  metadata.gz: 510554091628f1449c479cb0a218a9875e446fb6414cb53d101390c6bff35490deb409979e73e8eddeb7edbffd56e6682ca3c96cfd60fab7ede0a7d0a9c27abb
+  data.tar.gz: 516bf6a7a61ddc1c2487261fd2b24aaf58fa105a6b914bd87ab3ae95771d9e70a5f854c72fb1c634a850631e350bc377bf25df7cd617100b2dc30e080b43f8f9

data/Gemfile

@@ -1,4 +1,5 @@
 source 'https://rubygems.org'
+# source 'https://gems.ruby-china.com'
 
 # Specify your gem's dependencies in trace_tree.gemspec
 gemspec

data/README.md

@@ -54,11 +54,19 @@ end
 * `:htmp => nil` by default. It is combination of `:html` and `:tmp`.
 * `:return => true` by default. It stores return values of functions in generated html. Hover function call and press `r` to print return value in console.
 * `:args => false` by default. Set it true to puts arguments of `:call` functions into html. Since arguments are always return values of other functions, so this option is not necessary.
-* `: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`.
 * `:no_methods => nil` by default. Give it regexp(s) to hide stack under matching methods. Useful when you want to dump stack of a rack middleware but lower middlewares.
 * `:warm => nil` by default. Set it something unique to the code block so that the code block will be traced only when it's called second time, in case we dump lots of code loading and initialization.
 * `: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 => nil` by default. Give it `STDOUT`/`STDERR` or anything responds to `:puts` to output a whole list of TracePoints. Or give it a file name in the default tmp dir of your system.
+* `transcode => false` by default. Set it true to convert unknown character into `"?"` when you see `Encoding::UndefinedConversionError`.
+
+### Methods' return values
+
+By default it stores return values of functions in generated html. If there is any kind of value can not be stringified, you can do something like this to avoid exception:
+
+```ruby
+TraceTree::ReturnValue.formatted(Mongo::Protocol::Message) { |_| "Mongo::Protocol::Message" }
+```
 
 ### Example 1: Output to HTML
 

data/lib/trace_tree.rb

@@ -18,7 +18,7 @@ class Binding
       return yield
     end
 
-    TraceTree.new(self).generate *log, **opt, &to_do
+    TraceTree.new(self).generate(*log, **opt, &to_do)
   end
 end
 
@@ -41,19 +41,21 @@ class TraceTree
 
   def generate *log, **opt, &to_do
     @opt = opt
-    @log = dump_location *log
+    @log = dump_location(*log)
     @debug = debug_location
     enhance_point
     @build_command = (opt[:html] || opt[:htmp]) ? :tree_html_full : :tree_graph
     make_filter
     @__file__, @__line__, there = bi.eval('[__FILE__, __LINE__, self]')
 
+    dry_run
+
     #start_trace
     timer[:trace]
-    @tp = TracePoint.new *Events, &@deal
+    @tp = TracePoint.new(*Events, &@deal)
     @tp.enable
 
-    there.instance_eval &to_do
+    there.instance_eval(&to_do)
   ensure
     #stop_trace
     return unless @tp
@@ -66,16 +68,23 @@ class TraceTree
 
   attr_reader :bi, :trace_points, :log, :build_command, :timer, :opt, :point_loader, :config
 
+  def dry_run
+    tp = TracePoint.new{}
+    tp.enable
+  ensure
+    tp.disable
+  end
+
   def debug_location
     loc = opt[:debug]
     return nil unless loc
     return loc if loc.respond_to? :puts
-    TmpFile.new loc
+    TmpFile.new loc, transcode: opt[:transcode]
   end
 
   def dump_location *log
-    return TmpFile.new opt[:tmp] if opt[:tmp]
-    return TmpFile.new(opt[:htmp] + '.html') if opt[:htmp]
+    return TmpFile.new(opt[:tmp], transcode: opt[:transcode]) if opt[:tmp]
+    return TmpFile.new((opt[:htmp] + '.html'), transcode: opt[:transcode]) if opt[:htmp]
     log.empty? ? STDOUT : log[0]
   end
 
@@ -89,7 +98,7 @@ class TraceTree
       enhancement << TraceTree::LuxuryReturnValue
     end
     enhancement << TraceTree::Args if opt[:args] == true
-    @point_loader = Point::Loader.new *enhancement, config
+    @point_loader = Point::Loader.new(*enhancement, config)
   end
 
   def dump_trace_tree
@@ -100,11 +109,14 @@ class TraceTree
     log.puts tree
     log.puts timer.to_s if opt[:timer]
   rescue => e
-    log.puts timer.to_s, e.inspect, e.backtrace, table_of_points
+    log.puts timer.to_s, e.inspect, e.backtrace
+    log.puts table_of_points
   end
 
   def table_of_points
     Terminal::Table.from_hashes trace_points_array.map(&:to_h)
+  rescue => e
+    log.puts "#{__method__}", e.inspect, e.backtrace
   end
 
   def make_filter
@@ -115,14 +127,7 @@ class TraceTree
         'return false unless outside_hidden_stack?(point)'
       end
 
-    path_filter =
-      if opt.key?(:in) || opt.key?(:out)
-        @in = Array(opt[:in] || //)
-        @out = Array(opt[:out])
-        'return false unless @in.any?{ |pattern| pattern =~ point.path } && @out.all?{ |pattern| pattern !~ point.path }'
-      else
-        nil
-      end
+    path_filter = nil
 
     if stack_filter.nil? && path_filter.nil?
       return @deal = -> point { trace_points << point_loader.create(point) }
@@ -207,7 +212,7 @@ class TraceTree
 
     stacks.keys.each{ |thread| thread[:trace_tree_no_methods_stack] = nil }
 
-    #binding.pry
+    # binding.pry
 
     stacks[trace_points.first.thread][0].
       callees[0].

data/lib/trace_tree/config.rb

@@ -11,7 +11,7 @@ class TraceTree
     def self.load
       config = DEFAULT
       custom = File.join ENV['HOME'], '.trace_tree_config'
-      if File.exists?(custom) && (hash = YAML.load File.read custom)
+      if File.exist?(custom) && (hash = YAML.load File.read custom)
         hash.select!{ |k, v| config.include? k }
         config = config.merge hash
       end

data/lib/trace_tree/point.rb

@@ -11,7 +11,8 @@ class TraceTree
     attr_accessor :terminal, :config
 
     Interfaces = [:event, :defined_class, :method_id, :path, :lineno]
-    attr_reader *Interfaces
+    attr_reader(*Interfaces)
+    class_eval 'def assign_trace_point_values(tp);' + Interfaces.map{ |i| "@#{i} = tp.#{i}" }.join(';') + ';end'
 
     class << self
       def inherited base
@@ -68,19 +69,15 @@ EOM
     end
 
     def initialize trace_point
-      Interfaces.each do |i|
-        instance_variable_set "@#{i}", trace_point.send(i)
-      end
+      assign_trace_point_values(trace_point)
 
       @return_value = trace_point.return_value if x_return?
+      @thread = Thread.current
 
-      if thread?
-        @thread = trace_point.self
-      else
+      unless thread?
         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
@@ -162,7 +159,7 @@ EOM
 
     def class_name
       c_call? ? defined_class : current.klass
-    rescue => e
+    rescue
       puts event
     end
 
@@ -191,7 +188,7 @@ EOM
       def initialize *enhancement, config
         @config = config
         @bases = Point.bases
-        @bases = @bases.map{ |b| b = b.clone; b.prepend *enhancement; b } unless enhancement.empty?
+        @bases = @bases.map{ |b| b = b.clone; b.prepend(*enhancement); b } unless enhancement.empty?
         sort_bases
       end
 

data/lib/trace_tree/return_value.rb

@@ -6,7 +6,7 @@ class TraceTree
     BLANK = ''.freeze
 
     NEED_PP = (
-      if File.exists? (pp_config = File.join(ENV['HOME'], '.trace_tree_pp'))
+      if File.exist? (pp_config = File.join(ENV['HOME'], '.trace_tree_pp'))
         IO.readlines(pp_config).map &:strip
       else
         []

data/lib/trace_tree/tmp_file.rb

@@ -12,14 +12,17 @@ class TraceTree
 
     DefaultName = 'trace_tree.html'
 
-    def initialize path
+    def initialize path, transcode: false
       path = recognize_dir path
       @tmp = custom path
+      @transcode = transcode
     end
 
     def puts *content
+      content = content.map{ |c| c.to_s.encode('UTF-8', invalid: :replace, undef: :replace, replace: '?') } if @transcode
+
       File.open @tmp, 'a' do |f|
-        f.puts *content
+        f.puts(*content)
       end
     end
 
@@ -45,7 +48,7 @@ class TraceTree
       path[-1] = time + path[-1]
       path = [Dir.tmpdir] + path
       ensure_parent path
-      File.join *path
+      File.join(*path)
     end
 
     def time
@@ -54,7 +57,7 @@ class TraceTree
 
     def ensure_parent path_arr
       dir = path_arr[0..-2]
-      FileUtils.mkdir_p File.join *dir
+      FileUtils.mkdir_p File.join(*dir)
     end
   end
 end

data/lib/trace_tree/version.rb

@@ -1,3 +1,3 @@
 class TraceTree
-  VERSION = "0.2.21"
+  VERSION = "0.3.2"
 end

data/trace_tree.gemspec

@@ -21,11 +21,11 @@ Gem::Specification.new do |spec|
   spec.require_paths = ["lib"]
 
   spec.add_development_dependency "bundler", "> 1.14"
-  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rake", ">= 12.3.3"
   spec.add_development_dependency "minitest", "~> 5.0"
   spec.add_development_dependency "pry"
 
-  spec.add_dependency "binding_of_callers", "~> 0.1.5"
+  spec.add_dependency "binding_of_callers", "~> 0.2.0"
   spec.add_dependency "tree_graph", "~> 0.2.0"
   spec.add_dependency "tree_html", "~> 0.1.7"
   spec.add_dependency "terminal-tableofhashes", "~> 0.1.0"

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: trace_tree
 version: !ruby/object:Gem::Version
-  version: 0.2.21
+  version: 0.3.2
 platform: ruby
 authors:
 - ken
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2019-12-27 00:00:00.000000000 Z
+date: 2021-05-29 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -28,16 +28,16 @@ dependencies:
   name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: 12.3.3
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: 12.3.3
 - !ruby/object:Gem::Dependency
   name: minitest
   requirement: !ruby/object:Gem::Requirement
@@ -72,14 +72,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.1.5
+        version: 0.2.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.1.5
+        version: 0.2.0
 - !ruby/object:Gem::Dependency
   name: tree_graph
   requirement: !ruby/object:Gem::Requirement
@@ -190,8 +190,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.7.6
+rubygems_version: 3.2.3
 signing_key: 
 specification_version: 4
 summary: Print TracePoint(:b_call, :b_return, :c_call, :c_return, :call, :return,