RubyGems - enhanced_errors - Versions diffs - 2.0.1 → 2.0.3 - Mend

enhanced_errors 2.0.1 → 2.0.3

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Files changed (24) hide show

checksums.yaml +4 -4
data/.yardoc/checksums +4 -4
data/.yardoc/object_types +0 -0
data/.yardoc/objects/root.dat +0 -0
data/doc/{Colors.html → Enhanced/Colors.html} +28 -28
data/doc/Enhanced/Integrations/RSpecErrorFailureMessage.html +182 -0
data/doc/Enhanced/Integrations.html +115 -0
data/doc/{Binding.html → Enhanced.html} +26 -39
data/doc/EnhancedErrors.html +998 -1332
data/doc/Exception.html +251 -0
data/doc/_index.html +28 -17
data/doc/class_list.html +1 -1
data/doc/file.README.html +116 -37
data/doc/index.html +116 -37
data/doc/method_list.html +83 -27
data/doc/top-level-namespace.html +9 -26
data/enhanced_errors.gemspec +1 -1
data/lib/enhanced_errors.rb +41 -15
metadata +7 -9
data/doc/Debugging.html +0 -181
data/doc/ErrorEnhancements.html +0 -258
data/doc/images/enhance.png +0 -0
data/doc/images/enhanced-error.png +0 -0
data/doc/images/enhanced-spec.png +0 -0

data/enhanced_errors.gemspec CHANGED Viewed

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

@@ -22,7 +22,7 @@ class EnhancedErrors
                   :override_messages
     GEMS_REGEX = %r{[\/\\]gems[\/\\]}
-    DEFAULT_MAX_LENGTH = 2500
+    DEFAULT_MAX_LENGTH = 3000
     # Maximum binding infos we will track per-exception instance. This is intended as an extra
     # safety rail, not a normal scenario.
@@ -30,6 +30,8 @@ class EnhancedErrors
     # Add @__memoized and @__inspect_output to the skip list so they don't appear in output
     RSPEC_SKIP_LIST = Set.new([
+                                :@assertions,
+                                :@integration_session,
                                 :@example,
                                 :@fixture_cache,
                                 :@fixture_cache_key,
@@ -38,6 +40,7 @@ class EnhancedErrors
                                 :@loaded_fixtures,
                                 :@connection_subscriber,
                                 :@saved_pool_configs,
+                                :@assertion_instance,
                                 :@legacy_saved_pool_configs,
                                 :@matcher_definitions,
                                 :@__memoized,
@@ -50,11 +53,13 @@ class EnhancedErrors
                                 :@association_cache,
                                 :@readonly,
                                 :@previously_new_record,
+                                :@routes, # usually just shows #<ActionDispatch::Routing::RouteSet:0x000000016087d708>
                                 :@destroyed,
                                 :@marked_for_destruction,
                                 :@destroyed_by_association,
                                 :@primary_key,
                                 :@strict_loading,
+                                :@assertion_instance,
                                 :@strict_loading_mode,
                                 :@mutations_before_last_save,
                                 :@mutations_from_database,
@@ -62,7 +67,8 @@ class EnhancedErrors
                                 :@predicate_builder,
                                 :@generated_relation_method,
                                 :@find_by_statement_cache,
-                                :@arel_table
+                                :@arel_table,
+                                :@response_klass,
                               ])
     @enabled = false
@@ -192,10 +198,14 @@ class EnhancedErrors
       @rspec_tracepoint = TracePoint.new(:b_return) do |tp|
         # This is super-kluge-y and should be replaced with... something TBD
-        if tp.self.class.name =~ /RSpec::ExampleGroups::[A-Z0-9]+.*/ &&
+        # fixes cases where class and name are screwed up or overridden
+        name = determine_object_name(tp)
+        if name =~ /RSpec::ExampleGroups::[A-Z0-9]+.*/ &&
            tp.method_id.nil? &&
-           !(tp.path =~ /rspec/) &&
-           tp.path =~ /_spec\.rb$/
+           !(tp.path.to_s =~ /rspec/) &&
+           tp.path.to_s =~ /_spec\.rb$/
           @rspec_example_binding = tp.binding
         end
       end
