enhanced_errors 3.0.5 → 3.0.7

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: e6463163f60ad8df047c834d0722ebfc800bbb8a9b57773d064b2a22eaeead69
-  data.tar.gz: 53c886d04c8b1c518d9a4d05262947f95ba462b9b3cd76cb913c2f2142080a6d
+  metadata.gz: 714303e7c9843a654ae44db08c3540bce67733db5f69bc241704cd79a95093f4
+  data.tar.gz: 3f3785c200717e230da689501f534317d0dae6fe8caa1563a887eef95b80ba01
 SHA512:
-  metadata.gz: 4428ec99b50fd747204426fe2059b140ed335f38486babd0f5882380391490ce5c1ef4e97a55e3fcf0caceabe099c59f5813bb2be722ab7edb584278d6e06afd
-  data.tar.gz: e30adc9c45a925c84bc9b97f07e8a96d351325dc74880b7ee1b38f7b02e96cafec3f91b25bedafcb87793d5c11fd90aee9ec3f1bd4c426263a17a91e6ce72acf
+  metadata.gz: ebf2fb3d3cb9a805da3c3d2278eae26b7319ff325be32f92cf0cfb530eb4093f160aacf9c5e19502c3b48a4a329cdeedd6f8dbb149e8999ec744026b5ddbd2d5
+  data.tar.gz: 155356eee4767b526eefb0b28168b644f2becb40c1d008d9744e593ad45e5fc3ac162f508a01b7bc9a805e56b465ff95cdf0a4afaf06d0514eb0f326ef1ceb76

data/README.md

@@ -47,8 +47,8 @@ require 'awesome_print' # Optional, for better output
 
 RSpec.configure do |config|
   
-  # Along with the requires, add this to your RSpec config to enhance your RSpec output
-  # Consider driving the config with an environment variable like this to make it configurable per-user or run
+  # Add this config to RSpec to enhance your output
+  # Consider driving the config with an environment variable to make it configurable per-user or run:
   # if ENV['enhanced_errors'] == 'true'
       config.before(:example) do |_example|
         EnhancedErrors.start_rspec_binding_capture

data/doc/Enhanced/Colors.html

@@ -381,9 +381,9 @@
 </div>
 
       <div id="footer">
-  Generated on Wed Dec 25 13:01:48 2024 by
+  Generated on Wed Dec 25 21:30:24 2024 by
   <a href="https://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
-  0.9.37 (ruby-3.4.1).
+  0.9.37 (ruby-3.3.6).
 </div>
 
     </div>

data/doc/Enhanced/Context.html

@@ -273,9 +273,9 @@
 </div>
 
       <div id="footer">
-  Generated on Wed Dec 25 13:01:48 2024 by
+  Generated on Wed Dec 25 21:30:25 2024 by
   <a href="https://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
-  0.9.37 (ruby-3.4.1).
+  0.9.37 (ruby-3.3.6).
 </div>
 
     </div>

data/doc/Enhanced/ExceptionBindingInfos.html

@@ -239,9 +239,9 @@
 </div>
 
       <div id="footer">
-  Generated on Wed Dec 25 13:01:48 2024 by
+  Generated on Wed Dec 25 21:30:24 2024 by
   <a href="https://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
-  0.9.37 (ruby-3.4.1).
+  0.9.37 (ruby-3.3.6).
 </div>
 
     </div>

data/doc/Enhanced/ExceptionContext.html

@@ -387,9 +387,9 @@
 </div>
 
       <div id="footer">
-  Generated on Wed Dec 25 13:01:48 2024 by
+  Generated on Wed Dec 25 21:30:24 2024 by
   <a href="https://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
-  0.9.37 (ruby-3.4.1).
+  0.9.37 (ruby-3.3.6).
 </div>
 
     </div>

data/doc/Enhanced.html

@@ -84,7 +84,7 @@
   <dl>
     <dt>Defined in:</dt>
     <dd>lib/enhanced/colors.rb<span class="defines">,<br />
-  lib/enhanced_errors.rb,<br /> lib/enhanced_errors.rb,<br /> lib/enhanced/context.rb,<br /> lib/enhanced/exception.rb,<br /> lib/enhanced/exception_context.rb</span>
+  lib/enhanced_errors.rb,<br /> lib/enhanced/context.rb,<br /> lib/enhanced/exception.rb,<br /> lib/enhanced/exception_context.rb</span>
 </dd>
   </dl>
   
@@ -114,9 +114,9 @@
 </div>
 
       <div id="footer">
