enhanced_errors 2.1.3 → 3.0.0

data/doc/method_list.html

@@ -73,23 +73,23 @@
 
   <li class="even ">
     <div class="item">
-      <span class='object_link'><a href="Exception.html#binding_infos-instance_method" title="Exception#binding_infos (method)">#binding_infos</a></span>
-      <small>Exception</small>
+      <span class='object_link'><a href="Context.html#binding_infos-instance_method" title="Context#binding_infos (method)">#binding_infos</a></span>
+      <small>Context</small>
     </div>
   </li>
   
 
   <li class="odd ">
     <div class="item">
-      <span class='object_link'><a href="EnhancedErrors.html#binding_infos_array_to_string-class_method" title="EnhancedErrors.binding_infos_array_to_string (method)">binding_infos_array_to_string</a></span>
-      <small>EnhancedErrors</small>
+      <span class='object_link'><a href="ExceptionBindingInfos.html#binding_infos-instance_method" title="ExceptionBindingInfos#binding_infos (method)">#binding_infos</a></span>
+      <small>ExceptionBindingInfos</small>
     </div>
   </li>
   
 
   <li class="even ">
     <div class="item">
-      <span class='object_link'><a href="EnhancedErrors.html#capture_events_count-class_method" title="EnhancedErrors.capture_events_count (method)">capture_events_count</a></span>
+      <span class='object_link'><a href="EnhancedErrors.html#binding_infos_array_to_string-class_method" title="EnhancedErrors.binding_infos_array_to_string (method)">binding_infos_array_to_string</a></span>
       <small>EnhancedErrors</small>
     </div>
   </li>
@@ -97,7 +97,7 @@
 
   <li class="odd ">
     <div class="item">
-      <span class='object_link'><a href="EnhancedErrors.html#capture_events_count=-class_method" title="EnhancedErrors.capture_events_count= (method)">capture_events_count=</a></span>
+      <span class='object_link'><a href="EnhancedErrors.html#capture_events_count-class_method" title="EnhancedErrors.capture_events_count (method)">capture_events_count</a></span>
       <small>EnhancedErrors</small>
     </div>
   </li>
@@ -105,7 +105,7 @@
 
   <li class="even ">
     <div class="item">
-      <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>
+      <span class='object_link'><a href="EnhancedErrors.html#capture_events_count=-class_method" title="EnhancedErrors.capture_events_count= (method)">capture_events_count=</a></span>
       <small>EnhancedErrors</small>
     </div>
   </li>
@@ -113,7 +113,7 @@
 
   <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_limit_exceeded%3F-class_method" title="EnhancedErrors.capture_limit_exceeded? (method)">capture_limit_exceeded?</a></span>
       <small>EnhancedErrors</small>
     </div>
   </li>
@@ -121,7 +121,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_rescue-class_method" title="EnhancedErrors.capture_rescue (method)">capture_rescue</a></span>
       <small>EnhancedErrors</small>
     </div>
   </li>
@@ -129,13 +129,21 @@
 
   <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>
+      <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="ExceptionBindingInfos.html#captured_variables-instance_method" title="ExceptionBindingInfos#captured_variables (method)">#captured_variables</a></span>
+      <small>ExceptionBindingInfos</small>
+    </div>
+  </li>
+  
+
+  <li class="odd ">
     <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>
@@ -143,7 +151,23 @@
   </li>
   
 
+  <li class="even ">
+    <div class="item">
+      <span class='object_link'><a href="EnhancedExceptionContext.html#clear_all-instance_method" title="EnhancedExceptionContext#clear_all (method)">#clear_all</a></span>
+      <small>EnhancedExceptionContext</small>
+    </div>
+  </li>
+  
+
   <li class="odd ">
+    <div class="item">
+      <span class='object_link'><a href="EnhancedExceptionContext.html#clear_context-instance_method" title="EnhancedExceptionContext#clear_context (method)">#clear_context</a></span>
+      <small>EnhancedExceptionContext</small>
+    </div>
+  </li>
+  
+
+  <li class="even ">
     <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>