@@ -562,27 +572,43 @@ class EnhancedErrors
           value = locals.include?(name) ? safe_local_variable_get(bind, name) : nil
           "#{name}=#{safe_inspect(value)}"
         rescue => e
-          "#{name}=#<Error getting argument: #{e.message}>"
+          "#{name}=[Error getting argument: #{e.message}]"
         end.join(", ")
       rescue => e
-        "#<Error getting arguments: #{e.message}>"
+        "[Error getting arguments: #{e.message}]"
       end
     end
-    def determine_object_name(tp, method_name)
-      if tp.self.is_a?(Class) && tp.self.singleton_class == tp.defined_class
-        "#{safe_to_s(tp.self)}.#{method_name}"
-      else
-        "#{safe_to_s(tp.self.class.name)}##{method_name}"
+    def determine_object_name(tp, method_name = '')
+      begin
+        # These tricks are used to get around the fact that `tp.self` can be a class that is
+        # wired up with method_missing where every direct call alters the class. This is true
+        # on certain builders or config objects and caused problems.
+        # Directly bind and call the `class` method to avoid triggering `method_missing`
+        self_class = Object.instance_method(:class).bind(tp.self).call
+        # Similarly, bind and call `singleton_class` safely
+        singleton_class = Object.instance_method(:singleton_class).bind(tp.self).call
+        if self_class && tp.defined_class == singleton_class
+          object_identifier = safe_to_s(tp.self)
+          method_suffix = method_name && !method_name.empty? ? ".#{method_name}" : ""
+          "#{object_identifier}#{method_suffix}"
+        else
+          object_class_name = safe_to_s(self_class.name || 'UnknownClass')
+          method_suffix = method_name && !method_name.empty? ? "##{method_name}" : ""
+          "#{object_class_name}#{method_suffix}"
+        end
+      rescue Exception => e
+        '[ErrorGettingName]'
       end
-    rescue => e
-      "#<Error inspecting value: #{e.message}>"
     end
     def get_global_variable_value(var)
       var.is_a?(Symbol) ? eval("#{var}") : nil
     rescue => e
-      "#<Error getting value for #{var}>"
+      "[Error getting value for #{var}]"
     end
     def method_and_args_desc(method_info)

metadata CHANGED Viewed

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: enhanced_errors
 version: !ruby/object:Gem::Version
-  version: 2.0.1
+  version: 2.0.3
 platform: ruby
 authors:
 - Eric Beland
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2024-12-09 00:00:00.000000000 Z
+date: 2024-12-10 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: awesome_print
@@ -70,11 +70,12 @@ files:
 - benchmark/benchmark.rb
 - benchmark/memory_bench.rb
 - benchmark/stackprofile.rb
-- doc/Binding.html
-- doc/Colors.html
-- doc/Debugging.html
+- doc/Enhanced.html
+- doc/Enhanced/Colors.html
+- doc/Enhanced/Integrations.html
+- doc/Enhanced/Integrations/RSpecErrorFailureMessage.html
 - doc/EnhancedErrors.html
-- doc/ErrorEnhancements.html
+- doc/Exception.html
 - doc/_index.html
 - doc/class_list.html
 - doc/css/common.css
@@ -83,9 +84,6 @@ files:
 - doc/file.README.html
 - doc/file_list.html
 - doc/frames.html
-- doc/images/enhance.png
-- doc/images/enhanced-error.png
-- doc/images/enhanced-spec.png
 - doc/index.html
 - doc/js/app.js
 - doc/js/full_list.js

data/doc/Debugging.html DELETED Viewed