-  Generated on Wed Dec 25 13:01:48 2024 by
+  Generated on Wed Dec 25 21:30:24 2024 by
   <a href="https://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
-  0.9.37 (ruby-3.4.1).
+  0.9.37 (ruby-3.3.6).
 </div>
 
     </div>

data/doc/EnhancedErrors.html

@@ -1966,7 +1966,7 @@
 
     <span class='id identifier rubyid_events'>events</span> <span class='op'>=</span> <span class='ivar'>@capture_events</span> <span class='op'>?</span> <span class='ivar'>@capture_events</span><span class='period'>.</span><span class='id identifier rubyid_to_a'>to_a</span> <span class='op'>:</span> <span class='id identifier rubyid_default_capture_events'>default_capture_events</span>
     <span class='ivar'>@exception_trace</span> <span class='op'>=</span> <span class='const'>TracePoint</span><span class='period'>.</span><span class='id identifier rubyid_new'>new</span><span class='lparen'>(</span><span class='op'>*</span><span class='id identifier rubyid_events'>events</span><span class='rparen'>)</span> <span class='kw'>do</span> <span class='op'>|</span><span class='id identifier rubyid_tp'>tp</span><span class='op'>|</span>
-      <span class='kw'>return</span> <span class='kw'>unless</span> <span class='id identifier rubyid_exception_is_handleable?'>exception_is_handleable?</span><span class='lparen'>(</span><span class='id identifier rubyid_tp'>tp</span><span class='period'>.</span><span class='id identifier rubyid_raised_exception'>raised_exception</span><span class='rparen'>)</span>
+      <span class='kw'>next</span> <span class='kw'>unless</span> <span class='id identifier rubyid_exception_is_handleable?'>exception_is_handleable?</span><span class='lparen'>(</span><span class='id identifier rubyid_tp'>tp</span><span class='period'>.</span><span class='id identifier rubyid_raised_exception'>raised_exception</span><span class='rparen'>)</span>
       <span class='id identifier rubyid_handle_tracepoint_event'>handle_tracepoint_event</span><span class='lparen'>(</span><span class='id identifier rubyid_tp'>tp</span><span class='rparen'>)</span>
     <span class='kw'>end</span>
 
@@ -2837,14 +2837,14 @@
     <span class='ivar'>@capture_next_binding</span> <span class='op'>=</span> <span class='kw'>false</span>
     <span class='ivar'>@rspec_tracepoint</span><span class='op'>&amp;.</span><span class='id identifier rubyid_disable'>disable</span>
     <span class='ivar'>@rspec_tracepoint</span> <span class='op'>=</span> <span class='const'>TracePoint</span><span class='period'>.</span><span class='id identifier rubyid_new'>new</span><span class='lparen'>(</span><span class='symbol'>:raise</span><span class='rparen'>)</span> <span class='kw'>do</span> <span class='op'>|</span><span class='id identifier rubyid_tp'>tp</span><span class='op'>|</span>
-      <span class='kw'>return</span> <span class='kw'>unless</span> <span class='id identifier rubyid_exception_is_handleable?'>exception_is_handleable?</span><span class='lparen'>(</span><span class='id identifier rubyid_tp'>tp</span><span class='period'>.</span><span class='id identifier rubyid_raised_exception'>raised_exception</span><span class='rparen'>)</span>
-      <span class='id identifier rubyid_class_name'>class_name</span> <span class='op'>=</span> <span class='id identifier rubyid_tp'>tp</span><span class='period'>.</span><span class='id identifier rubyid_raised_exception'>raised_exception</span><span class='period'>.</span><span class='id identifier rubyid_class'>class</span><span class='period'>.</span><span class='id identifier rubyid_name'>name</span>
-      <span class='kw'>case</span> <span class='id identifier rubyid_class_name'>class_name</span>
+      <span class='kw'>case</span> <span class='id identifier rubyid_tp'>tp</span><span class='period'>.</span><span class='id identifier rubyid_raised_exception'>raised_exception</span><span class='period'>.</span><span class='id identifier rubyid_class'>class</span><span class='period'>.</span><span class='id identifier rubyid_name'>name</span>
       <span class='kw'>when</span> <span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>RSpec::Expectations::ExpectationNotMetError</span><span class='tstring_end'>&#39;</span></span>
         <span class='id identifier rubyid_start_rspec_binding_trap'>start_rspec_binding_trap</span>
       <span class='kw'>else</span>
         <span class='id identifier rubyid_handle_tracepoint_event'>handle_tracepoint_event</span><span class='lparen'>(</span><span class='id identifier rubyid_tp'>tp</span><span class='rparen'>)</span>
       <span class='kw'>end</span>
