enhanced_errors 3.0.3 → 3.0.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: f31d5706d675b416846c7fe44cc1c6f6eb405489d574a9e9578aebee106109af
-  data.tar.gz: a5d31e4545534bfba158646f30d99bae1107086c51e20d1f8a5ad77454d74c23
+  metadata.gz: e6463163f60ad8df047c834d0722ebfc800bbb8a9b57773d064b2a22eaeead69
+  data.tar.gz: 53c886d04c8b1c518d9a4d05262947f95ba462b9b3cd76cb913c2f2142080a6d
 SHA512:
-  metadata.gz: b79305f72e59ac8c615b137b6279c74d13156085d698bcc6efaf0d6c637bd489d6bfe1e93bfc1aede2673abe60033b3e64111b07b4916b4fe880f417684bfdbd
-  data.tar.gz: 97c791940c780ee0952e82f256b640923ba59623052224ec0c3ca5d84bf57a471f349e281cea82c0f00976dbba497a62bdc39fa5f1115d655e96baa980d0215c
+  metadata.gz: 4428ec99b50fd747204426fe2059b140ed335f38486babd0f5882380391490ce5c1ef4e97a55e3fcf0caceabe099c59f5813bb2be722ab7edb584278d6e06afd
+  data.tar.gz: e30adc9c45a925c84bc9b97f07e8a96d351325dc74880b7ee1b38f7b02e96cafec3f91b25bedafcb87793d5c11fd90aee9ec3f1bd4c426263a17a91e6ce72acf

data/README.md

@@ -33,7 +33,6 @@ end
 <img src="./doc/images/enhanced-spec.png" style="height: 369px; width: 712px;"></img>
 
 
-
 The RSpec test-time only approach constrained only to test-time.
 
 ### RSpec Setup
@@ -41,31 +40,41 @@ The RSpec test-time only approach constrained only to test-time.
 Use EnhancedErrors with RSpec for test-specific exception capturing, ideal for CI and local testing without impacting production.
 
 ```ruby
+# usually in spec_helper.rb or rails_helper.rb
 
-RSpec.configure do |config|
-  config.before(:example) do |_example|
-    EnhancedErrors.start_rspec_binding_capture
-  end
-
-  config.before(:example) do |_example|
-    EnhancedErrors.start_rspec_binding_capture
-  end
+require 'enhanced_errors'
+require 'awesome_print' # Optional, for better output
 
-  config.after(:example) do |example|
-    EnhancedErrors.override_rspec_message(example, EnhancedErrors.stop_rspec_binding_capture)
-  end
+RSpec.configure do |config|
+  
+  # Along with the requires, add this to your RSpec config to enhance your RSpec output
+  # Consider driving the config with an environment variable like this to make it configurable per-user or run
+  # if ENV['enhanced_errors'] == 'true'
+      config.before(:example) do |_example|
+        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
+  # end
+  
 end
 ```
 
 <br>
 
-
+''''''
 ## MiniTest Setup
 
 ```ruby
 require 'enhanced_errors'
+require 'awesome_print' # Optional, for better output
 require 'enhanced/minitest_patch'
-
 # Once the patch is loaded, it should just work!
 
 ```
@@ -127,11 +136,19 @@ EnhancedErrors.enhance_exceptions!(override_messages: true)
 <img src="./doc/images/enhanced-error.png" style="height: 215px; width: 429px;"></img>
 <br>
 
+EnhancedErrors use-cases:
+* Handle test and CI failures faster by skipping that pesky "reproduction" step.
+* LLM-candy - Feed debug output with variable values into your LLM, making state examine-able
+* Debug deep-stack errors and reduce mean time to resolution (MTTR).
+* Address elusive "Heisenbugs" by capturing full error context preemptively.
+* Debug cron jobs and daemons with rich, failure-specific logs.
+* Catch data-driven bugs in long jobs without re-runs or extensive logging.
 
 
 ## Features
 
 - **Pure Ruby**: No external dependencies, C extensions, or C API calls.
