enhanced_errors 3.0.4 → 3.0.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: fcc0ec081a5d0c8971d430b9d87a241c5678d07037a661fc3202b9b5cc416840
-  data.tar.gz: c136809b9cb0927ec57f95df48a30020875dd0725c6c0efd3983235d8ae2cc82
+  metadata.gz: e6463163f60ad8df047c834d0722ebfc800bbb8a9b57773d064b2a22eaeead69
+  data.tar.gz: 53c886d04c8b1c518d9a4d05262947f95ba462b9b3cd76cb913c2f2142080a6d
 SHA512:
-  metadata.gz: 4d7c0b9e0ae3d02b32442b9a02c9c1b29f35051e2c0c4c9de085a60c11fa7d05b132602ebabfdc438f4721b579deefd561efa13c470324fa5ccd341015eabeee
-  data.tar.gz: b004525dd0f9dfa3327067b78b3cdf2a9db98bbfa75bd85dc348e220c7ab966d6b8360c0157e8bc23d39a8e8f65219e53c069ad242dda10cf83c5756e96fadf1
+  metadata.gz: 4428ec99b50fd747204426fe2059b140ed335f38486babd0f5882380391490ce5c1ef4e97a55e3fcf0caceabe099c59f5813bb2be722ab7edb584278d6e06afd
+  data.tar.gz: e30adc9c45a925c84bc9b97f07e8a96d351325dc74880b7ee1b38f7b02e96cafec3f91b25bedafcb87793d5c11fd90aee9ec3f1bd4c426263a17a91e6ce72acf

data/README.md

@@ -40,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!
 
 ```
@@ -126,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`).
@@ -140,14 +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.
-* LLM-food - Feed debug info with variables into an LLM, making state examine-able for it
 
 ## 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,10 +448,13 @@ 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
 
@@ -459,3 +465,4 @@ Bug reports and pull requests are welcome on GitHub.
 ## License
 
 The gem is available as open-source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
+

data/benchmark/result.txt

@@ -3,11 +3,9 @@ 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.000296   0.000040   0.000336 (  0.000334)
-
-Cost per 100 raised exceptions: 0.56 ms
-                                                                             user     system      total        real
-Stress 1k EnhancedErrors  (Tight error raising loop w/ EnhancedErrors):  0.005498   0.000147   0.005645 (  0.005647)
-
+                                          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 24 15:27:20 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.1.3).
+  0.9.37 (ruby-3.4.1).
 </div>
 
     </div>

data/doc/Enhanced/Context.html

@@ -273,9 +273,9 @@
 </div>
 
       <div id="footer">
-  Generated on Tue Dec 24 15:27:20 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.1.3).
+  0.9.37 (ruby-3.4.1).
 </div>
 
     </div>

data/doc/Enhanced/ExceptionBindingInfos.html

@@ -217,21 +217,15 @@
 18
 19
 20
-21
-22
-23
-24</pre>
+21</pre>
     </td>
     <td>
       <pre class="code"><span class="info file"># File 'lib/enhanced/exception.rb', line 15</span>
 
 <span class='kw'>def</span> <span class='id identifier rubyid_captured_variables'>captured_variables</span>
-  <span class='kw'>if</span> <span class='id identifier rubyid_binding_infos'>binding_infos</span><span class='period'>.</span><span class='id identifier rubyid_any?'>any?</span>
-    <span class='id identifier rubyid_bindings_of_interest'>bindings_of_interest</span> <span class='op'>=</span> <span class='id identifier rubyid_select_binding_infos'>select_binding_infos</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_format'><span class='object_link'><a href="../EnhancedErrors.html#format-class_method" title="EnhancedErrors.format (method)">format</a></span></span><span class='lparen'>(</span><span class='id identifier rubyid_bindings_of_interest'>bindings_of_interest</span><span class='rparen'>)</span>
-  <span class='kw'>else</span>
-    <span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_end'>&#39;</span></span>
-  <span class='kw'>end</span>
+  <span class='kw'>return</span> <span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_end'>&#39;</span></span> <span class='kw'>unless</span> <span class='id identifier rubyid_binding_infos'>binding_infos</span><span class='op'>&amp;.</span><span class='id identifier rubyid_any?'>any?</span>
+  <span class='id identifier rubyid_bindings_of_interest'>bindings_of_interest</span> <span class='op'>=</span> <span class='id identifier rubyid_select_binding_infos'>select_binding_infos</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_format'><span class='object_link'><a href="../EnhancedErrors.html#format-class_method" title="EnhancedErrors.format (method)">format</a></span></span><span class='lparen'>(</span><span class='id identifier rubyid_bindings_of_interest'>bindings_of_interest</span><span class='rparen'>)</span>
 <span class='kw'>rescue</span>
   <span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_end'>&#39;</span></span>
 <span class='kw'>end</span></pre>
@@ -245,9 +239,9 @@
 </div>
 
       <div id="footer">
-  Generated on Tue Dec 24 15:27:20 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.1.3).
+  0.9.37 (ruby-3.4.1).
 </div>
 
     </div>

data/doc/Enhanced/ExceptionContext.html

@@ -387,9 +387,9 @@
 </div>
 
       <div id="footer">
-  Generated on Tue Dec 24 15:27:20 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.1.3).
+  0.9.37 (ruby-3.4.1).
 </div>
 
     </div>

data/doc/Enhanced.html

@@ -114,9 +114,9 @@
 </div>
 
       <div id="footer">
-  Generated on Tue Dec 24 15:27:20 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.1.3).
+  0.9.37 (ruby-3.4.1).
 </div>
 
     </div>