+    <span class='kw'>rescue</span> <span class='op'>=&gt;</span> <span class='id identifier rubyid_e'>e</span>
+      <span class='id identifier rubyid_puts'>puts</span> <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>Error in RSpec binding capture </span><span class='embexpr_beg'>#{</span><span class='id identifier rubyid_e'>e</span><span class='embexpr_end'>}</span><span class='tstring_content'> </span><span class='embexpr_beg'>#{</span><span class='id identifier rubyid_e'>e</span><span class='period'>.</span><span class='id identifier rubyid_backtrace'>backtrace</span><span class='embexpr_end'>}</span><span class='tstring_end'>&quot;</span></span>
     <span class='kw'>end</span>
   <span class='kw'>end</span>
   <span class='ivar'>@rspec_tracepoint</span><span class='op'>&amp;.</span><span class='id identifier rubyid_enable'>enable</span>
@@ -3036,9 +3036,9 @@
 </div>
 
       <div id="footer">
-  Generated on Wed Dec 25 13:01:48 2024 by
+  Generated on Wed Dec 25 21:30:25 2024 by
   <a href="https://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
-  0.9.37 (ruby-3.4.1).
+  0.9.37 (ruby-3.3.6).
 </div>
 
     </div>

data/doc/Exception.html

@@ -111,9 +111,9 @@
 </div>
 
       <div id="footer">
-  Generated on Wed Dec 25 13:01:48 2024 by
+  Generated on Wed Dec 25 21:30:25 2024 by
   <a href="https://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
-  0.9.37 (ruby-3.4.1).
+  0.9.37 (ruby-3.3.6).
 </div>
 
     </div>

data/doc/Minitest.html

@@ -230,9 +230,9 @@
 </div>
 
       <div id="footer">
-  Generated on Wed Dec 25 13:01:48 2024 by
+  Generated on Wed Dec 25 21:30:24 2024 by
   <a href="https://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
-  0.9.37 (ruby-3.4.1).
+  0.9.37 (ruby-3.3.6).
 </div>
 
     </div>

data/doc/_index.html

@@ -156,9 +156,9 @@
 </div>
 
       <div id="footer">
-  Generated on Wed Dec 25 13:01:48 2024 by
+  Generated on Wed Dec 25 21:30:24 2024 by
   <a href="https://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
-  0.9.37 (ruby-3.4.1).
+  0.9.37 (ruby-3.3.6).
 </div>
 
     </div>

data/doc/file.README.html

@@ -104,8 +104,8 @@
 </span>
 <span class='const'>RSpec</span><span class='period'>.</span><span class='id identifier rubyid_configure'>configure</span> <span class='kw'>do</span> <span class='op'>|</span><span class='id identifier rubyid_config'>config</span><span class='op'>|</span>
   
-  <span class='comment'># Along with the requires, add this to your RSpec config to enhance your RSpec output
-</span>  <span class='comment'># Consider driving the config with an environment variable like this to make it configurable per-user or run
+  <span class='comment'># Add this config to RSpec to enhance your output
+</span>  <span class='comment'># Consider driving the config with an environment variable to make it configurable per-user or run:
 </span>  <span class='comment'># if ENV[&#39;enhanced_errors&#39;] == &#39;true&#39;
 </span>      <span class='id identifier rubyid_config'>config</span><span class='period'>.</span><span class='id identifier rubyid_before'>before</span><span class='lparen'>(</span><span class='symbol'>:example</span><span class='rparen'>)</span> <span class='kw'>do</span> <span class='op'>|</span><span class='id identifier rubyid__example'>_example</span><span class='op'>|</span>
         <span class='const'><span class='object_link'><a href="EnhancedErrors.html" title="EnhancedErrors (class)">EnhancedErrors</a></span></span><span class='period'>.</span><span class='id identifier rubyid_start_rspec_binding_capture'><span class='object_link'><a href="EnhancedErrors.html#start_rspec_binding_capture-class_method" title="EnhancedErrors.start_rspec_binding_capture (method)">start_rspec_binding_capture</a></span></span>
@@ -481,9 +481,9 @@
 </div></div>
 
       <div id="footer">
-  Generated on Wed Dec 25 13:01:48 2024 by
+  Generated on Wed Dec 25 21:30:24 2024 by
   <a href="https://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
-  0.9.37 (ruby-3.4.1).
+  0.9.37 (ruby-3.3.6).
 </div>
 
     </div>

data/doc/index.html

