power_trace 0.1.0 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: e0d694b8c7925be5e04c1f5f3ea4a5da6b35c877b21889b4087932431cbafb5b
-  data.tar.gz: 36e4678c7647402010216e5312f42f4675eaafcd8d46f32c8564b0ccc97cd161
+  metadata.gz: 489aca17c7b57c040a81bcb25149149c616f3c822c23f65b20f94fc630178eaa
+  data.tar.gz: 0bcc29315b7c6c5399b840340ecec4f8e628b463e90e2288515c020d849deb26
 SHA512:
-  metadata.gz: 66bde570863c5e24f4c8a853fa68e40f810f5a5278e2296a52ca8b4fa6cc1e0ad47394453e7814b8b61355576075a3a9dbd8534bb63a7404d7e15a093bed102b
-  data.tar.gz: 5a24fd2fd709ad654b12adf15e1a321425316839e400d33d75a336b78565ee3c6520daad0cf881f32c13d5ec0d5e09df492631f8c554b0d66843a4b68d9fc8dd
+  metadata.gz: 91826f382a2687ca209f52498789410eb712fa371ba2f5205b20fb6c1831e75637874c593e8b98520368deed3ad19c6a047389921066bb7686b69b9f2ec666b8
+  data.tar.gz: d62169e40fbdb3fe21b209ce788eab7cfa8426bc776b0d336da9544389ac0590b98b93fc7f8ce260521bfccb237c6312ed79c1f885667296737e015fb514a1a0

data/Gemfile.lock

@@ -1,10 +1,9 @@
 PATH
   remote: .
   specs:
-    power_trace (0.1.0)
+    power_trace (0.2.0)
       activesupport
-      pry
-      pry-stack_explorer
+      binding_of_caller (~> 0.8.0)
 
 GEM
   remote: https://rubygems.org/
@@ -28,9 +27,6 @@ GEM
     pry (0.13.1)
       coderay (~> 1.1)
       method_source (~> 1.0)
-    pry-stack_explorer (0.5.1)
-      binding_of_caller (~> 0.7)
-      pry (~> 0.13)
     rake (12.3.3)
     rspec (3.9.0)
       rspec-core (~> 3.9.0)
@@ -55,6 +51,7 @@ PLATFORMS
 
 DEPENDENCIES
   power_trace!
+  pry
   rake (~> 12.0)
   rspec (~> 3.0)
 

data/README.md

@@ -1,6 +1,6 @@
 # power_trace
 