@@ -151,7 +175,7 @@
   </li>
   
 
-  <li class="even ">
+  <li class="odd ">
     <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>
@@ -159,7 +183,7 @@
   </li>
   
 
-  <li class="odd ">
+  <li class="even ">
     <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>
@@ -167,6 +191,14 @@
   </li>
   
 
+  <li class="odd ">
+    <div class="item">
+      <span class='object_link'><a href="EnhancedExceptionContext.html#context_for-instance_method" title="EnhancedExceptionContext#context_for (method)">#context_for</a></span>
+      <small>EnhancedExceptionContext</small>
+    </div>
+  </li>
+  
+
   <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>
@@ -217,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>
@@ -225,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>
@@ -233,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>
@@ -241,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>
@@ -249,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>
@@ -257,8 +289,8 @@
 
   <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>
   
@@ -297,7 +329,7 @@
 
   <li class="even ">
     <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>
@@ -305,7 +337,7 @@
 
   <li class="odd ">
     <div class="item">
-      <span class='object_link'><a href="EnhancedErrors.html#mutex-class_method" title="EnhancedErrors.mutex (method)">mutex</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>
@@ -313,7 +345,7 @@
 
   <li class="even ">
     <div class="item">
-      <span class='object_link'><a href="EnhancedErrors.html#on_capture-class_method" title="EnhancedErrors.on_capture (method)">on_capture</a></span>
+      <span class='object_link'><a href="EnhancedErrors.html#mutex-class_method" title="EnhancedErrors.mutex (method)">mutex</a></span>
       <small>EnhancedErrors</small>
     </div>
   </li>
@@ -321,7 +353,7 @@
 
   <li class="odd ">
     <div class="item">
-      <span class='object_link'><a href="EnhancedErrors.html#on_capture=-class_method" title="EnhancedErrors.on_capture= (method)">on_capture=</a></span>
+      <span class='object_link'><a href="EnhancedErrors.html#on_capture-class_method" title="EnhancedErrors.on_capture (method)">on_capture</a></span>
       <small>EnhancedErrors</small>
     </div>
   </li>
@@ -329,7 +361,7 @@
 
   <li class="even ">
     <div class="item">
-      <span class='object_link'><a href="EnhancedErrors.html#on_capture_hook-class_method" title="EnhancedErrors.on_capture_hook (method)">on_capture_hook</a></span>
+      <span class='object_link'><a href="EnhancedErrors.html#on_capture=-class_method" title="EnhancedErrors.on_capture= (method)">on_capture=</a></span>
       <small>EnhancedErrors</small>
     </div>
   </li>
@@ -337,7 +369,7 @@
 
   <li class="odd ">
     <div class="item">
-      <span class='object_link'><a href="EnhancedErrors.html#on_format-class_method" title="EnhancedErrors.on_format (method)">on_format</a></span>
+      <span class='object_link'><a href="EnhancedErrors.html#on_capture_hook-class_method" title="EnhancedErrors.on_capture_hook (method)">on_capture_hook</a></span>
       <small>EnhancedErrors</small>
     </div>
   </li>
@@ -345,13 +377,21 @@
 
   <li class="even ">
     <div class="item">
-      <span class='object_link'><a href="EnhancedErrors.html#on_format=-class_method" title="EnhancedErrors.on_format= (method)">on_format=</a></span>
+      <span class='object_link'><a href="EnhancedErrors.html#on_format-class_method" title="EnhancedErrors.on_format (method)">on_format</a></span>
       <small>EnhancedErrors</small>
     </div>
   </li>
   
 
   <li class="odd ">
