power_trace 0.2.1 → 0.2.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 50de15a293011f6ecb4eea0b038887a8f7464d6710a0ab1ec86d543fe672d6d5
-  data.tar.gz: a30ed54a320eed790138bc06d0a440718aa3d684e1aaacb9d18b8fbad2cc8ac0
+  metadata.gz: 75a503a2bc8b1ee1123f7b37cf6a1e8ce7873256cf85b0c9cb00371fb17239d2
+  data.tar.gz: 41aaddfe26306041d6a580c7a212018eae7df3b3f289b0ed02dbba6ccf59d5a7
 SHA512:
-  metadata.gz: a1180aaa9d14886e1ae1f97c71cc021a9dac81e50023030d920665852c3ff703746c4557a7f0d3b049bb5b3384c116ce39e32f99725195bad82e225a0f27f3dc
-  data.tar.gz: 3cc3f32b84765bb5474e6dc64a17d44b1398b4b87e8c66d7716ec90a0d5d9581a8ae5ff6571e7cca870bc3dde43177eed2a0f0ddf21e2ef04150037c0c81969d
+  metadata.gz: b19155914a1f24eca4f1e71731ed1f2128190e9399f14b10e6a5eeaa715aa69effbb7760ec303e26d6bb2241ee7a9ec215b08f132aa1753e6813f74a9b528a0e
+  data.tar.gz: cfd37781a60288fd72a2cab5ff052eee371a5f0b4bae99bb5ce503aa59180a197b3911b22ce9b99c82f71a1e68e375deb2add39ec0fd83524c2d1413532162d8

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    power_trace (0.2.1)
+    power_trace (0.2.2)
       activesupport
       binding_of_caller (~> 0.8.0)
 
@@ -44,7 +44,7 @@ GEM
     thread_safe (0.3.6)
     tzinfo (1.2.7)
       thread_safe (~> 0.1)
-    zeitwerk (2.3.1)
+    zeitwerk (2.4.0)
 
 PLATFORMS
   ruby

data/README.md

@@ -50,12 +50,7 @@ It should look just like the normal `puts(caller)`, just colorized and with more
 
 Except for the call site, each entry also contains rich information about the runtime context. You can build your own debugging tool with that information easily.
 
-There are 2 types of entries:
-
-- `MethodEntry`- a method call's trace
-- `BlockEntry` - a block evaluation's trace
-
-They both have these attributes:
+Every entry has these attributes:
 
 - `filepath`
 - `line_number`
@@ -64,9 +59,7 @@ They both have these attributes:
 - `locals` - local variables in that frame
 - `arguments`
     - the method call's arguments