@@ -104,8 +104,8 @@
 </span>
 <span class='const'>RSpec</span><span class='period'>.</span><span class='id identifier rubyid_configure'>configure</span> <span class='kw'>do</span> <span class='op'>|</span><span class='id identifier rubyid_config'>config</span><span class='op'>|</span>
   
-  <span class='comment'># Along with the requires, add this to your RSpec config to enhance your RSpec output
-</span>  <span class='comment'># Consider driving the config with an environment variable like this to make it configurable per-user or run
+  <span class='comment'># Add this config to RSpec to enhance your output
+</span>  <span class='comment'># Consider driving the config with an environment variable to make it configurable per-user or run:
 </span>  <span class='comment'># if ENV[&#39;enhanced_errors&#39;] == &#39;true&#39;
 </span>      <span class='id identifier rubyid_config'>config</span><span class='period'>.</span><span class='id identifier rubyid_before'>before</span><span class='lparen'>(</span><span class='symbol'>:example</span><span class='rparen'>)</span> <span class='kw'>do</span> <span class='op'>|</span><span class='id identifier rubyid__example'>_example</span><span class='op'>|</span>
         <span class='const'><span class='object_link'><a href="EnhancedErrors.html" title="EnhancedErrors (class)">EnhancedErrors</a></span></span><span class='period'>.</span><span class='id identifier rubyid_start_rspec_binding_capture'><span class='object_link'><a href="EnhancedErrors.html#start_rspec_binding_capture-class_method" title="EnhancedErrors.start_rspec_binding_capture (method)">start_rspec_binding_capture</a></span></span>
@@ -481,9 +481,9 @@
 </div></div>
 
       <div id="footer">
-  Generated on Wed Dec 25 13:01:48 2024 by
+  Generated on Wed Dec 25 21:30:24 2024 by
   <a href="https://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
-  0.9.37 (ruby-3.4.1).
+  0.9.37 (ruby-3.3.6).
 </div>
 
     </div>

data/doc/top-level-namespace.html

@@ -113,8 +113,12 @@
 
 </div>
         </dt>
-        <dd><pre class="code"><span class='qwords_beg'>%w[</span><span class='tstring_content'>RSpec::Expectations::ExpectationNotMetError</span><span class='words_sep'> </span><span class='tstring_content'>RSpec::Matchers::BuiltIn::RaiseError</span><span class='words_sep'>
-</span><span class='tstring_content'>JSON::ParserError</span><span class='words_sep'> </span><span class='tstring_content'>Zlib::Error</span><span class='words_sep'> </span><span class='tstring_content'>OpenSSL::SSL::SSLError</span><span class='words_sep'> </span><span class='tstring_content'>Psych::Exception</span><span class='tstring_end'>]</span></span></pre></dd>
+        <dd><pre class="code"><span class='qwords_beg'>%w[</span><span class='tstring_content'>JSON::ParserError</span><span class='words_sep'> </span><span class='tstring_content'>Zlib::Error</span><span class='words_sep'> </span><span class='tstring_content'>OpenSSL::SSL::SSLError</span><span class='words_sep'> </span><span class='tstring_content'>Psych::BadAlias</span><span class='tstring_end'>]</span></span></pre></dd>
+      
+        <dt id="IGNORED_RSPEC_EXCEPTIONS-constant" class="">IGNORED_RSPEC_EXCEPTIONS =
+          
+        </dt>
+        <dd><pre class="code"><span class='qwords_beg'>%w[</span><span class='tstring_content'>RSpec::Expectations::ExpectationNotMetError</span><span class='words_sep'> </span><span class='tstring_content'>RSpec::Matchers::BuiltIn::RaiseError</span><span class='tstring_end'>]</span></span></pre></dd>
       
     </dl>
   
@@ -130,9 +134,9 @@
 </div>
 
       <div id="footer">
-  Generated on Wed Dec 25 13:01:48 2024 by
+  Generated on Wed Dec 25 21:30:24 2024 by
   <a href="https://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
-  0.9.37 (ruby-3.4.1).
+  0.9.37 (ruby-3.3.6).
 </div>
 
     </div>

data/enhanced_errors.gemspec

@@ -1,6 +1,6 @@
 Gem::Specification.new do |spec|
   spec.name = "enhanced_errors"
-  spec.version = "3.0.5"
+  spec.version = "3.0.7"
   spec.authors = ["Eric Beland"]
 
   spec.summary = "Automatically enhance your errors with messages containing variable values from the moment they were raised."

data/lib/enhanced_errors.rb