+    <div class="item">
+      <span class='object_link'><a href="EnhancedErrors.html#on_format=-class_method" title="EnhancedErrors.on_format= (method)">on_format=</a></span>
+      <small>EnhancedErrors</small>
+    </div>
+  </li>
+  
+
+  <li class="even ">
     <div class="item">
       <span class='object_link'><a href="Minitest.html#original_run_one_method-class_method" title="Minitest.original_run_one_method (method)">original_run_one_method</a></span>
       <small>Minitest</small>
@@ -359,7 +399,7 @@
   </li>
   
 
-  <li class="even ">
+  <li class="odd ">
     <div class="item">
       <span class='object_link'><a href="EnhancedErrors.html#override_exception_message-class_method" title="EnhancedErrors.override_exception_message (method)">override_exception_message</a></span>
       <small>EnhancedErrors</small>
@@ -367,7 +407,7 @@
   </li>
   
 
-  <li class="odd ">
+  <li class="even ">
     <div class="item">
       <span class='object_link'><a href="EnhancedErrors.html#override_messages-class_method" title="EnhancedErrors.override_messages (method)">override_messages</a></span>
       <small>EnhancedErrors</small>
@@ -375,7 +415,7 @@
   </li>
   
 
-  <li class="even ">
+  <li class="odd ">
     <div class="item">
       <span class='object_link'><a href="EnhancedErrors.html#override_rspec_message-class_method" title="EnhancedErrors.override_rspec_message (method)">override_rspec_message</a></span>
       <small>EnhancedErrors</small>
@@ -383,7 +423,7 @@
   </li>
   
 
-  <li class="odd ">
+  <li class="even ">
     <div class="item">
       <span class='object_link'><a href="EnhancedErrors.html#reset!-class_method" title="EnhancedErrors.reset! (method)">reset!</a></span>
       <small>EnhancedErrors</small>
@@ -391,7 +431,7 @@
   </li>
   
 
-  <li class="even ">
+  <li class="odd ">
     <div class="item">
       <span class='object_link'><a href="Minitest.html#run_one_method-class_method" title="Minitest.run_one_method (method)">run_one_method</a></span>
       <small>Minitest</small>
@@ -399,7 +439,7 @@
   </li>
   
 
-  <li class="odd ">
+  <li class="even ">
     <div class="item">
       <span class='object_link'><a href="EnhancedErrors.html#running_in_ci%3F-class_method" title="EnhancedErrors.running_in_ci? (method)">running_in_ci?</a></span>
       <small>EnhancedErrors</small>
@@ -407,7 +447,7 @@
   </li>
   
 
-  <li class="even ">
+  <li class="odd ">
     <div class="item">
       <span class='object_link'><a href="EnhancedErrors.html#safe_prepend_module-class_method" title="EnhancedErrors.safe_prepend_module (method)">safe_prepend_module</a></span>
       <small>EnhancedErrors</small>
@@ -415,7 +455,7 @@
   </li>
   
 
-  <li class="odd ">
+  <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>
@@ -423,7 +463,7 @@
   </li>
   
 
-  <li class="even ">
+  <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>
@@ -431,7 +471,7 @@
   </li>
   
 
-  <li class="odd ">
+  <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>
       <small>EnhancedErrors</small>
@@ -439,7 +479,7 @@
   </li>
   
 
-  <li class="even ">
+  <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>
       <small>EnhancedErrors</small>
@@ -447,7 +487,7 @@
   </li>
   
 
-  <li class="odd ">
+  <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>
       <small>EnhancedErrors</small>
@@ -455,6 +495,14 @@
   </li>
   
 
+  <li class="odd ">
+    <div class="item">
+      <span class='object_link'><a href="EnhancedExceptionContext.html#store_context-instance_method" title="EnhancedExceptionContext#store_context (method)">#store_context</a></span>
+      <small>EnhancedExceptionContext</small>
+    </div>
+  </li>
+  
+
   <li class="even ">
     <div class="item">
       <span class='object_link'><a href="EnhancedErrors.html#validate_binding_format-class_method" title="EnhancedErrors.validate_binding_format (method)">validate_binding_format</a></span>

