enhanced_errors 2.2.0 → 3.0.1

data/doc/EnhancedExceptionContext.html

@@ -387,7 +387,7 @@
 </div>
 
       <div id="footer">
-  Generated on Tue Dec 17 14:09:26 2024 by
+  Generated on Tue Dec 17 15:42:48 2024 by
   <a href="https://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
   0.9.37 (ruby-3.3.6).
 </div>

data/doc/Exception.html

@@ -111,7 +111,7 @@
 </div>
 
       <div id="footer">
-  Generated on Tue Dec 17 14:09:26 2024 by
+  Generated on Tue Dec 17 15:42:48 2024 by
   <a href="https://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
   0.9.37 (ruby-3.3.6).
 </div>

data/doc/ExceptionBindingInfos.html

@@ -245,7 +245,7 @@
 </div>
 
       <div id="footer">
-  Generated on Tue Dec 17 14:09:26 2024 by
+  Generated on Tue Dec 17 15:42:48 2024 by
   <a href="https://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
   0.9.37 (ruby-3.3.6).
 </div>

data/doc/Minitest.html

@@ -228,7 +228,7 @@
 </div>
 
       <div id="footer">
-  Generated on Tue Dec 17 14:09:26 2024 by
+  Generated on Tue Dec 17 15:42:48 2024 by
   <a href="https://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
   0.9.37 (ruby-3.3.6).
 </div>

data/doc/_index.html

@@ -150,7 +150,7 @@
 </div>
 
       <div id="footer">
-  Generated on Tue Dec 17 14:09:26 2024 by
+  Generated on Tue Dec 17 15:42:48 2024 by
   <a href="https://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
   0.9.37 (ruby-3.3.6).
 </div>

data/doc/file.README.html

@@ -243,7 +243,7 @@
 <p>You can pass configuration options to <code>enhance_exceptions!</code>:</p>
 
 <pre class="code ruby"><code class="ruby">
-<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_enhance_exceptions!'><span class='object_link'><a href="EnhancedErrors.html#enhance_exceptions!-class_method" title="EnhancedErrors.enhance_exceptions! (method)">enhance_exceptions!</a></span></span><span class='lparen'>(</span><span class='label'>enabled:</span> <span class='kw'>true</span><span class='comma'>,</span> <span class='label'>max_length:</span> <span class='int'>2000</span><span class='rparen'>)</span> <span class='kw'>do</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_enhance_exceptions!'><span class='object_link'><a href="EnhancedErrors.html#enhance_exceptions!-class_method" title="EnhancedErrors.enhance_exceptions! (method)">enhance_exceptions!</a></span></span><span class='lparen'>(</span><span class='label'>enabled:</span> <span class='kw'>true</span><span class='comma'>,</span> <span class='label'>max_capture_length:</span> <span class='int'>2000</span><span class='rparen'>)</span> <span class='kw'>do</span>
   <span class='comment'># Additional configuration here
 </span>  <span class='id identifier rubyid_add_to_skip_list'>add_to_skip_list</span> <span class='symbol'>:@instance_variable_to_skip</span><span class='comma'>,</span> <span class='symbol'>:local_to_skip</span>
 <span class='kw'>end</span>
@@ -253,7 +253,7 @@
 </li><li>
 <p><code>enabled</code>: Enables or disables the enhancement (default: <code>true</code>).</p>
 </li><li>
-<p><code>max_length</code>: Sets the maximum length of the captured_variables string (default: <code>2500</code>).</p>
+<p><code>max_capture_length</code>: Sets the maximum length of the captured_variables string (default: <code>2500</code>).</p>
 </li></ul>
 
 <h3 id="label-Environment-Based+Defaults">Environment-Based Defaults</h3>
@@ -486,7 +486,7 @@
 </div></div>
 
       <div id="footer">
-  Generated on Tue Dec 17 14:09:26 2024 by
+  Generated on Tue Dec 17 15:42:48 2024 by
   <a href="https://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
   0.9.37 (ruby-3.3.6).
 </div>

data/doc/index.html

@@ -243,7 +243,7 @@
 <p>You can pass configuration options to <code>enhance_exceptions!</code>:</p>
 
 <pre class="code ruby"><code class="ruby">
