enhanced_errors 2.1.0 → 2.1.2

data/doc/top-level-namespace.html

@@ -82,7 +82,7 @@
 <p class="children">
   
     
-      <strong class="modules">Modules:</strong> <span class='object_link'><a href="Enhanced.html" title="Enhanced (module)">Enhanced</a></span>
+      <strong class="modules">Modules:</strong> <span class='object_link'><a href="Enhanced.html" title="Enhanced (module)">Enhanced</a></span>, <span class='object_link'><a href="Minitest.html" title="Minitest (module)">Minitest</a></span>
     
   
     
@@ -122,9 +122,9 @@
 </div>
 
       <div id="footer">
-  Generated on Mon Dec  9 19:51:26 2024 by
+  Generated on Mon Dec 16 10:41:42 2024 by
   <a href="https://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
-  0.9.37 (ruby-3.1.3).
+  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 = "2.1.0"
+  spec.version = "2.1.2"
   spec.authors = ["Eric Beland"]
 
   spec.summary = "Automatically enhance your errors with messages containing variable values from the moment they were raised."

data/examples/demo_rspec.rb

@@ -14,8 +14,12 @@ RSpec.configure do |config|
     EnhancedErrors.start_rspec_binding_capture
   end
 
+  config.before(:example) do |_example|
+    EnhancedErrors.start_rspec_binding_capture
+  end
+
   config.after(:example) do |example|
-    EnhancedErrors.override_exception_message(example.exception, EnhancedErrors.stop_rspec_binding_capture)
+    EnhancedErrors.override_rspec_message(example, EnhancedErrors.stop_rspec_binding_capture)
   end
   # -- End EnhancedErrors config
 
@@ -36,6 +40,17 @@ RSpec.describe 'Neo' do
       stop = 'bullets'
       raise 'No!'
     end
+
+    it "dodges multiple exception-bullets at once" do
+      foo = 'bar'
+      expect(1).to eq(2)
+      expect(true).to eq(false)
+    end
+
+    after(:each) do
+      raise "This is another error"
+    end
+
   end
 end
 

data/lib/enhanced_errors.rb

@@ -21,70 +21,71 @@ class EnhancedErrors
       @monitor ||= Monitor.new
     end
 
-    attr_accessor :enabled, :config_block, :on_capture_hook, :eligible_for_capture, :trace, :override_messages
+    attr_accessor :enabled, :config_block, :on_capture_hook, :eligible_for_capture, :exception_trace, :override_messages
 
     GEMS_REGEX = %r{[\/\\]gems[\/\\]}
-    RSPEC_EXAMPLE_REGEXP = /RSpec::ExampleGroups::[A-Z0-9]+.*/
     DEFAULT_MAX_LENGTH = 2000
     MAX_BINDING_INFOS = 3
 
     RSPEC_SKIP_LIST = [
-                                :@__inspect_output,
-                                :@__memoized,
-                                :@assertion_delegator,
-                                :@assertion_instance,
-                                :@assertions,
-                                :@connection_subscriber,
-                                :@example,
-                                :@fixture_cache,
-                                :@fixture_cache_key,
-                                :@fixture_connection_pools,
-                                :@fixture_connections,
-                                :@integration_session,
-                                :@legacy_saved_pool_configs,
-                                :@loaded_fixtures,
-                                :@matcher_definitions,
-                                :@saved_pool_configs
-                              ].freeze
+      :@__inspect_output,
+      :@__memoized,
+      :@assertion_delegator,
+      :@assertion_instance,
+      :@assertions,
+      :@connection_subscriber,
+      :@example,
+      :@fixture_cache,
+      :@fixture_cache_key,
+      :@fixture_connection_pools,
+      :@fixture_connections,
+      :@integration_session,
+      :@legacy_saved_pool_configs,
+      :@loaded_fixtures,
+      :@matcher_definitions,
+      :@saved_pool_configs
+    ].freeze
 
     RAILS_SKIP_LIST = [
-                                :@new_record,
-                                :@attributes,
-                                :@association_cache,
-                                :@readonly,
-                                :@previously_new_record,
-                                :@_routes,
-                                :@routes,
-                                :@app,
-                                :@arel_table,
-                                :@assertion_instance,
-                                :@association_cache,
-                                :@attributes,
-                                :@destroyed,
-                                :@destroyed_by_association,
-                                :@find_by_statement_cache,
-                                :@generated_relation_method,
-                                :@integration_session,
-                                :@marked_for_destruction,
-                                :@mutations_before_last_save,
-                                :@mutations_from_database,
-                                :@new_record,
-                                :@predicate_builder,
-                                :@previously_new_record,
-                                :@primary_key,
-                                :@readonly,
-                                :@relation_delegate_cache,
-                                :@response,
-                                :@response_klass,
-                                :@routes,
-                                :@strict_loading,
-                                :@strict_loading_mode
-                              ].freeze
+      :@new_record,
+      :@attributes,
+      :@association_cache,
+      :@readonly,
+      :@previously_new_record,
+      :@_routes,
+      :@routes,
+      :@app,
+      :@arel_table,
+      :@assertion_instance,
+      :@association_cache,
+      :@attributes,
+      :@destroyed,
+      :@destroyed_by_association,
+      :@find_by_statement_cache,
+      :@generated_relation_method,
+      :@integration_session,
+      :@marked_for_destruction,
+      :@mutations_before_last_save,
+      :@mutations_from_database,
+      :@new_record,
+      :@predicate_builder,
+      :@previously_new_record,
+      :@primary_key,
+      :@readonly,
+      :@relation_delegate_cache,
+      :@response,
+      :@response_klass,
+      :@routes,
+      :@strict_loading,
+      :@strict_loading_mode
+    ].freeze
 
     MINITEST_SKIP_LIST = [:@NAME, :@failures, :@time].freeze
 
     DEFAULT_SKIP_LIST = (RAILS_SKIP_LIST + RSPEC_SKIP_LIST + MINITEST_SKIP_LIST)
 
