enhanced_errors 2.1.3 → 3.0.0

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.
@@ -0,0 +1,397 @@
1
+ <!DOCTYPE html>
2
+ <html>
3
+ <head>
4
+ <meta charset="utf-8">
5
+ <meta name="viewport" content="width=device-width, initial-scale=1.0">
6
+ <title>
7
+ Module: EnhancedExceptionContext
8
+
9
+ &mdash; Documentation by YARD 0.9.37
10
+
11
+ </title>
12
+
13
+ <link rel="stylesheet" href="css/style.css" type="text/css" />
14
+
15
+ <link rel="stylesheet" href="css/common.css" type="text/css" />
16
+
17
+ <script type="text/javascript">
18
+ pathId = "EnhancedExceptionContext";
19
+ relpath = '';
20
+ </script>
21
+
22
+
23
+ <script type="text/javascript" charset="utf-8" src="js/jquery.js"></script>
24
+
25
+ <script type="text/javascript" charset="utf-8" src="js/app.js"></script>
26
+
27
+
28
+ </head>
29
+ <body>
30
+ <div class="nav_wrap">
31
+ <iframe id="nav" src="class_list.html?1"></iframe>
32
+ <div id="resizer"></div>
33
+ </div>
34
+
35
+ <div id="main" tabindex="-1">
36
+ <div id="header">
37
+ <div id="menu">
38
+
39
+ <a href="_index.html">Index (E)</a> &raquo;
40
+
41
+
42
+ <span class="title">EnhancedExceptionContext</span>
43
+
44
+ </div>
45
+
46
+ <div id="search">
47
+
48
+ <a class="full_list_link" id="class_list_link"
49
+ href="class_list.html">
50
+
51
+ <svg width="24" height="24">
52
+ <rect x="0" y="4" width="24" height="4" rx="1" ry="1"></rect>
53
+ <rect x="0" y="12" width="24" height="4" rx="1" ry="1"></rect>
54
+ <rect x="0" y="20" width="24" height="4" rx="1" ry="1"></rect>
55
+ </svg>
56
+ </a>
57
+
58
+ </div>
59
+ <div class="clear"></div>
60
+ </div>
61
+
62
+ <div id="content"><h1>Module: EnhancedExceptionContext
63
+
64
+
65
+
66
+ </h1>
67
+ <div class="box_info">
68
+
69
+
70
+
71
+
72
+ <dl>
73
+ <dt>Extended by:</dt>
74
+ <dd><span class='object_link'><a href="" title="EnhancedExceptionContext (module)">EnhancedExceptionContext</a></span></dd>
75
+ </dl>
76
+
77
+
78
+
79
+
80
+
81
+
82
+ <dl>
83
+ <dt>Included in:</dt>
84
+ <dd><span class='object_link'><a href="" title="EnhancedExceptionContext (module)">EnhancedExceptionContext</a></span></dd>
85
+ </dl>
86
+
87
+
88
+
89
+ <dl>
90
+ <dt>Defined in:</dt>
91
+ <dd>lib/enhanced/enhanced_exception_context.rb</dd>
92
+ </dl>
93
+
94
+ </div>
95
+
96
+
97
+
98
+ <h2>
99
+ Constant Summary
100
+ <small><a href="#" class="constants_summary_toggle">collapse</a></small>
101
+ </h2>
102
+
103
+ <dl class="constants">
104
+
105
+ <dt id="REGISTRY-constant" class="">REGISTRY =
106
+
107
+ </dt>
108
+ <dd><pre class="code"><span class='lbrace'>{</span><span class='rbrace'>}</span></pre></dd>
109
+
110
+ <dt id="MUTEX-constant" class="">MUTEX =
111
+
112
+ </dt>
113
+ <dd><pre class="code"><span class='const'>Monitor</span><span class='period'>.</span><span class='id identifier rubyid_new'>new</span></pre></dd>
114
+
115
+ </dl>
116
+
117
+
118
+
119
+
120
+
121
+
122
+
123
+
124
+
125
+ <h2>
126
+ Instance Method Summary
127
+ <small><a href="#" class="summary_toggle">collapse</a></small>
128
+ </h2>
129
+
130
+ <ul class="summary">
131
+
132
+ <li class="public ">
133
+ <span class="summary_signature">
134
+
135
+ <a href="#clear_all-instance_method" title="#clear_all (instance method)">#<strong>clear_all</strong> &#x21d2; Object </a>
136
+
137
+
138
+
139
+ </span>
140
+
141
+
142
+
143
+
144
+
145
+
146
+
147
+
148
+
149
+ <span class="summary_desc"><div class='inline'></div></span>
150
+
151
+ </li>
152
+
153
+
154
+ <li class="public ">
155
+ <span class="summary_signature">
156
+
157
+ <a href="#clear_context-instance_method" title="#clear_context (instance method)">#<strong>clear_context</strong>(exception) &#x21d2; Object </a>
158
+
159
+
160
+
161
+ </span>
162
+
163
+
164
+
165
+
166
+
167
+
168
+
169
+
170
+
171
+ <span class="summary_desc"><div class='inline'></div></span>
172
+
173
+ </li>
174
+
175
+
176
+ <li class="public ">
177
+ <span class="summary_signature">
178
+
179
+ <a href="#context_for-instance_method" title="#context_for (instance method)">#<strong>context_for</strong>(exception) &#x21d2; Object </a>
180
+
181
+
182
+
183
+ </span>
184
+
185
+
186
+
187
+
188
+
189
+
190
+
191
+
192
+
193
+ <span class="summary_desc"><div class='inline'></div></span>
194
+
195
+ </li>
196
+
197
+
198
+ <li class="public ">
199
+ <span class="summary_signature">
200
+
201
+ <a href="#store_context-instance_method" title="#store_context (instance method)">#<strong>store_context</strong>(exception, context) &#x21d2; Object </a>
202
+
203
+
204
+
205
+ </span>
206
+
207
+
208
+
209
+
210
+
211
+
212
+
213
+
214
+
215
+ <span class="summary_desc"><div class='inline'></div></span>
216
+
217
+ </li>
218
+
219
+
220
+ </ul>
221
+
222
+
223
+
224
+
225
+ <div id="instance_method_details" class="method_details_list">
226
+ <h2>Instance Method Details</h2>
227
+
228
+
229
+ <div class="method_details first">
230
+ <h3 class="signature first" id="clear_all-instance_method">
231
+
232
+ #<strong>clear_all</strong> &#x21d2; <tt>Object</tt>
233
+
234
+
235
+
236
+
237
+
238
+ </h3><table class="source_code">
239
+ <tr>
240
+ <td>
241
+ <pre class="lines">
242
+
243
+
244
+ 42
245
+ 43
246
+ 44
247
+ 45
248
+ 46</pre>
249
+ </td>
250
+ <td>
251
+ <pre class="code"><span class="info file"># File 'lib/enhanced/enhanced_exception_context.rb', line 42</span>
252
+
253
+ <span class='kw'>def</span> <span class='id identifier rubyid_clear_all'>clear_all</span>
254
+ <span class='const'><span class='object_link'><a href="#MUTEX-constant" title="EnhancedExceptionContext::MUTEX (constant)">MUTEX</a></span></span><span class='period'>.</span><span class='id identifier rubyid_synchronize'>synchronize</span> <span class='kw'>do</span>
255
+ <span class='const'><span class='object_link'><a href="#REGISTRY-constant" title="EnhancedExceptionContext::REGISTRY (constant)">REGISTRY</a></span></span><span class='period'>.</span><span class='id identifier rubyid_clear'>clear</span>
256
+ <span class='kw'>end</span>
257
+ <span class='kw'>end</span></pre>
258
+ </td>
259
+ </tr>
260
+ </table>
261
+ </div>
262
+
263
+ <div class="method_details ">
264
+ <h3 class="signature " id="clear_context-instance_method">
265
+
266
+ #<strong>clear_context</strong>(exception) &#x21d2; <tt>Object</tt>
267
+
268
+
269
+
270
+
271
+
272
+ </h3><table class="source_code">
273
+ <tr>
274
+ <td>
275
+ <pre class="lines">
276
+
277
+
278
+ 36
279
+ 37
280
+ 38
281
+ 39
282
+ 40</pre>
283
+ </td>
284
+ <td>
285
+ <pre class="code"><span class="info file"># File 'lib/enhanced/enhanced_exception_context.rb', line 36</span>
286
+
287
+ <span class='kw'>def</span> <span class='id identifier rubyid_clear_context'>clear_context</span><span class='lparen'>(</span><span class='id identifier rubyid_exception'>exception</span><span class='rparen'>)</span>
288
+ <span class='const'><span class='object_link'><a href="#MUTEX-constant" title="EnhancedExceptionContext::MUTEX (constant)">MUTEX</a></span></span><span class='period'>.</span><span class='id identifier rubyid_synchronize'>synchronize</span> <span class='kw'>do</span>
289
+ <span class='const'><span class='object_link'><a href="#REGISTRY-constant" title="EnhancedExceptionContext::REGISTRY (constant)">REGISTRY</a></span></span><span class='period'>.</span><span class='id identifier rubyid_delete'>delete</span><span class='lparen'>(</span><span class='id identifier rubyid_exception'>exception</span><span class='period'>.</span><span class='id identifier rubyid_object_id'>object_id</span><span class='rparen'>)</span>
290
+ <span class='kw'>end</span>
291
+ <span class='kw'>end</span></pre>
292
+ </td>
293
+ </tr>
294
+ </table>
295
+ </div>
296
+
297
+ <div class="method_details ">
298
+ <h3 class="signature " id="context_for-instance_method">
299
+
300
+ #<strong>context_for</strong>(exception) &#x21d2; <tt>Object</tt>
301
+
302
+
303
+
304
+
305
+
306
+ </h3><table class="source_code">
307
+ <tr>
308
+ <td>
309
+ <pre class="lines">
310
+
311
+
312
+ 20
313
+ 21
314
+ 22
315
+ 23
316
+ 24
317
+ 25
318
+ 26
319
+ 27
320
+ 28
321
+ 29
322
+ 30
323
+ 31
324
+ 32
325
+ 33
326
+ 34</pre>
327
+ </td>
328
+ <td>
329
+ <pre class="code"><span class="info file"># File 'lib/enhanced/enhanced_exception_context.rb', line 20</span>
330
+
331
+ <span class='kw'>def</span> <span class='id identifier rubyid_context_for'>context_for</span><span class='lparen'>(</span><span class='id identifier rubyid_exception'>exception</span><span class='rparen'>)</span>
332
+ <span class='const'><span class='object_link'><a href="#MUTEX-constant" title="EnhancedExceptionContext::MUTEX (constant)">MUTEX</a></span></span><span class='period'>.</span><span class='id identifier rubyid_synchronize'>synchronize</span> <span class='kw'>do</span>
333
+ <span class='id identifier rubyid_entry'>entry</span> <span class='op'>=</span> <span class='const'><span class='object_link'><a href="#REGISTRY-constant" title="EnhancedExceptionContext::REGISTRY (constant)">REGISTRY</a></span></span><span class='lbracket'>[</span><span class='id identifier rubyid_exception'>exception</span><span class='period'>.</span><span class='id identifier rubyid_object_id'>object_id</span><span class='rbracket'>]</span>
334
+ <span class='kw'>return</span> <span class='kw'>nil</span> <span class='kw'>unless</span> <span class='id identifier rubyid_entry'>entry</span>
335
+
336
+ <span class='kw'>begin</span>
337
+ <span class='id identifier rubyid__'>_</span> <span class='op'>=</span> <span class='id identifier rubyid_entry'>entry</span><span class='lbracket'>[</span><span class='symbol'>:weak_exc</span><span class='rbracket'>]</span><span class='period'>.</span><span class='id identifier rubyid___getobj__'>__getobj__</span> <span class='comment'># ensure exception is still alive
338
+ </span> <span class='id identifier rubyid_entry'>entry</span><span class='lbracket'>[</span><span class='symbol'>:context</span><span class='rbracket'>]</span>
339
+ <span class='kw'>rescue</span> <span class='const'>RefError</span>
340
+ <span class='comment'># Exception no longer alive, clean up
341
+ </span> <span class='const'><span class='object_link'><a href="#REGISTRY-constant" title="EnhancedExceptionContext::REGISTRY (constant)">REGISTRY</a></span></span><span class='period'>.</span><span class='id identifier rubyid_delete'>delete</span><span class='lparen'>(</span><span class='id identifier rubyid_exception'>exception</span><span class='period'>.</span><span class='id identifier rubyid_object_id'>object_id</span><span class='rparen'>)</span>
342
+ <span class='kw'>nil</span>
343
+ <span class='kw'>end</span>
344
+ <span class='kw'>end</span>
345
+ <span class='kw'>end</span></pre>
346
+ </td>
347
+ </tr>
348
+ </table>
349
+ </div>
350
+
351
+ <div class="method_details ">
352
+ <h3 class="signature " id="store_context-instance_method">
353
+
354
+ #<strong>store_context</strong>(exception, context) &#x21d2; <tt>Object</tt>
355
+
356
+
357
+
358
+
359
+
360
+ </h3><table class="source_code">
361
+ <tr>
362
+ <td>
363
+ <pre class="lines">
364
+
365
+
366
+ 14
367
+ 15
368
+ 16
369
+ 17
370
+ 18</pre>
371
+ </td>
372
+ <td>
373
+ <pre class="code"><span class="info file"># File 'lib/enhanced/enhanced_exception_context.rb', line 14</span>
374
+
375
+ <span class='kw'>def</span> <span class='id identifier rubyid_store_context'>store_context</span><span class='lparen'>(</span><span class='id identifier rubyid_exception'>exception</span><span class='comma'>,</span> <span class='id identifier rubyid_context'>context</span><span class='rparen'>)</span>
376
+ <span class='const'><span class='object_link'><a href="#MUTEX-constant" title="EnhancedExceptionContext::MUTEX (constant)">MUTEX</a></span></span><span class='period'>.</span><span class='id identifier rubyid_synchronize'>synchronize</span> <span class='kw'>do</span>
377
+ <span class='const'><span class='object_link'><a href="#REGISTRY-constant" title="EnhancedExceptionContext::REGISTRY (constant)">REGISTRY</a></span></span><span class='lbracket'>[</span><span class='id identifier rubyid_exception'>exception</span><span class='period'>.</span><span class='id identifier rubyid_object_id'>object_id</span><span class='rbracket'>]</span> <span class='op'>=</span> <span class='lbrace'>{</span> <span class='label'>weak_exc:</span> <span class='const'>WeakRef</span><span class='period'>.</span><span class='id identifier rubyid_new'>new</span><span class='lparen'>(</span><span class='id identifier rubyid_exception'>exception</span><span class='rparen'>)</span><span class='comma'>,</span> <span class='label'>context:</span> <span class='id identifier rubyid_context'>context</span> <span class='rbrace'>}</span>
378
+ <span class='kw'>end</span>
379
+ <span class='kw'>end</span></pre>
380
+ </td>
381
+ </tr>
382
+ </table>
383
+ </div>
384
+
385
+ </div>
386
+
387
+ </div>
388
+
389
+ <div id="footer">
390
+ Generated on Tue Dec 17 15:42:48 2024 by
391
+ <a href="https://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
392
+ 0.9.37 (ruby-3.3.6).
393
+ </div>
394
+
395
+ </div>
396
+ </body>
397
+ </html>
data/doc/Exception.html CHANGED
@@ -71,6 +71,11 @@
71
71
 
