enhanced_errors 3.0.1 → 3.0.3

data/lib/enhanced_errors.rb

@@ -7,11 +7,9 @@ require 'monitor'
 require_relative 'enhanced/colors'
 require_relative 'enhanced/exception'
 
-IGNORED_EXCEPTIONS = %w[SystemExit NoMemoryError SignalException Interrupt
- ScriptError LoadError NotImplementedError SyntaxError
- RSpec::Expectations::ExpectationNotMetError
- RSpec::Matchers::BuiltIn::RaiseError
- SystemStackError Psych::BadAlias]
+IGNORED_EXCEPTIONS = %w[SystemExit NoMemoryError SignalException Interrupt ScriptError LoadError
+NotImplementedError SyntaxError RSpec::Expectations::ExpectationNotMetError
+RSpec::Matchers::BuiltIn::RaiseError SystemStackError Psych::BadAlias]
 
 class EnhancedErrors
   extend ::Enhanced
@@ -24,8 +22,8 @@ class EnhancedErrors
     attr_accessor :enabled, :config_block, :on_capture_hook, :eligible_for_capture, :exception_trace, :override_messages
 
     GEMS_REGEX = %r{[\/\\]gems[\/\\]}
-    DEFAULT_MAX_CAPTURE_LENGTH = 2500
-    MAX_BINDING_INFOS = 3
+    DEFAULT_MAX_CAPTURE_LENGTH = 2200
+    MAX_BINDING_INFOS = 2
 
     RSPEC_SKIP_LIST = [
       :@__inspect_output,
@@ -86,6 +84,16 @@ class EnhancedErrors
 
     RSPEC_HANDLER_NAMES = ['RSpec::Expectations::PositiveExpectationHandler', 'RSpec::Expectations::NegativeExpectationHandler']
 
+    CI_ENV_VARS = {
+      'CI' => ENV['CI'],
+      'JENKINS' => ENV['JENKINS'],
+      'GITHUB_ACTIONS' => ENV['GITHUB_ACTIONS'],
+      'CIRCLECI' => ENV['CIRCLECI'],
+      'TRAVIS' => ENV['TRAVIS'],
+      'APPVEYOR' => ENV['APPVEYOR'],
+      'GITLAB_CI' => ENV['GITLAB_CI']
+    }
+
     @enabled = nil
     @max_capture_length = nil
     @capture_rescue = nil
@@ -98,10 +106,6 @@ class EnhancedErrors
     @exception_trace = nil
     @override_messages = nil
 
-    # Default values
-    @max_capture_events = -1 # -1 means no limit
-    @capture_events_count = 0
-
     # Thread-safe getters and setters
     def enabled=(val)
       mutex.synchronize { @enabled = val }
@@ -119,19 +123,6 @@ class EnhancedErrors
       mutex.synchronize { @capture_rescue }
     end
 
-    def capture_events_count
-      mutex.synchronize { @capture_events_count || 0 }
-    end
-
-    def capture_events_count=(val)
-      mutex.synchronize { @capture_events_count = val }
-    end
-
-    def max_capture_events
-      mutex.synchronize { @max_capture_events || -1 }
-    end
-
-
     def max_capture_length
       mutex.synchronize { @max_capture_length || DEFAULT_MAX_CAPTURE_LENGTH }
     end
@@ -140,18 +131,6 @@ class EnhancedErrors
       mutex.synchronize { @max_capture_length = value }
     end
 
-    def max_capture_events=(value)
-      mutex.synchronize do
-        @max_capture_events = value
-      end
-    end
-
-    def capture_limit_exceeded?
-      mutex.synchronize do
-       max_capture_events > 0 && capture_events_count >= max_capture_events
-      end
-    end
-
     def disable_capturing!
       mutex.synchronize do
         @enabled = false
@@ -170,7 +149,6 @@ class EnhancedErrors
         @rspec_tracepoint = nil
         @minitest_trace = nil
         @exception_trace = nil
-        @capture_events_count = 0
         @enabled = true
       end
     end
@@ -183,25 +161,22 @@ class EnhancedErrors
 
     def override_rspec_message(example, binding_or_bindings)
       exception_obj = example.exception
-      case exception_obj
-      when nil
-        return nil
-      when RSpec::Core::MultipleExceptionError
+      return if exception_obj.nil?
+
+      from_bindings = [binding_or_bindings].flatten.compact
+      case exception_obj.class.to_s
+      when 'RSpec::Core::MultipleExceptionError'
         exception_obj.all_exceptions.each do |exception|
-          override_exception_message(exception, binding_or_bindings)
+          override_exception_message(exception, from_bindings + exception.binding_infos)
         end
-      else
+      when 'RSpec::Expectations::ExpectationNotMetError'
         override_exception_message(exception_obj, binding_or_bindings)
+      else
+        override_exception_message(exception_obj, from_bindings + exception_obj.binding_infos)
       end
     end
 
     def override_exception_message(exception, binding_or_bindings)
-      return nil unless exception && exception.respond_to?(:message)
-      test_binding = !(binding_or_bindings.nil? || binding_or_bindings.empty?)
-      exception_binding = (exception.binding_infos.length > 0)
-      has_message = !(exception.respond_to?(:unaltered_message))
-      return nil unless (test_binding || exception_binding) && has_message
-
       variable_str = EnhancedErrors.format(binding_or_bindings)
       message_str = exception.message
       exception.define_singleton_method(:unaltered_message) { message_str }
@@ -224,14 +199,8 @@ class EnhancedErrors
         @output_format = nil
         @eligible_for_capture = nil
         @original_global_variables = nil
-        @override_messages = override_messages
-
-        # Ensure these are not nil
-        if @max_capture_events.nil?
-          @max_capture_events = -1
-        end
-        @capture_events_count ||= 0
 
+        @override_messages = override_messages
         @rspec_failure_message_loaded = true
 
         @enabled = enabled
@@ -252,32 +221,12 @@ class EnhancedErrors
 
         validate_and_set_capture_events(capture_events)
 
-        # If max_capture_events == 0, capturing is off from the start.
-        if @max_capture_events == 0
-          @enabled = false
-          return
-        end
-
         events = @capture_events ? @capture_events.to_a : default_capture_events
         @exception_trace = TracePoint.new(*events) do |tp|
           handle_tracepoint_event(tp)
         end
 
-        # Only enable trace if still enabled and not limited
-        if @enabled && (@max_capture_events == -1 || @capture_events_count < @max_capture_events)
-          @exception_trace.enable
-        end
-      end
-    end
-
-    def safe_prepend_module(target_class, mod)
-      mutex.synchronize do
-        if defined?(target_class) && target_class.is_a?(Module)
-          target_class.prepend(mod)
-          true
-        else
-          false
-        end
+        @exception_trace.enable if @enabled
       end
     end
 
@@ -286,6 +235,7 @@ class EnhancedErrors
     end
 
     def start_minitest_binding_capture
+      EnhancedExceptionContext.clear_all
       @enabled = true if @enabled.nil?
       return unless @enabled
       mutex.synchronize do
@@ -298,7 +248,6 @@ class EnhancedErrors
     end
 
     def stop_minitest_binding_capture
-      disable_capturing! if capture_limit_exceeded?
       mutex.synchronize do
         @minitest_trace&.disable
         @minitest_trace = nil
@@ -320,6 +269,7 @@ class EnhancedErrors
     end
 
     def start_rspec_binding_capture
+      EnhancedExceptionContext.clear_all
       @enabled = true if @enabled.nil?
       return unless @enabled
 
@@ -328,37 +278,38 @@ class EnhancedErrors
         @capture_next_binding = false
         @rspec_tracepoint&.disable
 
-        @rspec_tracepoint = TracePoint.new(:raise, :b_return) do |tp|
-          # puts "name #{tp.raised_exception.class.name rescue ''} method:#{tp.method_id} tp.binding:#{tp.binding.local_variables rescue ''}"
-          # puts "event: #{tp.event} defined_class#{class_to_string(tp.defined_class)} #{tp.path}:#{tp.lineno} #{tp.callee_id} "
-          # This trickery below is to help us identify the anonymous block return we want to grab
-          # Very kluge-y and edge cases have grown it, but it works
-          if tp.event == :b_return
-            if RSPEC_HANDLER_NAMES.include?(class_to_string(tp.defined_class))
-              @capture_next_binding = :next
-              next
-            end
-            next unless @capture_next_binding
-            if @capture_next_binding == :next || @capture_next_binding == :next_matching && is_rspec_example?(tp)
-              @capture_next_binding = false
-              @rspec_example_binding = tp.binding
-            end
-          elsif tp.event == :raise
+        @rspec_tracepoint = TracePoint.new(:raise) do |tp|
             class_name = tp.raised_exception.class.name
             case class_name
             when 'RSpec::Expectations::ExpectationNotMetError'
-              @capture_next_binding = :next_matching
+              start_rspec_binding_trap
             else
               handle_tracepoint_event(tp)
             end
           end
         end
         @rspec_tracepoint.enable
+    end
+
+    # grab the next rspec binding that goes by, and then stop the expensive listening trace
+    def start_rspec_binding_trap
+      @rspec_binding_trap = TracePoint.new(:b_return) do |tp|
+        # kluge-y hack and will be a pain to maintain
+        if tp.callee_id == :handle_matcher
+          @capture_next_binding = :next
+          next
+        end
+        next unless @capture_next_binding
+        @capture_next_binding = false
+        @rspec_example_binding = tp.binding
+        @rspec_binding_trap.disable
+        @rspec_binding_trap = nil
       end
+      @rspec_binding_trap.enable
     end
 
+
     def stop_rspec_binding_capture
-      disable_capturing! if capture_limit_exceeded?
       mutex.synchronize do
         @rspec_tracepoint&.disable
         @rspec_tracepoint = nil
@@ -502,16 +453,8 @@ class EnhancedErrors
     def running_in_ci?
       mutex.synchronize do
         return @running_in_ci if defined?(@running_in_ci)
-        ci_env_vars = {
-          'CI' => ENV['CI'],
-          'JENKINS' => ENV['JENKINS'],
-          'GITHUB_ACTIONS' => ENV['GITHUB_ACTIONS'],
-          'CIRCLECI' => ENV['CIRCLECI'],
-          'TRAVIS' => ENV['TRAVIS'],
-          'APPVEYOR' => ENV['APPVEYOR'],
-          'GITLAB_CI' => ENV['GITLAB_CI']
-        }
-        @running_in_ci = ci_env_vars.any? { |_, value| value.to_s.downcase == 'true' }
+
+        @running_in_ci = CI_ENV_VARS.any? { |_, value| value.to_s.downcase == 'true' }
       end
     end
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: enhanced_errors
 version: !ruby/object:Gem::Version
-  version: 3.0.1
+  version: 3.0.3
 platform: ruby
 authors:
 - Eric Beland
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2024-12-17 00:00:00.000000000 Z
+date: 2024-12-18 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: awesome_print
@@ -141,7 +141,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.3.26
+rubygems_version: 3.5.22
 signing_key:
 specification_version: 4
 summary: Automatically enhance your errors with messages containing variable values