enhanced_errors 2.1.1 → 2.1.2

data/doc/Exception.html

@@ -241,9 +241,9 @@
 </div>
 
       <div id="footer">
-  Generated on Sun Dec 15 22:33:19 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/doc/Minitest.html

@@ -228,9 +228,9 @@
 </div>
 
       <div id="footer">
-  Generated on Sun Dec 15 22:33:19 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/doc/_index.html

@@ -135,9 +135,9 @@
 </div>
 
       <div id="footer">
-  Generated on Sun Dec 15 22:33:19 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/doc/file.README.html

@@ -384,7 +384,7 @@
 <ul><li>
 <p><strong>Info Level</strong>: Respects the skip list, excluding predefined sensitive or irrelevant variables. Global variables are ignored.</p>
 </li><li>
-<p><strong>Debug Level</strong>: Ignores the skip lists, capturing all variables including those typically excluded and global variables.  Global variables are only captured in debug mode, and they exclude the default Ruby global variables.</p>
+<p><strong>Debug Level</strong>: Ignores the skip lists, capturing all variables including those typically excluded and global variables. Global variables are only captured in debug mode, and they exclude the default Ruby global variables.</p>
 </li></ul>
 
 <p><strong>Default Behavior</strong>: By default, <code>info</code> level is used, which excludes variables in the skip list to protect sensitive information. In <code>debug</code> mode, the skip lists are ignored to provide more comprehensive data, which is useful during development but should be used cautiously to avoid exposing sensitive data. The info mode is recommended.</p>
@@ -486,9 +486,9 @@
 </div></div>
 
       <div id="footer">
-  Generated on Sun Dec 15 22:33:19 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/doc/index.html

@@ -384,7 +384,7 @@
 <ul><li>
 <p><strong>Info Level</strong>: Respects the skip list, excluding predefined sensitive or irrelevant variables. Global variables are ignored.</p>
 </li><li>
-<p><strong>Debug Level</strong>: Ignores the skip lists, capturing all variables including those typically excluded and global variables.  Global variables are only captured in debug mode, and they exclude the default Ruby global variables.</p>
+<p><strong>Debug Level</strong>: Ignores the skip lists, capturing all variables including those typically excluded and global variables. Global variables are only captured in debug mode, and they exclude the default Ruby global variables.</p>
 </li></ul>
 
 <p><strong>Default Behavior</strong>: By default, <code>info</code> level is used, which excludes variables in the skip list to protect sensitive information. In <code>debug</code> mode, the skip lists are ignored to provide more comprehensive data, which is useful during development but should be used cautiously to avoid exposing sensitive data. The info mode is recommended.</p>
@@ -486,9 +486,9 @@
 </div></div>
 
       <div id="footer">
-  Generated on Sun Dec 15 22:33:19 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/doc/method_list.html

@@ -105,7 +105,7 @@
 
   <li class="even ">
     <div class="item">
-      <span class='object_link'><a href="EnhancedErrors.html#capture_rescue-class_method" title="EnhancedErrors.capture_rescue (method)">capture_rescue</a></span>
+      <span class='object_link'><a href="EnhancedErrors.html#capture_limit_exceeded%3F-class_method" title="EnhancedErrors.capture_limit_exceeded? (method)">capture_limit_exceeded?</a></span>
       <small>EnhancedErrors</small>
     </div>
   </li>
@@ -113,13 +113,21 @@
 
   <li class="odd ">
     <div class="item">
-      <span class='object_link'><a href="EnhancedErrors.html#capture_rescue=-class_method" title="EnhancedErrors.capture_rescue= (method)">capture_rescue=</a></span>
+      <span class='object_link'><a href="EnhancedErrors.html#capture_rescue-class_method" title="EnhancedErrors.capture_rescue (method)">capture_rescue</a></span>
       <small>EnhancedErrors</small>
     </div>
   </li>
   
 
   <li class="even ">
