enhanced_errors 2.0.5 → 2.0.6

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 3897d29e868998ef225633f9f0f0f99a994b55563d65bff843ade348e7229bb9
-  data.tar.gz: 37f1db45f0c18c64846d396088f71bab2312b89da1a375b4d325309832983efc
+  metadata.gz: 9e6ed241407a54376e0c64f2c1adc087e3dae4980ac5b7e84c947d92ff787392
+  data.tar.gz: 4f949a5145869e73e7f795a9c009800433956162a6d25695c2a9e8ba3a39da05
 SHA512:
-  metadata.gz: b156387888d9479f5d474808a922127fbfc5c6ed7035c6d8ef552dabca39b550655e191bfc6f0f11d64db36ded66fe03619cca7eaff2f5b725abb3d106f07d87
-  data.tar.gz: ce0fcadb20a8be1f0b53921cf990e5c458ce6ba1099dc5b9ceff1c8459ab82b707234bfbf964b10036a5b37a33b0248337d0289005b0f32c61933efa25ef44de
+  metadata.gz: 02312f5287c4214c59b4b4a53e723d53d4dff511f24c335a7f7a84f049bb06638f77ea22f488cba5682fba66f581116b2bb1a4b3a79d8b6a5a290f5f822f1ea8
+  data.tar.gz: 13d06fa670a3f34bb67624ec40bc9a87810536aace8c2867e64620092c13d8e48d25675241491d821491cb2f3a893c1d8faa2ede7ff2f22c45b50fb506fbbd74

data/README.md

@@ -79,33 +79,19 @@ exceptions except those that pass by during the RSpec run.
 ```ruby
 
 RSpec.configure do |config|
-   
-  # add these config changes to your RSpec config to get variable messages
-  config.before(:suite) do
-    RSpec::Core::Example.prepend(Enhanced::Integrations::RSpecErrorFailureMessage)
-  end
-  
   config.before(:example) do |_example|
     EnhancedErrors.start_rspec_binding_capture
   end
 
   config.after(:example) do |example|
     example.metadata[:expect_binding] = EnhancedErrors.stop_rspec_binding_capture
+    EnhancedErrors.override_exception_message(example.exception, example.metadata[:expect_binding])
   end
-  
 end
-
 ```
 
-## Minitest
-
-Untested as of yet, but enhance_exceptions!(override_messages: true) is likely to work.
+## TODO: Minitest
 
-If anyone wants to look into an integration implementation like RSpec, it would
-be welcomed. With a more targeted approach like the RSpec one, exceptions could be captured and 
-modified only during test time, like the RSpec approach. This would be advantageous as
-it wouldn't modify the exception message itself, but still makes the variable output available in
-test messages.
 
 ## Enhancing .message
 

data/enhanced_errors.gemspec

@@ -1,6 +1,6 @@
 Gem::Specification.new do |spec|
   spec.name = "enhanced_errors"
-  spec.version = "2.0.5"
+  spec.version = "2.0.6"
   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

@@ -3,14 +3,13 @@
 require 'set'
 require 'json'
 
-require_relative 'enhanced/integrations/rspec_error_failure_message'
 require_relative 'enhanced/colors'
 
 IGNORED_EXCEPTIONS = %w[SystemExit NoMemoryError SignalException Interrupt
-                        ScriptError LoadError NotImplementedError SyntaxError
-                        RSpec::Expectations::ExpectationNotMetError
-                        RSpec::Matchers::BuiltIn::RaiseError
-                        SystemStackError Psych::BadAlias]
+ ScriptError LoadError NotImplementedError SyntaxError
+ RSpec::Expectations::ExpectationNotMetError
+ RSpec::Matchers::BuiltIn::RaiseError
+ SystemStackError Psych::BadAlias]
 
 class EnhancedErrors
   extend ::Enhanced
@@ -106,7 +105,8 @@ class EnhancedErrors
     # and modifies the exceptions .message to display the variables
     def override_exception_message(exception, binding_or_bindings)
       # Ensure binding_or_bindings is always an array for compatibility