@@ -1,181 +0,0 @@
-<!DOCTYPE html>
-<html>
-  <head>
-    <meta charset="utf-8">
-<meta name="viewport" content="width=device-width, initial-scale=1.0">
-<title>
-  Module: Debugging
-    &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 = "Debugging";
-  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 (D)</a> &raquo;
-    <span class="title">Debugging</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>Module: Debugging
-</h1>
-<div class="box_info">
-  <dl>
-    <dt>Included in:</dt>
-    <dd><span class='object_link'><a href="Binding.html" title="Binding (class)">Binding</a></span></dd>
-  </dl>
-  <dl>
-    <dt>Defined in:</dt>
-    <dd>lib/binding.rb</dd>
-  </dl>
-</div>
-    <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="#let_vars_hash-instance_method" title="#let_vars_hash (instance method)">#<strong>let_vars_hash</strong>  &#x21d2; Object </a>
-  </span>
-    <span class="summary_desc"><div class='inline'></div></span>
-</li>
-    </ul>
-  <div id="instance_method_details" class="method_details_list">
-    <h2>Instance Method Details</h2>
-      <div class="method_details first">
-  <h3 class="signature first" id="let_vars_hash-instance_method">
-    #<strong>let_vars_hash</strong>  &#x21d2; <tt>Object</tt>
-</h3><table class="source_code">
-  <tr>
-    <td>
-      <pre class="lines">
-2
-3
-4
-5</pre>
-    </td>
-    <td>
-      <pre class="code"><span class="info file"># File 'lib/binding.rb', line 2</span>
-<span class='kw'>def</span> <span class='id identifier rubyid_let_vars_hash'>let_vars_hash</span>
-  <span class='id identifier rubyid_memoized_values'>memoized_values</span> <span class='op'>=</span> <span class='kw'>self</span><span class='period'>.</span><span class='id identifier rubyid_receiver'>receiver</span><span class='period'>.</span><span class='id identifier rubyid_instance_variable_get'>instance_variable_get</span><span class='lparen'>(</span><span class='symbol'>:@__memoized</span><span class='rparen'>)</span><span class='op'>&amp;.</span><span class='id identifier rubyid_instance_variable_get'>instance_variable_get</span><span class='lparen'>(</span><span class='symbol'>:@memoized</span><span class='rparen'>)</span>
-  <span class='id identifier rubyid_memoized_values'>memoized_values</span> <span class='op'>&amp;&amp;</span> <span class='op'>!</span><span class='id identifier rubyid_memoized_values'>memoized_values</span><span class='period'>.</span><span class='id identifier rubyid_empty?'>empty?</span> <span class='op'>?</span> <span class='id identifier rubyid_memoized_values'>memoized_values</span><span class='period'>.</span><span class='id identifier rubyid_dup'>dup</span> <span class='op'>:</span> <span class='lbrace'>{</span><span class='rbrace'>}</span>
-<span class='kw'>end</span></pre>
-    </td>
-  </tr>
-</table>
-</div>
-  </div>
-</div>
-      <div id="footer">
-  Generated on Sun Nov 10 12:01:14 2024 by
-  <a href="https://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
-  0.9.37 (ruby-3.1.3).
-</div>
-    </div>
-  </body>
-</html>

data/doc/ErrorEnhancements.html DELETED Viewed