+- **Improved RSpec and Minitest errors for straight-to-fix--look-ma-no-debugging, look-ma-no-reproducing 
 - **Customizable Output**: Supports multiple output formats (`:json`, `:plaintext`, `:terminal`).
 - **Flexible Hooks**: Redact or modifying captured data via the `on_capture` hook. Update the final string with on_format.
 - **Environment-Based Defaults**: For Rails apps, automatically adjusts settings based on the environment (`development`, `test`, `production`, `ci`).
@@ -141,13 +158,6 @@ EnhancedErrors.enhance_exceptions!(override_messages: true)
 - **No dependencies**:  EnhancedErrors does not ___require___ any dependencies--it uses [awesome_print](https://github.com/awesome-print/awesome_print) for nicer output if it is installed and available.
 - **Lightweight**: Minimal performance impact, as tracing is only active during exception raising.
 
-EnhancedErrors use-cases:
-
-* Catch data-driven bugs without needing re-runs or extensive logging.
-* Debug deep-stack errors and reduce mean time to resolution (MTTR).
-* Handle CI failures faster by skipping reproduction steps.
-* Address elusive "Heisenbugs" by capturing error context preemptively.
-* Debug cron jobs and daemons with rich, failure-specific logs.
 
 ## Installation
 
@@ -218,9 +228,6 @@ EnhancedErrors adjusts its default settings based on the environment:
 - **Development/Test**:
     - Default Output format: `:terminal`
     - Terminal Color output: Enabled
-- **Production**:
-    - Output format: `:json`
-    - Terminal Color output: Disabled
 - **CI Environment**:
     - Output format: `:plaintext`
     - Color output: Disabled
@@ -332,10 +339,6 @@ These exceptions are always ignored:
 
 ```ruby
 SystemExit NoMemoryError SignalException Interrupt
-ScriptError LoadError NotImplementedError SyntaxError
-RSpec::Expectations::ExpectationNotMetError
-RSpec::Matchers::BuiltIn::RaiseError
-SystemStackError Psych::BadAlias
 ```
 
 While this is close to "Things that don't descend from StandardError", it's not exactly that.
@@ -429,9 +432,9 @@ To make that work, it has to be able to safely be 'on' ahead of time, and gather
 a way I naturally will retain without requiring extra preparation I obviously didn't know to do.
 
 - EnhancedErrors won't interrupt CI, but it lets me know what happened _without_ reproduction steps
-- EnhancedErrors could, theoretically, also be fine in production (if data security, redaction, 
-PII, access, and encryption concerns were all addressed. 
-Big list, but another option is to selectively enable targeted capture.
+- EnhancedErrors could, theoretically, be fine in production (if data security, redaction, 
+PII, access, and encryption concerns were addressed). Big list, but another option is to selectively enable targeted capture.
+The hooks provide a place to handle things of this sort. 
 - Has decent performance characteristics
 - **Only** becomes active in exception raise/rescue scenarios
 
@@ -445,14 +448,19 @@ Exceptions. It operates in a narrow scope--becoming active only when exceptions
 
 - **Small Overhead**: Since TracePoint is only activated during exception raising and rescuing, the performance impact is negligible during normal operation. (Benchmark included)
 
-- **TBD**: Memory considerations. This does capture data when an exception happens. EnhancedErrors hides under the bed when it sees **NoMemoryError**.
+- **TBD**: Memory considerations. This does capture data when an exception happens. EnhancedErrors hides under the bed 
+when it sees the scariest exceptions.
 
-- **Goal: Production Safety**: The gem is designed to, eventually, be made safe for production use, giving you valuable insights without compromising performance.
-I would not enable it in production *yet*.
+- **Goal: Production Safety**: The gem is designed to, eventually, be suitable for production use. 
+I might not enable it in production *yet* as it is pretty new. It would require
+a thoughtful approach (perhaps behind a feature flag, or only capturing targeted exceptions
+via the eligible for capture feature).
 
 ## Contributing
 
-Bug reports and pull requests are welcome on GitHub at [https://github.com/your_username/enhanced_errors](https://github.com/your_username/enhanced_errors).
+Bug reports and pull requests are welcome on GitHub. 
+
+* Please include tests to demonstrate your contribution working.
 
 ## License
 

data/benchmark/benchmark.rb

@@ -1,8 +1,15 @@
 require 'benchmark'
-require_relative '../lib/enhanced/enhanced' # Adjust the path if necessary
+require_relative '../lib/enhanced_errors' # Adjust the path if necessary
+
+#require 'profile'
+
+# In general, the results of this are--catching exception bindings is pretty cheap.
+# However, catching :call, :return, :b_return, :b_call are 100x more expensive.
+# Makes sense if you think about the relative frequency of things.
+
 
 # Define the number of iterations
-ITERATIONS = 10_000
+ITERATIONS = 1_000
 EXCEPTIONS_PER_BATCH = 100
 
 class Boo < StandardError; end
@@ -12,20 +19,8 @@ def calculate_cost(time_in_seconds)
   (milliseconds / (ITERATIONS / EXCEPTIONS_PER_BATCH)).round(2)
 end
 
-def with_enhanced_errors
-  EnhancedErrors.enhance_exceptions!(debug: false)
-  ITERATIONS.times do
-    begin
-      foo = 'bar'
-      @boo = 'baz'
-      raise 'Test exception with EnhancedErrors'
-    rescue => e
-      e.message
-    end
-  end
-end
 
-def without_enhanced_errors
+def raise_errors
   ITERATIONS.times do
     begin
       foo = 'bar'
@@ -38,8 +33,9 @@ def without_enhanced_errors
 end
 
 def when_capture_only_regexp_matched
+  rxp = /Boo/
   EnhancedErrors.enhance_exceptions!(debug: false) do
-    eligible_for_capture { |exception| !!/Boo/.match(exception.class.to_s) }
+    eligible_for_capture { |exception| !!rxp.match(exception.class.to_s) }
   end
 
   ITERATIONS.times do
@@ -54,8 +50,9 @@ def when_capture_only_regexp_matched
 end
 
 def when_capture_only_regexp_did_not_match
-  EnhancedErrors.enhance_exceptions!(debug: false) do
-    eligible_for_capture { |exception| !!/Baz/.match(exception.class.to_s) }
+  rxp = /Baz/
+  EnhancedErrors.enhance_exceptions!(override_messages: true) do
+    eligible_for_capture { |exception| !!rxp.match(exception.class.to_s) }
   end
 
   ITERATIONS.times do
@@ -71,18 +68,23 @@ end
 
 puts "Cost Exploration\n"
 Benchmark.bm(35) do |x|
-  without_time = x.report('10k Without EnhancedErrors:') { without_enhanced_errors }
-  with_time = x.report('10k With EnhancedErrors:') { with_enhanced_errors }
-
-  puts "\nCost per 100 exceptions (Without EnhancedErrors): #{calculate_cost(without_time.real)} ms"
-  puts "Cost per 100 exceptions (With EnhancedErrors): #{calculate_cost(with_time.real)} ms"
+  without_time = x.report('Baseline 1k (NO EnhancedErrors, tight error raise loop):') { raise_errors }
 end
 
-puts "\nProof that if you only match the classes you care about, the cost is nominal\n"
-Benchmark.bm(35) do |x|
-  matched_time = x.report('10k With capture_only_regexp match:') { when_capture_only_regexp_matched }
-  not_matched_time = x.report('10k Without capture_only_regexp match:') { when_capture_only_regexp_did_not_match }
+puts "\n"
+EnhancedErrors.enhance_exceptions!(debug: false)
 
-  puts "\nCost per 100 exceptions (Capture Only Match): #{calculate_cost(matched_time.real)} ms"
-  puts "Cost per 100 exceptions (No Match): #{calculate_cost(not_matched_time.real)} ms"
+Benchmark.bm(35) do |x|
+  with_time = x.report('Stress 1k EnhancedErrors  (Tight error raising loop w/ EnhancedErrors):') { raise_errors }
+  puts "Cost per 100 raised exceptions: #{calculate_cost(with_time.real)} ms"
 end
+
+
+# puts "\nProof that if you only match the classes you care about, the cost is nominal\n"
+# Benchmark.bm(35) do |x|
+#   matched_time = x.report('1k capture_only_regexp match (same as always-on) :') { when_capture_only_regexp_matched }
+#   not_matched_time = x.report('1k capture_only_regexp not matching (low-cost):') { when_capture_only_regexp_did_not_match }
+#
+#   puts "\nCost per 100 exceptions (Capture Only Match): #{calculate_cost(matched_time.real)} ms"
+#   puts "Cost per 100 exceptions (No Match): #{calculate_cost(not_matched_time.real)} ms"
+# end

data/benchmark/memory_bench.rb

@@ -71,7 +71,7 @@ def test_exception_with_large_variable(iterations, large_string)
   puts "Memory usage after exceptions: #{memory_usage} KB"
 end
 
-iterations = 10  # Adjust iterations as needed
+iterations = 10000  # Adjust iterations as needed
 
 test_with_tracepoint(iterations, large_string)
 test_without_tracepoint(iterations, large_string)

data/benchmark/result.txt

@@ -0,0 +1,11 @@
+Result from MacOs, Ruby 3.3.6 for benchmark.rb
+
+--------------------------------------------
+
+Cost Exploration
+                                          user     system      total        real
+Baseline 1k (NO EnhancedErrors, tight error raise loop):  0.000386   0.000049   0.000435 (  0.000434)
+
+                                          user     system      total        real
+Stress 1k EnhancedErrors  (Tight error raising loop w/ EnhancedErrors):  0.007653   0.000241   0.007894 (  0.007894)
+Cost per 100 raised exceptions: 0.79 ms

data/doc/Enhanced/Colors.html

@@ -381,9 +381,9 @@
 </div>
 
       <div id="footer">
-  Generated on Tue Dec 17 21:43:58 2024 by
+  Generated on Wed Dec 25 13:01: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).
+  0.9.37 (ruby-3.4.1).
 </div>
 
     </div>

data/doc/Enhanced/Context.html

@@ -0,0 +1,283 @@
+<!DOCTYPE html>
+<html>
+  <head>
+    <meta charset="utf-8">
+<meta name="viewport" content="width=device-width, initial-scale=1.0">
+<title>
+  Class: Enhanced::Context
+  
+    &mdash; Documentation by YARD 0.9.37
+  
+</title>
+
+  <link rel="stylesheet" href="../css/style.css" type="text/css" />
+
+  <link rel="stylesheet" href="../css/common.css" type="text/css" />
+
+<script type="text/javascript">
+  pathId = "Enhanced::Context";
+  relpath = '../';
+</script>
+
+
+  <script type="text/javascript" charset="utf-8" src="../js/jquery.js"></script>
+
+  <script type="text/javascript" charset="utf-8" src="../js/app.js"></script>
+
+
+  </head>
+  <body>
+    <div class="nav_wrap">
+      <iframe id="nav" src="../class_list.html?1"></iframe>
+      <div id="resizer"></div>
+    </div>
+
+    <div id="main" tabindex="-1">
+      <div id="header">
+        <div id="menu">
+  
+    <a href="../_index.html">Index (C)</a> &raquo;
+    <span class='title'><span class='object_link'><a href="../Enhanced.html" title="Enhanced (module)">Enhanced</a></span></span>
+     &raquo; 
+    <span class="title">Context</span>
+  
+</div>
+
+        <div id="search">
+  
+    <a class="full_list_link" id="class_list_link"
+        href="../class_list.html">
+
+        <svg width="24" height="24">
+          <rect x="0" y="4" width="24" height="4" rx="1" ry="1"></rect>
+          <rect x="0" y="12" width="24" height="4" rx="1" ry="1"></rect>
+          <rect x="0" y="20" width="24" height="4" rx="1" ry="1"></rect>
+        </svg>
+    </a>
+  
+</div>
+        <div class="clear"></div>
+      </div>
+
+      <div id="content"><h1>Class: Enhanced::Context
+  
+  
+  
+</h1>
+<div class="box_info">
+  
+  <dl>
+    <dt>Inherits:</dt>
+    <dd>
+      <span class="inheritName">Object</span>
+      
+        <ul class="fullTree">
+          <li>Object</li>
+          
+            <li class="next">Enhanced::Context</li>
+          
+        </ul>
+        <a href="#" class="inheritanceTree">show all</a>
+      
+    </dd>
+  </dl>
+  
+
+  
+  
+  
+  
+  
+
+  
+
+  
+  <dl>
+    <dt>Defined in:</dt>
+    <dd>lib/enhanced/context.rb</dd>
+  </dl>
+  
+</div>
+
+
+
+
+
+  <h2>Instance Attribute Summary <small><a href="#" class="summary_toggle">collapse</a></small></h2>
+  <ul class="summary">
+    
+      <li class="public ">
+  <span class="summary_signature">
+    
+      <a href="#binding_infos-instance_method" title="#binding_infos (instance method)">#<strong>binding_infos</strong>  &#x21d2; Object </a>
+    
+
+    
+  </span>
+  
+  
+  
+    
+    
+  
+  
+  
+  
+  
+
+  
+    <span class="summary_desc"><div class='inline'>
+<p>Returns the value of attribute binding_infos.</p>
+</div></span>
+  
+</li>
+
+    
+  </ul>
+
+
+
+
+  
+    <h2>
+      Instance Method Summary
+      <small><a href="#" class="summary_toggle">collapse</a></small>
+    </h2>
+
+    <ul class="summary">
+      
+        <li class="public ">
+  <span class="summary_signature">
+    
+      <a href="#initialize-instance_method" title="#initialize (instance method)">#<strong>initialize</strong>  &#x21d2; Context </a>
+    
+
+    
+  </span>
+  
+  
+    <span class="note title constructor">constructor</span>
+  
+  
+  
+  
+  
+  
+
+  
+    <span class="summary_desc"><div class='inline'>
+<p>A new instance of Context.</p>
+</div></span>
+  
+</li>
+
+      
+    </ul>
+  
+
+<div id="constructor_details" class="method_details_list">
+  <h2>Constructor Details</h2>
+  
+    <div class="method_details first">
+  <h3 class="signature first" id="initialize-instance_method">
+  
+    #<strong>initialize</strong>  &#x21d2; <tt><span class='object_link'><a href="" title="Enhanced::Context (class)">Context</a></span></tt> 
+  
+
+  
+
+  
+</h3><div class="docstring">
+  <div class="discussion">
+    
+<p>Returns a new instance of Context.</p>
+
+
+  </div>
+</div>
+<div class="tags">
+  
+
+</div><table class="source_code">
+  <tr>
+    <td>
+      <pre class="lines">
+
+
+5
+6
+7</pre>
+    </td>
+    <td>
+      <pre class="code"><span class="info file"># File 'lib/enhanced/context.rb', line 5</span>
+
+<span class='kw'>def</span> <span class='id identifier rubyid_initialize'>initialize</span>
+  <span class='ivar'>@binding_infos</span> <span class='op'>=</span> <span class='lbracket'>[</span><span class='rbracket'>]</span>
+<span class='kw'>end</span></pre>
+    </td>
+  </tr>
+</table>
+</div>
+  
+</div>
+
+  <div id="instance_attr_details" class="attr_details">
+    <h2>Instance Attribute Details</h2>
+    
+      
+      <span id="binding_infos=-instance_method"></span>
+      <div class="method_details first">
+  <h3 class="signature first" id="binding_infos-instance_method">
+  
+    #<strong>binding_infos</strong>  &#x21d2; <tt>Object</tt> 
+  
+
+  
+
+  
+</h3><div class="docstring">
+  <div class="discussion">
+    
+<p>Returns the value of attribute binding_infos.</p>
+
+
+  </div>
+</div>
+<div class="tags">
+  
+
+</div><table class="source_code">
+  <tr>
+    <td>
+      <pre class="lines">
+
+
+3
+4
+5</pre>
+    </td>
+    <td>
+      <pre class="code"><span class="info file"># File 'lib/enhanced/context.rb', line 3</span>
+
+<span class='kw'>def</span> <span class='id identifier rubyid_binding_infos'>binding_infos</span>
+  <span class='ivar'>@binding_infos</span>
+<span class='kw'>end</span></pre>
+    </td>
+  </tr>
+</table>
+</div>
+    
+  </div>
+
+
+</div>
+
+      <div id="footer">
+  Generated on Wed Dec 25 13:01:48 2024 by
+  <a href="https://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
+  0.9.37 (ruby-3.4.1).
+</div>
+
+    </div>
+  </body>
+</html>