-<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_enhance_exceptions!'><span class='object_link'><a href="EnhancedErrors.html#enhance_exceptions!-class_method" title="EnhancedErrors.enhance_exceptions! (method)">enhance_exceptions!</a></span></span><span class='lparen'>(</span><span class='label'>enabled:</span> <span class='kw'>true</span><span class='comma'>,</span> <span class='label'>max_length:</span> <span class='int'>2000</span><span class='rparen'>)</span> <span class='kw'>do</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_enhance_exceptions!'><span class='object_link'><a href="EnhancedErrors.html#enhance_exceptions!-class_method" title="EnhancedErrors.enhance_exceptions! (method)">enhance_exceptions!</a></span></span><span class='lparen'>(</span><span class='label'>enabled:</span> <span class='kw'>true</span><span class='comma'>,</span> <span class='label'>max_capture_length:</span> <span class='int'>2000</span><span class='rparen'>)</span> <span class='kw'>do</span>
   <span class='comment'># Additional configuration here
 </span>  <span class='id identifier rubyid_add_to_skip_list'>add_to_skip_list</span> <span class='symbol'>:@instance_variable_to_skip</span><span class='comma'>,</span> <span class='symbol'>:local_to_skip</span>
 <span class='kw'>end</span>
@@ -253,7 +253,7 @@
 </li><li>
 <p><code>enabled</code>: Enables or disables the enhancement (default: <code>true</code>).</p>
 </li><li>
-<p><code>max_length</code>: Sets the maximum length of the captured_variables string (default: <code>2500</code>).</p>
+<p><code>max_capture_length</code>: Sets the maximum length of the captured_variables string (default: <code>2500</code>).</p>
 </li></ul>
 
 <h3 id="label-Environment-Based+Defaults">Environment-Based Defaults</h3>
@@ -486,7 +486,7 @@
 </div></div>
 
       <div id="footer">
-  Generated on Tue Dec 17 14:09:26 2024 by
+  Generated on Tue Dec 17 15:42:48 2024 by
   <a href="https://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
   0.9.37 (ruby-3.3.6).
 </div>

data/doc/method_list.html

@@ -249,7 +249,7 @@
 
   <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>
+      <span class='object_link'><a href="EnhancedErrors.html#enhance_exceptions!-class_method" title="EnhancedErrors.enhance_exceptions! (method)">enhance_exceptions!</a></span>
       <small>EnhancedErrors</small>
     </div>
   </li>
@@ -257,7 +257,7 @@
 
   <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>
+      <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>
@@ -265,7 +265,7 @@
 
   <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>
+      <span class='object_link'><a href="EnhancedErrors.html#format-class_method" title="EnhancedErrors.format (method)">format</a></span>
       <small>EnhancedErrors</small>
     </div>
   </li>
@@ -273,7 +273,7 @@
 
   <li class="odd ">
     <div class="item">
-      <span class='object_link'><a href="EnhancedErrors.html#format-class_method" title="EnhancedErrors.format (method)">format</a></span>
+      <span class='object_link'><a href="EnhancedErrors.html#get_default_format_for_environment-class_method" title="EnhancedErrors.get_default_format_for_environment (method)">get_default_format_for_environment</a></span>
       <small>EnhancedErrors</small>
     </div>
   </li>
@@ -281,7 +281,7 @@
 
   <li class="even ">
     <div class="item">
-      <span class='object_link'><a href="EnhancedErrors.html#get_default_format_for_environment-class_method" title="EnhancedErrors.get_default_format_for_environment (method)">get_default_format_for_environment</a></span>
+      <span class='object_link'><a href="EnhancedErrors.html#increment_capture_events_count-class_method" title="EnhancedErrors.increment_capture_events_count (method)">increment_capture_events_count</a></span>
       <small>EnhancedErrors</small>
     </div>
   </li>
@@ -289,23 +289,23 @@
 
   <li class="odd ">
     <div class="item">
-      <span class='object_link'><a href="EnhancedErrors.html#increment_capture_events_count-class_method" title="EnhancedErrors.increment_capture_events_count (method)">increment_capture_events_count</a></span>
-      <small>EnhancedErrors</small>
+      <span class='object_link'><a href="Context.html#initialize-instance_method" title="Context#initialize (method)">#initialize</a></span>
+      <small>Context</small>
     </div>
   </li>
   
 
   <li class="even ">
     <div class="item">