72
72
 
73
73
 
74
+ <dl>
75
+ <dt>Includes:</dt>
76
+ <dd><span class='object_link'><a href="ExceptionBindingInfos.html" title="ExceptionBindingInfos (module)">ExceptionBindingInfos</a></span></dd>
77
+ </dl>
78
+
74
79
 
75
80
 
76
81
 
@@ -83,165 +88,30 @@
83
88
 
84
89
  </div>
85
90
 
86
- <h2>Overview</h2><div class="docstring">
87
- <div class="discussion">
88
-
89
- <p>exception.rb</p>
90
91
 
91
92
 
92
- </div>
93
- </div>
94
- <div class="tags">
95
-
96
93
 
97
- </div>
98
94
 
99
95
 
100
96
 
101
97
 
102
98
 
103
-
104
-
105
- <h2>
106
- Instance Method Summary
107
- <small><a href="#" class="summary_toggle">collapse</a></small>
108
- </h2>
109
-
110
- <ul class="summary">
111
-
112
- <li class="public ">
113
- <span class="summary_signature">
114
-
115
- <a href="#binding_infos-instance_method" title="#binding_infos (instance method)">#<strong>binding_infos</strong> &#x21d2; Object </a>
116
-
117
-
118
-
119
- </span>
120
-
121
99
 