-    - will always be empty for a `BlockEntry`
-
-![use individual entries](https://github.com/st0012/power_trace/blob/master/images/entries.png)
+    - will be empty for `block` entries
 
 #### Convert It Into Backtraces
 

data/benchmarks/raise_with_power_trace.rb

@@ -0,0 +1,110 @@
+require 'benchmark'
+lib = File.expand_path("../lib", __dir__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+
+n = 1_000
+
+class Foo
+  def first_call
+    second_call(20)
+  end
+
+  def second_call(num)
+    third_call_with_block do |ten|
+      forth_call(num, ten)
+    end
+  end
+
+  def third_call_with_block(&block)
+    yield(10)
+  end
+
+  def forth_call(num1, num2)
+    raise "Foo Error"
+  end
+end
+
+foo = Foo.new
+
+Benchmark.benchmark do |bm|
+  bench_proc = proc do
+    3.times do
+      bm.report do
+        n.times do
+          foo.first_call rescue nil
+        end
+      end
+    end
+  end
+
+  puts "#{n} times - ruby #{RUBY_VERSION}"
+  puts("Normal raise")
+
+  bench_proc.call
+
+  puts("====================================")
+  puts("======= power_trace required =======")
+  puts("====================================")
+
+  require "power_trace"
+
+  cases = [
+    {
+      replace_backtrace: false,
+      trace_limit: 10
+    },
+    {
+      replace_backtrace: false,
+      trace_limit: 50
+    },
+    {
+      replace_backtrace: true,
+      trace_limit: 10
+    },
+    {
+      replace_backtrace: true,
+      trace_limit: 50
+    }
+  ]
+
+  cases.each do |setup|
+    PowerTrace.replace_backtrace = setup[:replace_backtrace]
+    PowerTrace.trace_limit = setup[:trace_limit]
+
+    message =
+      if setup[:replace_backtrace]
+        "Raise and replace backtrace (trace_limit: #{PowerTrace.trace_limit})"
+      else
+        "Raise and store power_trace (trace_limit: #{PowerTrace.trace_limit})"
+      end
+
+    puts(message)
+    bench_proc.call
+  end
+end
+
+# 1000 times - ruby 2.7.1
+# Normal raise
+#    0.002032   0.000093   0.002125 (  0.002119)
+#    0.001131   0.000107   0.001238 (  0.001239)
+#    0.001092   0.000100   0.001192 (  0.001192)
+# ====================================
+# ======= power_trace required =======
+# ====================================
+# Raise and store power_trace (trace_limit: 10)
+#    0.157296   0.001807   0.159103 (  0.159504)
+#    0.159911   0.000668   0.160579 (  0.160961)
+#    0.152814   0.000493   0.153307 (  0.153658)
+# Raise and store power_trace (trace_limit: 50)
+#    0.228311   0.000649   0.228960 (  0.229264)
+#    0.248271   0.001956   0.250227 (  0.257272)
+#    0.229469   0.000923   0.230392 (  0.230822)
+# Raise and replace backtrace (trace_limit: 10)
+#    0.331577   0.000360   0.331937 (  0.332203)
+#    0.354934   0.001634   0.356568 (  0.356939)
+#    0.334688   0.001201   0.335889 (  0.336682)
+# Raise and replace backtrace (trace_limit: 50)
+#    0.557920   0.002530   0.560450 (  0.561101)
+#    0.553058   0.001767   0.554825 (  0.555651)
+#    0.560771   0.002160   0.562931 (  0.563613)
+

data/lib/power_trace.rb

@@ -11,9 +11,20 @@ module PowerTrace
   cattr_accessor :power_rspec_trace, instance_accessor: false
   self.power_rspec_trace = false
 
+  cattr_accessor :trace_limit, instance_accessor: false
+  self.trace_limit = 50
+
   def power_trace(options = {})
     PowerTrace::Stack.new(options)
   end
+
+  class << self
+    def print_power_trace_error(exception)
+      puts(exception)
+      puts(exception.backtrace)
+      puts("there's a bug in power_trace, please open an issue at https://github.com/st0012/power_trace")
+    end
+  end
 end
 
 include PowerTrace

data/lib/power_trace/entry.rb

@@ -132,8 +132,23 @@ module PowerTrace
 
       [locals, arguments]
     end
+
+    def method
+      @method ||= Object.instance_method(:method).bind(@receiver).call(name)
+    rescue NameError
+      # if any part of the program uses Refinement to extend its methods
+      # we might still get NoMethodError when trying to get that method outside the scope
+      nil
+    end
+
+    private
+
+    def method_parameters
+      if method
+        method.parameters.map { |parameter| parameter[1] }
+      else
+        []
+      end
+    end
   end
 end
-
-require "power_trace/entries/method_entry"
-require "power_trace/entries/block_entry"

data/lib/power_trace/exception_patch.rb

@@ -30,12 +30,10 @@ TracePoint.trace(:raise) do |tp|
 
     if PowerTrace.replace_backtrace
       e.set_backtrace(
-        e.stored_power_trace.to_backtrace(colorize: PowerTrace.colorize_backtrace)
+        e.stored_power_trace.to_backtrace
       )
     end
   rescue => e
-    puts(e)
-    puts(e.backtrace)
-    puts("power_trace's BUG")
+    PowerTrace.print_power_trace_error(e)
   end
 end

data/lib/power_trace/rspec_patch.rb

@@ -3,15 +3,13 @@ RSpec::Core::Formatters::ExceptionPresenter.class_eval do
 
   def formatted_backtrace(exception=@exception)
     if PowerTrace.power_rspec_trace || PowerTrace.replace_backtrace
-      backtrace_formatter.format_backtrace(exception.stored_power_trace.to_backtrace(extra_info_indent: 8), example.metadata) +
-        formatted_cause(exception)
+      backtrace = exception.stored_power_trace.to_backtrace(extra_info_indent: 8)
+      backtrace_formatter.format_backtrace(backtrace, example.metadata) + formatted_cause(exception)
     else
       original_formatted_backtrace
     end
   rescue => e
-    puts(e)
-    puts(e.backtrace)
-    puts("there's a bug in power_trace, please open an issue at https://github.com/st0012/power_trace")
+    PowerTrace.print_power_trace_error(e)
     original_formatted_backtrace
   end
 end

data/lib/power_trace/stack.rb

@@ -24,6 +24,7 @@ module PowerTrace
     end
 
     def to_backtrace(output_options = {})
+      output_options[:colorize] = output_options.fetch(:colorize, PowerTrace.colorize_backtrace) if @exception
       output_options = extract_output_options(output_options)
       @entries.map { |e| e.to_s(output_options) }
     end
@@ -52,16 +53,14 @@ module PowerTrace
       power_trace_index = (frames.index { |b| b.frame_description&.to_sym == :power_trace } || 0) + 1
       power_trace_index += 1 if @exception
 
-      frames[power_trace_index..].map do |b|
-        case b.frame_type
-        when :method
-          MethodEntry.new(b)
-        when :block
-          BlockEntry.new(b)
+      end_index =
+        if @exception
+          power_trace_index + PowerTrace.trace_limit - 1
         else
-          Entry.new(b)
+          -1
         end
-      end
+
+      frames[power_trace_index..end_index].map { |b| Entry.new(b) }
     end
   end
 end

data/lib/power_trace/version.rb

@@ -1,3 +1,3 @@
 module PowerTrace
-  VERSION = "0.2.1"
+  VERSION = "0.2.2"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: power_trace
 version: !ruby/object:Gem::Version
-  version: 0.2.1
+  version: 0.2.2
 platform: ruby
 authors:
 - st0012
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2020-07-13 00:00:00.000000000 Z
+date: 2020-07-16 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -75,6 +75,7 @@ files:
 - LICENSE.txt
 - README.md
 - Rakefile
+- benchmarks/raise_with_power_trace.rb
 - bin/console
 - bin/setup
 - images/entries.png
@@ -84,8 +85,6 @@ files:
 - images/power_trace_rspec_error.png
 - images/print_directly.png
 - lib/power_trace.rb
-- lib/power_trace/entries/block_entry.rb
-- lib/power_trace/entries/method_entry.rb
 - lib/power_trace/entry.rb
 - lib/power_trace/exception_patch.rb
 - lib/power_trace/helpers/colorize_helper.rb

data/lib/power_trace/entries/block_entry.rb

@@ -1,4 +0,0 @@
-module PowerTrace
-  class BlockEntry < Entry
-  end
-end

data/lib/power_trace/entries/method_entry.rb

@@ -1,25 +0,0 @@
-module PowerTrace
-  class MethodEntry < Entry
-    def method
-      @method ||= Object.instance_method(:method).bind(@receiver).call(name)
-    rescue NameError
-      # if any part of the program uses Refinement to extend its methods
-      # we might still get NoMethodError when trying to get that method outside the scope
-      nil
-    end
-
-    private
-
-    def method_parameters
-      if method
-        method.parameters.map { |parameter| parameter[1] }
-      else
-        []
-      end
-    end
-
-    def defined_class
-      method.owner
-    end
-  end
-end