-      return exception if binding_or_bindings.nil? || binding_or_bindings.empty? || exception.respond_to?(:unaltered_message)
+      return exception if binding_or_bindings.nil? || binding_or_bindings.empty?
+      return exception if exception.respond_to?(:unaltered_message)
       variable_str = EnhancedErrors.format(binding_or_bindings)
       message_str = exception.message
       exception.define_singleton_method(:unaltered_message) { message_str }
@@ -186,26 +186,36 @@ class EnhancedErrors
       puts "Failed to prepend RSpec custom failure message: #{e.message}"
     end
 
-
     def start_rspec_binding_capture
       @rspec_example_binding = nil
+      @capture_next_binding = false
 
       # In the Exception binding infos, I observed that re-setting
       # the tracepoint without disabling it seemed to accumulate traces
       # in the test suite where things are disabled and re-enabled often.
       @rspec_tracepoint&.disable
 
-      @rspec_tracepoint = TracePoint.new(:b_return) do |tp|
+      @rspec_tracepoint = TracePoint.new(:raise, :b_return) do |tp|
         # This is super-kluge-y and should be replaced with... something TBD
-
-        # early easy checks to nope out of the object name and other checks
-        if tp.method_id.nil? && !(tp.path.include?('rspec')) && tp.path.end_with?('_spec.rb')
-         # fixes cases where class and name are screwed up or overridden
-          if determine_object_name(tp) =~ RSPEC_EXAMPLE_REGEXP
-            @rspec_example_binding = tp.binding
+        # only look at block returns once we have seen an ExpectationNotMetError
+
+        case tp.event
+        when :b_return
+          # only active if we are capturing the next binding
+          next unless @capture_next_binding && @rspec_example_binding.nil?
+          # early easy checks to nope out of the object name and other checks
+          if @capture_next_binding && tp.method_id.nil? && !(tp.path.include?('rspec')) && tp.path.end_with?('_spec.rb')
+            # fixes cases where class and name are screwed up or overridden
+            if determine_object_name(tp) =~ RSPEC_EXAMPLE_REGEXP
+              @rspec_example_binding = tp.binding
+            end
+          end
+        when :raise
+          # turn on capture of next binding
+          if tp.raised_exception.class.name == 'RSpec::Expectations::ExpectationNotMetError'
+            @capture_next_binding ||= true
           end
         end
-
       end
 
       @rspec_tracepoint.enable
@@ -214,6 +224,7 @@ class EnhancedErrors
     def stop_rspec_binding_capture
       @rspec_tracepoint&.disable
       binding_info = convert_binding_to_binding_info(@rspec_example_binding) if @rspec_example_binding
+      @capture_next_binding = false
       @rspec_example_binding = nil
       binding_info
     end
@@ -621,7 +632,7 @@ class EnhancedErrors
 
     def variable_description(vars_hash)
       vars_hash.map do |name, value|
-        "  #{Colors.purple(name)}: #{format_variable(value)}\n"
+        " #{Colors.purple(name)}: #{format_variable(value)}\n"
       end.join
     rescue
       ''
@@ -691,4 +702,4 @@ class EnhancedErrors
       !ignored && !rspec
     end
   end
-end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: enhanced_errors
 version: !ruby/object:Gem::Version
-  version: 2.0.5
+  version: 2.0.6
 platform: ruby
 authors:
 - Eric Beland
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2024-12-12 00:00:00.000000000 Z
+date: 2024-12-13 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: awesome_print
@@ -96,7 +96,6 @@ files:
 - examples/example_spec.rb
 - lib/enhanced/colors.rb
 - lib/enhanced/exception.rb
-- lib/enhanced/integrations/rspec_error_failure_message.rb
 - lib/enhanced_errors.rb
 homepage: https://github.com/ericbeland/enhanced_errors
 licenses: []

data/lib/enhanced/integrations/rspec_error_failure_message.rb

@@ -1,13 +0,0 @@
-module Enhanced
-  module Integrations
-    module RSpecErrorFailureMessage
-      def execution_result
-        result = super
-        if result.exception
-          EnhancedErrors.override_exception_message(result.exception, self.metadata[:expect_binding])
-        end
-        result
-      end
-    end
-  end
-end