122
100
 
123
101
 
124
102
 
125
103
 
126
104
 
127
-
128
-
129
- <span class="summary_desc"><div class='inline'></div></span>
105
+ <h2>Method Summary</h2>
130
106
 
131
- </li>
132
-
133
-
134
- <li class="public ">
135
- <span class="summary_signature">
136
-
137
- <a href="#captured_variables-instance_method" title="#captured_variables (instance method)">#<strong>captured_variables</strong> &#x21d2; Object </a>
138
-
107
+ <h3 class="inherited">Methods included from <span class='object_link'><a href="ExceptionBindingInfos.html" title="ExceptionBindingInfos (module)">ExceptionBindingInfos</a></span></h3>
108
+ <p class="inherited"><span class='object_link'><a href="ExceptionBindingInfos.html#binding_infos-instance_method" title="ExceptionBindingInfos#binding_infos (method)">#binding_infos</a></span>, <span class='object_link'><a href="ExceptionBindingInfos.html#captured_variables-instance_method" title="ExceptionBindingInfos#captured_variables (method)">#captured_variables</a></span></p>
139
109
 
140
-
141
- </span>
142
-
143
-
144
-
145
-
146
-
147
-
148
-
149
-
150
-
151
- <span class="summary_desc"><div class='inline'></div></span>
152
-
153
- </li>
154
-
155
-
156
- </ul>
157
-
158
-
159
-
160
-
161
- <div id="instance_method_details" class="method_details_list">
162
- <h2>Instance Method Details</h2>
163
-
164
-
165
- <div class="method_details first">
166
- <h3 class="signature first" id="binding_infos-instance_method">
167
-
168
- #<strong>binding_infos</strong> &#x21d2; <tt>Object</tt>
169
-
170
-
171
-
172
-
173
-
174
- </h3><table class="source_code">
175
- <tr>
176
- <td>
177
- <pre class="lines">
178
-
179
-
180
- 15
181
- 16
182
- 17</pre>
183
- </td>
184
- <td>
185
- <pre class="code"><span class="info file"># File 'lib/enhanced/exception.rb', line 15</span>
186
-
187
- <span class='kw'>def</span> <span class='id identifier rubyid_binding_infos'>binding_infos</span>
188
- <span class='ivar'>@binding_infos</span> <span class='op'>||=</span> <span class='lbracket'>[</span><span class='rbracket'>]</span>
189
- <span class='kw'>end</span></pre>
190
- </td>
191
- </tr>
192
- </table>
193
- </div>
194
-
195
- <div class="method_details ">
196
- <h3 class="signature " id="captured_variables-instance_method">
197
-
198
- #<strong>captured_variables</strong> &#x21d2; <tt>Object</tt>
199
-
200
-
201
-
202
-
203
-
204
- </h3><table class="source_code">
205
- <tr>
206
- <td>
207
- <pre class="lines">
208
-
209
-
210
- 4
211
- 5
212
- 6
213
- 7
214
- 8
215
- 9
216
- 10
217
- 11
218
- 12
219
- 13</pre>
220
- </td>
221
- <td>
222
- <pre class="code"><span class="info file"># File 'lib/enhanced/exception.rb', line 4</span>
223
-
224
- <span class='kw'>def</span> <span class='id identifier rubyid_captured_variables'>captured_variables</span>
225
- <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>
226
- <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>
227
- <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>
228
- <span class='kw'>else</span>
229
- <span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_end'>&#39;</span></span>
230
- <span class='kw'>end</span>
231
- <span class='kw'>rescue</span>
232
- <span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_end'>&#39;</span></span>
233
- <span class='kw'>end</span></pre>
234
- </td>
235
- </tr>
236
- </table>
237
- </div>
238
-
239
- </div>
240
110
 
241
111
  </div>
242
112
 
243
113
  <div id="footer">
244
- Generated on Mon Dec 16 11:33:57 2024 by
114
+ Generated on Tue Dec 17 15:42:48 2024 by
245
115
  <a href="https://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
246
116
  0.9.37 (ruby-3.3.6).
247
117
  </div>