+    <div class="item">
+      <span class='object_link'><a href="EnhancedErrors.html#capture_rescue=-class_method" title="EnhancedErrors.capture_rescue= (method)">capture_rescue=</a></span>
+      <small>EnhancedErrors</small>
+    </div>
+  </li>
+  
+
+  <li class="odd ">
     <div class="item">
       <span class='object_link'><a href="Exception.html#captured_variables-instance_method" title="Exception#captured_variables (method)">#captured_variables</a></span>
       <small>Exception</small>
@@ -127,7 +135,7 @@
   </li>
   
 
-  <li class="odd ">
+  <li class="even ">
     <div class="item">
       <span class='object_link'><a href="EnhancedErrors.html#class_to_string-class_method" title="EnhancedErrors.class_to_string (method)">class_to_string</a></span>
       <small>EnhancedErrors</small>
@@ -135,7 +143,7 @@
   </li>
   
 
-  <li class="even ">
+  <li class="odd ">
     <div class="item">
       <span class='object_link'><a href="Enhanced/Colors.html#code-class_method" title="Enhanced::Colors.code (method)">code</a></span>
       <small>Enhanced::Colors</small>
@@ -143,7 +151,7 @@
   </li>
   
 
-  <li class="odd ">
+  <li class="even ">
     <div class="item">
       <span class='object_link'><a href="Enhanced/Colors.html#color-class_method" title="Enhanced::Colors.color (method)">color</a></span>
       <small>Enhanced::Colors</small>
@@ -151,7 +159,7 @@
   </li>
   
 
-  <li class="even ">
+  <li class="odd ">
     <div class="item">
       <span class='object_link'><a href="EnhancedErrors.html#config_block-class_method" title="EnhancedErrors.config_block (method)">config_block</a></span>
       <small>EnhancedErrors</small>
@@ -159,7 +167,7 @@
   </li>
   
 
-  <li class="odd ">
+  <li class="even ">
     <div class="item">
       <span class='object_link'><a href="EnhancedErrors.html#convert_binding_to_binding_info-class_method" title="EnhancedErrors.convert_binding_to_binding_info (method)">convert_binding_to_binding_info</a></span>
       <small>EnhancedErrors</small>
@@ -167,6 +175,14 @@
   </li>
   
 
+  <li class="odd ">
+    <div class="item">
+      <span class='object_link'><a href="EnhancedErrors.html#disable_capturing!-class_method" title="EnhancedErrors.disable_capturing! (method)">disable_capturing!</a></span>
+      <small>EnhancedErrors</small>
+    </div>
+  </li>
+  
+
   <li class="even ">
     <div class="item">
       <span class='object_link'><a href="EnhancedErrors.html#eligible_for_capture-class_method" title="EnhancedErrors.eligible_for_capture (method)">eligible_for_capture</a></span>
@@ -200,6 +216,14 @@
   
 
   <li class="even ">
+    <div class="item">
+      <span class='object_link'><a href="EnhancedErrors.html#enforce_capture_limit!-class_method" title="EnhancedErrors.enforce_capture_limit! (method)">enforce_capture_limit!</a></span>
+      <small>EnhancedErrors</small>
+    </div>
+  </li>
+  
+
+  <li class="odd ">
     <div class="item">
       <span class='object_link'><a href="EnhancedErrors.html#enhance_exceptions!-class_method" title="EnhancedErrors.enhance_exceptions! (method)">enhance_exceptions!</a></span>
       <small>EnhancedErrors</small>
@@ -207,6 +231,14 @@
   </li>
   
 
+  <li class="even ">
+    <div class="item">
+      <span class='object_link'><a href="EnhancedErrors.html#exception_trace-class_method" title="EnhancedErrors.exception_trace (method)">exception_trace</a></span>
+      <small>EnhancedErrors</small>
+    </div>
+  </li>
+  
+
   <li class="odd ">
     <div class="item">
       <span class='object_link'><a href="EnhancedErrors.html#format-class_method" title="EnhancedErrors.format (method)">format</a></span>
@@ -384,14 +416,6 @@
   
 
   <li class="odd ">