+    RSPEC_HANDLER_NAMES = ['RSpec::Expectations::PositiveExpectationHandler', 'RSpec::Expectations::NegativeExpectationHandler']
+
     @enabled = false
     @max_length = nil
     @capture_rescue = nil
@@ -94,12 +95,11 @@ class EnhancedErrors
     @output_format = nil
     @eligible_for_capture = nil
     @original_global_variables = nil
-    @trace = nil
+    @exception_trace = nil
     @override_messages = nil
-    @rspec_failure_message_loaded = nil
 
     # Default values
-    @max_capture_events = -1   # -1 means no limit
+    @max_capture_events = -1 # -1 means no limit
     @capture_events_count = 0
 
     # Thread-safe getters and setters
@@ -116,11 +116,11 @@ class EnhancedErrors
     end
 
     def capture_rescue
-      mutex.synchronize {  @capture_rescue }
+      mutex.synchronize { @capture_rescue }
     end
 
     def capture_events_count
-      mutex.synchronize { @capture_events_count }
+      mutex.synchronize { @capture_events_count || 0 }
     end
 
     def capture_events_count=(val)
@@ -128,7 +128,7 @@ class EnhancedErrors
     end
 
     def max_capture_events
-      mutex.synchronize { @max_capture_events }
+      mutex.synchronize { @max_capture_events || -1 }
     end
 
     def max_capture_events=(value)
@@ -139,7 +139,7 @@ class EnhancedErrors
           if @enabled
             puts "EnhancedErrors: max_capture_events set to 0, disabling capturing."
             @enabled = false
-            @trace&.disable
+            @exception_trace&.disable
             @rspec_tracepoint&.disable
             @minitest_trace&.disable
           end
@@ -147,23 +147,36 @@ class EnhancedErrors
       end
     end
 
+    def enforce_capture_limit!
+      disable_capturing! if capture_limit_exceeded?
+    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
+        @rspec_tracepoint&.disable
+        @minitest_trace&.disable
+        @exception_trace&.disable
+      end
+    end
+
     def increment_capture_events_count
       mutex.synchronize do
+        @capture_events_count ||= 0
+        @max_capture_events ||= -1
         @capture_events_count += 1
-        # Check if we've hit the limit
-        if @max_capture_events > 0 && @capture_events_count >= @max_capture_events
-          # puts "EnhancedErrors: max_capture_events limit (#{@max_capture_events}) reached, disabling capturing."
-          @enabled = false
-        end
       end
     end
 
     def reset_capture_events_count
       mutex.synchronize do
         @capture_events_count = 0
-        @enabled = true
-        @rspec_tracepoint.enable if @rspec_tracepoint
-        @trace.enable if @trace
       end
     end
 
@@ -184,6 +197,19 @@ class EnhancedErrors
       end
     end
 
+    def override_rspec_message(example, binding_or_bindings)
+      exception_obj = example.exception
+      case exception_obj
+      when nil
+        return nil
+      when RSpec::Core::MultipleExceptionError
+        override_exception_message(exception_obj.all_exceptions.first, binding_or_bindings)
+      else
+        override_exception_message(exception_obj, binding_or_bindings)
+      end
+
+    end
+
     def override_exception_message(exception, binding_or_bindings)
       return nil unless exception
       rspec_binding = !(binding_or_bindings.nil? || binding_or_bindings.empty?)
@@ -211,8 +237,8 @@ class EnhancedErrors
 
     def enhance_exceptions!(enabled: true, debug: false, capture_events: nil, override_messages: false, **options, &block)
       mutex.synchronize do
-        @trace&.disable
-        @trace = nil
+        @exception_trace&.disable
+        @exception_trace = nil
 
         @output_format = nil
         @eligible_for_capture = nil
@@ -220,7 +246,9 @@ class EnhancedErrors
         @override_messages = override_messages
 
         # Ensure these are not nil
-        @max_capture_events = -1 if @max_capture_events.nil?
+        if @max_capture_events.nil?
+          @max_capture_events = -1
+        end
         @capture_events_count = 0
 
         @rspec_failure_message_loaded = true
@@ -256,13 +284,13 @@ class EnhancedErrors
         end
 
         events = @capture_events ? @capture_events.to_a : default_capture_events