@@ -1,258 +0,0 @@
-<!DOCTYPE html>
-<html>
-  <head>
-    <meta charset="utf-8">
-<meta name="viewport" content="width=device-width, initial-scale=1.0">
-<title>
-  Module: ErrorEnhancements
-    &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 = "ErrorEnhancements";
-  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 (E)</a> &raquo;
-    <span class="title">ErrorEnhancements</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>Module: ErrorEnhancements
-</h1>
-<div class="box_info">
-  <dl>
-    <dt>Defined in:</dt>
-    <dd>lib/error_enhancements.rb</dd>
-  </dl>
-</div>
-    <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="#message-instance_method" title="#message (instance method)">#<strong>message</strong>  &#x21d2; Object </a>
-  </span>
-    <span class="summary_desc"><div class='inline'></div></span>
-</li>
-        <li class="public ">
-  <span class="summary_signature">
-      <a href="#variables_message-instance_method" title="#variables_message (instance method)">#<strong>variables_message</strong>  &#x21d2; Object </a>
-  </span>
-    <span class="summary_desc"><div class='inline'></div></span>
-</li>
-    </ul>
-  <div id="instance_method_details" class="method_details_list">
-    <h2>Instance Method Details</h2>
-      <div class="method_details first">
-  <h3 class="signature first" id="message-instance_method">
-    #<strong>message</strong>  &#x21d2; <tt>Object</tt>
-</h3><table class="source_code">
-  <tr>
-    <td>
-      <pre class="lines">
-2
-3
-4
-5
-6
-7
-8
-9
-10
-11</pre>
-    </td>
-    <td>
-      <pre class="code"><span class="info file"># File 'lib/error_enhancements.rb', line 2</span>
-<span class='kw'>def</span> <span class='id identifier rubyid_message'>message</span>
-  <span class='id identifier rubyid_original_message'>original_message</span> <span class='op'>=</span> <span class='kw'>super</span><span class='lparen'>(</span><span class='rparen'>)</span>
-  <span class='kw'>if</span> <span class='id identifier rubyid_original_message'>original_message</span><span class='period'>.</span><span class='id identifier rubyid_include?'>include?</span><span class='lparen'>(</span><span class='id identifier rubyid_variables_message'>variables_message</span><span class='rparen'>)</span>
-    <span class='id identifier rubyid_original_message'>original_message</span>
-  <span class='kw'>else</span>
-    <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='embexpr_beg'>#{</span><span class='id identifier rubyid_original_message'>original_message</span><span class='embexpr_end'>}</span><span class='tstring_content'>\n</span><span class='embexpr_beg'>#{</span><span class='id identifier rubyid_variables_message'>variables_message</span><span class='embexpr_end'>}</span><span class='tstring_end'>&quot;</span></span>
-  <span class='kw'>end</span>
-<span class='kw'>rescue</span> <span class='op'>=&gt;</span> <span class='id identifier rubyid_e'>e</span>
-  <span class='id identifier rubyid_original_message'>original_message</span>
-<span class='kw'>end</span></pre>
-    </td>
-  </tr>
-</table>
-</div>
-      <div class="method_details ">
-  <h3 class="signature " id="variables_message-instance_method">
-    #<strong>variables_message</strong>  &#x21d2; <tt>Object</tt>
-</h3><table class="source_code">
-  <tr>
-    <td>
-      <pre class="lines">
-13
-14
-15
-16
-17
-18
-19
-20
-21
-22
-23
-24</pre>
-    </td>
-    <td>
-      <pre class="code"><span class="info file"># File 'lib/error_enhancements.rb', line 13</span>
-<span class='kw'>def</span> <span class='id identifier rubyid_variables_message'>variables_message</span>
-  <span class='ivar'>@variables_message</span> <span class='op'>||=</span> <span class='kw'>begin</span>
-                           <span class='id identifier rubyid_bindings_of_interest'>bindings_of_interest</span> <span class='op'>=</span> <span class='lbracket'>[</span><span class='rbracket'>]</span>
-                           <span class='kw'>if</span> <span class='kw'>defined?</span><span class='lparen'>(</span><span class='ivar'>@binding_infos</span><span class='rparen'>)</span> <span class='op'>&amp;&amp;</span> <span class='ivar'>@binding_infos</span> <span class='op'>&amp;&amp;</span> <span class='op'>!</span><span class='ivar'>@binding_infos</span><span class='period'>.</span><span class='id identifier rubyid_empty?'>empty?</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='lparen'>(</span><span class='ivar'>@binding_infos</span><span class='rparen'>)</span>
-                           <span class='kw'>end</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='op'>=&gt;</span> <span class='id identifier rubyid_e'>e</span>
-                           <span class='id identifier rubyid_puts'>puts</span> <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>Error in variables_message: </span><span class='embexpr_beg'>#{</span><span class='id identifier rubyid_e'>e</span><span class='period'>.</span><span class='id identifier rubyid_message'>message</span><span class='embexpr_end'>}</span><span class='tstring_end'>&quot;</span></span>
-                           <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_end'>&quot;</span></span>
-                         <span class='kw'>end</span>
-<span class='kw'>end</span></pre>
-    </td>
-  </tr>
-</table>
-</div>
-  </div>
-</div>
-      <div id="footer">
-  Generated on Sun Nov 10 12:01:14 2024 by
-  <a href="https://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
-  0.9.37 (ruby-3.1.3).
-</div>
-    </div>
-  </body>
-</html>

data/doc/images/enhance.png DELETED Viewed

Binary file

data/doc/images/enhanced-error.png DELETED Viewed

Binary file

data/doc/images/enhanced-spec.png DELETED Viewed

Binary file