-![Ruby](https://github.com/st0012/power_trace/workflows/Ruby/badge.svg)
+![Ruby](https://github.com/st0012/power_trace/workflows/Ruby/badge.svg) [![Gem Version](https://badge.fury.io/rb/power_trace.svg)](https://badge.fury.io/rb/power_trace)
 
 Backtrace (Stack traces) are essential information for debugging our applications. However, they only tell us what the program did, but don't tell us what it had (the arguments, local variables...etc.). So it's very often that we'd need to visit each call site, rerun the program, and try to print out the variables. To me, It's like the Google map's navigation only tells us the name of the roads, but not showing us the map along with them.
 
@@ -82,10 +82,34 @@ I don't recommend using it like this for other purposes, though. Because by defa
 
 - `colorize` - to decide whether to colorize each entry in their string format. Default is `true`.
 - `line_limit` - `power_trace` truncates every argument/local variable's value to avoid creating too much noise. Default is `100`
+- `extra_info_indent` - 
 
-### Get `power_trace` From An Exception (Experimental)
+By default, extra info sections (locals/arguments) are indented with `4` spaces. Like:
 
-You can also access an exception object's enhanced backtrace with the `power_trace` method:
+```
+/Users/st0012/projects/power_trace/spec/fixtures.rb:23:in `forth_call'
+    (Arguments)
+      num1: 20
+      num2: 10
+```
+
+You can change this indentation with the `extra_info_indent: Int` option. It's useful when you need to adjust the output from some formatting tools (like `RSpec` formatters).
+
+### Use It With StandardError (Experimental)
+
+If you set 
+
+```ruby
+PowerTrace.replace_backtrace = true
+```
+
+it will replace every `StandardError` exception's backtrace with the `power_trace.to_backtrace`. So most of the error traces you see will also contain the colorized environment information!
+
+This is still an experimental feature for now, as it has a very wide impact on all the libraries and your own code. **Don't try this on production!!!!**
+
+#### Get `power_trace` Manually From A StandardError Exception
+
+If you think the above feature is too aggressive. You can access an exception object's enhanced backtrace manually with the `power_trace` method:
 
 ```ruby
 begin
@@ -95,7 +119,24 @@ rescue => e
 end
 ```
 
-And use it as you get it from the call site.
+This feature doesn't require any flag to enable, as the information is added as an extra field and doesn't override anything.
+
+### Use It With RSpec
+
+You can also prettify RSpec's error messages with `power_trace`, just use the below config:
+
+```ruby
+PowerTrace.power_rspec_trace = true
+```
+
+Result:
+
+**Before**
+![normal rspec error message](https://github.com/st0012/power_trace/blob/master/images/normal_rspec_error.png)
+
+**After**
+![rspec error message with config set to true](https://github.com/st0012/power_trace/blob/master/images/power_trace_rspec_error.png)
+
 
 ## Inspirations & Helpful Tools
 
@@ -111,7 +152,7 @@ To install this gem onto your local machine, run `bundle exec rake install`. To
 
 ## Contributing
 
-Bug reports and pull requests are welcome on GitHub at [https://github.com/[USERNAME]/power_trace](https://github.com/%5BUSERNAME%5D/power_trace). This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [code of conduct](https://github.com/%5BUSERNAME%5D/power_trace/blob/master/CODE_OF_CONDUCT.md).
+Bug reports and pull requests are welcome on GitHub at [https://github.com/st0012/power_trace](https://github.com/st0012/power_trace). This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [code of conduct](https://github.com/%5BUSERNAME%5D/power_trace/blob/master/CODE_OF_CONDUCT.md).
 
 ## License
 

data/lib/power_trace.rb

@@ -2,6 +2,15 @@ require "power_trace/version"
 require "power_trace/stack"
 
 module PowerTrace
+  cattr_accessor :colorize_backtrace, instance_accessor: false
+  self.colorize_backtrace = true
+
+  cattr_accessor :replace_backtrace, instance_accessor: false
+  self.replace_backtrace = false
+
+  cattr_accessor :power_rspec_trace, instance_accessor: false
+  self.power_rspec_trace = false
+
   def power_trace(options = {})
     PowerTrace::Stack.new(options)
   end
@@ -10,3 +19,9 @@ end
 include PowerTrace
 
 require "power_trace/exception_patch"
+
+require "rspec" rescue LoadError
+
+if defined?(RSpec)
+  require "power_trace/rspec_patch"
+end

data/lib/power_trace/entries/block_entry.rb

@@ -1,7 +1,4 @@
 module PowerTrace
   class BlockEntry < Entry
-    def method_parameters
-      []
-    end
   end
 end

data/lib/power_trace/entries/method_entry.rb

@@ -2,10 +2,20 @@ 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
-      method.parameters.map { |parameter| parameter[1] }
+      if method
+        method.parameters.map { |parameter| parameter[1] }
+      else
+        []
+      end
     end
 
     def defined_class

data/lib/power_trace/entry.rb

@@ -6,8 +6,6 @@ module PowerTrace
     include ColorizeHelper
     UNDEFINED = "[undefined]"
 
-    INDENT = "\s" * 4
-
     attr_reader :frame, :filepath, :line_number, :receiver, :locals, :arguments
 
     def initialize(frame)
@@ -27,11 +25,17 @@ module PowerTrace
     end
 
     def arguments_string(options = {})
-      hash_to_string(arguments, false, options[:line_limit])
+      <<~STR.chomp
+        #{options[:indentation]}(Arguments)
+        #{hash_to_string(arguments, false, options)}
+      STR
     end
 
     def locals_string(options = {})
-      hash_to_string(locals, false, options[:line_limit])
+      <<~STR.chomp
+        #{options[:indentation]}(Locals)
+        #{hash_to_string(locals, false, options)}
+      STR
     end
 
     def call_trace(options = {})
@@ -39,10 +43,10 @@ module PowerTrace
     end
 
     ATTRIBUTE_COLORS = {
-      name: COLORS[:blue],
-      location: COLORS[:green],
-      arguments_string: COLORS[:orange],
-      locals_string: COLORS[:megenta]
+      name: :blue,
+      location: :green,
+      arguments_string: :orange,
+      locals_string: :megenta
     }
 
     ATTRIBUTE_COLORS.each do |attribute, color|
@@ -53,7 +57,7 @@ module PowerTrace
         call_result = send("original_#{attribute}", options)
 
         if options[:colorize]
-          "#{color}#{call_result}#{COLORS[:reset]}"
+          send("#{color}_color", call_result)
         else
           call_result
         end
@@ -61,37 +65,43 @@ module PowerTrace
     end
 
     def to_s(options = {})
-      assemble_string(options)
+      # this is to prevent entries from polluting each other's options
+      # of course, that'd only happen if I did something stupid ;)
+      assemble_string(options.dup)
     end
 
     private
 
+    def method_parameters
+      []
+    end
+
     def assemble_string(options)
       strings = [call_trace(options)]
 
+      indentation = "\s" * options[:extra_info_indent]
+      options[:indentation] = indentation
+
       if arguments.present?
-        strings << <<~STR.chomp
-            (Arguments)
-        #{arguments_string(options)}
-        STR
+        strings << arguments_string(options)
       end
 
       if locals.present?
-        strings << <<~STR.chomp
-            (Locals)
-        #{locals_string(options)}
-        STR
+        strings << locals_string(options)
       end
 
       strings.join("\n")
     end
 
-    def hash_to_string(hash, inspect, truncation)
+    def hash_to_string(hash, inspect, options)
+      truncation = options[:line_limit]
+      indentation = options[:indentation] + "\s" * 2
+
       elements_string = hash.map do |key, value|
         value_string = value_to_string(value, truncation)
         "#{key.to_s}: #{value_string}"
-      end.join("\n#{INDENT}")
-      "#{INDENT}#{elements_string}"
+      end.join("\n#{indentation}")
+      "#{indentation}#{elements_string}"
     end
 
     def value_to_string(value, truncation)

data/lib/power_trace/exception_patch.rb

@@ -1,14 +1,41 @@
-class Exception
-  attr_accessor :power_trace
+class StandardError
+  attr_accessor :stored_power_trace
 end
 
+# the purposes of this section are:
+# 1. capture and store a power_trace when the exception is firstly raised (will skip re-raising conditions)
+# 2. if `replace_backtrace` is set to `true, it'll use the captured power_trace to replace the exception's original backtrace
 TracePoint.trace(:raise) do |tp|
   begin
     e = tp.raised_exception
-    e.power_trace = power_trace(exception: true)
+
+    # it's too risky to deal with non-StandardError exceptions
+    next unless e.is_a?(StandardError)
+
+    # ignore re-raised exceptions
+    next if e.stored_power_trace
+
+    # these errors are commonly used as flow control so working with them can be error-prone and slow
+    # we can revisit them once the gem gets more stable
+    next if e.is_a?(LoadError)
+    next if e.is_a?(NameError)
+    next if e.is_a?(SystemCallError)
+
+    if defined?(Bootsnap)
+      next if e.is_a?(Bootsnap::LoadPathCache::FallbackScan)
+      next if e.is_a?(Bootsnap::LoadPathCache::ReturnFalse)
+    end
+
+    e.stored_power_trace = power_trace(exception: true)
+
+    if PowerTrace.replace_backtrace
+      e.set_backtrace(
+        e.stored_power_trace.to_backtrace(colorize: PowerTrace.colorize_backtrace)
+      )
+    end
   rescue => e
-    puts e
-    puts e.backtrace
-    fail "power_trace BUG"
+    puts(e)
+    puts(e.backtrace)
+    puts("power_trace's BUG")
   end
 end

data/lib/power_trace/helpers/colorize_helper.rb

@@ -17,12 +17,5 @@ module PowerTrace
         "#{color_mark}#{str}#{RESET_MARK}"
       end
     end
-
-    COLORS = COLOR_CODES.each_with_object({}) do |(name, code), hash|
-      hash[name] = "\u001b[38;5;#{code}m"
-    end.merge(
-      reset: "\u001b[0m",
-      nocolor: ""
-    )
   end
 end

data/lib/power_trace/rspec_patch.rb

@@ -0,0 +1,17 @@
+RSpec::Core::Formatters::ExceptionPresenter.class_eval do
+  alias :original_formatted_backtrace :formatted_backtrace
+
+  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)
+    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")
+    original_formatted_backtrace
+  end
+end

data/lib/power_trace/stack.rb

@@ -1,5 +1,5 @@
 require "power_trace/entry"
-require "pry-stack_explorer"
+require "binding_of_caller"
 
 module PowerTrace
   class Stack
@@ -9,7 +9,8 @@ module PowerTrace
 
     OUTPUT_OPTIONS_DEFAULT = {
       colorize: true,
-      line_limit: 100
+      line_limit: 100,
+      extra_info_indent: 4
     }
 
     def initialize(options = {})
@@ -44,12 +45,8 @@ module PowerTrace
       end
     end
 
-    def frame_manager
-      PryStackExplorer.frame_manager(Pry.new)
-    end
-
     def extract_entries
-      frames = frame_manager.bindings
+      frames = binding.callers
       # when using pry console, the power_trace_index will be `nil` and breaks EVERYTHING
       # so we should fallback it to 0
       power_trace_index = (frames.index { |b| b.frame_description&.to_sym == :power_trace } || 0) + 1
@@ -61,6 +58,8 @@ module PowerTrace
           MethodEntry.new(b)
         when :block
           BlockEntry.new(b)
+        else
+          Entry.new(b)
         end
       end
     end

data/lib/power_trace/version.rb

@@ -1,3 +1,3 @@
 module PowerTrace
-  VERSION = "0.1.0"
+  VERSION = "0.2.0"
 end

data/power_trace.gemspec

@@ -29,6 +29,7 @@ So I hope to solve this problem by adding some additional runtime info to the ba
   spec.require_paths = ["lib"]
 
   spec.add_dependency "activesupport"
-  spec.add_dependency "pry"
-  spec.add_dependency "pry-stack_explorer"
+  spec.add_dependency "binding_of_caller", "~> 0.8.0"
+
+  spec.add_development_dependency "pry"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: power_trace
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors:
 - st0012
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2020-07-09 00:00:00.000000000 Z
+date: 2020-07-13 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -25,27 +25,27 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: pry
+  name: binding_of_caller
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 0.8.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 0.8.0
 - !ruby/object:Gem::Dependency
-  name: pry-stack_explorer
+  name: pry
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
-  type: :runtime
+  type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
@@ -78,7 +78,9 @@ files:
 - bin/setup
 - images/entries.png
 - images/normal_backtrace.png
+- images/normal_rspec_error.png
 - images/power_trace_backtrace.png
+- images/power_trace_rspec_error.png
 - images/print_directly.png
 - lib/power_trace.rb
 - lib/power_trace/entries/block_entry.rb
@@ -86,6 +88,7 @@ files:
 - lib/power_trace/entry.rb
 - lib/power_trace/exception_patch.rb
 - lib/power_trace/helpers/colorize_helper.rb
+- lib/power_trace/rspec_patch.rb
 - lib/power_trace/stack.rb
 - lib/power_trace/version.rb
 - power_trace.gemspec