-        @trace = TracePoint.new(*events) do |tp|
+        @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)
-          @trace.enable
+          @exception_trace.enable
         end
       end
     end
@@ -278,23 +306,12 @@ class EnhancedErrors
       end
     end
 
-    def safely_prepend_rspec_custom_failure_message
-      mutex.synchronize do
-        return if @rspec_failure_message_loaded
-        if defined?(RSpec::Core::Example) && !RSpec::Core::Example < Enhanced::Integrations::RSpecErrorFailureMessage
-          RSpec::Core::Example.prepend(Enhanced::Integrations::RSpecErrorFailureMessage)
-          @rspec_failure_message_loaded = true
-        end
-      end
-    rescue => e
-      puts "Failed to prepend RSpec custom failure message: #{e.message}"
-    end
-
     def is_a_minitest?(klass)
       klass.ancestors.include?(Minitest::Test) && klass.name != 'Minitest::Test'
     end
 
     def start_minitest_binding_capture
+      return if capture_limit_exceeded?
       mutex.synchronize do
         @minitest_trace = TracePoint.new(:return) do |tp|
           next unless tp.method_id.to_s.start_with?('test_') && is_a_minitest?(tp.defined_class)
@@ -305,6 +322,7 @@ class EnhancedErrors
     end
 
     def stop_minitest_binding_capture
+      disable_capturing! if capture_limit_exceeded?
       mutex.synchronize do
         @minitest_trace&.disable
         @minitest_trace = nil
@@ -312,26 +330,48 @@ class EnhancedErrors
       end
     end
 
+    def class_to_string(klass)
+      return '' if klass.nil?
+      if klass.singleton_class?
+        (match = klass.to_s.match(/#<Class:(.*?)>/)) ? match[1] : klass.to_s
+      else
+        klass.to_s
+      end
+    end
+
+    def is_rspec_example?(tracepoint)
+      tracepoint.method_id.nil? && !(tracepoint.path.include?('rspec')) && tracepoint.path.end_with?('_spec.rb')
+    end
+
     def start_rspec_binding_capture
+      return if capture_limit_exceeded?
       mutex.synchronize do
         @rspec_example_binding = nil
         @capture_next_binding = false
         @rspec_tracepoint&.disable
-        @enabled = true if @enabled.nil?
 
         @rspec_tracepoint = TracePoint.new(:raise, :b_return) do |tp|
-          # This trickery is to help us identify the anonymous block return we want to grab
+          # 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
-            next unless @capture_next_binding && @rspec_example_binding.nil?
-            if @capture_next_binding && tp.method_id.nil? && !(tp.path.include?('rspec')) && tp.path.end_with?('_spec.rb')
-              if determine_object_name(tp) =~ RSPEC_EXAMPLE_REGEXP
-                increment_capture_events_count
-                @rspec_example_binding = tp.binding
-              end
+            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)
+              increment_capture_events_count
+              @capture_next_binding = false
+              @rspec_example_binding = tp.binding
             end
           elsif tp.event == :raise
-            if tp.raised_exception.class.name == 'RSpec::Expectations::ExpectationNotMetError'
-              @capture_next_binding ||= true
+            class_name = tp.raised_exception.class.name
+            case class_name
+            when 'RSpec::Expectations::ExpectationNotMetError'
+              @capture_next_binding = :next_matching
             else
               handle_tracepoint_event(tp)
             end
@@ -342,6 +382,7 @@ class EnhancedErrors
     end
 
     def stop_rspec_binding_capture
+      disable_capturing! if capture_limit_exceeded?
       mutex.synchronize do
         @rspec_tracepoint&.disable
         @rspec_tracepoint = nil
@@ -567,6 +608,7 @@ class EnhancedErrors
 
     def handle_tracepoint_event(tp)
       # Check enabled outside the synchronized block for speed, but still safe due to re-check inside.
+      enforce_capture_limit!
       return unless mutex.synchronize { @enabled }
       return if Thread.current[:enhanced_errors_processing] || Thread.current[:on_capture] || ignored_exception?(tp.raised_exception)
 
@@ -712,7 +754,7 @@ class EnhancedErrors
     end
 
     def valid_capture_events?(capture_events)
-      capture_events.is_a?(Array) && [:raise, :rescue] && capture_events
+      capture_events.is_a?(Array) && capture_events.all? { |ev| [:raise, :rescue].include?(ev) }
     end
 
     def extract_arguments(tp, method_name)

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: enhanced_errors
 version: !ruby/object:Gem::Version
-  version: 2.1.0
+  version: 2.1.2
 platform: ruby
 authors:
 - Eric Beland
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2024-12-15 00:00:00.000000000 Z
+date: 2024-12-16 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: awesome_print
@@ -90,6 +90,7 @@ files:
 - doc/Enhanced/Integrations/RSpecErrorFailureMessage.html
 - doc/EnhancedErrors.html
 - doc/Exception.html
+- doc/Minitest.html
 - doc/_index.html
 - doc/class_list.html
 - doc/css/common.css
@@ -135,7 +136,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