-    <div class="item">
-      <span class='object_link'><a href="EnhancedErrors.html#safely_prepend_rspec_custom_failure_message-class_method" title="EnhancedErrors.safely_prepend_rspec_custom_failure_message (method)">safely_prepend_rspec_custom_failure_message</a></span>
-      <small>EnhancedErrors</small>
-    </div>
-  </li>
-  
-
-  <li class="even ">
     <div class="item">
       <span class='object_link'><a href="EnhancedErrors.html#skip_list-class_method" title="EnhancedErrors.skip_list (method)">skip_list</a></span>
       <small>EnhancedErrors</small>
@@ -399,17 +423,9 @@
   </li>
   
 
-  <li class="odd ">
-    <div class="item">
-      <span class='object_link'><a href="EnhancedErrors.html#start_minitest_binding_capture-class_method" title="EnhancedErrors.start_minitest_binding_capture (method)">start_minitest_binding_capture</a></span>
-      <small>EnhancedErrors</small>
-    </div>
-  </li>
-  
-
   <li class="even ">
     <div class="item">
-      <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 class='object_link'><a href="EnhancedErrors.html#start_minitest_binding_capture-class_method" title="EnhancedErrors.start_minitest_binding_capture (method)">start_minitest_binding_capture</a></span>
       <small>EnhancedErrors</small>
     </div>
   </li>
@@ -417,7 +433,7 @@
 
   <li class="odd ">
     <div class="item">
-      <span class='object_link'><a href="EnhancedErrors.html#stop_minitest_binding_capture-class_method" title="EnhancedErrors.stop_minitest_binding_capture (method)">stop_minitest_binding_capture</a></span>
+      <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>
       <small>EnhancedErrors</small>
     </div>
   </li>
@@ -425,7 +441,7 @@
 
   <li class="even ">
     <div class="item">
-      <span class='object_link'><a href="EnhancedErrors.html#stop_rspec_binding_capture-class_method" title="EnhancedErrors.stop_rspec_binding_capture (method)">stop_rspec_binding_capture</a></span>
+      <span class='object_link'><a href="EnhancedErrors.html#stop_minitest_binding_capture-class_method" title="EnhancedErrors.stop_minitest_binding_capture (method)">stop_minitest_binding_capture</a></span>
       <small>EnhancedErrors</small>
     </div>
   </li>
@@ -433,7 +449,7 @@
 
   <li class="odd ">
     <div class="item">
-      <span class='object_link'><a href="EnhancedErrors.html#trace-class_method" title="EnhancedErrors.trace (method)">trace</a></span>
+      <span class='object_link'><a href="EnhancedErrors.html#stop_rspec_binding_capture-class_method" title="EnhancedErrors.stop_rspec_binding_capture (method)">stop_rspec_binding_capture</a></span>
       <small>EnhancedErrors</small>
     </div>
   </li>

data/doc/top-level-namespace.html

@@ -122,9 +122,9 @@
 </div>
 
       <div id="footer">
-  Generated on Sun Dec 15 22:33:19 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.1"
+  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/lib/enhanced_errors.rb

@@ -21,65 +21,64 @@ 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
 
@@ -96,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
@@ -118,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)
@@ -130,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)
@@ -141,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
@@ -149,25 +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
 
@@ -228,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
@@ -237,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
@@ -273,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
@@ -295,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)
@@ -322,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
@@ -332,22 +333,22 @@ class EnhancedErrors
     def class_to_string(klass)
       return '' if klass.nil?
       if klass.singleton_class?
-        klass.to_s.match(/#<Class:(.*?)>/)[1]
+        (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')
+      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|
           # puts "name #{tp.raised_exception.class.name rescue ''} method:#{tp.method_id} tp.binding:#{tp.binding.local_variables rescue ''}"
@@ -381,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
@@ -606,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)
 
@@ -751,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,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: enhanced_errors
 version: !ruby/object:Gem::Version
-  version: 2.1.1
+  version: 2.1.2
 platform: ruby
 authors:
 - Eric Beland
@@ -136,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