-      <span class='object_link'><a href="Context.html#initialize-instance_method" title="Context#initialize (method)">#initialize</a></span>
-      <small>Context</small>
+      <span class='object_link'><a href="EnhancedErrors.html#is_a_minitest%3F-class_method" title="EnhancedErrors.is_a_minitest? (method)">is_a_minitest?</a></span>
+      <small>EnhancedErrors</small>
     </div>
   </li>
   
 
   <li class="odd ">
     <div class="item">
-      <span class='object_link'><a href="EnhancedErrors.html#is_a_minitest%3F-class_method" title="EnhancedErrors.is_a_minitest? (method)">is_a_minitest?</a></span>
+      <span class='object_link'><a href="EnhancedErrors.html#is_rspec_example%3F-class_method" title="EnhancedErrors.is_rspec_example? (method)">is_rspec_example?</a></span>
       <small>EnhancedErrors</small>
     </div>
   </li>
@@ -313,7 +313,7 @@
 
   <li class="even ">
     <div class="item">
-      <span class='object_link'><a href="EnhancedErrors.html#is_rspec_example%3F-class_method" title="EnhancedErrors.is_rspec_example? (method)">is_rspec_example?</a></span>
+      <span class='object_link'><a href="EnhancedErrors.html#max_capture_events-class_method" title="EnhancedErrors.max_capture_events (method)">max_capture_events</a></span>
       <small>EnhancedErrors</small>
     </div>
   </li>
@@ -321,7 +321,7 @@
 
   <li class="odd ">
     <div class="item">
-      <span class='object_link'><a href="EnhancedErrors.html#max_capture_events-class_method" title="EnhancedErrors.max_capture_events (method)">max_capture_events</a></span>
+      <span class='object_link'><a href="EnhancedErrors.html#max_capture_events=-class_method" title="EnhancedErrors.max_capture_events= (method)">max_capture_events=</a></span>
       <small>EnhancedErrors</small>
     </div>
   </li>
@@ -329,7 +329,7 @@
 
   <li class="even ">
     <div class="item">
-      <span class='object_link'><a href="EnhancedErrors.html#max_capture_events=-class_method" title="EnhancedErrors.max_capture_events= (method)">max_capture_events=</a></span>
+      <span class='object_link'><a href="EnhancedErrors.html#max_capture_length-class_method" title="EnhancedErrors.max_capture_length (method)">max_capture_length</a></span>
       <small>EnhancedErrors</small>
     </div>
   </li>
@@ -337,7 +337,7 @@
 
   <li class="odd ">
     <div class="item">
-      <span class='object_link'><a href="EnhancedErrors.html#max_length-class_method" title="EnhancedErrors.max_length (method)">max_length</a></span>
+      <span class='object_link'><a href="EnhancedErrors.html#max_capture_length=-class_method" title="EnhancedErrors.max_capture_length= (method)">max_capture_length=</a></span>
       <small>EnhancedErrors</small>
     </div>
   </li>

data/doc/top-level-namespace.html

@@ -122,7 +122,7 @@
 </div>
 
       <div id="footer">
-  Generated on Tue Dec 17 14:09:26 2024 by
+  Generated on Tue Dec 17 15:42:48 2024 by
   <a href="https://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
   0.9.37 (ruby-3.3.6).
 </div>

data/enhanced_errors.gemspec

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

@@ -24,7 +24,7 @@ class EnhancedErrors
     attr_accessor :enabled, :config_block, :on_capture_hook, :eligible_for_capture, :exception_trace, :override_messages
 
     GEMS_REGEX = %r{[\/\\]gems[\/\\]}