data/doc/top-level-namespace.html

@@ -82,11 +82,11 @@
 <p class="children">
   
     
-      <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>
+      <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="EnhancedExceptionContext.html" title="EnhancedExceptionContext (module)">EnhancedExceptionContext</a></span>, <span class='object_link'><a href="ExceptionBindingInfos.html" title="ExceptionBindingInfos (module)">ExceptionBindingInfos</a></span>, <span class='object_link'><a href="Minitest.html" title="Minitest (module)">Minitest</a></span>
     
   
     
-      <strong class="classes">Classes:</strong> <span class='object_link'><a href="EnhancedErrors.html" title="EnhancedErrors (class)">EnhancedErrors</a></span>, <span class='object_link'><a href="Exception.html" title="Exception (class)">Exception</a></span>
+      <strong class="classes">Classes:</strong> <span class='object_link'><a href="Context.html" title="Context (class)">Context</a></span>, <span class='object_link'><a href="EnhancedErrors.html" title="EnhancedErrors (class)">EnhancedErrors</a></span>, <span class='object_link'><a href="Exception.html" title="Exception (class)">Exception</a></span>
     
   
 </p>
@@ -122,7 +122,7 @@
 </div>
 
       <div id="footer">
-  Generated on Mon Dec 16 11:33:57 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.1.3"
+  spec.version = "3.0.0"
   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,10 +14,6 @@ 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_rspec_message(example, EnhancedErrors.stop_rspec_binding_capture)
   end

data/lib/enhanced/context.rb

@@ -0,0 +1,7 @@
+class Context
+  attr_accessor :binding_infos
+
+  def initialize
+    @binding_infos = []
+  end
+end

data/lib/enhanced/enhanced_exception_context.rb

@@ -0,0 +1,47 @@
+require 'weakref'
+
+require_relative 'context'
+
+require 'weakref'
+require 'monitor'
+
+module EnhancedExceptionContext
+  extend self
+
+  REGISTRY = {}
+  MUTEX = Monitor.new
+
+  def store_context(exception, context)
+    MUTEX.synchronize do
+      REGISTRY[exception.object_id] = { weak_exc: WeakRef.new(exception), context: context }
+    end
+  end
+
+  def context_for(exception)
+    MUTEX.synchronize do
+      entry = REGISTRY[exception.object_id]
+      return nil unless entry
+
+      begin
+        _ = entry[:weak_exc].__getobj__ # ensure exception is still alive
+        entry[:context]
+      rescue RefError
+        # Exception no longer alive, clean up
+        REGISTRY.delete(exception.object_id)
+        nil
+      end
+    end
+  end
+
+  def clear_context(exception)
+    MUTEX.synchronize do
+      REGISTRY.delete(exception.object_id)
+    end
+  end
+
+  def clear_all
+    MUTEX.synchronize do
+      REGISTRY.clear
+    end
+  end
+end

data/lib/enhanced/exception.rb

@@ -1,6 +1,16 @@
 # exception.rb
+require_relative 'enhanced_exception_context'
+
+module ExceptionBindingInfos
+  def binding_infos
+    ctx = EnhancedExceptionContext.context_for(self)
+    unless ctx
+      ctx = Context.new
+      EnhancedExceptionContext.store_context(self, ctx)
+    end
+    ctx.binding_infos
+  end
 
-class Exception
   def captured_variables
     if binding_infos.any?
       bindings_of_interest = select_binding_infos
@@ -12,10 +22,6 @@ class Exception
     ''
   end
 
-  def binding_infos
-    @binding_infos ||= []
-  end
-
   private
 
   def select_binding_infos
@@ -43,3 +49,7 @@ class Exception
     bindings_of_interest.compact
   end
 end
+
+class Exception
+  prepend ExceptionBindingInfos
+end