@@ -8,8 +8,8 @@ module Enhanced; end
 
 # Exceptions we could handle but overlook for other reasons. These class constants are not always loaded
 # and generally are only be available when `required`, so we detect them by strings.
-IGNORED_EXCEPTIONS = %w[RSpec::Expectations::ExpectationNotMetError RSpec::Matchers::BuiltIn::RaiseError
-                        JSON::ParserError Zlib::Error OpenSSL::SSL::SSLError Psych::Exception]
+IGNORED_EXCEPTIONS = %w[JSON::ParserError Zlib::Error OpenSSL::SSL::SSLError Psych::BadAlias]
+IGNORED_RSPEC_EXCEPTIONS = %w[RSpec::Expectations::ExpectationNotMetError RSpec::Matchers::BuiltIn::RaiseError]
 
 class EnhancedErrors
   extend ::Enhanced
@@ -218,7 +218,7 @@ class EnhancedErrors
 
         events = @capture_events ? @capture_events.to_a : default_capture_events
         @exception_trace = TracePoint.new(*events) do |tp|
-          return unless exception_is_handleable?(tp.raised_exception)
+          next unless exception_is_handleable?(tp.raised_exception)
           handle_tracepoint_event(tp)
         end
 
@@ -276,14 +276,14 @@ class EnhancedErrors
         @capture_next_binding = false
         @rspec_tracepoint&.disable
         @rspec_tracepoint = TracePoint.new(:raise) do |tp|
-          return unless exception_is_handleable?(tp.raised_exception)
-          class_name = tp.raised_exception.class.name
-          case class_name
+          case tp.raised_exception.class.name
           when 'RSpec::Expectations::ExpectationNotMetError'
             start_rspec_binding_trap
           else
             handle_tracepoint_event(tp)
           end
+        rescue => e
+          puts "Error in RSpec binding capture #{e} #{e.backtrace}"
         end
       end
       @rspec_tracepoint&.enable
@@ -635,8 +635,11 @@ class EnhancedErrors
       Thread.current[:enhanced_errors_processing] = false
     end
 
+    # Specifically avoid psych, and system level libraries, or libraries where variable context isn't
+    # likely to be particularly helpful or relevant.
     def ignored_exception?(exception)
-      IGNORED_EXCEPTIONS.include?(exception.class.name)
+      name = exception.class.name
+      IGNORED_EXCEPTIONS.include?(name) || name =~ /^(Gem|Psych|Zlib|OpenSSL|DRb|Prism|Reline|Fiddle)::/
     end
 
     def test_name
@@ -818,10 +821,18 @@ class EnhancedErrors
     # By default, we have filtering for safety, but past that, we capture everything by default
     # at the moment.
     def default_eligible_for_capture(exception)
-      true
+      ignored = ignored_exception?(exception) || IGNORED_RSPEC_EXCEPTIONS.include?(exception.class.name)
+      rspec = exception.class.name.start_with?('RSpec::Matchers')
+      !(ignored || rspec)
     end
 
+    # overall--do we process this, including whether we ignore it or not for more general reasons
     def exception_is_handleable?(exception)
+      exception && processable_exception?(exception) && !ignored_exception?(exception)
+    end
+
+    # some exceptions, we just don't want to touch
+    def processable_exception?(exception)
       case exception
       when SystemExit, SignalException, SystemStackError, NoMemoryError
         # Non-actionable: Ignore these exceptions
@@ -850,7 +861,3 @@ class EnhancedErrors
 
   end
 end
-
-module Enhanced
-
-end

metadata

@@ -1,13 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: enhanced_errors
 version: !ruby/object:Gem::Version
-  version: 3.0.5
+  version: 3.0.7
 platform: ruby
 authors:
 - Eric Beland
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2024-12-25 00:00:00.000000000 Z
+date: 2024-12-26 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: awesome_print
@@ -68,6 +69,7 @@ dependencies:
 description: 'EnhancedErrors will automatically enhance your errors with messages
   containing variable values from the moment they were raised, using no extra dependencies,
   and only Ruby''s built-in TracePoint. '
+email:
 executables: []
 extensions: []
 extra_rdoc_files: []
@@ -123,6 +125,7 @@ licenses: []
 metadata:
   homepage_uri: https://github.com/ericbeland/enhanced_errors
   source_code_uri: https://github.com/ericbeland/enhanced_errors
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -137,7 +140,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.6.2
+rubygems_version: 3.3.26
+signing_key:
 specification_version: 4
 summary: Automatically enhance your errors with messages containing variable values
   from the moment they were raised.