-    DEFAULT_MAX_LENGTH = 2000
+    DEFAULT_MAX_CAPTURE_LENGTH = 2500
     MAX_BINDING_INFOS = 3
 
     RSPEC_SKIP_LIST = [
@@ -87,7 +87,7 @@ class EnhancedErrors
     RSPEC_HANDLER_NAMES = ['RSpec::Expectations::PositiveExpectationHandler', 'RSpec::Expectations::NegativeExpectationHandler']
 
     @enabled = nil
-    @max_length = nil
+    @max_capture_length = nil
     @capture_rescue = nil
     @skip_list = nil
     @capture_events = nil
@@ -131,18 +131,21 @@ class EnhancedErrors
       mutex.synchronize { @max_capture_events || -1 }
     end
 
+
+    def max_capture_length
+      mutex.synchronize { @max_capture_length || DEFAULT_MAX_CAPTURE_LENGTH }
+    end
+
+    def max_capture_length=(val)
+      mutex.synchronize { @max_capture_length = value }
+    end
+
     def max_capture_events=(value)
       mutex.synchronize do
         @max_capture_events = value
       end
     end
 
-    def enforce_capture_limit
-      exceeded = capture_limit_exceeded?
-      disable_capturing! if capture_limit_exceeded?
-      exceeded
-    end
-
     def capture_limit_exceeded?
       mutex.synchronize do
        max_capture_events > 0 && capture_events_count >= max_capture_events
@@ -158,13 +161,6 @@ class EnhancedErrors
       end
     end
 
-    def increment_capture_events_count
-      mutex.synchronize do
-        @capture_events_count ||= 0
-        @max_capture_events ||= -1
-        @capture_events_count += 1
-      end
-    end
 
     def reset!
       mutex.synchronize do
@@ -179,17 +175,6 @@ class EnhancedErrors
       end
     end
 
-    def max_length(value = nil)
-      mutex.synchronize do
-        if value.nil?
-          @max_length ||= DEFAULT_MAX_LENGTH
-        else
-          @max_length = value
-        end
-        @max_length
-      end
-    end
-
     def skip_list
       mutex.synchronize do
         @skip_list ||= DEFAULT_SKIP_LIST
@@ -212,16 +197,13 @@ class EnhancedErrors
 
     def override_exception_message(exception, binding_or_bindings)
       return nil unless exception && exception.respond_to?(:message)
-      rspec_binding = !(binding_or_bindings.nil? || binding_or_bindings.empty?)
+      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 (rspec_binding || exception_binding) && has_message
+      return nil unless (test_binding || exception_binding) && has_message
 
       variable_str = EnhancedErrors.format(binding_or_bindings)
       message_str = exception.message
-      if exception.respond_to?(:captured_variables) && !message_str.include?(exception.captured_variables)
-        message_str += exception.captured_variables
-      end
       exception.define_singleton_method(:unaltered_message) { message_str }
       exception.define_singleton_method(:message) do
         "#{message_str}#{variable_str}"
@@ -304,14 +286,12 @@ class EnhancedErrors
     end
 
     def start_minitest_binding_capture
-      EnhancedExceptionContext.clear_all
-      return if enforce_capture_limit
       @enabled = true if @enabled.nil?
+      return unless @enabled
       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)
           @minitest_test_binding = tp.binding
-          increment_capture_events_count
         end
         @minitest_trace.enable
       end
@@ -340,8 +320,9 @@ class EnhancedErrors
     end
 
     def start_rspec_binding_capture
-      return if enforce_capture_limit
       @enabled = true if @enabled.nil?
+      return unless @enabled
+
       mutex.synchronize do
         @rspec_example_binding = nil
         @capture_next_binding = false
@@ -358,10 +339,8 @@ class EnhancedErrors
               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
-              increment_capture_events_count
               @rspec_example_binding = tp.binding
             end
           elsif tp.event == :raise
@@ -588,7 +567,7 @@ class EnhancedErrors
       end
 
       mutex.synchronize do
-        max_len = @max_length || DEFAULT_MAX_LENGTH
+        max_len = @max_capture_length || DEFAULT_MAX_CAPTURE_LENGTH
         if result.length > max_len
           result = result[0...max_len] + "... (truncated)"
         end
@@ -606,7 +585,6 @@ class EnhancedErrors
     def handle_tracepoint_event(tp)
       # Check enabled outside the synchronized block for speed, but still safe due to re-check inside.
       return unless enabled
-      return if enforce_capture_limit
       return if Thread.current[:enhanced_errors_processing] || Thread.current[:on_capture] || ignored_exception?(tp.raised_exception)
 
       Thread.current[:enhanced_errors_processing] = true
@@ -682,7 +660,6 @@ class EnhancedErrors
 
       if binding_info
         binding_info = validate_binding_format(binding_info)
-        increment_capture_events_count
         if binding_info && exception.binding_infos.length >= MAX_BINDING_INFOS
           exception.binding_infos.delete_at(MAX_BINDING_INFOS / 2.round)
         end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: enhanced_errors
 version: !ruby/object:Gem::Version
-  version: 2.2.0
+  version: 3.0.1
 platform: ruby
 authors:
 - Eric Beland
@@ -141,7 +141,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.5.22
+rubygems_version: 3.3.26
 signing_key:
 specification_version: 4
 summary: Automatically enhance your errors with messages containing variable values